<h2>Table of Contents</h2>
<ul class="toc">
<li>1. <a href="#typedefs-section">Type Definitions</a><ul class="toc">
-<li>1.1. <a href="#SensorType">SensorType</a>
+<li>
+ 1.1. <a href="#SensorType">SensorType</a>
</li>
-<li>1.2. <a href="#ProximityState">ProximityState</a>
+<li>
+ 1.2. <a href="#ProximityState">ProximityState</a>
</li>
-<li>1.3. <a href="#MagneticSensorAccuracy">MagneticSensorAccuracy</a>
+<li>
+ 1.3. <a href="#MagneticSensorAccuracy">MagneticSensorAccuracy</a>
</li>
</ul>
</li>
</li>
<li>2.9. <a href="#HRMRawSensor">HRMRawSensor</a>
</li>
-<li>2.10. <a href="#SensorData">SensorData</a>
+<li>2.10. <a href="#GravitySensor">GravitySensor</a>
</li>
-<li>2.11. <a href="#SensorLightData">SensorLightData</a>
+<li>2.11. <a href="#GyroscopeSensor">GyroscopeSensor</a>
</li>
-<li>2.12. <a href="#SensorMagneticData">SensorMagneticData</a>
+<li>2.12. <a href="#GyroscopeRotationVectorSensor">GyroscopeRotationVectorSensor</a>
</li>
-<li>2.13. <a href="#SensorPressureData">SensorPressureData</a>
+<li>2.13. <a href="#SensorData">SensorData</a>
</li>
-<li>2.14. <a href="#SensorProximityData">SensorProximityData</a>
+<li>2.14. <a href="#SensorLightData">SensorLightData</a>
</li>
-<li>2.15. <a href="#SensorUltravioletData">SensorUltravioletData</a>
+<li>2.15. <a href="#SensorMagneticData">SensorMagneticData</a>
</li>
-<li>2.16. <a href="#SensorHRMRawData">SensorHRMRawData</a>
+<li>2.16. <a href="#SensorPressureData">SensorPressureData</a>
</li>
-<li>2.17. <a href="#SensorDataSuccessCallback">SensorDataSuccessCallback</a>
+<li>2.17. <a href="#SensorProximityData">SensorProximityData</a>
+</li>
+<li>2.18. <a href="#SensorUltravioletData">SensorUltravioletData</a>
+</li>
+<li>2.19. <a href="#SensorHRMRawData">SensorHRMRawData</a>
+</li>
+<li>2.20. <a href="#SensorGravityData">SensorGravityData</a>
+</li>
+<li>2.21. <a href="#SensorGyroscopeData">SensorGyroscopeData</a>
+</li>
+<li>2.22. <a href="#SensorGyroscopeRotationVectorData">SensorGyroscopeRotationVectorData</a>
+</li>
+<li>2.23. <a href="#SensorDataSuccessCallback">SensorDataSuccessCallback</a>
</li>
</ul>
</li>
<tr>
<td><a href="#SensorService">SensorService</a></td>
<td>
-<a href="#Sensor">Sensor</a> <a href="#SensorService::getDefaultSensor">getDefaultSensor</a> (<a href="#SensorType">SensorType</a> type)<br>
- <a href="#SensorType">SensorType</a>[] <a href="#SensorService::getAvailableSensors">getAvailableSensors</a> ()</td>
+<div>
+<a href="#Sensor">Sensor</a> <a href="#SensorService::getDefaultSensor">getDefaultSensor</a> (<a href="#SensorType">SensorType</a> type)</div>
+<div>
+<a href="#SensorType">SensorType</a>[] <a href="#SensorService::getAvailableSensors">getAvailableSensors</a> ()</div>
+</td>
</tr>
<tr>
<td><a href="#Sensor">Sensor</a></td>
-<td>void <a href="#Sensor::start">start</a> (<a href="tizen.html#SuccessCallback">SuccessCallback</a> successCallback, optional <a href="tizen.html#ErrorCallback">ErrorCallback</a>? errorCallback)<br>
- void <a href="#Sensor::stop">stop</a> ()<br>
- void <a href="#Sensor::setChangeListener">setChangeListener</a> (<a href="#SensorDataSuccessCallback">SensorDataSuccessCallback</a> successCallback, optional long? interval)<br>
- void <a href="#Sensor::unsetChangeListener">unsetChangeListener</a> ()</td>
+<td>
+<div>void <a href="#Sensor::start">start</a> (<a href="tizen.html#SuccessCallback">SuccessCallback</a> successCallback, optional <a href="tizen.html#ErrorCallback">ErrorCallback</a>? errorCallback)</div>
+<div>void <a href="#Sensor::stop">stop</a> ()</div>
+<div>void <a href="#Sensor::setChangeListener">setChangeListener</a> (<a href="#SensorDataSuccessCallback">SensorDataSuccessCallback</a> successCallback, optional long? interval)</div>
+<div>void <a href="#Sensor::unsetChangeListener">unsetChangeListener</a> ()</div>
+</td>
</tr>
<tr>
<td><a href="#LightSensor">LightSensor</a></td>
-<td>void <a href="#LightSensor::getLightSensorData">getLightSensorData</a> (<a href="#SensorDataSuccessCallback">SensorDataSuccessCallback</a> successCallback, optional <a href="tizen.html#ErrorCallback">ErrorCallback</a>? errorCallback)</td>
+<td><div>void <a href="#LightSensor::getLightSensorData">getLightSensorData</a> (<a href="#SensorDataSuccessCallback">SensorDataSuccessCallback</a> successCallback, optional <a href="tizen.html#ErrorCallback">ErrorCallback</a>? errorCallback)</div></td>
</tr>
<tr>
<td><a href="#MagneticSensor">MagneticSensor</a></td>
-<td>void <a href="#MagneticSensor::getMagneticSensorData">getMagneticSensorData</a> (<a href="#SensorDataSuccessCallback">SensorDataSuccessCallback</a> successCallback, optional <a href="tizen.html#ErrorCallback">ErrorCallback</a>? errorCallback)</td>
+<td><div>void <a href="#MagneticSensor::getMagneticSensorData">getMagneticSensorData</a> (<a href="#SensorDataSuccessCallback">SensorDataSuccessCallback</a> successCallback, optional <a href="tizen.html#ErrorCallback">ErrorCallback</a>? errorCallback)</div></td>
</tr>
<tr>
<td><a href="#PressureSensor">PressureSensor</a></td>
-<td>void <a href="#PressureSensor::getPressureSensorData">getPressureSensorData</a> (<a href="#SensorDataSuccessCallback">SensorDataSuccessCallback</a> successCallback, optional <a href="tizen.html#ErrorCallback">ErrorCallback</a>? errorCallback)</td>
+<td><div>void <a href="#PressureSensor::getPressureSensorData">getPressureSensorData</a> (<a href="#SensorDataSuccessCallback">SensorDataSuccessCallback</a> successCallback, optional <a href="tizen.html#ErrorCallback">ErrorCallback</a>? errorCallback)</div></td>
</tr>
<tr>
<td><a href="#ProximitySensor">ProximitySensor</a></td>
-<td>void <a href="#ProximitySensor::getProximitySensorData">getProximitySensorData</a> (<a href="#SensorDataSuccessCallback">SensorDataSuccessCallback</a> successCallback, optional <a href="tizen.html#ErrorCallback">ErrorCallback</a>? errorCallback)</td>
+<td><div>void <a href="#ProximitySensor::getProximitySensorData">getProximitySensorData</a> (<a href="#SensorDataSuccessCallback">SensorDataSuccessCallback</a> successCallback, optional <a href="tizen.html#ErrorCallback">ErrorCallback</a>? errorCallback)</div></td>
</tr>
<tr>
<td><a href="#UltravioletSensor">UltravioletSensor</a></td>
-<td>void <a href="#UltravioletSensor::getUltravioletSensorData">getUltravioletSensorData</a> (<a href="#SensorDataSuccessCallback">SensorDataSuccessCallback</a> successCallback, optional <a href="tizen.html#ErrorCallback">ErrorCallback</a>? errorCallback)</td>
+<td><div>void <a href="#UltravioletSensor::getUltravioletSensorData">getUltravioletSensorData</a> (<a href="#SensorDataSuccessCallback">SensorDataSuccessCallback</a> successCallback, optional <a href="tizen.html#ErrorCallback">ErrorCallback</a>? errorCallback)</div></td>
</tr>
<tr>
<td><a href="#HRMRawSensor">HRMRawSensor</a></td>
-<td>void <a href="#HRMRawSensor::getHRMRawSensorData">getHRMRawSensorData</a> (<a href="#SensorDataSuccessCallback">SensorDataSuccessCallback</a> successCallback, optional <a href="tizen.html#ErrorCallback">ErrorCallback</a>? errorCallback)</td>
+<td><div>void <a href="#HRMRawSensor::getHRMRawSensorData">getHRMRawSensorData</a> (<a href="#SensorDataSuccessCallback">SensorDataSuccessCallback</a> successCallback, optional <a href="tizen.html#ErrorCallback">ErrorCallback</a>? errorCallback)</div></td>
+</tr>
+<tr>
+<td><a href="#GravitySensor">GravitySensor</a></td>
+<td><div>void <a href="#GravitySensor::getGravitySensorData">getGravitySensorData</a> (<a href="#SensorDataSuccessCallback">SensorDataSuccessCallback</a> successCallback, optional <a href="tizen.html#ErrorCallback">ErrorCallback</a>? errorCallback)</div></td>
+</tr>
+<tr>
+<td><a href="#GyroscopeSensor">GyroscopeSensor</a></td>
+<td><div>void <a href="#GyroscopeSensor::getGyroscopeSensorData">getGyroscopeSensorData</a> (<a href="#SensorDataSuccessCallback">SensorDataSuccessCallback</a> successCallback, optional <a href="tizen.html#ErrorCallback">ErrorCallback</a>? errorCallback)</div></td>
+</tr>
+<tr>
+<td><a href="#GyroscopeRotationVectorSensor">GyroscopeRotationVectorSensor</a></td>
+<td><div>void <a href="#GyroscopeRotationVectorSensor::getGyroscopeRotationVectorSensorData">getGyroscopeRotationVectorSensorData</a> (<a href="#SensorDataSuccessCallback">SensorDataSuccessCallback</a> successCallback, optional <a href="tizen.html#ErrorCallback">ErrorCallback</a>? errorCallback)</div></td>
</tr>
<tr>
<td><a href="#SensorData">SensorData</a></td>
<td></td>
</tr>
<tr>
+<td><a href="#SensorGravityData">SensorGravityData</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#SensorGyroscopeData">SensorGyroscopeData</a></td>
+<td></td>
+</tr>
+<tr>
+<td><a href="#SensorGyroscopeRotationVectorData">SensorGyroscopeRotationVectorData</a></td>
+<td></td>
+</tr>
+<tr>
<td><a href="#SensorDataSuccessCallback">SensorDataSuccessCallback</a></td>
-<td>void <a href="#SensorDataSuccessCallback::onsuccess">onsuccess</a> (optional <a href="#SensorData">SensorData</a>? sensorData)</td>
+<td><div>void <a href="#SensorDataSuccessCallback::onsuccess">onsuccess</a> (optional <a href="#SensorData">SensorData</a>? sensorData)</div></td>
</tr>
</tbody>
</table>
<div class="brief">
Specifies the sensor type available to the API.
</div>
-<pre class="webidl prettyprint"> enum SensorType { "LIGHT", "MAGNETIC", "PRESSURE", "PROXIMITY", "ULTRAVIOLET", "HRM_RAW" };</pre>
+<pre class="webidl prettyprint"> enum SensorType { "LIGHT", "MAGNETIC", "PRESSURE", "PROXIMITY", "ULTRAVIOLET", "HRM_RAW", "GRAVITY", "GYROSCOPE", "GYROSCOPE_ROTATION_VECTOR" };</pre>
<p><span class="version">
Since: </span>
2.3
ULTRAVIOLET - Ultraviolet sensor </li>
<li>
HRM_RAW - HRM sensor </li>
+ <li>
+GRAVITY - Gravity sensor </li>
+ <li>
+GYROSCOPE - Gyroscope sensor </li>
+ <li>
+GYROSCOPE_ROTATION_VECTOR - Gyroscope rotation vector sensor </li>
</ul>
</div>
<p><span class="remark"> Remark : </span>
<em>HRM_RAW</em> is supported since Tizen 2.3.1
</p>
+<p><span class="remark"> Remark : </span>
+ <em>GRAVITY</em>, <em>GYROSCOPE</em> and <em>GYROSCOPE_ROTATION_VECTOR</em> are supported since Tizen 3.0
+ </p>
</div>
<div class="enum" id="ProximityState">
<a class="backward-compatibility-anchor" name="::Sensor::ProximityState"></a><h3>1.2. ProximityState</h3>
<li>
ULTRAVIOLET - tizen.systeminfo.getCapability(<em>"http://tizen.org/feature/sensor.ultraviolet"</em>) </li>
<li>
- HRM_RAW - tizen.systeminfo.getCapability(<em>"http://tizen.org/feature/sensor.heart_rate_monitor"</em>) </li>
+ HRM_RAW - tizen.systeminfo.getCapability(<em>"http://tizen.org/feature/sensor.heart_rate_monitor"</em>) </li>
+ <li>
+ GRAVITY - tizen.systeminfo.getCapability(<em>"http://tizen.org/feature/sensor.gravity"</em>) </li>
+ <li>
+ GYROSCOPE - tizen.systeminfo.getCapability(<em>"http://tizen.org/feature/sensor.gyroscope"</em>) </li>
+ <li>
+ GYROSCOPE_ROTATION_VECTOR - tizen.systeminfo.getCapability(<em>"http://tizen.org/feature/sensor.gyroscope_rotation_vector"</em>) </li>
</ul>
</div>
<p><span class="privilegelevel">
http://tizen.org/privilege/healthinfo
</p>
<p><span class="remark"> Remark : </span>
- <b>http://tizen.org/privilege/healthinfo</b> is required only for <a href="#SensorType">HRM_RAW </a> type. <em>HRM_RAW</em> is supported since Tizen 2.3.1
+ <b>http://tizen.org/privilege/healthinfo</b> is required only for <a href="#SensorType">HRM_RAW </a> type. <em>HRM_RAW</em> is supported since Tizen 2.3.1.
</p>
<div class="parameters">
<p><span class="param">Parameters:</span></p>
Since: </span>
2.3
</p>
-<p><span class="privilegelevel">
- Privilege level: </span>
- public
- </p>
-<p><span class="privilege">
- Privilege: </span>
- http://tizen.org/privilege/healthinfo
- </p>
-<p><span class="remark"> Remark : </span>
- <b>http://tizen.org/privilege/healthinfo</b> is required only for <a href="#SensorType">HRM_RAW </a> type. <em>HRM_RAW</em> is supported since Tizen 2.3.1.
- </p>
<div class="returntype">
<p><span class="return">Return value:</span></p>
SensorType[] All available sensor types
</dt>
<dd>
<div class="brief">
-Registers a change listener to retrieve sensor data periodically.
+ Registers a listener to retrieve sensor data periodically.
</div>
<div class="synopsis"><pre class="signature prettyprint">void setChangeListener(<a href="#SensorDataSuccessCallback">SensorDataSuccessCallback</a> successCallback, optional long? interval);
</pre></div>
The start() method must be called to turn on the sensor, or the sensor data will not change.
</p>
</div>
-<p><span class="remark">Remark: </span><em>interval</em> is supported since Tizen 3.0</p>
+<p><span class="remark"> Remark : </span>
+ <em>interval</em> is supported since Tizen 3.0
+ </p>
+<p><span class="remark"> Remark : </span>
+ The specified interval is only a suggested interval between sensor measurements. You will get at least one sensor measurement within the interval you specify, but the actual interval between sensor measurements can be affected by other applications and the system. To reduce the system overhead, it is recommended to set the longest interval that you can, because the system usually chooses the shortest interval among all intervals specified.
+ </p>
<div class="parameters">
<p><span class="param">Parameters:</span></p>
<ul>
Callback method to be invoked periodically.
</li>
<li class="param">
- <span class="name">interval</span>
- <span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
- The period in milliseconds at which sensor data will be sent to the application which calls this method.<br />
- <em>interval</em> should be in range <10, 1000> inclusively. However, if it is null or zero, it will be set to the default value of 100 ms.<br />
-For the <a href="#SensorType">PROXIMITY</a> sensor type,<em> interval</em> will be ignored.
- </li>
+<span class="name">interval</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ The interval in milliseconds (ms) at which sensor data will be sent to the Web Application which calls this method since Tizen 3.0<br><em>interval</em> can be between 10ms and 1000ms inclusive, however, if it is null or zero, it is set to the default value of 100ms.<br>For the <a href="#SensorType">PROXIMITY</a> sensor type, <em>interval</em> will be ignored.
+ </li>
</ul>
</div>
<div class="exceptionlist">
</li></ul>
</div>
<div class="example">
-<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint">
- var proximitySensor = tizen.sensorservice.getDefaultSensor("PROXIMITY");
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var proximitySensor = tizen.sensorservice.getDefaultSensor("PROXIMITY");
function onsuccessCB() {
console.log("proximity sensor start");
console.log("proximity distance : " + sensorData.proximityState);
}
- // order to receive proximity sensor data every 100 ms (default value):
- proximitySensor.setChangeListener(onchangedCB);
+ // interval can be ommitted.
+ proximitySensor.setChangeListener(onchangedCB, 200);
- // start the sensor service to begin receiving events:
proximitySensor.start(onsuccessCB);
- </div><div class="example"><span class="example"><p>Code example:</p></span>
- <pre name="code" class="examplecode prettyprint">
- var lightSensor = tizen.sensorservice.getDefaultSensor("LIGHT");
-
- function onSuccessCB() {
- console.log("Light sensor service has started.");
- }
-
- function onChangedCB(sensorData) {
- console.log("Current light level: " + sensorData.lightLevel);
- }
-
- // order to receive light sensor data every 500 ms:
- lightSensor.setChangeListener(onChangedCB, 500);
-
- // start the sensor service to begin receiving events:
- lightSensor.start(onSuccessCB);
</pre>
</div>
</dd>
Since: </span>
2.3
</p>
-
+
<div class="methods">
<h4>Methods</h4>
<dl>
Since: </span>
2.3
</p>
-
+
<div class="methods">
<h4>Methods</h4>
<dl>
Since: </span>
2.3
</p>
-
+
<div class="methods">
<h4>Methods</h4>
<dl>
Since: </span>
2.3
</p>
-
+
<div class="methods">
<h4>Methods</h4>
<dl>
Since: </span>
2.3
</p>
-
+
<div class="methods">
<h4>Methods</h4>
<dl>
Since: </span>
2.3.1
</p>
-
+
<div class="methods">
<h4>Methods</h4>
<dl>
</dl>
</div>
</div>
+<div class="interface" id="GravitySensor">
+<a class="backward-compatibility-anchor" name="::Sensor::GravitySensor"></a><h3>2.10. GravitySensor</h3>
+<div class="brief">
+ The GravitySensor interface provides methods to access gravity sensor data.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface GravitySensor : <a href="#Sensor">Sensor</a> {
+
+ void getGravitySensorData(<a href="#SensorDataSuccessCallback">SensorDataSuccessCallback</a> successCallback,
+ optional <a href="tizen.html#ErrorCallback">ErrorCallback</a>? errorCallback) raises(<a href="tizen.html#WebAPIException">WebAPIException</a>);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+
+ <div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="GravitySensor::getGravitySensorData">
+<a class="backward-compatibility-anchor" name="::Sensor::GravitySensor::getGravitySensorData"></a><code><b><span class="methodName">getGravitySensorData</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Gets the current gravity sensor data. You can refer to the <a href="sensor.html#SensorGravityData">SensorGravityData</a> interface.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void getGravitySensorData(<a href="#SensorDataSuccessCallback">SensorDataSuccessCallback</a> successCallback, optional <a href="tizen.html#ErrorCallback">ErrorCallback</a>? errorCallback);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+Note that before calling the getGravitySensorData() method, the start() method should be called to turn on the sensor.
+ </p>
+ <p>
+The <em>ErrorCallback</em> method is launched with these error types:
+ </p>
+ <ul>
+ <li>
+ ServiceNotAvailableError : If the <em>getGravitySensorData()</em> method is called without first calling the <em>start()</em> method </li>
+ <li>
+ AbortError : If the system operation was aborted </li>
+ </ul>
+ </div>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">successCallback</span>:
+ Callback method to be invoked when the sensor data has been read
+ </li>
+ <li class="param">
+<span class="name">errorCallback</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Callback method to be invoked when an error occurs
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>WebAPIException<ul><li class="list"><p>
+ with error type TypeMismatchError, if any input parameter is not compatible with the expected type for that parameter.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var gravitySensor = tizen.sensorservice.getDefaultSensor("GRAVITY");
+
+ function onGetSuccessCB(sensorData) {
+ console.log("######## Get the gravity sensor data ########");
+ console.log("x: " + sensorData.x);
+ console.log("y: " + sensorData.y);
+ console.log("z: " + sensorData.z);
+ }
+
+ function onerrorCB(error) {
+ console.log("error occurs");
+ }
+
+ function onsuccessCB() {
+ console.log("sensor start");
+ gravitySensor.getGravitySensorData(onGetSuccessCB, onerrorCB);
+ }
+
+ gravitySensor.start(onsuccessCB);
+ </pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="GyroscopeSensor">
+<a class="backward-compatibility-anchor" name="::Sensor::GyroscopeSensor"></a><h3>2.11. GyroscopeSensor</h3>
+<div class="brief">
+ The GyroscopeSensor interface provides methods to access gyroscope sensor data.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface GyroscopeSensor : <a href="#Sensor">Sensor</a> {
+
+ void getGyroscopeSensorData(<a href="#SensorDataSuccessCallback">SensorDataSuccessCallback</a> successCallback,
+ optional <a href="tizen.html#ErrorCallback">ErrorCallback</a>? errorCallback) raises(<a href="tizen.html#WebAPIException">WebAPIException</a>);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+
+ <div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="GyroscopeSensor::getGyroscopeSensorData">
+<a class="backward-compatibility-anchor" name="::Sensor::GyroscopeSensor::getGyroscopeSensorData"></a><code><b><span class="methodName">getGyroscopeSensorData</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Gets the current gyroscope sensor data. You can refer to the <a href="sensor.html#SensorGyroscopeData">SensorGyroscopeData</a> interface.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void getGyroscopeSensorData(<a href="#SensorDataSuccessCallback">SensorDataSuccessCallback</a> successCallback, optional <a href="tizen.html#ErrorCallback">ErrorCallback</a>? errorCallback);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+Note that before calling the getGyroscopeSensorData() method, the start() method should be called to turn on the sensor.
+ </p>
+ <p>
+The <em>ErrorCallback</em> method is launched with these error types:
+ </p>
+ <ul>
+ <li>
+ ServiceNotAvailableError : If the <em>getGyroscopeSensorData()</em> method is called without first calling the <em>start()</em> method </li>
+ <li>
+ AbortError : If the system operation was aborted </li>
+ </ul>
+ </div>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">successCallback</span>:
+ Callback method to be invoked when the sensor data has been read
+ </li>
+ <li class="param">
+<span class="name">errorCallback</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Callback method to be invoked when an error occurs
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>WebAPIException<ul><li class="list"><p>
+ with error type TypeMismatchError, if any input parameter is not compatible with the expected type for that parameter.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var gyroscopeSensor = tizen.sensorservice.getDefaultSensor("GYROSCOPE");
+
+ function onGetSuccessCB(sensorData) {
+ console.log("######## Get the gyroscope sensor date ########");
+ console.log("x: " + sensorData.x);
+ console.log("y: " + sensorData.y);
+ console.log("z: " + sensorData.z);
+ }
+
+ function onerrorCB(error) {
+ console.log("error occurs");
+ }
+
+ function onsuccessCB() {
+ console.log("sensor start");
+ gyroscopeSensor.getGyroscopeSensorData(onGetSuccessCB, onerrorCB);
+ }
+
+ gyroscopeSensor.start(onsuccessCB);
+ </pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
+<div class="interface" id="GyroscopeRotationVectorSensor">
+<a class="backward-compatibility-anchor" name="::Sensor::GyroscopeRotationVectorSensor"></a><h3>2.12. GyroscopeRotationVectorSensor</h3>
+<div class="brief">
+ The GyroscopeRotationVectorSensor interface provides methods to access gyroscope rotation vector sensor data.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface GyroscopeRotationVectorSensor : <a href="#Sensor">Sensor</a> {
+
+ void getGyroscopeRotationVectorSensorData(<a href="#SensorDataSuccessCallback">SensorDataSuccessCallback</a> successCallback,
+ optional <a href="tizen.html#ErrorCallback">ErrorCallback</a>? errorCallback) raises(<a href="tizen.html#WebAPIException">WebAPIException</a>);
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+
+ <div class="methods">
+<h4>Methods</h4>
+<dl>
+<dt class="method" id="GyroscopeRotationVectorSensor::getGyroscopeRotationVectorSensorData">
+<a class="backward-compatibility-anchor" name="::Sensor::GyroscopeRotationVectorSensor::getGyroscopeRotationVectorSensorData"></a><code><b><span class="methodName">getGyroscopeRotationVectorSensorData</span></b></code>
+</dt>
+<dd>
+<div class="brief">
+ Gets the current gyroscope rotation vector sensor data. You can refer to the <a href="sensor.html#SensorGyroscopeRotationVectorData">SensorGyroscopeRotationVectorData</a> interface.
+ </div>
+<div class="synopsis"><pre class="signature prettyprint">void getGyroscopeRotationVectorSensorData(<a href="#SensorDataSuccessCallback">SensorDataSuccessCallback</a> successCallback, optional <a href="tizen.html#ErrorCallback">ErrorCallback</a>? errorCallback);
+ </pre></div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+Note that before calling the getGyroscopeRotationVectorSensorData() method, the start() method should be called to turn on the sensor.
+ </p>
+ <p>
+The <em>ErrorCallback</em> method is launched with these error types:
+ </p>
+ <ul>
+ <li>
+ ServiceNotAvailableError : If the <em>getGyroscopeRotationVectorSensorData()</em> method is called without first calling the <em>start()</em> method </li>
+ <li>
+ AbortError : If the system operation was aborted </li>
+ </ul>
+ </div>
+<div class="parameters">
+<p><span class="param">Parameters:</span></p>
+<ul>
+ <li class="param">
+<span class="name">successCallback</span>:
+ Callback method to be invoked when the sensor data has been read
+ </li>
+ <li class="param">
+<span class="name">errorCallback</span><span class="optional"> [optional]</span><span class="optional"> [nullable]</span>:
+ Callback method to be invoked when an error occurs
+ </li>
+ </ul>
+</div>
+<div class="exceptionlist">
+<p><span class="except">Exceptions:</span></p>
+ <ul class="exception"><li>WebAPIException<ul><li class="list"><p>
+ with error type TypeMismatchError, if any input parameter is not compatible with the expected type for that parameter.
+ </p></li></ul>
+</li></ul>
+ </div>
+<div class="example">
+<span class="example"><p>Code example:</p></span><pre name="code" class="examplecode prettyprint"> var gyroscopeRotationVectorSensor = tizen.sensorservice.getDefaultSensor("GYROSCOPE_ROTATION_VECTOR");
+
+ function onGetSuccessCB(sensorData) {
+ console.log("######## Get the gyroscope rotation vector sensor data ########");
+ console.log("x: " + sensorData.x);
+ console.log("y: " + sensorData.y);
+ console.log("z: " + sensorData.z);
+ console.log("w: " + sensorData.w);
+ }
+
+ function onerrorCB(error) {
+ console.log("error occurs");
+ }
+
+ function onsuccessCB() {
+ console.log("sensor start");
+ gyroscopeRotationVectorSensor.getGyroscopeRotationVectorSensorData(onGetSuccessCB, onerrorCB);
+ }
+
+ gyroscopeRotationVectorSensor.start(onsuccessCB);
+ </pre>
+</div>
+</dd>
+</dl>
+</div>
+</div>
<div class="interface" id="SensorData">
-<a class="backward-compatibility-anchor" name="::Sensor::SensorData"></a><h3>2.10. SensorData</h3>
+<a class="backward-compatibility-anchor" name="::Sensor::SensorData"></a><h3>2.13. SensorData</h3>
<div class="brief">
The SensorData interface is a common abstract interface used by different types of sensor data objects.
</div>
</p>
</div>
<div class="interface" id="SensorLightData">
-<a class="backward-compatibility-anchor" name="::Sensor::SensorLightData"></a><h3>2.11. SensorLightData</h3>
+<a class="backward-compatibility-anchor" name="::Sensor::SensorLightData"></a><h3>2.14. SensorLightData</h3>
<div class="brief">
The SensorLightData interface represents light sensor data.
</div>
Since: </span>
2.3
</p>
-
+
<div class="attributes">
<h4>Attributes</h4>
<ul><li class="attribute" id="SensorLightData::lightLevel">
</div>
</div>
<div class="interface" id="SensorMagneticData">
-<a class="backward-compatibility-anchor" name="::Sensor::SensorMagneticData"></a><h3>2.12. SensorMagneticData</h3>
+<a class="backward-compatibility-anchor" name="::Sensor::SensorMagneticData"></a><h3>2.15. SensorMagneticData</h3>
<div class="brief">
The SensorMagneticData interface represents magnetic sensor data.
</div>
Since: </span>
2.3
</p>
-
+
<div class="attributes">
<h4>Attributes</h4>
<ul>
</div>
</div>
<div class="interface" id="SensorPressureData">
-<a class="backward-compatibility-anchor" name="::Sensor::SensorPressureData"></a><h3>2.13. SensorPressureData</h3>
+<a class="backward-compatibility-anchor" name="::Sensor::SensorPressureData"></a><h3>2.16. SensorPressureData</h3>
<div class="brief">
The SensorPressureData interface represents pressure sensor data.
</div>
Since: </span>
2.3
</p>
-
+
<div class="attributes">
<h4>Attributes</h4>
<ul><li class="attribute" id="SensorPressureData::pressure">
</div>
</div>
<div class="interface" id="SensorProximityData">
-<a class="backward-compatibility-anchor" name="::Sensor::SensorProximityData"></a><h3>2.14. SensorProximityData</h3>
+<a class="backward-compatibility-anchor" name="::Sensor::SensorProximityData"></a><h3>2.17. SensorProximityData</h3>
<div class="brief">
The SensorProximityData interface represents proximity sensor data.
</div>
Since: </span>
2.3
</p>
-
+
<div class="attributes">
<h4>Attributes</h4>
<ul><li class="attribute" id="SensorProximityData::proximityState">
</div>
</div>
<div class="interface" id="SensorUltravioletData">
-<a class="backward-compatibility-anchor" name="::Sensor::SensorUltravioletData"></a><h3>2.15. SensorUltravioletData</h3>
+<a class="backward-compatibility-anchor" name="::Sensor::SensorUltravioletData"></a><h3>2.18. SensorUltravioletData</h3>
<div class="brief">
The SensorUltravioletData interface represents ultraviolet sensor data.
</div>
Since: </span>
2.3
</p>
-
+
<div class="attributes">
<h4>Attributes</h4>
<ul><li class="attribute" id="SensorUltravioletData::ultravioletLevel">
</div>
</div>
<div class="interface" id="SensorHRMRawData">
-<a class="backward-compatibility-anchor" name="::Sensor::SensorHRMRawData"></a><h3>2.16. SensorHRMRawData</h3>
+<a class="backward-compatibility-anchor" name="::Sensor::SensorHRMRawData"></a><h3>2.19. SensorHRMRawData</h3>
<div class="brief">
The SensorHRMRawData interface represents HRM sensor raw data.
</div>
Since: </span>
2.3.1
</p>
-
+
<div class="attributes">
<h4>Attributes</h4>
<ul>
</ul>
</div>
</div>
+<div class="interface" id="SensorGravityData">
+<a class="backward-compatibility-anchor" name="::Sensor::SensorGravityData"></a><h3>2.20. SensorGravityData</h3>
+<div class="brief">
+ The SensorGravityData interface represents gravity sensor data. You can refer to <a href="https://developer.tizen.org/development/guides/native-application/system/sensor#gravity">this guide</a> to learn more about gravity sensor data.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface SensorGravityData : <a href="#SensorData">SensorData</a> {
+
+ readonly attribute double x;
+
+ readonly attribute double y;
+
+ readonly attribute double z;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="remark"> Remark : </span>
+ An example of how to access and use this interface can be found in the <a href="sensor.html#GravitySensor::getGravitySensorData">getGravitySensorData()</a> code example.
+ </p>
+
+ <div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="SensorGravityData::x">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">double </span><span class="name">x</span></span><div class="brief">
+ Value of the Earth's gravity in the device's X axis in m/s².<br>The value can be between -9.8 and 9.8 inclusive.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="SensorGravityData::y">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">double </span><span class="name">y</span></span><div class="brief">
+ Value of the Earth's gravity in the device's Y axis in m/s².<br>The value can be between -9.8 and 9.8 inclusive.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="SensorGravityData::z">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">double </span><span class="name">z</span></span><div class="brief">
+ Value of the Earth's gravity in the device's Z axis in m/s².<br>The value can be between -9.8 and 9.8 inclusive.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+</div>
+<div class="interface" id="SensorGyroscopeData">
+<a class="backward-compatibility-anchor" name="::Sensor::SensorGyroscopeData"></a><h3>2.21. SensorGyroscopeData</h3>
+<div class="brief">
+ The SensorGyroscopeData interface represents gyroscope sensor data. You can refer to <a href="https://developer.tizen.org/development/guides/native-application/system/sensor#gyro">this guide</a> to learn more about gyroscope sensor data.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface SensorGyroscopeData : <a href="#SensorData">SensorData</a> {
+
+ readonly attribute double x;
+
+ readonly attribute double y;
+
+ readonly attribute double z;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<p><span class="remark"> Remark : </span>
+ An example of how to access and use this interface can be found in the <a href="sensor.html#GyroscopeSensor::getGyroscopeSensorData">getGyroscopeSensorData()</a> code example.
+ </p>
+
+ <div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="SensorGyroscopeData::x">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">double </span><span class="name">x</span></span><div class="brief">
+ The angular velocity about the device's X axis in °/s.<br>The value can be between -573.0 and 573.0 inclusive.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="SensorGyroscopeData::y">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">double </span><span class="name">y</span></span><div class="brief">
+ The angular velocity about the device's Y axis in °/s.<br>The value can be between -573.0 and 573.0 inclusive.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="SensorGyroscopeData::z">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">double </span><span class="name">z</span></span><div class="brief">
+ The angular velocity about the device's Z axis in °/s.<br>The value can be between -573.0 and 573.0 inclusive.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+</div>
+<div class="interface" id="SensorGyroscopeRotationVectorData">
+<a class="backward-compatibility-anchor" name="::Sensor::SensorGyroscopeRotationVectorData"></a><h3>2.22. SensorGyroscopeRotationVectorData</h3>
+<div class="brief">
+ The SensorGyroscopeRotationVectorData interface represents gyroscope rotation vector sensor data. You can refer to <a href="https://developer.tizen.org/development/guides/native-application/system/sensor#gyro_rotation">this guide</a> to learn more about gyroscope sensor data.
+ </div>
+<pre class="webidl prettyprint"> [NoInterfaceObject] interface SensorGyroscopeRotationVectorData : <a href="#SensorData">SensorData</a> {
+
+ readonly attribute double x;
+
+ readonly attribute double y;
+
+ readonly attribute double z;
+
+ readonly attribute double w;
+ };</pre>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+<div class="description">
+ <p>
+A gyroscope rotation vector sensor data represents the orientation of the device as a combination of an angle and an axis when the device has rotated through an angle about an axis (X, Y, or Z).
+It is equal to the components of a unit quaternion (cos(θ/2), x * sin(θ/2), y * sin(θ/2), z * sin(θ/2)).
+ </p>
+ </div>
+<p><span class="remark"> Remark : </span>
+ An example of how to access and use this interface can be found in the <a href="sensor.html#GyroscopeRotationVectorSensor::getGyroscopeRotationVectorSensorData">getGyroscopeRotationVectorSensorData()</a> code example.
+ </p>
+
+ <div class="attributes">
+<h4>Attributes</h4>
+<ul>
+<li class="attribute" id="SensorGyroscopeRotationVectorData::x">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">double </span><span class="name">x</span></span><div class="brief">
+ The X direction component of the rotation vector (x * sin(θ/2)).<br>The value can be between -1 and 1 inclusive.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="SensorGyroscopeRotationVectorData::y">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">double </span><span class="name">y</span></span><div class="brief">
+ The Y direction component of the rotation vector (y * sin(θ/2)).<br>The value can be between -1 and 1 inclusive.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="SensorGyroscopeRotationVectorData::z">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">double </span><span class="name">z</span></span><div class="brief">
+ The Z direction component of the rotation vector (z * sin(θ/2)).<br>The value can be between -1 and 1 inclusive.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+<li class="attribute" id="SensorGyroscopeRotationVectorData::w">
+<span class="attrName"><span class="readonly"> readonly
+</span><span class="type">double </span><span class="name">w</span></span><div class="brief">
+ The scalar component of the rotation vector (cos(θ/2)).<br>The value can be between -1 and 1 inclusive.
+ </div>
+<p><span class="version">
+ Since: </span>
+ 3.0
+ </p>
+</li>
+</ul>
+</div>
+</div>
<div class="interface" id="SensorDataSuccessCallback">
-<a class="backward-compatibility-anchor" name="::Sensor::SensorDataSuccessCallback"></a><h3>2.17. SensorDataSuccessCallback</h3>
+<a class="backward-compatibility-anchor" name="::Sensor::SensorDataSuccessCallback"></a><h3>2.23. SensorDataSuccessCallback</h3>
<div class="brief">
- The SensorDataSuccessCallback interface is a callback interface that is invoked when the sensor data has changed. For example, see the Sensor interface.
+ The SensorDataSuccessCallback interface is a callback interface that is invoked periodically. For example, see the Sensor interface.
</div>
<pre class="webidl prettyprint"> [Callback=FunctionOnly, NoInterfaceObject] interface SensorDataSuccessCallback {
void onsuccess(optional <a href="#SensorData">SensorData</a>? sensorData);
</dt>
<dd>
<div class="brief">
- Called when the sensor data has changed.
+ Called periodically.
</div>
<div class="synopsis"><pre class="signature prettyprint">void onsuccess(optional <a href="#SensorData">SensorData</a>? sensorData);
</pre></div>
</div></p>
<li class="feature">http://tizen.org/feature/sensor.heart_rate_monitor</li>
</div>
+<div class="def-api-feature">
+<p><div class="description">
+ <p>
+To guarantee that the gravity sensor application runs on a device with a gravity sensor, declare the following feature requirements in the config file:
+ </p>
+ </div></p>
+<li class="feature">http://tizen.org/feature/sensor.gravity</li>
+</div>
+<div class="def-api-feature">
+<p><div class="description">
+ <p>
+To guarantee that the gyroscope sensor application runs on a device with a gyroscope sensor, declare the following feature requirements in the config file:
+ </p>
+ </div></p>
+<li class="feature">http://tizen.org/feature/sensor.gyroscope</li>
+</div>
+<div class="def-api-feature">
+<p><div class="description">
+ <p>
+To guarantee that the gyroscope rotation vector sensor application runs on a device with a gyroscope rotation vector sensor, declare the following feature requirements in the config file:
+ </p>
+ </div></p>
+<li class="feature">http://tizen.org/feature/sensor.gyroscope_rotation_vector</li>
+</div>
<p></p>
For more information, see <a href="https://developer.tizen.org/development/getting-started/web-application/understanding-tizen-programming/application-filtering">Application Filtering</a>.
</div>
<h2 id="full-webidl">4. Full WebIDL</h2>
<pre class="webidl prettyprint">module Sensor {
- enum SensorType { "LIGHT", "MAGNETIC", "PRESSURE", "PROXIMITY", "ULTRAVIOLET", "HRM_RAW" };
+ enum SensorType { "LIGHT", "MAGNETIC", "PRESSURE", "PROXIMITY", "ULTRAVIOLET", "HRM_RAW", "GRAVITY", "GYROSCOPE", "GYROSCOPE_ROTATION_VECTOR" };
enum ProximityState { "FAR", "NEAR" };
optional <a href="tizen.html#ErrorCallback">ErrorCallback</a>? errorCallback) raises(<a href="tizen.html#WebAPIException">WebAPIException</a>);
};
+ [NoInterfaceObject] interface GravitySensor : <a href="#Sensor">Sensor</a> {
+
+ void getGravitySensorData(<a href="#SensorDataSuccessCallback">SensorDataSuccessCallback</a> successCallback,
+ optional <a href="tizen.html#ErrorCallback">ErrorCallback</a>? errorCallback) raises(<a href="tizen.html#WebAPIException">WebAPIException</a>);
+ };
+
+ [NoInterfaceObject] interface GyroscopeSensor : <a href="#Sensor">Sensor</a> {
+
+ void getGyroscopeSensorData(<a href="#SensorDataSuccessCallback">SensorDataSuccessCallback</a> successCallback,
+ optional <a href="tizen.html#ErrorCallback">ErrorCallback</a>? errorCallback) raises(<a href="tizen.html#WebAPIException">WebAPIException</a>);
+ };
+
+ [NoInterfaceObject] interface GyroscopeRotationVectorSensor : <a href="#Sensor">Sensor</a> {
+
+ void getGyroscopeRotationVectorSensorData(<a href="#SensorDataSuccessCallback">SensorDataSuccessCallback</a> successCallback,
+ optional <a href="tizen.html#ErrorCallback">ErrorCallback</a>? errorCallback) raises(<a href="tizen.html#WebAPIException">WebAPIException</a>);
+ };
+
[NoInterfaceObject] interface SensorData {
};
readonly attribute unsigned long lightIntensity;
};
+ [NoInterfaceObject] interface SensorGravityData : <a href="#SensorData">SensorData</a> {
+
+ readonly attribute double x;
+
+ readonly attribute double y;
+
+ readonly attribute double z;
+ };
+
+ [NoInterfaceObject] interface SensorGyroscopeData : <a href="#SensorData">SensorData</a> {
+
+ readonly attribute double x;
+
+ readonly attribute double y;
+
+ readonly attribute double z;
+ };
+
+ [NoInterfaceObject] interface SensorGyroscopeRotationVectorData : <a href="#SensorData">SensorData</a> {
+
+ readonly attribute double x;
+
+ readonly attribute double y;
+
+ readonly attribute double z;
+
+ readonly attribute double w;
+ };
+
[Callback=FunctionOnly, NoInterfaceObject] interface SensorDataSuccessCallback {
void onsuccess(optional <a href="#SensorData">SensorData</a>? sensorData);
};
projects / sdk / online-doc.git / commitdiff