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