src/Tizen.Sensor/Tizen.Sensor/SensorEnumerations.cs

   1 /*
   2  * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the License);
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an AS IS BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 using System;
  18
  19 namespace Tizen.Sensor
  20 {
  21     /// <summary>
  22     /// The SensorType Enum defintion for all sensor types.
  23     /// </summary>
  24     internal enum SensorType
  25     {
  26         /// <summary>
  27         /// All sensors. This can be used to retrieve the Sensor class object for all available sensors.
  28         /// </summary>
  29         All = -1,
  30         /// <summary>
  31         /// Accelerometer sensor.
  32         /// </summary>
  33         Accelerometer = 0,
  34         /// <summary>
  35         /// Gravity sensor.
  36         /// </summary>
  37         GravitySensor = 1,
  38         /// <summary>
  39         /// Linear Acceleration sensor.
  40         /// </summary>
  41         LinearAccelerationSensor = 2,
  42         /// <summary>
  43         /// Magnetometer sensor.
  44         /// </summary>
  45         Magnetometer = 3,
  46         /// <summary>
  47         /// Rotation Vector sensor.
  48         /// </summary>
  49         RotationVectorSensor = 4,
  50         /// <summary>
  51         /// Orientation sensor.
  52         /// </summary>
  53         OrientationSensor = 5,
  54         /// <summary>
  55         /// The Gyroscope sensor.
  56         /// </summary>
  57         Gyroscope = 6,
  58         /// <summary>
  59         /// Light sensor.
  60         /// </summary>
  61         LightSensor = 7,
  62         /// <summary>
  63         /// Proximity sensor.
  64         /// </summary>
  65         ProximitySensor = 8,
  66         /// <summary>
  67         /// Pressure sensor.
  68         /// </summary>
  69         PressureSensor = 9,
  70         /// <summary>
  71         /// Ultraviolet sensor.
  72         /// </summary>
  73         UltravioletSensor = 10,
  74         /// <summary>
  75         /// Temperature sensor.
  76         /// </summary>
  77         TemperatureSensor = 11,
  78         /// <summary>
  79         /// Humidity sensor.
  80         /// </summary>
  81         HumiditySensor = 12,
  82         /// <summary>
  83         /// Hear rate monitor sensor.
  84         /// </summary>
  85         HeartRateMonitor = 13,
  86         /// <summary>
  87         /// The Uncalibrated Gyroscope sensor.
  88         /// </summary>
  89         UncalibratedGyroscope = 17,
  90         /// <summary>
  91         /// Uncalibrated Geomagnetic sensor.
  92         /// </summary>
  93         UncalibratedMagnetometer = 18,
  94         /// <summary>
  95         /// The Gyroscope-based rotation vector sensor.
  96         /// </summary>
  97         GyroscopeRotationVectorSensor = 19,
  98         /// <summary>
  99         /// Geomagnetic-based rotation vector sensor.
 100         /// </summary>
 101         MagnetometerRotationVectorSensor = 20,
 102         /// <summary>
 103         /// Pedometer sensor.
 104         /// </summary>
 105         Pedometer = 0x300,
 106         /// <summary>
 107         /// Sleep monitor sensor.
 108         /// </summary>
 109         SleepMonitor = 0x301,
 110         /// <summary>
 111         /// Stationary activity detector.
 112         /// </summary>
 113         /// Auto Rotation sensor.
 114         /// </summary>
 115         AutoRotation = 0x901,
 116         /// <summary>
 117         StationaryActivityDetector = 0x1A00,
 118         /// <summary>
 119         /// Walking activity detector.
 120         /// </summary>
 121         WalkingActivityDetector = 0x1A00,
 122         /// <summary>
 123         /// Running activity detector.
 124         /// </summary>
 125         RunningActivityDetector = 0x1A00,
 126         /// <summary>
 127         /// InVehicle activity detector.
 128         /// </summary>
 129         InVehicleActivityDetector = 0x1A00,
 130         /// <summary>
 131         /// Wrist up gesture detector.
 132         /// </summary>
 133         WristUpGestureDetector = 0x1201,
 134         /// <summary>
 135         /// Pick up gesture detector.
 136         /// </summary>
 137         PickUpGestureDetector = 0x1204,
 138         /// <summary>
 139         /// Face down gesture detector.
 140         /// </summary>
 141         FaceDownGestureDetector = 0x1205
 142     }
 143
 144     /// <summary>
 145     /// The sensor attribute.
 146     /// </summary>
 147     internal enum SensorAttribute
 148     {
 149         /// <summary>
 150         /// The axis orientation.
 151         /// </summary>
 152         AxisOrientation = 1,
 153
 154         /// <summary>
 155         /// The pause policy.
 156         /// </summary>
 157         PausePolicy
 158     }
 159
 160     /// <summary>
 161     /// The SensorDataAccuracy Enum definition for all possible sensor data accuracy values.
 162     /// </summary>
 163     /// <since_tizen> 3 </since_tizen>
 164     public enum SensorDataAccuracy
 165     {
 166         /// <summary>
 167         /// Undefined sensor data accuracy.
 168         /// </summary>
 169         /// <since_tizen> 3 </since_tizen>
 170         Undefined = -1,
 171         /// <summary>
 172         /// Sensor data not accurate.
 173         /// </summary>
 174         /// <since_tizen> 3 </since_tizen>
 175         Bad = 0,
 176         /// <summary>
 177         /// Moderately accurate sensor data.
 178         /// </summary>
 179         /// <since_tizen> 3 </since_tizen>
 180         Normal = 1,
 181         /// <summary>
 182         /// Highly accurate sensor data.
 183         /// </summary>
 184         /// <since_tizen> 3 </since_tizen>
 185         Good = 2,
 186         /// <summary>
 187         /// Very highly accurate sensor data.
 188         /// </summary>
 189         /// <since_tizen> 3 </since_tizen>
 190         VeryGood = 3
 191     }
 192
 193     /// <summary>
 194     /// The Sensor Option Enum definition for pause policies of sensor.
 195     /// </summary>
 196     /// <since_tizen> 3 </since_tizen>
 197     public enum SensorPausePolicy
 198     {
 199         /// <summary>
 200         /// Receives data when the LCD is off and in the power save mode.
 201         /// </summary>
 202         /// <since_tizen> 3 </since_tizen>
 203         None,
 204         /// <summary>
 205         /// Does not receive data when the LCD is off.
 206         /// </summary>
 207         /// <since_tizen> 3 </since_tizen>
 208         DisplayOff,
 209         /// <summary>
 210         /// Does not receive data in the power save mode.
 211         /// </summary>
 212         /// <since_tizen> 3 </since_tizen>
 213         PowerSaveMode,
 214         /// <summary>
 215         /// Does not receive data when the LCD is off and in the power save mode.
 216         /// </summary>
 217         /// <since_tizen> 3 </since_tizen>
 218         All
 219     }
 220
 221     /// <summary>
 222     /// The pedometer state.
 223     /// </summary>
 224     /// <since_tizen> 3 </since_tizen>
 225     public enum PedometerState
 226     {
 227         /// <summary>
 228         /// Unknown.
 229         /// </summary>
 230         /// <since_tizen> 3 </since_tizen>
 231         Unknown = -1,
 232
 233         /// <summary>
 234         /// Stop state.
 235         /// </summary>
 236         /// <since_tizen> 3 </since_tizen>
 237         Stop,
 238
 239         /// <summary>
 240         /// Walking state.
 241         /// </summary>
 242         /// <since_tizen> 3 </since_tizen>
 243         Walk,
 244
 245         /// <summary>
 246         /// Running state.
 247         /// </summary>
 248         /// <since_tizen> 3 </since_tizen>
 249         Run
 250     }
 251
 252     /// <summary>
 253     /// The sleep monitor state.
 254     /// </summary>
 255     /// <since_tizen> 3 </since_tizen>
 256     public enum SleepMonitorState
 257     {
 258         /// <summary>
 259         /// Unknown.
 260         /// </summary>
 261         /// <since_tizen> 3 </since_tizen>
 262         Unknown = -1,
 263
 264         /// <summary>
 265         /// The wake state.
 266         /// </summary>
 267         /// <since_tizen> 3 </since_tizen>
 268         Wake,
 269
 270         /// <summary>
 271         /// The sleeping state.
 272         /// </summary>
 273         /// <since_tizen> 3 </since_tizen>
 274         Sleep
 275     }
 276
 277     /// <summary>
 278     /// The proximity sensor state.
 279     /// </summary>
 280     /// <since_tizen> 3 </since_tizen>
 281     public enum ProximitySensorState
 282     {
 283         /// <summary>
 284         /// Unknown.
 285         /// </summary>
 286         /// <since_tizen> 3 </since_tizen>
 287         Unknown = -1,
 288
 289         /// <summary>
 290         /// Near sate.
 291         /// </summary>
 292         /// <since_tizen> 3 </since_tizen>
 293         Near = 0,
 294
 295         /// <summary>
 296         /// Far state.
 297         /// </summary>
 298         /// <since_tizen> 3 </since_tizen>
 299         Far = 5
 300     }
 301
 302     /// <summary>
 303     /// The detector sensor state.
 304     /// </summary>
 305     /// <since_tizen> 3 </since_tizen>
 306     public enum DetectorState
 307     {
 308         /// <summary>
 309         /// Unknown.
 310         /// </summary>
 311         /// <since_tizen> 3 </since_tizen>
 312         Unknown = -1,
 313
 314         /// <summary>
 315         /// None sate.
 316         /// </summary>
 317         /// <since_tizen> 3 </since_tizen>
 318         NotDetected = 0,
 319
 320         /// <summary>
 321         /// Detected state.
 322         /// </summary>
 323         /// <since_tizen> 3 </since_tizen>
 324         Detected = 1
 325     }
 326
 327     /// <summary>
 328     /// The auto rotation state.
 329     /// </summary>
 330     /// <since_tizen> 7 </since_tizen>
 331     public enum AutoRotationState
 332     {
 333         /// <summary>
 334         /// Degree_0 sate.
 335         /// </summary>
 336         /// <since_tizen> 7 </since_tizen>
 337         Degree_0 = 1,
 338
 339         /// <summary>
 340         /// Degree_90 state.
 341         /// </summary>
 342         /// <since_tizen> 7 </since_tizen>
 343         Degree_90 = 2,
 344
 345         /// <summary>
 346         /// Degree_180 state.
 347         /// </summary>
 348         /// <since_tizen> 7 </since_tizen>
 349         Degree_180 = 3,
 350
 351         /// <summary>
 352         /// Degree_270 state.
 353         /// </summary>
 354         /// <since_tizen> 7 </since_tizen>
 355         Degree_270 = 4
 356     }
 357 }