* a device has one sensor for one type.
* However, if the device supports multiple sensors of the same type,
* sensor_get_sensor_list() function can be used to get the list of all the sensors of the type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef void* sensor_h;
/**
* @brief Enumeration for errors.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
SENSOR_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */
SENSOR_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< Not supported */
SENSOR_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED, /**< Permission denied */
SENSOR_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */
- SENSOR_ERROR_NO_DATA = TIZEN_ERROR_NO_DATA, /**< No data available
- @if MOBILE (Since 3.0) @elseif WEARABLE (Since 2.3.2) @endif */
+ SENSOR_ERROR_NO_DATA = TIZEN_ERROR_NO_DATA, /**< No data available (Since 3.0) */
SENSOR_ERROR_NOT_NEED_CALIBRATION = TIZEN_ERROR_SENSOR | 0x03, /**< Sensor doesn't need calibration */
SENSOR_ERROR_OPERATION_FAILED = TIZEN_ERROR_SENSOR | 0x06, /**< Operation failed */
- SENSOR_ERROR_NOT_AVAILABLE = TIZEN_ERROR_SENSOR | 0x07, /**< The sensor is supported, but currently not available
- @if MOBILE (Since 3.0) @elseif WEARABLE (Since 2.3.2) @endif */
+ SENSOR_ERROR_NOT_AVAILABLE = TIZEN_ERROR_SENSOR | 0x07, /**< The sensor is supported, but currently not available (Since 3.0) */
} sensor_error_e;
* @brief Enumeration for proximity sensor events.
* @details In its #sensor_event_s, #SENSOR_PROXIMITY reports the existence of
* nearby objects in front of the sensor as one of the followings.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
SENSOR_PROXIMITY_NEAR = 0, /**< An object is placed near the proximity sensor */
/**
* @brief Enumeration for sensor types.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum
{
SENSOR_ULTRAVIOLET, /**< Ultraviolet sensor */
SENSOR_TEMPERATURE, /**< Temperature sensor */
SENSOR_HUMIDITY, /**< Humidity sensor */
- SENSOR_HRM, /**< Heart-rate monitor @if MOBILE (Since 2.3.1) @endif
+ SENSOR_HRM, /**< Heart-rate monitor (Since 2.3.1)
@n Privilege : %http://tizen.org/privilege/healthinfo */
- SENSOR_HRM_LED_GREEN, /**< Green LED sensor of HRM @if MOBILE (Since 2.3.1) @endif
+ SENSOR_HRM_LED_GREEN, /**< Green LED sensor of HRM (Since 2.3.1)
@n Privilege : %http://tizen.org/privilege/healthinfo */
- SENSOR_HRM_LED_IR, /**< Infra-Red LED sensor of HRM @if MOBILE (Since 2.3.1) @endif
+ SENSOR_HRM_LED_IR, /**< Infra-Red LED sensor of HRM (Since 2.3.1)
@n Privilege : %http://tizen.org/privilege/healthinfo */
- SENSOR_HRM_LED_RED, /**< Red LED sensor of HRM @if MOBILE (Since 2.3.1) @endif
+ SENSOR_HRM_LED_RED, /**< Red LED sensor of HRM (Since 2.3.1)
@n Privilege : %http://tizen.org/privilege/healthinfo */
- SENSOR_GYROSCOPE_UNCALIBRATED, /**< Uncalibrated Gyroscope sensor
- @if MOBILE (Since 2.4) @elseif WEARABLE (Since 2.3.2) @endif */
- SENSOR_GEOMAGNETIC_UNCALIBRATED, /**< Uncalibrated Geomagnetic sensor
- @if MOBILE (Since 2.4) @elseif WEARABLE (Since 2.3.2) @endif */
- SENSOR_GYROSCOPE_ROTATION_VECTOR, /**< Gyroscope-based rotation vector sensor
- @if MOBILE (Since 2.4) @elseif WEARABLE (Since 2.3.2) @endif */
- SENSOR_GEOMAGNETIC_ROTATION_VECTOR, /**< Geomagnetic-based rotation vector sensor
- @if MOBILE (Since 2.4) @elseif WEARABLE (Since 2.3.2) @endif */
+ SENSOR_GYROSCOPE_UNCALIBRATED, /**< Uncalibrated Gyroscope sensor (Since 2.4) */
+ SENSOR_GEOMAGNETIC_UNCALIBRATED, /**< Uncalibrated Geomagnetic sensor (Since 2.4) */
+ SENSOR_GYROSCOPE_ROTATION_VECTOR, /**< Gyroscope-based rotation vector sensor (Since 2.4) */
+ SENSOR_GEOMAGNETIC_ROTATION_VECTOR, /**< Geomagnetic-based rotation vector sensor (Since 2.4) */
SENSOR_GYROSCOPE_ORIENTATION = 100, /**< Orientation sensor based on gyroscope rotation vector Since 6.5 */
SENSOR_GEOMAGNETIC_ORIENTATION = 105, /**< Orientation sensor based on geomagnetic rotation vector Since 6.5 */
SENSOR_SIGNIFICANT_MOTION = 256, /**< Significant motion sensor (Since 4.0) */
* @brief Checks whether a given sensor type is supported in the current device.
* @details If the given sensor type is not supported, sensor_get_default_sensor() will return an error.
* It is thus recommended to check the availability of the sensor before actually acquiring #sensor_h.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @param[in] type A sensor type to check
* @param[out] supported If supported, @c true; Otherwise @c false
* @brief Checks whether a given sensor is a wake-up sensor or not.
* @details If a sensor is a wake-up sensor, the sensor is able to wake-up the system
* to report its sensor data even if the system is in sleep mode.
- * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
+ * @since_tizen 3.0
*
* @param[in] sensor A sensor handle to check
* @param[out] wakeup If the sensor is a wake-up sensor, @c true;
* If the device has more than one sensor of the given type,
* this function returns the default sensor of the given type,
* which is designated by the device.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @remarks Some sensor types are privileged. An application should have the privilege
* %http://tizen.org/privilege/healthinfo to get handles for the following sensors:
* In such case, this function can be used to get the handles of all sensors of the type.@n
* The first element of the @a list denotes the default sensor,
* which can be retrieved by sensor_get_default_sensor().
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @remarks Some sensor types are privileged. An application should have the privilege
* %http://tizen.org/privilege/healthinfo to get handles for the following sensors:
/**
* @brief Gets the name of a sensor.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @remarks The @a name must be released using free(), if not being used anymore.
*
/**
* @brief Gets the vendor of a sensor.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @remarks The @a vendor must be released using free(), if not being used anymore.
*
/**
* @brief Gets the type of a sensor, if it belongs to the known types defined in #sensor_type_e.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @param[in] sensor A sensor handle
* @param[out] type The type of the sensor
* the lower bound of all sensor values is returned.
* Otherwise, the lower bound of the representative sensor value, e.g.,
* the step count of #SENSOR_HUMAN_PEDOMETER, is returned.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @param[in] sensor A sensor handle
* @param[out] min_range The lower bound
* the upper bound of all sensor values is returned.
* Otherwise, the upper bound of the representative sensor value, e.g.,
* the step count of #SENSOR_HUMAN_PEDOMETER, is returned.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @param[in] sensor A sensor handle
* @param[out] max_range The upper bound
* The resolution denotes the smallest difference between sensor readings,
* each of which is in the range that can be verified by
* sensor_get_min_range() and sensor_get_max_range().
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @param[in] sensor A sensor handle
* @param[out] resolution The resolution
/**
* @brief Gets the possible shorted update interval of a sensor.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @param[in] sensor A sensor handle
* @param[out] min_interval The shorted interval in milliseconds
* the returned count may not mean the maximum number of sensor data that can be batched.
* See sensor_get_max_batch_count() for such purpose, finding out the
* possible maximum number of batched data.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @param[in] sensor A sensor handle
* @param[out] fifo_count The FIFO count
* If this returns a positive count, i.e., the sensor supports batching,
* the count also can be used to guess the possible longest batch latency
* of the sensor, with respect to the update interval to use.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @param[in] sensor A sensor handle
* @param[out] max_batch_count If the sensor does not support batching, 0;
/**
* @brief The upper bound of #sensor_event_s::value_count.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
#define MAX_VALUE_SIZE 16
* Then the sensor's data can observed asynchronously, can be read synchronously if available, via the listener.
* Applications are also able to control the behavior of each sensor, for example,
* update interval of sensor readings.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef struct sensor_listener_s *sensor_listener_h;
* #sensor_event_s::value_count is thus set to 3.@n
* Note that, even if the data values are @c float, in some cases,
* it may contain one or more categorical data as in #sensor_proximity_e.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @see #sensor_pedometer_state_e
* @see #sensor_sleep_state_e
*/
/**
* @brief Enumeration for sensor data accuracy.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum
{
/**
* @brief Enumeration for sensor listener behavior attributes
- * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
+ * @since_tizen 3.0
*/
typedef enum
{
/**
* @brief Enumeration for sensor options.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
#ifndef __SENSOR_COMMON_H__
typedef enum
* By default, #SENSOR_AXIS_DISPLAY_ORIENTED is used.
* If you need to use the data that are not affected by display orientations,
* #SENSOR_AXIS_DEVICE_ORIENTED needs to be set.
- * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
+ * @since_tizen 3.0
*/
typedef enum
{
* @details To be power-efficient, you can set the policy of how to pause and resume
* a sensor listener regarding the system status.
* By default, #SENSOR_PAUSE_ALL is used to obtain the maximum power efficiency.
- * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
+ * @since_tizen 3.0
*/
typedef enum
{
/**
* @deprecated Deprecated since 5.5. Use sensor_events_cb() instead.
* @brief Called when a sensor event occurs.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @remarks @a sensor should not be freed, it's managed by platform.
* @remarks @a event should not be freed and can be used only in the callback. To use outside the callback, make a copy.
* @details Sensors can be affected by the environment.
* For example, #SENSOR_MAGNETIC is sensitive to any surrounding objects that can influence
* electromagnetic fields. This function is called if the accuracy of the corresponding sensor is changed.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @param[in] sensor A sensor handle
* @param[in] timestamp The time in milliseconds when the accuracy changed
/**
* @brief Creates a sensor listener.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @remarks The @a listener must be released using sensor_destroy_listener().
*
/**
* @brief Releases all the resources allocated for a listener.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @remarks If this function is called while the sensor is still running,
* that is, sensor_listener_start() was called but sensor_listener_stop() was not,
* with a specific update interval.
* Note that, unlike the accelerometer, sensors like #SENSOR_PROXIMITY emit events
* only if their states change.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @param[in] listener A listener handle
*
* @details The listener's event callback function stops being called.
* But the sensor itself may not be stopped if there are other listeners
* that are using the same sensor.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @param[in] listener A listener handle
*
/**
* @deprecated Deprecated since 5.5. Use sensor_listener_set_events_cb() instead.
* @brief Registers the callback function to be invoked when sensor events are delivered via a sensor listener.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @param[in] listener A listener handle
* @param[in] interval_ms A desired update interval between sensor events in milliseconds.@n
/**
* @deprecated Deprecated since 5.5. Use sensor_listener_unset_events_cb() instead.
* @brief Unregisters the sensor event callback function attached to a given sensor listener.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @param[in] listener A listener handle
*
* @details In addition to sensor_event_cb(), sensor_accuracy_changed_cb() also can be attached
* to sensor listeners. With this accuracy callback function, applications can be notified
* the changes of the corresponding sensors separately.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @param[in] listener A listener handle
* @param[in] callback A callback function to attach with the @a listener handle
/**
* @brief Unregisters the sensor accuracy change callback function attached to a given sensor listener.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @param[in] listener A listener handle
*
* @details This function synchronously reads the sensor reading of the corresponding sensor, if available.
* Otherwise, if the sensor is not ready to report its values, this function fails and returns
* #SENSOR_ERROR_OPERATION_FAILED.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @remarks As a sensor usually works in an event-driven manner, it may not be able to read its data on demand.
* Then this function tries to return the last known values.@n
* 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.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @remarks Normally, a sensor's default update interval is 100 ms,
* and you can use the default interval by setting the interval to 0.
* up to 10,000 ms, before delivering the data through the HAL.@n
* In case of non-batching sensors, this function returns #SENSOR_ERROR_NONE,
* but nothing is affected by the input latency value.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @remarks Even if you set a batch latency, the sensor may not work as you intended,
* as one sensor can be used by more than one listeners.
* what is the reference coordinate of the sensor values,
* and when the system is allowed to turn off the sensor implicitly to reduce the power consumption.
* See #sensor_attribute_e for more details about the available control parameters.
- * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
+ * @since_tizen 3.0
*
* @param[in] listener A listener handle
* @param[in] attribute An attribute to change
/**
* @brief Changes the power-saving behavior of a sensor listener.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @remarks sensor_listener_set_attribute_int() with #SENSOR_ATTRIBUTE_PAUSE_POLICY replaces this function.
*
/**
* @brief Option handle to contain recording policies and parameters.
* @details one or more sensor options can be created by using sensor_recorder_create_option().
- * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
+ * @since_tizen 3.0
*/
typedef void *sensor_recorder_option_h;
/**
* @brief Query handle to contain filtering and aggregation parameters for recorded data.
* @details one or more sensor options can be created by using sensor_recorder_create_query().
- * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
+ * @since_tizen 3.0
*/
typedef void *sensor_recorder_query_h;
/**
* @brief Data handle to contain retrieved sensor records.
- * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
+ * @since_tizen 3.0
*/
typedef void *sensor_recorder_data_h;
* then applications can request to record a specific sensor with the parameters via
* sensor_recorder_start().
* If a parameter is not supported for the specified sensor type, it will be ignored.
- * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
+ * @since_tizen 3.0
*/
typedef enum
{
* battery efficient than to listen the sensor data continuously.@n
* If the application does not set the interval explicitly, the default value is chosen.
* The default values are differ from sensor to sensor.
- * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
+ * @since_tizen 3.0
* @remarks If more than one applications set different intervals, the shortest value is chosen.
*/
typedef enum
* @details None, one, or more query parameters can be set to #sensor_recorder_query_h,
* to specify the data to be retrieved via sensor_recorder_read().
* If a necessary parameter is not set, the default value is chosen.
- * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
+ * @since_tizen 3.0
*/
typedef enum
{
/**
* @brief Enumeration for data attributes can be contained in #sensor_recorder_data_h.
- * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
+ * @since_tizen 3.0
* @see sensor_recorder_data_get_int()
* @see sensor_recorder_data_get_double()
*/
typedef enum
{
- SENSOR_RECORDER_DATA_STEPS = 0x00, /**< Count of both walking and running steps; int
- @if WEARABLE (Since 3.0) @endif */
- SENSOR_RECORDER_DATA_WALK_STEPS, /**< Count of walking steps; int
- @if WEARABLE (Since 3.0) @endif */
- SENSOR_RECORDER_DATA_RUN_STEPS, /**< Count of running steps; int
- @if WEARABLE (Since 3.0) @endif */
- SENSOR_RECORDER_DATA_DISTANCE, /**< Distance walked or ran (m); double
- @if WEARABLE (Since 3.0) @endif */
- SENSOR_RECORDER_DATA_CALORIE, /**< Calorie burned (kcal); double
- @if WEARABLE (Since 3.0) @endif */
- SENSOR_RECORDER_DATA_HEART_RATE = 0x10, /**< Heart Rate (BPM); int
- @if WEARABLE (Since 3.0) @endif */
- SENSOR_RECORDER_DATA_SLEEP_STATE = 0x20, /**< Sleep state; int; One of #sensor_sleep_state_e
- @if WEARABLE (Since 3.0) @endif */
+ SENSOR_RECORDER_DATA_STEPS = 0x00, /**< Count of both walking and running steps; int (Since 3.0) */
+ SENSOR_RECORDER_DATA_WALK_STEPS, /**< Count of walking steps; int (Since 3.0) */
+ SENSOR_RECORDER_DATA_RUN_STEPS, /**< Count of running steps; int (Since 3.0) */
+ SENSOR_RECORDER_DATA_DISTANCE, /**< Distance walked or ran (m); double (Since 3.0) */
+ SENSOR_RECORDER_DATA_CALORIE, /**< Calorie burned (kcal); double (Since 3.0) */
+ SENSOR_RECORDER_DATA_HEART_RATE = 0x10, /**< Heart Rate (BPM); int (Since 3.0) */
+ SENSOR_RECORDER_DATA_SLEEP_STATE = 0x20, /**< Sleep state; int; One of #sensor_sleep_state_e (Since 3.0) */
SENSOR_RECORDER_DATA_PRESSURE = 0x30, /**< Pressure; double */
SENSOR_RECORDER_DATA_MAX_PRESSURE, /**< Max pressure; double */
SENSOR_RECORDER_DATA_MIN_PRESSURE, /**< Min pressure; double */
/**
* @brief Checks whether it is supported to record a given sensor type.
- * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
+ * @since_tizen 3.0
*
* @param[in] type A sensor type to check
* @param[out] supported If supported, @c true; Otherwise @c false
/**
* @brief Starts to record a given sensor type.
- * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
+ * @since_tizen 3.0
*
* @remarks Some sensor types are privileged. An application should have the privilege
* %http://tizen.org/privilege/healthinfo to get access to the following sensors:
/**
* @brief Stops recording a given sensor type.
- * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
+ * @since_tizen 3.0
*
* @param[in] type A sensor type being recorded
*
/**
* @brief Creates a recorder option handle.
- * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
+ * @since_tizen 3.0
*
* @remarks The @a option must be released using sensor_recorder_destroy_option().
*
/**
* @brief Destroys a recorder option handle.
- * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
+ * @since_tizen 3.0
*
* @param[in] option Option handle
*
/**
* @brief Sets a recording option parameter.
- * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
+ * @since_tizen 3.0
*
* @param[in] option Option handle
* @param[in] param Option parameter
/**
* @brief Creates a recorder query handle.
- * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
+ * @since_tizen 3.0
*
* @remarks The @a query must be released using sensor_recorder_destroy_query().
*
/**
* @brief Destroys a recorder query handle.
- * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
+ * @since_tizen 3.0
*
* @param[in] query Query handle
*
/**
* @brief Sets an integer-type query parameter
- * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
+ * @since_tizen 3.0
*
* @param[in] query Query handle
* @param[in] param Query parameter
/**
* @brief Sets a time-type query parameter.
- * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
+ * @since_tizen 3.0
*
* @param[in] query Query handle
* @param[in] param Query parameter
* #SENSOR_ERROR_NONE, Successful\n
* #SENSOR_ERROR_OPERATION_FAILED, Operation failed\n
* #SENSOR_ERROR_NO_DATA, No data retrieved.
- * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
+ * @since_tizen 3.0
*
* @param[in] type Sensor type
* @param[in] data Retrieved data record
/**
* @brief Queries the recorded data asynchronously.
- * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
+ * @since_tizen 3.0
*
* @remarks Some sensor types are privileged. An application should have the privilege
* %http://tizen.org/privilege/healthinfo to get access to the following sensors:
/**
* @brief Queries the recorded data synchronously.
- * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
+ * @since_tizen 3.0
*
* @remarks Some sensor types are privileged. An application should have the privilege
* %http://tizen.org/privilege/healthinfo to get access to the following sensors:
/**
* @brief Gets the start and the end time of the time period of a given record data.
- * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
+ * @since_tizen 3.0
*
* @param[in] data Record data handle
* @param[out] start_time Start time of the time period of the record
/**
* @brief Gets an integer value from a record data.
- * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
+ * @since_tizen 3.0
*
* @param[in] data Record data handle
* @param[in] key Data attribute to retrieve
/**
* @brief Gets a double value from a record data.
- * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif
+ * @since_tizen 3.0
*
* @param[in] data Record data handle
* @param[in] key Data attribute to retrieve
/**
* @brief Enumeration of the axis used in sensor_util_remap_coordinate_system().
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum
{
* [0 m 0] = I * R * geomagnetic (m = magnitude of the geomagnetic field) \n
* R is the identity matrix when the device is aligned with the world's coordinate system, that is, when the device's X axis points towards the East, the Y axis points to the North Pole and the device is facing the sky. \n
* I is a rotation matrix transforming the geomagnetic vector into the same coordinate space as gravity (the world's coordinate space). I is a simple rotation around the X axis. \n
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @remarks Parameters Gx, Gy, and Gz can be obtained from the values returned by #SENSOR_GRAVITY. \n
* Parameters Mx, My, and Mz can be obtained from the values returned by #SENSOR_MAGNETIC.
*
* @details Rotation vectors (Vx, Vy, Vz) can be obtained from #SENSOR_ROTATION_VECTOR.
* It returns a 9 element rotation matrix in the array R. R must have length as 9.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @param[in] Vx The X-axis rotation vector
* @param[in] Vy The Y-axis rotation vector
* @brief Rotates the supplied rotation matrix so that it is expressed in a different coordinate system.
*
* @details This is typically used when an application needs to compute the three orientation angles of the device in a different coordinate system.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @remarks inR and outR can be the same array, but this is not recommended for performance reasons.
* This returns an error when X and Y define the same axis.
/**
* @brief Computes the geomagnetic inclination angle in radians from the inclination matrix I returned by sensor_util_get_rotation_matrix().
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @param[in] I The inclination matrix from sensor_util_get_rotation_matrix()
* @param[out] inclination The geomagnetic inclination angle in radians
* - values[0]: azimuth, rotation around the Z axis.
* - values[1]: pitch, rotation around the X axis.
* - values[2]: roll, rotation around the Y axis.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @remarks Parameter R must be an array of 9 floats from sensor_util_get_rotation_matrix() \n
* Returned values are always arrays of 3 floats.
* @details Given a current rotation matrix (R) and a previous rotation matrix (prevR), it computes
* the rotation around the x,y, and z axes which transforms prevR to R.
* It outputs a 3 element vector containing the x,y, and z angle change at indexes 0, 1, and 2 respectively. \n
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @remarks Each input matrix is a 3x3 matrix like this form:
* <pre>
/**
* @brief Gets the declination of the horizontal component of the magnetic field from true north, in degrees.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @param[in] latitude The latitude in geodetic coordinates
* @param[in] longitude The longitude in geodetic coordinates
projects / platform / core / api / sensor.git / commitdiff