Release 4.0.0-preview1-00051
[platform/core/csapi/tizenfx.git] / src / Tizen.Sensor / Tizen.Sensor / Plugins / HeartRateMonitor.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     /// HeartRateMonitor Class. Used for registering callbacks for heart rate monitor and getting heart rate data
23     /// </summary>
24     public sealed class HeartRateMonitor : Sensor
25     {
26         private const string HRMKey = "http://tizen.org/feature/sensor.heart_rate_monitor";
27
28         /// <summary>
29         /// Gets the value of the heart rate monitor.
30         /// </summary>
31         /// <since_tizen> 3 </since_tizen>
32         /// <value> Heart rate </value>
33         public int HeartRate { get; private set; } = int.MinValue;
34
35         /// <summary>
36         /// Returns true or false based on whether heart rate monitor is supported by device.
37         /// </summary>
38         /// <since_tizen> 3 </since_tizen>
39         /// <value><c>true</c> if supported; otherwise, <c>false</c>.</value>
40         public static bool IsSupported
41         {
42             get
43             {
44                 Log.Info(Globals.LogTag, "Checking if the HeartRateMonitor is supported");
45                 return CheckIfSupported(SensorType.HeartRateMonitor, HRMKey);
46             }
47         }
48
49         /// <summary>
50         /// Returns the number of heart rate monitors available on the device.
51         /// </summary>
52         /// <since_tizen> 3 </since_tizen>
53         /// <value> The count of heart rate monitors </value>
54         public static int Count
55         {
56             get
57             {
58                 Log.Info(Globals.LogTag, "Getting the count of heart rate monitors");
59                 return GetCount();
60             }
61         }
62
63         /// <summary>
64         /// Initializes a new instance of the <see cref="Tizen.Sensor.HeartRateMonitor"/> class.
65         /// </summary>
66         /// <since_tizen> 3 </since_tizen>
67         /// <privilege>http://tizen.org/privilege/healthinfo</privilege>
68         /// <privlevel>public</privlevel>
69         /// <feature>http://tizen.org/feature/sensor.heart_rate_monitor</feature>
70         /// <exception cref="ArgumentException">Thrown when an invalid argument is used</exception>
71         /// <exception cref="NotSupportedException">Thrown when the sensor is not supported</exception>
72         /// <exception cref="UnauthroizedAccessException">Thrown when the app has no privilege to use the sensor</exception>
73         /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state</exception>
74         /// <param name='index'>
75         /// Index. Default value for this is 0. Index refers to a particular heart rate monitor in case of multiple sensors
76         /// </param>
77         public HeartRateMonitor(uint index = 0) : base(index)
78         {
79             Log.Info(Globals.LogTag, "Creating HeartRateMonitor object");
80         }
81
82         internal override SensorType GetSensorType()
83         {
84             return SensorType.HeartRateMonitor;
85         }
86
87         /// <summary>
88         /// Event Handler for storing the callback functions for event corresponding to change in heart rate monitor data.
89         /// </summary>
90         /// <since_tizen> 3 </since_tizen>
91         public event EventHandler<HeartRateMonitorDataUpdatedEventArgs> DataUpdated;
92
93         private static int GetCount()
94         {
95             IntPtr list;
96             int count;
97             int error = Interop.SensorManager.GetSensorList(SensorType.HeartRateMonitor, out list, out count);
98             if (error != (int)SensorError.None)
99             {
100                 Log.Error(Globals.LogTag, "Error getting sensor list for heart rate");
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                 HeartRate = (int)sensorData.values[0];
117
118                 DataUpdated?.Invoke(this, new HeartRateMonitorDataUpdatedEventArgs((int)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 heart rate monitor");
125                 throw SensorErrorFactory.CheckAndThrowException(error, "Unable to set event callback for heart rate");
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 heart rate monitor");
135                 throw SensorErrorFactory.CheckAndThrowException(error, "Unable to unset event callback for heart rate");
136             }
137         }
138     }
139 }