2 * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 namespace Tizen.Sensor
22 /// The HumiditySensor class is used for registering callbacks for the humidity sensor and getting the humidity data.
24 /// <since_tizen> 3 </since_tizen>
25 public sealed class HumiditySensor : Sensor
27 private const string HumiditySensorKey = "http://tizen.org/feature/sensor.humidity";
30 /// Gets the value of the humidity sensor.
32 /// <since_tizen> 3 </since_tizen>
33 /// <value> Humidity </value>
34 public float Humidity { get; private set; } = float.MinValue;
37 /// Returns true or false based on whether the humidity sensor is supported by the device.
39 /// <since_tizen> 3 </since_tizen>
40 /// <value><c>true</c> if supported; otherwise <c>false</c>.</value>
41 public static bool IsSupported
45 Log.Info(Globals.LogTag, "Checking if the HumiditySensor is supported");
46 return CheckIfSupported(SensorType.HumiditySensor, HumiditySensorKey);
51 /// Returns the number of humidity sensors available on the device.
53 /// <since_tizen> 3 </since_tizen>
54 /// <value> The count of humidity sensors. </value>
55 public static int Count
59 Log.Info(Globals.LogTag, "Getting the count of humidity sensors");
65 /// Initializes a new instance of the <see cref="Tizen.Sensor.HumiditySensor"/> class.
67 /// <since_tizen> 3 </since_tizen>
68 /// <feature>http://tizen.org/feature/sensor.humidity</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 humidity sensor in case of multiple sensors.
75 public HumiditySensor(uint index = 0) : base(index)
77 Log.Info(Globals.LogTag, "Creating HumiditySensor object");
80 internal override SensorType GetSensorType()
82 return SensorType.HumiditySensor;
86 /// An event handler for storing the callback functions for the event corresponding to the change in the humidity sensor data.
88 /// <since_tizen> 3 </since_tizen>
90 public event EventHandler<HumiditySensorDataUpdatedEventArgs> DataUpdated;
92 private static int GetCount()
96 int error = Interop.SensorManager.GetSensorList(SensorType.HumiditySensor, out list, out count);
97 if (error != (int)SensorError.None)
99 Log.Error(Globals.LogTag, "Error getting sensor list for humidity");
103 Interop.Libc.Free(list);
108 /// Read humidity sensor data synchronously.
110 internal override void ReadData()
112 Interop.SensorEventStruct sensorData;
113 int error = Interop.SensorListener.ReadData(ListenerHandle, out sensorData);
114 if (error != (int)SensorError.None)
116 Log.Error(Globals.LogTag, "Error reading humidity sensor data");
117 throw SensorErrorFactory.CheckAndThrowException(error, "Reading humidity sensor data failed");
120 TimeSpan = new TimeSpan((Int64)sensorData.timestamp);
121 Humidity = sensorData.values[0];
124 private static Interop.SensorListener.SensorEventsCallback _callback;
126 internal override void EventListenStart()
128 _callback = (IntPtr sensorHandle, IntPtr eventPtr, uint events_count, IntPtr data) => {
129 updateBatchEvents(eventPtr, events_count);
130 Interop.SensorEventStruct sensorData = latestEvent();
132 TimeSpan = new TimeSpan((Int64)sensorData.timestamp);
133 Humidity = sensorData.values[0];
135 DataUpdated?.Invoke(this, new HumiditySensorDataUpdatedEventArgs(sensorData.values[0]));
138 int error = Interop.SensorListener.SetEventsCallback(ListenerHandle, _callback, IntPtr.Zero);
139 if (error != (int)SensorError.None)
141 Log.Error(Globals.LogTag, "Error setting event callback for humidity sensor");
142 throw SensorErrorFactory.CheckAndThrowException(error, "Unable to set event callback for humidity");
146 internal override void EventListenStop()
148 int error = Interop.SensorListener.UnsetEventsCallback(ListenerHandle);
149 if (error != (int)SensorError.None)
151 Log.Error(Globals.LogTag, "Error unsetting event callback for humidity sensor");
152 throw SensorErrorFactory.CheckAndThrowException(error, "Unable to unset event callback for humidity");