<doc>
	<legacy_id></legacy_id>
	<name>mobileSensorReading</name>
	<type>function</type>

	<syntax>
		<example>mobileSensorReading(<i>sensor, detailed)</i></example>
	</syntax>

	<synonyms>
	</synonyms>

	<summary>Returns the reading from the named sensor.</summary>

	<examples>
<example>get mobileSensorReading(&quot;heading&quot;,false)</example>
<example>put mobileSensorReading(&quot;location&quot;,true) into tDeviceLocation</example>
	</examples>

	<history>
		<introduced version="5.5">Added.</introduced>
		<deprecated version=""></deprecated>
		<removed version=""></removed>
		<changed version=""></changed>
	</history>

	<objects>
	</objects>

	<platforms>
		<ios/>
		<android/>
	</platforms>

	<classes>
		<mobile/>
	</classes>

	<security>
	</security>


	<classification>
		<category>sensors</category>
	</classification>

	<references>
		<function tag="mobileCurrentLocation">mobileCurrentLocation Function</function>
		<function tag="mobileCurrentHeading">mobileCurrentHeading Function</function>
		<function tag="mobileCanTrackHeading">mobileCanTrackHeading Function</function>
		<function tag="mobileCanTrackLocation">mobileCanTrackLocation Function</function>
		<command tag="mobileStartTrackingSensor">mobileStartTrackingSensor Command</command>
		<command tag="mobileStopTrackingSensor">mobileStopTrackingSensor Command</command>
		<message tag="locationChanged">locationChanged Message</message>
		<message tag="trackingError">trackingError Message</message>
		<message tag="headingChanged">headingChanged Message</message>
		<message tag="accelerationChanged">accelerationChanged Message</message>
		<message tag="rotationRateChanged">rotationRateChanged Message</message>
	</references>

	<description>
	<overview>Use the <b>mobileSensorReading</b> function to fetch a reading from the named device sensor.</overview>

		<parameters>
  <parameter>
    <name>sensor</name>
    <description>The name of the sensor you wish to start using</description>
    <options title="">
      <option>
        <item>location</item>
        <description>the location of the device</description>
      </option>
      <option>
        <item>heading</item>
        <description>the heading of the device</description>
      </option>
      <option>
        <item>acceleration</item>
        <description>the acceleration of the device</description>
      </option>
      <option>
        <item>rotation rate</item>
        <description>the rotation of the device</description>
      </option>
    </options>
  </parameter>
  <parameter>
    <name>detailed</name>
    <description>How detailed the readings from sensors should be. The default value is false</description>
    <options title="">
      <option>
        <item>true</item>
        <description>additional readings will be provided.</description>
      </option>
      <option>
        <item>false</item>
        <description>basic readings will be provided.</description>
      </option>
    </options>
  </parameter>		</parameters>

	<value>Location -  a comma separated list of the latitude, longitude and altitude of the device. If <i>detailed</i> is true an array containing the keys latitude, longitude, altitude, timestamp, horizontal accuracy and vertical accuracy is returned.<p>Heading - the heading of the device in degrees. If <i>detailed</i> is true an array containing the keys heading, magnetic heading, true heading, timestamp, x, y, z and accuracy is returned.</p><p>Acceleration - a comma separated list of the acceleration in the x, y and z axes. If <i>detailed</i> is true an array containing the keys x, y, z and timestamp is returned.</p><p>Rotation Rate - a comma separated list of the rate of rotation around the x, y and z axes. If <i>detailed</i> is true an array containin the keys x, y, z and timestamp is returned.</p></value>
	<comments>The <b>mobileSensorReading</b> function returns a reading from the named sensor.</comments>
	</description>
</doc>