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 SleepMonitor class is used for registering callbacks for the sleep monitor and getting the sleep data.
24 /// <since_tizen> 3 </since_tizen>
25 public sealed class SleepMonitor : Sensor
27 private static string SleepMonitorKey = "http://tizen.org/feature/sensor.sleep_monitor";
30 /// Gets the value of the sleep state.
32 /// <since_tizen> 3 </since_tizen>
33 /// <value> The sleep state. </value>
34 public SleepMonitorState SleepState { get; private set; } = SleepMonitorState.Unknown;
37 /// Returns true or false based on whether the sleep monitor 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 SleepMonitor is supported");
46 return CheckIfSupported(SensorType.SleepMonitor, SleepMonitorKey);
51 /// Returns the number of sleep monitors available on the device.
53 /// <since_tizen> 3 </since_tizen>
54 /// <value> The count of sleep monitors. </value>
55 public static int Count
59 Log.Info(Globals.LogTag, "Getting the count of sleep monitors");
65 /// Initializes a new instance of the <see cref="Tizen.Sensor.SleepMonitor"/> class.
67 /// <since_tizen> 3 </since_tizen>
68 /// <privilege>http://tizen.org/privilege/healthinfo</privilege>
69 /// <privlevel>public</privlevel>
70 /// <feature>http://tizen.org/feature/sensor.sleep_monitor</feature>
71 /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
72 /// <exception cref="NotSupportedException">Thrown when the sensor is not supported.</exception>
73 /// <exception cref="UnauthorizedAccessException">Thrown when the application has no privilege to use the sensor.</exception>
74 /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
75 /// <param name='index'>
76 /// Index. Default value for this is 0. Index refers to a particular sleep monitor in case of multiple sensors.
78 public SleepMonitor(uint index = 0) : base(index)
80 Log.Info(Globals.LogTag, "Creating SleepMonitor object");
83 internal override SensorType GetSensorType()
85 return SensorType.SleepMonitor;
89 /// An event handler for storing the callback functions for the event corresponding to the change in the sleep monitor data.
91 /// <since_tizen> 3 </since_tizen>
93 public event EventHandler<SleepMonitorDataUpdatedEventArgs> DataUpdated;
96 private static int GetCount()
100 int error = Interop.SensorManager.GetSensorList(SensorType.SleepMonitor, out list, out count);
101 if (error != (int)SensorError.None)
103 Log.Error(Globals.LogTag, "Error getting sensor list for sleep");
107 Interop.Libc.Free(list);
111 private static Interop.SensorListener.SensorEventCallback _callback;
113 internal override void EventListenStart()
115 _callback = (IntPtr sensorHandle, IntPtr eventPtr, IntPtr data) => {
116 Interop.SensorEventStruct sensorData = Interop.IntPtrToEventStruct(eventPtr);
118 TimeSpan = new TimeSpan((Int64)sensorData.timestamp);
119 SleepState = (SleepMonitorState)sensorData.values[0];
121 DataUpdated?.Invoke(this, new SleepMonitorDataUpdatedEventArgs((int)sensorData.values[0]));
124 int error = Interop.SensorListener.SetEventCallback(ListenerHandle, Interval, _callback, IntPtr.Zero);
125 if (error != (int)SensorError.None)
127 Log.Error(Globals.LogTag, "Error setting event callback for sleep monitor");
128 throw SensorErrorFactory.CheckAndThrowException(error, "Unable to set event callback for sleep");
132 internal override void EventListenStop()
134 int error = Interop.SensorListener.UnsetEventCallback(ListenerHandle);
135 if (error != (int)SensorError.None)
137 Log.Error(Globals.LogTag, "Error unsetting event callback for sleep monitor");
138 throw SensorErrorFactory.CheckAndThrowException(error, "Unable to unset event callback for sleep");