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 #define PRIV_APPLICATION_SENSOR "http://tizen.org/privilege/applicationsensor"
  64 #define PRIV_APPLICATION_SENSOR_WRITE "http://tizen.org/privilege/applicationsensor.write"
  65
  66 typedef int64_t sensor_id_t;
  67 typedef void *sensor_t;
  68
  69 typedef enum sensor_type_t {
  70         UNKNOWN_SENSOR = -2,
  71         ALL_SENSOR = -1,
  72         ACCELEROMETER_SENSOR = 0,
  73         GRAVITY_SENSOR,
  74         LINEAR_ACCEL_SENSOR,
  75         GEOMAGNETIC_SENSOR,
  76         ROTATION_VECTOR_SENSOR,
  77         ORIENTATION_SENSOR,
  78         GYROSCOPE_SENSOR,
  79         LIGHT_SENSOR,
  80         PROXIMITY_SENSOR,
  81         PRESSURE_SENSOR,
  82         ULTRAVIOLET_SENSOR,
  83         TEMPERATURE_SENSOR,
  84         HUMIDITY_SENSOR,
  85         HRM_SENSOR,
  86         BIO_HRM_SENSOR = HRM_SENSOR,
  87         HRM_LED_GREEN_SENSOR,
  88         BIO_LED_GREEN_SENSOR = HRM_LED_GREEN_SENSOR,
  89         HRM_LED_IR_SENSOR,
  90         BIO_LED_IR_SENSOR = HRM_LED_IR_SENSOR,
  91         HRM_LED_RED_SENSOR,
  92         BIO_LED_RED_SENSOR = HRM_LED_RED_SENSOR,
  93         GYROSCOPE_UNCAL_SENSOR,
  94         GEOMAGNETIC_UNCAL_SENSOR,
  95         GYROSCOPE_RV_SENSOR,
  96         GEOMAGNETIC_RV_SENSOR,
  97
  98         HUMAN_PEDOMETER_SENSOR = 0x300,
  99         HUMAN_SLEEP_MONITOR_SENSOR,
 100         HUMAN_SLEEP_DETECTOR_SENSOR,
 101         SLEEP_DETECTOR_SENSOR = HUMAN_SLEEP_DETECTOR_SENSOR,
 102         HUMAN_STRESS_MONITOR_SENSOR,
 103         STRESS_MONITOR_SENSOR = HUMAN_STRESS_MONITOR_SENSOR,
 104
 105         EXERCISE_WALKING_SENSOR = 0x400,
 106         EXERCISE_RUNNING_SENSOR,
 107         EXERCISE_HIKING_SENSOR,
 108         EXERCISE_CYCLING_SENSOR,
 109         EXERCISE_ELLIPTICAL_SENSOR,
 110         EXERCISE_INDOOR_CYCLING_SENSOR,
 111         EXERCISE_ROWING_SENSOR,
 112         EXERCISE_STEPPER_SENSOR,
 113
 114         EXTERNAL_EXERCISE_SENSOR = 0x800,
 115         EXERCISE_SENSOR = EXTERNAL_EXERCISE_SENSOR,
 116
 117         FUSION_SENSOR = 0x900,
 118         AUTO_ROTATION_SENSOR,
 119         AUTO_BRIGHTNESS_SENSOR,
 120
 121         GESTURE_MOVEMENT_SENSOR = 0x1200,
 122         GESTURE_WRIST_UP_SENSOR,
 123         GESTURE_WRIST_DOWN_SENSOR,
 124         GESTURE_MOVEMENT_STATE_SENSOR,
 125         GESTURE_FACE_DOWN_SENSOR,
 126
 127         ACTIVITY_TRACKER_SENSOR = 0x1A00,
 128         ACTIVITY_LEVEL_MONITOR_SENSOR,
 129         GPS_BATCH_SENSOR,
 130
 131         HRM_CTRL_SENSOR = 0x1A80,
 132
 133         WEAR_STATUS_SENSOR = 0x2000,
 134         WEAR_ON_MONITOR_SENSOR,
 135         NO_MOVE_DETECTOR_SENSOR,
 136         RESTING_HR_SENSOR,
 137         STEP_LEVEL_MONITOR_SENSOR,
 138         EXERCISE_STANDALONE_SENSOR,
 139         EXERCISE_COACH_SENSOR = EXERCISE_STANDALONE_SENSOR,
 140         EXERCISE_HR_SENSOR,
 141         WORKOUT_SENSOR,
 142         AUTOSESSION_EXERCISE_SENSOR = WORKOUT_SENSOR,
 143         CYCLE_MONITOR_SENSOR,
 144         STAIR_TRACKER_SENSOR,
 145         PRESSURE_INDICATOR_SENSOR,
 146         PRESSURE_ALERT_SENSOR,
 147         HR_CALORIE_SENSOR,
 148
 149         CONTEXT_SENSOR = 0x7000,
 150         MOTION_SENSOR,
 151         PIR_SENSOR,
 152         PIR_LONG_SENSOR,
 153         DUST_SENSOR,
 154         THERMOMETER_SENSOR,
 155         PEDOMETER_SENSOR,
 156         FLAT_SENSOR,
 157         HRM_RAW_SENSOR,
 158         BIO_SENSOR = HRM_RAW_SENSOR,
 159         TILT_SENSOR,
 160         RV_RAW_SENSOR,
 161         GSR_SENSOR,
 162         SIMSENSE_SENSOR,
 163         PPG_SENSOR,
 164
 165         CUSTOM_SENSOR = 0X9000,
 166 } sensor_type_t;
 167
 168 typedef struct sensor_info2_t {
 169         uint32_t id;
 170         sensor_type_t type;
 171         const char *uri;
 172         const char *vendor;
 173         float min_range;
 174         float max_range;
 175         float resolution;
 176         int min_interval;
 177         int max_batch_count;
 178         bool wakeup_supported;
 179         const char *privilege;
 180         void *reserved[8];
 181 } sensor_info2_t;
 182
 183 typedef enum sensor_privilege_t {
 184         SENSOR_PRIVILEGE_PUBLIC = 0,
 185 } sensor_privilege_t;
 186
 187 typedef struct sensor_event_t {
 188         unsigned int event_type;
 189         sensor_id_t sensor_id;
 190         unsigned int data_length;
 191         sensor_data_t *data;
 192 } sensor_event_t;
 193
 194 /*
 195  *      To prevent naming confliction as using same enums as sensor CAPI use
 196  */
 197 #ifndef __SENSOR_H__
 198 enum sensor_option_t {
 199         SENSOR_OPTION_DEFAULT = 0,
 200         SENSOR_OPTION_ON_IN_SCREEN_OFF = 1,
 201         SENSOR_OPTION_ON_IN_POWERSAVE_MODE = 2,
 202         SENSOR_OPTION_ALWAYS_ON = SENSOR_OPTION_ON_IN_SCREEN_OFF | SENSOR_OPTION_ON_IN_POWERSAVE_MODE,
 203         SENSOR_OPTION_END
 204 };
 205
 206 typedef enum sensor_option_t sensor_option_e;
 207 #endif
 208
 209 enum sensord_attribute_e {
 210         SENSORD_ATTRIBUTE_AXIS_ORIENTATION = 1,
 211         SENSORD_ATTRIBUTE_PAUSE_POLICY,
 212         SENSORD_ATTRIBUTE_INTERVAL = 0x10,
 213         SENSORD_ATTRIBUTE_MAX_BATCH_LATENCY,
 214         SENSORD_ATTRIBUTE_PASSIVE_MODE,
 215         SENSORD_ATTRIBUTE_FLUSH,
 216 };
 217
 218 enum sensord_axis_e {
 219         SENSORD_AXIS_DEVICE_ORIENTED = 1,
 220         SENSORD_AXIS_DISPLAY_ORIENTED,
 221 };
 222
 223 enum sensord_pause_e {
 224         SENSORD_PAUSE_NONE = 0,
 225         SENSORD_PAUSE_ON_DISPLAY_OFF = 1,
 226         SENSORD_PAUSE_ON_POWERSAVE_MODE = 2,
 227         SENSORD_PAUSE_ALL = 3,
 228         SENSORD_PAUSE_END,
 229 };
 230
 231 enum poll_interval_t {
 232         POLL_100HZ_MS   = 10,
 233         POLL_50HZ_MS    = 20,
 234         POLL_25HZ_MS    = 40,
 235         POLL_20HZ_MS    = 50,
 236         POLL_10HZ_MS    = 100,
 237         POLL_5HZ_MS             = 200,
 238         POLL_1HZ_MS             = 1000,
 239         POLL_MAX_HZ_MS  = 255000,
 240 };
 241
 242 #define DEFAULT_INTERVAL POLL_10HZ_MS
 243
 244 enum sensor_interval_t {
 245         SENSOR_INTERVAL_FASTEST = POLL_100HZ_MS,
 246         SENSOR_INTERVAL_NORMAL = POLL_5HZ_MS,
 247 };
 248
 249 enum proxi_change_state {
 250         PROXIMITY_STATE_NEAR = 0,
 251         PROXIMITY_STATE_FAR = 1,
 252 };
 253
 254 enum auto_rotation_state {
 255         AUTO_ROTATION_DEGREE_UNKNOWN = 0,
 256         AUTO_ROTATION_DEGREE_0,
 257         AUTO_ROTATION_DEGREE_90,
 258         AUTO_ROTATION_DEGREE_180,
 259         AUTO_ROTATION_DEGREE_270,
 260 };
 261
 262 #ifdef __cplusplus
 263 }
 264 #endif
 265
 266 #include <sensor_deprecated.h>
 267
 268 #endif /* __SENSOR_TYPES_H__ */