Add sensor types and enum for new sensors 42/228042/2 accepted/tizen/unified/20200402.155354 submit/tizen/20200327.054009 submit/tizen/20200330.005543
authorBoram Bae <boram21.bae@samsung.com>
Wed, 18 Mar 2020 08:35:49 +0000 (17:35 +0900)
committerBoram Bae <boram21.bae@samsung.com>
Fri, 27 Mar 2020 05:17:25 +0000 (14:17 +0900)
Change-Id: I6934843154a7dea1a66628df1602ec76543fb757
Signed-off-by: Boram Bae <boram21.bae@samsung.com>
doc/sensor_doc.h
include/sensor.h

index 8106d63..744d3a0 100644 (file)
  * @section CAPI_SYSTEM_SENSOR_MODULE_FEATURE Related Features
  * A variety of sensors are typically available on mobile and wearable devices.
  * Regarding the types of sensors, this API is related with the following features:\n
- *  - http://tizen.org/feature/sensor.accelerometer\n
- *  - http://tizen.org/feature/sensor.barometer\n
- *  - http://tizen.org/feature/sensor.gyroscope\n
- *  - http://tizen.org/feature/sensor.magnetometer\n
- *  - http://tizen.org/feature/sensor.photometer\n
- *  - http://tizen.org/feature/sensor.proximity\n
- *  - http://tizen.org/feature/sensor.tiltmeter\n
- *  - http://tizen.org/feature/sensor.ultraviolet\n
- *  - http://tizen.org/feature/sensor.temperature\n
- *  - http://tizen.org/feature/sensor.humidity\n
- *  - http://tizen.org/feature/sensor.linear_acceleration\n
- *  - http://tizen.org/feature/sensor.rotation_vector\n
- *  - http://tizen.org/feature/sensor.gravity\n
- *  - http://tizen.org/feature/sensor.heart_rate_monitor\n
- *  - http://tizen.org/feature/sensor.heart_rate_monitor.led_green\n
- *  - http://tizen.org/feature/sensor.heart_rate_monitor.led_ir\n
- *  - http://tizen.org/feature/sensor.heart_rate_monitor.led_red\n
- *  - http://tizen.org/feature/sensor.gyroscope.uncalibrated\n
- *  - http://tizen.org/feature/sensor.magnetometer.uncalibrated\n
- *  - http://tizen.org/feature/sensor.gyroscope_rotation_vector\n
- *  - http://tizen.org/feature/sensor.geomagnetic_rotation_vector\n
- *  - http://tizen.org/feature/sensor.pedometer\n
- *  - http://tizen.org/feature/sensor.sleep_monitor\n
- *  - http://tizen.org/feature/sensor.stress_monitor\n
+ *  - %http://tizen.org/feature/sensor.accelerometer\n
+ *  - %http://tizen.org/feature/sensor.barometer\n
+ *  - %http://tizen.org/feature/sensor.gyroscope\n
+ *  - %http://tizen.org/feature/sensor.magnetometer\n
+ *  - %http://tizen.org/feature/sensor.photometer\n
+ *  - %http://tizen.org/feature/sensor.proximity\n
+ *  - %http://tizen.org/feature/sensor.tiltmeter\n
+ *  - %http://tizen.org/feature/sensor.ultraviolet\n
+ *  - %http://tizen.org/feature/sensor.temperature\n
+ *  - %http://tizen.org/feature/sensor.humidity\n
+ *  - %http://tizen.org/feature/sensor.linear_acceleration\n
+ *  - %http://tizen.org/feature/sensor.rotation_vector\n
+ *  - %http://tizen.org/feature/sensor.gravity\n
+ *  - %http://tizen.org/feature/sensor.heart_rate_monitor\n
+ *  - %http://tizen.org/feature/sensor.heart_rate_monitor.led_green\n
+ *  - %http://tizen.org/feature/sensor.heart_rate_monitor.led_ir\n
+ *  - %http://tizen.org/feature/sensor.heart_rate_monitor.led_red\n
+ *  - %http://tizen.org/feature/sensor.heart_rate_monitor.batch\n
+ *  - %http://tizen.org/feature/sensor.heart_rate_monitor.led_green.batch\n
+ *  - %http://tizen.org/feature/sensor.gyroscope.uncalibrated\n
+ *  - %http://tizen.org/feature/sensor.magnetometer.uncalibrated\n
+ *  - %http://tizen.org/feature/sensor.gyroscope_rotation_vector\n
+ *  - %http://tizen.org/feature/sensor.geomagnetic_rotation_vector\n
+ *  - %http://tizen.org/feature/sensor.pedometer\n
+ *  - %http://tizen.org/feature/sensor.sleep_monitor\n
+ *  - %http://tizen.org/feature/sensor.stress_monitor\n
  *
  * It is recommended to design feature related codes in your application for reliability.\n
  *
  * - %http://tizen.org/sensor/healthinfo/heart_rate_monitor.led_green (#SENSOR_HRM_LED_GREEN) \n
  * - %http://tizen.org/sensor/healthinfo/heart_rate_monitor.led_ir (#SENSOR_HRM_LED_IR) \n
  * - %http://tizen.org/sensor/healthinfo/heart_rate_monitor.led_red (#SENSOR_HRM_LED_RED) \n
+ * - %http://tizen.org/sensor/healthinfo/heart_rate_monitor.batch (#SENSOR_HRM_BATCH) \n
+ * - %http://tizen.org/sensor/healthinfo/heart_rate_monitor.led_green.batch (#HRM_LED_GREEN_BATCH_SENSOR) \n
  * - %http://tizen.org/sensor/general/gyroscope.uncalibrated (#SENSOR_GYROSCOPE_UNCALIBRATED) \n
  * - %http://tizen.org/sensor/general/geomagnetic.uncalibrated (#SENSOR_GEOMAGNETIC_UNCALIBRATED) \n
  * - %http://tizen.org/sensor/general/gyroscope_rotation_vector (#SENSOR_GYROSCOPE_ROTATION_VECTOR) \n
index 9152827..bcb3e6d 100644 (file)
@@ -100,6 +100,23 @@ typedef enum {
        SENSOR_SLEEP_STATE_SLEEP,        /**< The user is asleep */
 } sensor_sleep_state_e;
 
+/**
+ * @brief   Enumeration for heart-rate monitor batch sensor state.
+ * @details In its #sensor_event_s, #SENSOR_HRM_BATCH reports the user's
+ *          heart-rate monitor state as one of the followings.
+ * @since_tizen 5.5
+ */
+typedef enum {
+       SENSOR_HRM_BATCH_STATE_NODATA_FLUSH = -99,           /**< Flush but there was no batched data */
+       SENSOR_HRM_BATCH_STATE_VERYLOW_RELIABILITY = -10,    /**< Very low measurement reliability */
+       SENSOR_HRM_BATCH_STATE_LOW_RELIABILITY = -8,         /**< Low measurement reliability */
+       SENSOR_HRM_BATCH_STATE_DETACHED_AUTO = -5,           /**< Device detachment was detected during auto measurement */
+       SENSOR_HRM_BATCH_STATE_DETACHED  = -3,               /**< Device detachment was detected */
+       SENSOR_HRM_BATCH_STATE_DETECT_MOVE = -2,             /**< The Movement was detected during on-demand measurement */
+       SENSOR_HRM_BATCH_STATE_ATTACHED = -1,                /**< Device attachment was detected */
+       SENSOR_HRM_BATCH_STATE_NONE = 0,                     /**< Initial state before measurement */
+       SENSOR_HRM_BATCH_STATE_OK = 1                        /**< Heart-rate was measured normally */
+} sensor_hrm_batch_state_e;
 
 /**
  * @brief   Enumeration for sensor types.
@@ -138,6 +155,10 @@ typedef enum
        SENSOR_GEOMAGNETIC_ROTATION_VECTOR,     /**< Geomagnetic-based rotation vector sensor
                                                     @if MOBILE (Since 2.4) @elseif WEARABLE (Since 2.3.2) @endif */
        SENSOR_SIGNIFICANT_MOTION = 0x100,      /**< Significant motion sensor (Since 4.0) */
+       SENSOR_HRM_BATCH = 0x200,               /**< Heart-rate monitor batch sensor (Since 5.5)
+                                                    @n Privilege : http://tizen.org/privilege/healthinfo */
+       SENSOR_HRM_LED_GREEN_BATCH,             /**< Green LED of HRM batch sensor (Since 5.5)
+                                                    @n Privilege : http://tizen.org/privilege/healthinfo */
        SENSOR_HUMAN_PEDOMETER = 0x300,         /**< Pedometer (Since 3.0)
                                                     @n Privilege : http://tizen.org/privilege/healthinfo */
        SENSOR_HUMAN_SLEEP_MONITOR,             /**< Sleep monitor (Since 3.0)