include/sensor_types.h

   1 /*
   2  * sensord
   3  *
   4  * Copyright (c) 2016 Samsung Electronics Co., Ltd.
   5  *
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  * http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  */
  19
  20 #ifndef __SENSOR_TYPES_H__
  21 #define __SENSOR_TYPES_H__
  22
  23 /* TODO: It is for compatibility with capi-system-sensor */
  24 #define __SENSOR_COMMON_H__
  25
  26 #include <stddef.h>
  27 #include <stdint.h>
  28 #include <sensor_hal_types.h>
  29
  30 #ifdef __cplusplus
  31 extern "C"
  32 {
  33 #endif
  34
  35 #ifndef OP_SUCCESS
  36 #define OP_SUCCESS 0
  37 #endif
  38 #ifndef OP_ERROR
  39 #define OP_ERROR   -1
  40 #endif
  41 #ifndef OP_DEFAULT
  42 #define OP_DEFAULT 1
  43 #endif
  44 #ifndef OP_CONTINUE
  45 #define OP_CONTINUE 2
  46 #endif
  47 #ifndef NAME_MAX
  48 #define NAME_MAX 256
  49 #endif
  50
  51 #define SENSOR_TYPE_SHIFT 32
  52 #define SENSOR_EVENT_SHIFT 16
  53 #define SENSOR_INDEX_MASK 0xFFFFFFFF
  54
  55 #define CONVERT_ID_TYPE(id) ((id) >> SENSOR_TYPE_SHIFT)
  56 #define CONVERT_TYPE_EVENT(type) ((type) << SENSOR_EVENT_SHIFT | 0x1)
  57
  58 #define MICROSECONDS(tv)        ((tv.tv_sec * 1000000ll) + tv.tv_usec)
  59
  60 #define SENSOR_UNKNOWN_TYPE "http://tizen.org/sensor/unknown"
  61 #define SENSOR_UNKNOWN_NAME "Unknown"
  62
  63 typedef int64_t sensor_id_t;
  64 typedef void *sensor_t;
  65
  66 typedef enum sensor_type_t {
  67         UNKNOWN_SENSOR = -2,
  68         ALL_SENSOR = -1,
  69         ACCELEROMETER_SENSOR = 0,
  70         GRAVITY_SENSOR,
  71         LINEAR_ACCEL_SENSOR,
  72         GEOMAGNETIC_SENSOR,
  73         ROTATION_VECTOR_SENSOR,
  74         ORIENTATION_SENSOR,
  75         GYROSCOPE_SENSOR,
  76         LIGHT_SENSOR,
  77         PROXIMITY_SENSOR,
  78         PRESSURE_SENSOR,
  79         ULTRAVIOLET_SENSOR,
  80         TEMPERATURE_SENSOR,
  81         HUMIDITY_SENSOR,
  82         HRM_SENSOR,
  83         BIO_HRM_SENSOR = HRM_SENSOR,
  84         HRM_LED_GREEN_SENSOR,
  85         BIO_LED_GREEN_SENSOR = HRM_LED_GREEN_SENSOR,
  86         HRM_LED_IR_SENSOR,
  87         BIO_LED_IR_SENSOR = HRM_LED_IR_SENSOR,
  88         HRM_LED_RED_SENSOR,
  89         BIO_LED_RED_SENSOR = HRM_LED_RED_SENSOR,
  90         GYROSCOPE_UNCAL_SENSOR,
  91         GEOMAGNETIC_UNCAL_SENSOR,
  92         GYROSCOPE_RV_SENSOR,
  93         GEOMAGNETIC_RV_SENSOR,
  94
  95         SIGNIFICANT_MOTION_SENSOR = 0x100,
  96
  97         HUMAN_PEDOMETER_SENSOR = 0x300,
  98         HUMAN_SLEEP_MONITOR_SENSOR,
  99         HUMAN_SLEEP_DETECTOR_SENSOR,
 100         SLEEP_DETECTOR_SENSOR = HUMAN_SLEEP_DETECTOR_SENSOR,
 101         HUMAN_STRESS_MONITOR_SENSOR,
 102         STRESS_MONITOR_SENSOR = HUMAN_STRESS_MONITOR_SENSOR,
 103
 104         EXERCISE_WALKING_SENSOR = 0x400,
 105         EXERCISE_RUNNING_SENSOR,
 106         EXERCISE_HIKING_SENSOR,
 107         EXERCISE_CYCLING_SENSOR,
 108         EXERCISE_ELLIPTICAL_SENSOR,
 109         EXERCISE_INDOOR_CYCLING_SENSOR,
 110         EXERCISE_ROWING_SENSOR,
 111         EXERCISE_STEPPER_SENSOR,
 112
 113         DATA_JOURNAL_SENSOR = 0x500,
 114
 115         EXTERNAL_EXERCISE_SENSOR = 0x800,
 116         EXERCISE_SENSOR = EXTERNAL_EXERCISE_SENSOR,
 117
 118         FUSION_SENSOR = 0x900,
 119         AUTO_ROTATION_SENSOR,
 120         AUTO_BRIGHTNESS_SENSOR,
 121         MYOTEST_SENSOR,
 122
 123         GESTURE_MOVEMENT_SENSOR = 0x1200,
 124         GESTURE_WRIST_UP_SENSOR,
 125         GESTURE_WRIST_DOWN_SENSOR,
 126         GESTURE_MOVEMENT_STATE_SENSOR,
 127         GESTURE_PICK_UP_SENSOR,
 128         GESTURE_FACE_DOWN_SENSOR,
 129
 130         ACTIVITY_TRACKER_SENSOR = 0x1A00,
 131         ACTIVITY_LEVEL_MONITOR_SENSOR,
 132         GPS_BATCH_SENSOR,
 133         PPG_BATCH_SENSOR,
 134         GPS_TIMESYNC_SENSOR,
 135
 136         HRM_CTRL_SENSOR = 0x1A80,
 137         REG_CTRL_SENSOR,
 138         GPS_CTRL_SENSOR,
 139
 140         WEAR_STATUS_SENSOR = 0x2000,
 141         WEAR_ON_MONITOR_SENSOR,
 142         NO_MOVE_DETECTOR_SENSOR,
 143         RESTING_HR_SENSOR,
 144         STEP_LEVEL_MONITOR_SENSOR,
 145         EXERCISE_STANDALONE_SENSOR,
 146         EXERCISE_COACH_SENSOR = EXERCISE_STANDALONE_SENSOR,
 147         EXERCISE_HR_SENSOR,
 148         WORKOUT_SENSOR,
 149         AUTOSESSION_EXERCISE_SENSOR = WORKOUT_SENSOR,
 150         CYCLE_MONITOR_SENSOR,
 151         STAIR_TRACKER_SENSOR,
 152         PRESSURE_INDICATOR_SENSOR,
 153         PRESSURE_ALERT_SENSOR,
 154         HR_CALORIE_SENSOR,
 155         SWIMMING_TRACKER_SENSOR,
 156         STRESS_TRACKER_SENSOR,
 157         FAKE_MOTION_SENSOR,
 158         GEOFENCE_SENSOR,
 159         SWIMMING_OUTDOOR_SENSOR,
 160         AUTO_SWIMMING_SENSOR,
 161         INACTIVITY_DETECTOR_SENSOR,
 162         HRM_BP_SENSOR,
 163         ECG_SENSOR,
 164         FALL_DETECTION_SENSOR,
 165
 166         CONTEXT_SENSOR = 0x7000,
 167         MOTION_SENSOR,
 168         PIR_SENSOR,
 169         PIR_LONG_SENSOR,
 170         DUST_SENSOR,
 171         THERMOMETER_SENSOR,
 172         PEDOMETER_SENSOR,
 173         FLAT_SENSOR,
 174         HRM_RAW_SENSOR,
 175         BIO_SENSOR = HRM_RAW_SENSOR,
 176         TILT_SENSOR,
 177         RV_RAW_SENSOR,
 178         GSR_SENSOR,
 179         SIMSENSE_SENSOR,
 180         PPG_SENSOR,
 181
 182         CUSTOM_SENSOR = 0X9000,
 183 } sensor_type_t;
 184
 185 typedef struct sensor_info2_t {
 186         uint32_t id;
 187         sensor_type_t type;
 188         const char *uri;
 189         const char *vendor;
 190         float min_range;
 191         float max_range;
 192         float resolution;
 193         int min_interval;
 194         int max_batch_count;
 195         bool wakeup_supported;
 196         const char *privilege;
 197         void *reserved[8];
 198 } sensor_info2_t;
 199
 200 typedef enum sensor_privilege_t {
 201         SENSOR_PRIVILEGE_PUBLIC = 0,
 202 } sensor_privilege_t;
 203
 204 typedef struct sensor_event_t {
 205         unsigned int event_type;
 206         sensor_id_t sensor_id;
 207         unsigned int data_length;
 208         sensor_data_t *data;
 209 } sensor_event_t;
 210
 211 /*
 212  *      To prevent naming confliction as using same enums as sensor CAPI use
 213  */
 214 #ifndef __SENSOR_H__
 215 enum sensor_option_t {
 216         SENSOR_OPTION_DEFAULT = 0,
 217         SENSOR_OPTION_ON_IN_SCREEN_OFF = 1,
 218         SENSOR_OPTION_ON_IN_POWERSAVE_MODE = 2,
 219         SENSOR_OPTION_ALWAYS_ON = SENSOR_OPTION_ON_IN_SCREEN_OFF | SENSOR_OPTION_ON_IN_POWERSAVE_MODE,
 220         SENSOR_OPTION_END
 221 };
 222
 223 typedef enum sensor_option_t sensor_option_e;
 224 #endif
 225
 226 enum sensord_attribute_e {
 227         SENSORD_ATTRIBUTE_AXIS_ORIENTATION = 1,
 228         SENSORD_ATTRIBUTE_PAUSE_POLICY,
 229         SENSORD_ATTRIBUTE_INTERVAL = 0x10,
 230         SENSORD_ATTRIBUTE_MAX_BATCH_LATENCY,
 231         SENSORD_ATTRIBUTE_PASSIVE_MODE,
 232         SENSORD_ATTRIBUTE_FLUSH,
 233 };
 234
 235 enum sensord_axis_e {
 236         SENSORD_AXIS_DEVICE_ORIENTED = 1,
 237         SENSORD_AXIS_DISPLAY_ORIENTED,
 238 };
 239
 240 enum sensord_pause_e {
 241         SENSORD_PAUSE_NONE = 0,
 242         SENSORD_PAUSE_ON_DISPLAY_OFF = 1,
 243         SENSORD_PAUSE_ON_POWERSAVE_MODE = 2,
 244         SENSORD_PAUSE_ALL = 3,
 245         SENSORD_PAUSE_END,
 246 };
 247
 248 enum poll_interval_t {
 249         POLL_100HZ_MS   = 10,
 250         POLL_50HZ_MS    = 20,
 251         POLL_25HZ_MS    = 40,
 252         POLL_20HZ_MS    = 50,
 253         POLL_10HZ_MS    = 100,
 254         POLL_5HZ_MS             = 200,
 255         POLL_1HZ_MS             = 1000,
 256         POLL_MAX_HZ_MS  = 255000,
 257 };
 258
 259 #define DEFAULT_INTERVAL POLL_10HZ_MS
 260
 261 enum sensor_interval_t {
 262         SENSOR_INTERVAL_FASTEST = POLL_100HZ_MS,
 263         SENSOR_INTERVAL_NORMAL = POLL_5HZ_MS,
 264 };
 265
 266 enum proxi_change_state {
 267         PROXIMITY_STATE_NEAR = 0,
 268         PROXIMITY_STATE_FAR = 1,
 269 };
 270
 271 enum auto_rotation_state {
 272         AUTO_ROTATION_DEGREE_UNKNOWN = 0,
 273         AUTO_ROTATION_DEGREE_0,
 274         AUTO_ROTATION_DEGREE_90,
 275         AUTO_ROTATION_DEGREE_180,
 276         AUTO_ROTATION_DEGREE_270,
 277 };
 278
 279 #ifdef __cplusplus
 280 }
 281 #endif
 282
 283 #include <sensor_deprecated.h>
 284
 285 #endif /* __SENSOR_TYPES_H__ */