GetSensor

sensorName

Returns

Data type returned

option1

option2

Battery

batteryLevel

The battery charge level (from 0.0 to 1.0).

number

batteryStatus

A number representing the status of the battery charge:
1 - unplugged
2 - charging
3 - plugged in and full

number

Location

location

The current location of an iOS device in the format:

latitude (in degrees)
longitude (in degrees)
horizontal accuracy (+/- accuracy in meters)

text¹

accuracy (in meters)

timeout (in seconds)

locationValues

The current location of an iOS device in the format:

latitude (in degrees)
longitude (in degrees)
altitude (in meters)
horizontal accuracy (+/- accuracy in meters)
vertical accuracy (+/- accuracy in meters)
age (in minutes)

text¹

accuracy (in meters)

timeout (in seconds)

Attitude, speed, and acceleration

attitude

The attitude for the iOS device in radians in the format:

roll
pitch
yaw

text¹

rotationRate

The rotation rate of the iOS device (in radians per second) in the format:

x
y
z

text¹

accelerationByUser

The acceleration the user is giving to the iOS device in meters per second squared (m/s²) in the format:

x
y
z

text¹

accelerationByGravity

The gravity acceleration in meters per second squared (m/s²) in the format:

x
y
z

text¹

speed

The speed of the device in meters per second.

number

accuracy (in meters)

timeout (in seconds)

heading

The current direction of movement (in degrees). It returns a value from 0.0 to 359.9 degrees.

number

accuracy (in meters)

timeout (in seconds)

Magnetic

magneticField

The magnetic field vector (in microteslas), with respect to the current attitude of the iOS device, in the format:

x
y
z

text¹

compassMagneticHeading

The orientation of the user's device (in degrees) relative to magnetic north. It returns a value from 0.0 to 359.9 degrees.

number

accuracy (in meters)

timeout (in seconds)

compassTrueHeading

The orientation of the user's device (in degrees) relative to true north. It returns a value from 0.0 to 359.9 degrees.

number

accuracy (in meters)

timeout (in seconds)

Step counts

stepCount

The number of steps detected by the device for the specified duration.

number

forPastSeconds

stepDistance

The estimated distance (in meters) traveled by the user for the specified duration.

number

forPastSeconds

stepFloorsUp

The approximate number of floors ascended by the user for the specified duration.

number

forPastSeconds

stepFloorsDown

The approximate number of floors descended by the user for the specified duration.

number

forPastSeconds

Air pressure

airPressure

The recorded air pressure (in kilopascals).

number

List of sensors

available

A list of available sensorName values for the device. The values are separated by carriage returns.

text