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         StationaryActivityDetector = 0x1A00,
 114         /// <summary>
 115         /// Walking activity detector.
 116         /// </summary>
 117         WalkingActivityDetector = 0x1A00,
 118         /// <summary>
 119         /// Running activity detector.
 120         /// </summary>
 121         RunningActivityDetector = 0x1A00,
 122         /// <summary>
 123         /// InVehicle activity detector.
 124         /// </summary>
 125         InVehicleActivityDetector = 0x1A00,
 126         /// <summary>
 127         /// Wrist up gesture detector.
 128         /// </summary>
 129         WristUpGestureDetector = 0x1201,
 130         /// <summary>
 131         /// Pick up gesture detector.
 132         /// </summary>
 133         PickUpGestureDetector = 0x1204,
 134         /// <summary>
 135         /// Face down gesture detector.
 136         /// </summary>
 137         FaceDownGestureDetector = 0x1205
 138     }
 139
 140     /// <summary>
 141     /// The sensor attribute.
 142     /// </summary>
 143     internal enum SensorAttribute
 144     {
 145         /// <summary>
 146         /// The axis orientation.
 147         /// </summary>
 148         AxisOrientation,
 149
 150         /// <summary>
 151         /// The pause policy.
 152         /// </summary>
 153         PausePolicy
 154     }
 155
 156     /// <summary>
 157     /// The SensorDataAccuracy Enum definition for all possible sensor data accuracy values.
 158     /// </summary>
 159     /// <since_tizen> 3 </since_tizen>
 160     public enum SensorDataAccuracy
 161     {
 162         /// <summary>
 163         /// Undefined sensor data accuracy.
 164         /// </summary>
 165         /// <since_tizen> 3 </since_tizen>
 166         Undefined = -1,
 167         /// <summary>
 168         /// Sensor data not accurate.
 169         /// </summary>
 170         /// <since_tizen> 3 </since_tizen>
 171         Bad = 0,
 172         /// <summary>
 173         /// Moderately accurate sensor data.
 174         /// </summary>
 175         /// <since_tizen> 3 </since_tizen>
 176         Normal = 1,
 177         /// <summary>
 178         /// Highly accurate sensor data.
 179         /// </summary>
 180         /// <since_tizen> 3 </since_tizen>
 181         Good = 2,
 182         /// <summary>
 183         /// Very highly accurate sensor data.
 184         /// </summary>
 185         /// <since_tizen> 3 </since_tizen>
 186         VeryGood = 3
 187     }
 188
 189     /// <summary>
 190     /// The Sensor Option Enum definition for sensor option values.
 191     /// </summary>
 192     /// <since_tizen> 3 </since_tizen>
 193     public enum SensorPausePolicy
 194     {
 195         /// <summary>
 196         /// Does not receive data when the LCD is off and in the power save mode.
 197         /// </summary>
 198         /// <since_tizen> 3 </since_tizen>
 199         None,
 200         /// <summary>
 201         /// Receives data when the LCD is off.
 202         /// </summary>
 203         /// <since_tizen> 3 </since_tizen>
 204         DisplayOff,
 205         /// <summary>
 206         /// Receives data in the power save mode.
 207         /// </summary>
 208         /// <since_tizen> 3 </since_tizen>
 209         PowerSaveMode,
 210         /// <summary>
 211         /// Receives data when the LCD is off and in the power save mode.
 212         /// </summary>
 213         /// <since_tizen> 3 </since_tizen>
 214         All
 215     }
 216
 217     /// <summary>
 218     /// The pedometer state.
 219     /// </summary>
 220     /// <since_tizen> 3 </since_tizen>
 221     public enum PedometerState
 222     {
 223         /// <summary>
 224         /// Unknown.
 225         /// </summary>
 226         /// <since_tizen> 3 </since_tizen>
 227         Unknown = -1,
 228
 229         /// <summary>
 230         /// Stop state.
 231         /// </summary>
 232         /// <since_tizen> 3 </since_tizen>
 233         Stop,
 234
 235         /// <summary>
 236         /// Walking state.
 237         /// </summary>
 238         /// <since_tizen> 3 </since_tizen>
 239         Walk,
 240
 241         /// <summary>
 242         /// Running state.
 243         /// </summary>
 244         /// <since_tizen> 3 </since_tizen>
 245         Run
 246     }
 247
 248     /// <summary>
 249     /// The sleep monitor state.
 250     /// </summary>
 251     /// <since_tizen> 3 </since_tizen>
 252     public enum SleepMonitorState
 253     {
 254         /// <summary>
 255         /// Unknown.
 256         /// </summary>
 257         /// <since_tizen> 3 </since_tizen>
 258         Unknown = -1,
 259
 260         /// <summary>
 261         /// The wake state.
 262         /// </summary>
 263         /// <since_tizen> 3 </since_tizen>
 264         Wake,
 265
 266         /// <summary>
 267         /// The sleeping state.
 268         /// </summary>
 269         /// <since_tizen> 3 </since_tizen>
 270         Sleep
 271     }
 272
 273     /// <summary>
 274     /// The proximity sensor state.
 275     /// </summary>
 276     /// <since_tizen> 3 </since_tizen>
 277     public enum ProximitySensorState
 278     {
 279         /// <summary>
 280         /// Unknown.
 281         /// </summary>
 282         /// <since_tizen> 3 </since_tizen>
 283         Unknown = -1,
 284
 285         /// <summary>
 286         /// Near sate.
 287         /// </summary>
 288         /// <since_tizen> 3 </since_tizen>
 289         Near = 0,
 290
 291         /// <summary>
 292         /// Far state.
 293         /// </summary>
 294         /// <since_tizen> 3 </since_tizen>
 295         Far = 5
 296     }
 297
 298     /// <summary>
 299     /// The detector sensor state.
 300     /// </summary>
 301     /// <since_tizen> 3 </since_tizen>
 302     public enum DetectorState
 303     {
 304         /// <summary>
 305         /// Unknown.
 306         /// </summary>
 307         /// <since_tizen> 3 </since_tizen>
 308         Unknown = -1,
 309
 310         /// <summary>
 311         /// None sate.
 312         /// </summary>
 313         /// <since_tizen> 3 </since_tizen>
 314         NotDetected = 0,
 315
 316         /// <summary>
 317         /// Detected state.
 318         /// </summary>
 319         /// <since_tizen> 3 </since_tizen>
 320         Detected = 1
 321     }
 322 }