Detailed Description

The SensorsScriptInterface class enables you to emulate built-in device sensors.

If the target devices contain built-in sensors, such as an accelerometer, a compass, or ambient light or proximity sensors, you can create scripts to emulate sensor values.

Many sensors update frequently, and therefore sensor readings done by the client application contain a fresh timestamp by default.

The SensorsScriptInterface class is exposed as sensors.

Ambient Light Sensor

The ambient light state in which the device is being used is defined in units of illuminance (LUX). You can either use predefined values or specify the amount of LUX to emulate.

The following script uses the ambientLightLevel property to set the value of the Ambient light field in the Sensors view to Dark:

sensors.ambientLightLevel = sensors.Dark
print(sensors.ambientLightLevel)

Accelerometer

The accelerometer sensor channel detects movement gestures, such as moving a mobile device up or down. The three-dimensional Cartesian coordinate system is used to illustrate direction of the acceleration. The x and y axes define a plane where z-axis direction is perpendicular to the xy plane. When a device moves along an axis in the positive direction, the acceleration is positive. When the device moves in the negative direction, the acceleration is negative. For example, when a device moves along the x-axis to the direction of -x, the acceleration is negative.

The following script uses the accelerometerX, accelerometerY, and accelerometerZ properties to set the values for the Accelerometer x, Accelerometer y, and Accelerometer z fields in the Sensors view to 1, 2, and 3:

sensors.accelerometerX = 1
sensors.accelerometerY = 2
sensors.accelerometerZ = 3
print(sensors.accelerometerX + ' ' + sensors.accelerometerY + ' ' + sensors.accelerometerZ)

Compass

The compass returns the azimuth of the device as degrees from magnetic north in a clockwise direction based on the top of the device. The calibration status of the device must be accurate for the azimuth to be accurate.

The following script uses the magnetometerX, magnetometerY, and magnetometerZ properties to set the raw magnetic flux density on the x, y, and z axis to 1 tesla.

Also, it uses the compassAzimuth property to set the compass azimuth to 0.42 and the magnetometerCalibrationLevel property to set the compass calibration level to 0.43.

sensors.magnetometerX = 1
sensors.magnetometerY = 1
sensors.magnetometerZ = 1
sensors.magnetometerCalibrationLevel = 1
print(sensors.magnetometerX + ' ' + sensors.magnetometerY + ' ' + sensors.magnetometerZ + ' ' + sensors.magnetometerCalibrationLevel)

sensors.compassAzimuth = 0.42
sensors.compassCalibrationLevel = 0.43
print(sensors.compassAzimuth + ' ' + sensors.compassCalibrationLevel)

Proximity Sensors

Proximity sensors indicate how far away from the user the device is.

The following script uses the irProximity property to set the value of the IR proximity slider in the Sensors view to 0.7:

sensors.irProximity = 0.7

The following script sets the proximitySensorClose() function to true to set the value of the Proximity distance field in the Sensors view to Near:

sensors.proximitySensorClose = true
print(sensors.proximitySensorClose)

Timestamp

The following script first sets the useCurrentTimestamp() function to true to select the Current radio button in the Timestamp group in the Sensors view and uses the timestamp() function to display the current timestamp in the field below. Second, it sets the useCurrentTimestamp() function to false to enable you to set your own timestamp:

sensors.useCurrentTimestamp = true
sensors.useCurrentTimestamp = false
sensors.timestamp = new Date