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