src/Tizen.Sensor/Tizen.Sensor/Plugins/Accelerometer.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     /// Accelerometer Sensor Class. Used for registering callbacks for accelerometer and getting accelerometer data
  23     /// </summary>
  24     public sealed class Accelerometer : Sensor
  25     {
  26         private static string AccelerometerKey = "http://tizen.org/feature/sensor.accelerometer";
  27         /// <summary>
  28         /// Gets the X component of the acceleration.
  29         /// </summary>
  30         /// <since_tizen> 3 </since_tizen>
  31         /// <value> X </value>
  32         public float X { get; private set; } = float.MinValue;
  33
  34         /// <summary>
  35         /// Gets the Y component of the acceleration.
  36         /// </summary>
  37         /// <since_tizen> 3 </since_tizen>
  38         /// <value> Y </value>
  39         public float Y { get; private set; } = float.MinValue;
  40
  41         /// <summary>
  42         /// Gets the Z component of the acceleration.
  43         /// </summary>
  44         /// <since_tizen> 3 </since_tizen>
  45         /// <value> Z </value>
  46         public float Z { get; private set; } = float.MinValue;
  47
  48         /// <summary>
  49         /// Returns true or false based on whether accelerometer sensor is supported by device.
  50         /// </summary>
  51         /// <since_tizen> 3 </since_tizen>
  52         /// <value><c>true</c> if supported; otherwise, <c>false</c>.</value>
  53         public static bool IsSupported
  54         {
  55             get
  56             {
  57                 Log.Info(Globals.LogTag, "Checking if the Accelerometer sensor is supported");
  58                 return CheckIfSupported(SensorType.Accelerometer, AccelerometerKey);
  59             }
  60         }
  61
  62         /// <summary>
  63         /// Returns the number of accelerometer sensors available on the device.
  64         /// </summary>
  65         /// <since_tizen> 3 </since_tizen>
  66         /// <value> The count of accelerometer sensors </value>
  67         /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
  68         public static int Count
  69         {
  70             get
  71             {
  72                 Log.Info(Globals.LogTag, "Getting the count of accelerometer sensors");
  73                 return GetCount();
  74             }
  75         }
  76
  77         /// <summary>
  78         /// Initializes a new instance of the <see cref="Tizen.Sensor.Accelerometer"/> class.
  79         /// </summary>
  80         /// <since_tizen> 3 </since_tizen>
  81         /// <feature>http://tizen.org/feature/sensor.accelerometer</feature>
  82         /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
  83         /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
  84         /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
  85         /// <param name='index'>
  86         /// Index. Default value for this is 0. Index refers to a particular accelerometer sensor in case of multiple sensors
  87         /// </param>
  88         public Accelerometer(uint index = 0) : base(index)
  89         {
  90             Log.Info(Globals.LogTag, "Creating Accelerometer object");
  91         }
  92
  93         internal override SensorType GetSensorType()
  94         {
  95             return SensorType.Accelerometer;
  96         }
  97
  98         /// <summary>
  99         /// Event Handler for storing the callback functions for event corresponding to change in accelerometer sensor data.
 100         /// </summary>
 101         /// <since_tizen> 3 </since_tizen>
 102         public event EventHandler<AccelerometerDataUpdatedEventArgs> DataUpdated;
 103
 104         private static int GetCount()
 105         {
 106             IntPtr list;
 107             int count;
 108             int error = Interop.SensorManager.GetSensorList(SensorType.Accelerometer, out list, out count);
 109             if (error != (int)SensorError.None)
 110             {
 111                 Log.Error(Globals.LogTag, "Error getting sensor list for accelerometer");
 112                 count = 0;
 113             }
 114             else
 115                 Interop.Libc.Free(list);
 116             return count;
 117         }
 118
 119         private static Interop.SensorListener.SensorEventCallback _callback;
 120
 121         internal override void EventListenStart()
 122         {
 123             _callback = (IntPtr sensorHandle, IntPtr eventPtr, IntPtr data) => {
 124                 Interop.SensorEventStruct sensorData = Interop.IntPtrToEventStruct(eventPtr);
 125
 126                 TimeSpan = new TimeSpan((Int64)sensorData.timestamp);
 127                 X = sensorData.values[0];
 128                 Y = sensorData.values[1];
 129                 Z = sensorData.values[2];
 130
 131                 DataUpdated?.Invoke(this, new AccelerometerDataUpdatedEventArgs(sensorData.values));
 132             };
 133
 134             int error = Interop.SensorListener.SetEventCallback(ListenerHandle, Interval, _callback, IntPtr.Zero);
 135             if (error != (int)SensorError.None)
 136             {
 137                 Log.Error(Globals.LogTag, "Error setting event callback for accelerometer sensor");
 138                 throw SensorErrorFactory.CheckAndThrowException(error, "Unable to set event callback for accelerometer");
 139             }
 140         }
 141
 142         internal override void EventListenStop()
 143         {
 144             int error = Interop.SensorListener.UnsetEventCallback(ListenerHandle);
 145             if (error != (int)SensorError.None)
 146             {
 147                 Log.Error(Globals.LogTag, "Error unsetting event callback for accelerometer sensor");
 148                 throw SensorErrorFactory.CheckAndThrowException(error, "Unable to unset event callback for accelerometer");
 149             }
 150         }
 151     }
 152 }