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     /// The HeartRateMonitor class is used for registering callbacks for the heart rate monitor and getting the heart rate data.
  23     /// </summary>
  24     /// <since_tizen> 3 </since_tizen>
  25     public sealed class HeartRateMonitor : Sensor
  26     {
  27         private const string HRMKey = "http://tizen.org/feature/sensor.heart_rate_monitor";
  28
  29         /// <summary>
  30         /// Gets the value of the heart rate monitor.
  31         /// </summary>
  32         /// <since_tizen> 3 </since_tizen>
  33         /// <value> The heart rate. </value>
  34         public int HeartRate { get; private set; } = int.MinValue;
  35
  36         /// <summary>
  37         /// Returns true or false based on whether the heart rate monitor 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 HeartRateMonitor is supported");
  46                 return CheckIfSupported(SensorType.HeartRateMonitor, HRMKey);
  47             }
  48         }
  49
  50         /// <summary>
  51         /// Returns the number of heart rate monitors available on the device.
  52         /// </summary>
  53         /// <since_tizen> 3 </since_tizen>
  54         /// <value> The count of heart rate monitors. </value>
  55         public static int Count
  56         {
  57             get
  58             {
  59                 Log.Info(Globals.LogTag, "Getting the count of heart rate monitors");
  60                 return GetCount();
  61             }
  62         }
  63
  64         /// <summary>
  65         /// Initializes a new instance of the <see cref="Tizen.Sensor.HeartRateMonitor"/> class.
  66         /// </summary>
  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.heart_rate_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 heart rate monitor in case of multiple sensors.
  77         /// </param>
  78         public HeartRateMonitor(uint index = 0) : base(index)
  79         {
  80             Log.Info(Globals.LogTag, "Creating HeartRateMonitor object");
  81         }
  82
  83         internal override SensorType GetSensorType()
  84         {
  85             return SensorType.HeartRateMonitor;
  86         }
  87
  88         /// <summary>
  89         /// An event handler for storing the callback functions for the event corresponding to the change in the heart rate monitor data.
  90         /// </summary>
  91         /// <since_tizen> 3 </since_tizen>
  92         public event EventHandler<HeartRateMonitorDataUpdatedEventArgs> DataUpdated;
  93
  94         private static int GetCount()
  95         {
  96             IntPtr list;
  97             int count;
  98             int error = Interop.SensorManager.GetSensorList(SensorType.HeartRateMonitor, out list, out count);
  99             if (error != (int)SensorError.None)
 100             {
 101                 Log.Error(Globals.LogTag, "Error getting sensor list for heart rate");
 102                 count = 0;
 103             }
 104             else
 105                 Interop.Libc.Free(list);
 106             return count;
 107         }
 108
 109         private static Interop.SensorListener.SensorEventCallback _callback;
 110
 111         internal override void EventListenStart()
 112         {
 113             _callback = (IntPtr sensorHandle, IntPtr eventPtr, IntPtr data) => {
 114                 Interop.SensorEventStruct sensorData = Interop.IntPtrToEventStruct(eventPtr);
 115
 116                 TimeSpan = new TimeSpan((Int64)sensorData.timestamp);
 117                 HeartRate = (int)sensorData.values[0];
 118
 119                 DataUpdated?.Invoke(this, new HeartRateMonitorDataUpdatedEventArgs((int)sensorData.values[0]));
 120             };
 121
 122             int error = Interop.SensorListener.SetEventCallback(ListenerHandle, Interval, _callback, IntPtr.Zero);
 123             if (error != (int)SensorError.None)
 124             {
 125                 Log.Error(Globals.LogTag, "Error setting event callback for heart rate monitor");
 126                 throw SensorErrorFactory.CheckAndThrowException(error, "Unable to set event callback for heart rate");
 127             }
 128         }
 129
 130         internal override void EventListenStop()
 131         {
 132             int error = Interop.SensorListener.UnsetEventCallback(ListenerHandle);
 133             if (error != (int)SensorError.None)
 134             {
 135                 Log.Error(Globals.LogTag, "Error unsetting event callback for heart rate monitor");
 136                 throw SensorErrorFactory.CheckAndThrowException(error, "Unable to unset event callback for heart rate");
 137             }
 138         }
 139     }
 140 }