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