Sensor - stingray.Sensor namespace reference - Stingray Lua API Reference
Description
Interface to communicate with devices sensors.
Accelerometer
 |
accelerometer_acceleration ( ) : stingray.Vector3
Returns acceleration from the devices in raw platform defined resolution.
|
| This function does not accept any parameters. |
|
Returns the accelerometers acceleration. |
Acceleration multiplied by acceleration resolution is G (9.81 m s^-2) in 3-axis.
| |
accelerometer_available ( ) : boolean
Indicates whether or not the devices has a available accelerometer.
|
| This function does not accept any parameters. |
boolean |
Returns true if the devices has a available accelerometer, or false otherwise. |
| |
accelerometer_frequency ( ) : number
Returns the devices current accelerometer update frequency,
if frequency is 0hz the accelerometer is not measuring any acceleration.
|
| This function does not accept any parameters. |
number |
Returns the accelerometer update frequency in hz. |
| |
accelerometer_resolution ( ) : stingray.Vector3
Returns acceleration resolution to be multiplied with acceleration.
|
| This function does not accept any parameters. |
|
Returns the acceleration resolution. |
Acceleration multiplied by accelerometer_acceleration_resolution is G (9.81 m s^-2) in 3-axis.
| |
set_accelerometer_frequency ( frequency )
Sets the update frequency for the accelerometer,
if 0hz is given as frequency the accelerometer is turned off.
|
frequency : | number |
Update frequency for accelerometer in hz. |
| This function does not return any values. |
Gravity Sensor
| |
gravity_sensor_available ( ) : boolean
Indicates whether or not the devices has a available gravity sensor.
|
| This function does not accept any parameters. |
boolean |
Returns true if the devices has a available gravity sensor, or false otherwise. |
| |
gravity_sensor_frequency ( ) : number
Returns the devices current gravity sensor update frequency,
if frequency is 0hz the gravity sensor it is not measuring any gravity.
|
| This function does not accept any parameters. |
number |
Returns the gravity sensor update frequency in hz. |
| |
gravity_sensor_gravity ( ) : stingray.Vector3
Returns gravity from the devices in raw platform defined resolution.
|
| This function does not accept any parameters. |
|
Returns the gravity sensor gravity. |
Gravity multiplied by acceleration resolution is G (9.81 m s^-2) in 3-axis.
| |
gravity_sensor_resolution ( ) : stingray.Vector3
Returns gravity resolution to be multiplied with gravity.
|
| This function does not accept any parameters. |
|
Returns the gravity resolution. |
Gravity multiplied by acceleration resolution is G (9.81 m s^-2) in 3-axis.
| |
set_gravity_sensor_frequency ( frequency )
Sets the update frequency for the gravity sensor,
if 0hz is given as frequency the gravity sensor is turned off.
|
frequency : | number |
Update frequency for gravity sensor in hz. |
| This function does not return any values. |
Gyroscope
| |
gyroscope_available ( ) : boolean
Indicates whether or not the devices has a available gyroscope.
|
| This function does not accept any parameters. |
boolean |
Returns true if the devices has a available gyroscope, or false otherwise. |
| |
gyroscope_frequency ( ) : number
Returns the devices current gyroscope update frequency,
if frequency is 0hz the gyroscope is not measuring any acceleration.
|
| This function does not accept any parameters. |
number |
Returns the gyroscope update frequency in hz. |
| |
gyroscope_rotation_rate ( ) : stingray.Vector3
Returns rotation rate from in degrees per second in 3-axis.
|
| This function does not accept any parameters. |
|
Returns the gyroscopes rotation rate. |
| |
set_gyroscope_frequency ( frequency )
Sets the update frequency for the gyroscope,
if 0hz is given as frequency the gyroscope is turned off.
|
frequency : | number |
Update frequency for gyroscope in hz. |
| This function does not return any values. |
Magnetometer
| |
magnetometer_available ( ) : boolean
Indicates whether or not the devices has a available magnetometer.
|
| This function does not accept any parameters. |
boolean |
Returns true if the devices has a available magnetometer, or false otherwise. |
| |
magnetometer_calibrated_magnetic_field ( ) : stingray.Vector3
Returns magnetic field from the devices as calibrated platform defined resolution,
or the same value as magnetometer_magnetic_field if calibrations was not available.
|
| This function does not accept any parameters. |
|
Returns the calibrated magnetometer magnetic field. |
Calibrated magnetic field multiplied by magnetic field resolution is magnetic field in microteslas in 3-axis.
| |
magnetometer_calibration_available ( ) : boolean
Indicates whether or not the devices can calibrate magnetometer.
|
| This function does not accept any parameters. |
boolean |
Returns true if the devices can calibrate magnetometer, or false otherwise. |
| |
magnetometer_frequency ( ) : number
Returns the devices current magnetometer update frequency,
if frequency is 0hz the magnetometer is not measuring any magnetic field.
|
| This function does not accept any parameters. |
number |
Returns the magnetometer update frequency in hz. |
| |
magnetometer_magnetic_field ( ) : stingray.Vector3
Returns magnetic field from the devices in raw platform defined resolution.
|
| This function does not accept any parameters. |
|
Returns the magnetometer magnetic field. |
Magnetic field multiplied by magnetic field resolution is magnetic field in microteslas in 3-axis.
| |
magnetometer_resolution ( ) : stingray.Vector3
Returns magnetic field resolution to be multiplied with magnetic field.
|
| This function does not accept any parameters. |
|
Returns the magnetic field resolution. |
Magnetic field multiplied by magnetic field resolution is magnetic field in microteslas in 3-axis.
| |
set_magnetometer_frequency ( frequency )
Sets the update frequency for the magnetometer,
if 0hz is given as frequency the magnetometer is turned off.
|
frequency : | number |
Update frequency for magnetometer in hz. |
| This function does not return any values. |
Orientation Sensor
| |
orientation_sensor_available ( ) : boolean
Indicates whether or not the devices has a available orientation sensor.
|
| This function does not accept any parameters. |
boolean |
Returns true if the devices has a available orientation sensor, or false otherwise. |
| |
orientation_sensor_frequency ( ) : number
Returns the devices current orientation sensor update frequency,
if frequency is 0hz the orientation sensor it is not measuring any orientation.
|
| This function does not accept any parameters. |
number |
Returns the orientation sensor update frequency in hz. |
| |
orientation_sensor_rotation ( ) : stingray.Quaternion
Returns devices orientation rotation.
|
| This function does not accept any parameters. |
|
Returns the orientation sensor rotation. |
| |
performance_hint ( ) : string
Returns the current performance hint as "fast" or "correct", default is "fast".
|
| This function does not accept any parameters. |
string |
Returns the current performance hint. |
| |
set_orientation_sensor_frequency ( frequency )
Sets the update frequency for the orientation sensor,
if 0hz is given as frequency the orientation sensor is turned off.
|
frequency : | number |
Update frequency for orientation sensor in hz. |
| This function does not return any values. |
| |
set_performance_hint ( hint )
Sets the performance hint flag for sensor data processing.
|
hint : | string |
Performance hint can be "fast" or "correct". |
| This function does not return any values. |
Sensor output can be computed as fast as possible or as correct on some platform, seting this hint allows the implementation to prioritize correctness or speed.