src/Tizen.Sensor/Tizen.Sensor/Plugins/MagnetometerRotationVectorSensor.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 MagnetometerRotationVectorSensor class is used for registering callbacks for the magnetometer rotation vector sensor and getting the magnetometer rotation vector data.
  23     /// </summary>
  24     /// <since_tizen> 3 </since_tizen>
  25     public sealed class MagnetometerRotationVectorSensor : Sensor
  26     {
  27         private static string MagnetometerRVKey = "http://tizen.org/feature/sensor.geomagnetic_rotation_vector";
  28
  29         private event EventHandler<SensorAccuracyChangedEventArgs> _accuracyChanged;
  30         /// <summary>
  31         /// Gets the X component of the magnetometer rotation vector.
  32         /// </summary>
  33         /// <since_tizen> 3 </since_tizen>
  34         /// <value> X </value>
  35         public float X { get; private set; } = float.MinValue;
  36
  37         /// <summary>
  38         /// Gets the Y component of the magnetometer rotation vector.
  39         /// </summary>
  40         /// <since_tizen> 3 </since_tizen>
  41         /// <value> Y </value>
  42         public float Y { get; private set; } = float.MinValue;
  43
  44         /// <summary>
  45         /// Gets the Z component of the magnetometer rotation vector.
  46         /// </summary>
  47         /// <since_tizen> 3 </since_tizen>
  48         /// <value> Z </value>
  49         public float Z { get; private set; } = float.MinValue;
  50
  51         /// <summary>
  52         /// Gets the W component of the magnetometer rotation vector.
  53         /// </summary>
  54         /// <since_tizen> 3 </since_tizen>
  55         /// <value> W </value>
  56         public float W { get; private set; } = float.MinValue;
  57
  58         /// <summary>
  59         /// Gets the accuracy of the magnetometer rotation vector data.
  60         /// </summary>
  61         /// <since_tizen> 3 </since_tizen>
  62         /// <value> Accuracy </value>
  63         public SensorDataAccuracy Accuracy { get; private set; }
  64
  65         /// <summary>
  66         /// Returns true or false based on whether the magnetometer rotation vector sensor is supported by the device.
  67         /// </summary>
  68         /// <since_tizen> 3 </since_tizen>
  69         /// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
  70         public static bool IsSupported
  71         {
  72             get
  73             {
  74                 Log.Info(Globals.LogTag, "Checking if the MagnetometerRotationVectorSensor is supported");
  75                 return CheckIfSupported(SensorType.MagnetometerRotationVectorSensor, MagnetometerRVKey);
  76             }
  77         }
  78
  79         /// <summary>
  80         /// Returns the number of magnetometer rotation vector sensors available on the device.
  81         /// </summary>
  82         /// <since_tizen> 3 </since_tizen>
  83         /// <value> The count of magnetometer rotation vector sensors. </value>
  84         public static int Count
  85         {
  86             get
  87             {
  88                 Log.Info(Globals.LogTag, "Getting the count of magnetometer rotation vector sensors");
  89                 return GetCount();
  90             }
  91         }
  92
  93         /// <summary>
  94         /// Initializes a new instance of the <see cref="Tizen.Sensor.MagnetometerRotationVectorSensor"/> class.
  95         /// </summary>
  96         /// <since_tizen> 3 </since_tizen>
  97         /// <feature>http://tizen.org/feature/sensor.geomagnetic_rotation_vector</feature>
  98         /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
  99         /// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
 100         /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
 101         /// <param name='index'>
 102         /// Index. Default value for this is 0. Index refers to a particular magnetometer rotation vector sensor in case of multiple sensors.
 103         /// </param>
 104         public MagnetometerRotationVectorSensor(uint index = 0) : base(index)
 105         {
 106             Log.Info(Globals.LogTag, "Creating MagnetometerRotationVectorSensor object");
 107         }
 108
 109         internal override SensorType GetSensorType()
 110         {
 111             return SensorType.MagnetometerRotationVectorSensor;
 112         }
 113
 114         /// <summary>
 115         /// An event handler for storing the callback functions for the event corresponding to the change in the magnetometer rotation vector sensor data.
 116         /// </summary>
 117         /// <since_tizen> 3 </since_tizen>
 118
 119         public event EventHandler<MagnetometerRotationVectorSensorDataUpdatedEventArgs> DataUpdated;
 120
 121         /// <summary>
 122         /// An event handler for accuracy changed events.
 123         /// </summary>
 124         /// <since_tizen> 3 </since_tizen>
 125         public event EventHandler<SensorAccuracyChangedEventArgs> AccuracyChanged
 126         {
 127             add
 128             {
 129                 if (_accuracyChanged == null)
 130                 {
 131                     AccuracyListenStart();
 132                 }
 133                 _accuracyChanged += value;
 134             }
 135             remove
 136             {
 137                 _accuracyChanged -= value;
 138                 if (_accuracyChanged == null)
 139                 {
 140                     AccuracyListenStop();
 141                 }
 142             }
 143         }
 144
 145         private static bool CheckIfSupported()
 146         {
 147             bool isSupported;
 148             int error = Interop.SensorManager.SensorIsSupported(SensorType.MagnetometerRotationVectorSensor, out isSupported);
 149             if (error != (int)SensorError.None)
 150             {
 151                 Log.Error(Globals.LogTag, "Error checking if magnetometer rotation vector sensor is supported");
 152                 isSupported = false;
 153             }
 154             return isSupported;
 155         }
 156
 157         private static int GetCount()
 158         {
 159             IntPtr list;
 160             int count;
 161             int error = Interop.SensorManager.GetSensorList(SensorType.MagnetometerRotationVectorSensor, out list, out count);
 162             if (error != (int)SensorError.None)
 163             {
 164                 Log.Error(Globals.LogTag, "Error getting sensor list for magnetometer rotation vector");
 165                 count = 0;
 166             }
 167             else
 168                 Interop.Libc.Free(list);
 169             return count;
 170         }
 171
 172         /// <summary>
 173         /// Read magnetometer rotation vector sensor data synchronously.
 174         /// </summary>
 175         internal override void ReadData()
 176         {
 177             Interop.SensorEventStruct sensorData;
 178             int error = Interop.SensorListener.ReadData(ListenerHandle, out sensorData);
 179             if (error != (int)SensorError.None)
 180             {
 181                 Log.Error(Globals.LogTag, "Error reading magnetometer rotation vector sensor data");
 182                 throw SensorErrorFactory.CheckAndThrowException(error, "Reading magnetometer rotation vector sensor data failed");
 183             }
 184
 185             TimeSpan = new TimeSpan((Int64)sensorData.timestamp);
 186             X = sensorData.values[0];
 187             Y = sensorData.values[1];
 188             Z = sensorData.values[2];
 189             W = sensorData.values[3];
 190             Accuracy = sensorData.accuracy;
 191         }
 192
 193         private static Interop.SensorListener.SensorEventsCallback _callback;
 194
 195         internal override void EventListenStart()
 196         {
 197             _callback = (IntPtr sensorHandle, IntPtr eventPtr, uint events_count, IntPtr data) => {
 198                 updateBatchEvents(eventPtr, events_count);
 199                 Interop.SensorEventStruct sensorData = latestEvent();
 200
 201                 TimeSpan = new TimeSpan((Int64)sensorData.timestamp);
 202                 X = sensorData.values[0];
 203                 Y = sensorData.values[1];
 204                 Z = sensorData.values[2];
 205                 W = sensorData.values[3];
 206                 Accuracy = sensorData.accuracy;
 207
 208                 DataUpdated?.Invoke(this, new MagnetometerRotationVectorSensorDataUpdatedEventArgs(sensorData.values, sensorData.accuracy));
 209             };
 210
 211             int error = Interop.SensorListener.SetEventsCallback(ListenerHandle, _callback, IntPtr.Zero);
 212             if (error != (int)SensorError.None)
 213             {
 214                 Log.Error(Globals.LogTag, "Error setting event callback for magnetometer rotation vector sensor");
 215                 throw SensorErrorFactory.CheckAndThrowException(error, "Unable to set event callback for magnetometer rotation vector");
 216             }
 217         }
 218
 219         internal override void EventListenStop()
 220         {
 221             int error = Interop.SensorListener.UnsetEventsCallback(ListenerHandle);
 222             if (error != (int)SensorError.None)
 223             {
 224                 Log.Error(Globals.LogTag, "Error unsetting event callback for magnetometer rotation vector sensor");
 225                 throw SensorErrorFactory.CheckAndThrowException(error, "Unable to unset event callback for magnetometer rotation vector");
 226             }
 227         }
 228
 229         private static Interop.SensorListener.SensorAccuracyCallback _accuracyCallback;
 230
 231         private void AccuracyListenStart()
 232         {
 233             _accuracyCallback = (IntPtr sensorHandle, UInt64 timestamp, SensorDataAccuracy accuracy, IntPtr data) => {
 234                 TimeSpan = new TimeSpan((Int64)timestamp);
 235                 Accuracy = accuracy;
 236                 _accuracyChanged?.Invoke(this, new SensorAccuracyChangedEventArgs(new TimeSpan((Int64)timestamp), accuracy));
 237             };
 238
 239             int error = Interop.SensorListener.SetAccuracyCallback(ListenerHandle, _accuracyCallback, IntPtr.Zero);
 240             if (error != (int)SensorError.None)
 241             {
 242                 Log.Error(Globals.LogTag, "Error setting accuracy event callback for magnetometer rotation vector sensor");
 243                 throw SensorErrorFactory.CheckAndThrowException(error, "Unable to set accuracy event callback for magnetometer rotation vector");
 244             }
 245         }
 246
 247         private void AccuracyListenStop()
 248         {
 249             int error = Interop.SensorListener.UnsetAccuracyCallback(ListenerHandle);
 250             if (error != (int)SensorError.None)
 251             {
 252                 Log.Error(Globals.LogTag, "Error unsetting accuracy event callback for magnetometer rotation vector sensor");
 253                 throw SensorErrorFactory.CheckAndThrowException(error, "Unable to unset accuracy event callback for magnetometer rotation vector");
 254             }
 255         }
 256     }
 257 }