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