1 /* 2 * Copyright (C) 2018 BlueKitchen GmbH 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 3. Neither the name of the copyright holders nor the names of 14 * contributors may be used to endorse or promote products derived 15 * from this software without specific prior written permission. 16 * 4. Any redistribution, use, or modification is done solely for 17 * personal benefit and not for any commercial purpose or for 18 * monetary gain. 19 * 20 * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS 21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 23 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS 24 * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 26 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 27 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 28 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 29 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 30 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 * 33 * Please inquire about commercial licensing options at 34 * [email protected] 35 * 36 */ 37 #ifndef HEART_RATE_SERVICE_SERVER_H 38 #define HEART_RATE_SERVICE_SERVER_H 39 40 #include <stdint.h> 41 42 #if defined __cplusplus 43 extern "C" { 44 #endif 45 46 /** 47 * @text The heart rate service server provides heart rate measurements via notifications. 48 * 49 * Each notification reports the heart rate measurement in beats per minute, and if enabled, 50 * the total energy expended in kilo Joules, as well as RR-intervals in 1/1024 seconds resolution. 51 * 52 * The Energy Expended field represents the accumulated energy expended 53 * in kilo Joules since the last time it was reset. If the maximum value of 65535 54 * kilo Joules is reached, it will remain at this value, until a reset command 55 * from the client is received. 56 * 57 * The RR-Interval represents the time between two consecutive R waves in 58 * an Electrocardiogram (ECG) waveform. If needed, the RR-Intervals are sent in 59 * multiple notifications. 60 * 61 * To use with your application, add `#import <heart_rate_service.gatt>` to your .gatt file. 62 * After adding it to your .gatt file, you call *heart_rate_server_init(body_sensor_location, energy_expended_supported)* 63 * with the intended sensor location, and a flag indicating if energy expanded is supported. 64 * 65 * If heart rate measurement changes, you can call 66 * *heart_rate_service_server_update_heart_rate_values(heart_rate_bpm, service_sensor_contact_status, rr_interval_count, rr_intervals)*. 67 * This function will trigger sending Notifications if the client enables them. 68 * 69 * If energy expanded is supported, you can call *heart_rate_service_add_energy_expended(energy_expended_kJ)* 70 * with the newly expanded energy. The accumulated energy expended value 71 * will be emitted with the next heart rate measurement. 72 */ 73 74 /* API_START */ 75 76 typedef enum { 77 HEART_RATE_SERVICE_BODY_SENSOR_LOCATION_OTHER = 0, 78 HEART_RATE_SERVICE_BODY_SENSOR_LOCATION_CHEST, 79 HEART_RATE_SERVICE_BODY_SENSOR_LOCATION_WRIST, 80 HEART_RATE_SERVICE_BODY_SENSOR_LOCATION_FINGER, 81 HEART_RATE_SERVICE_BODY_SENSOR_LOCATION_HAND, 82 HEART_RATE_SERVICE_BODY_SENSOR_LOCATION_EAR_LOBE, 83 HEART_RATE_SERVICE_BODY_SENSOR_LOCATION_FOOT 84 } heart_rate_service_body_sensor_location_t; 85 86 typedef enum { 87 HEART_RATE_SERVICE_SENSOR_CONTACT_UNKNOWN = 0, 88 HEART_RATE_SERVICE_SENSOR_CONTACT_UNSUPPORTED, 89 HEART_RATE_SERVICE_SENSOR_CONTACT_NO_CONTACT, 90 HEART_RATE_SERVICE_SENSOR_CONTACT_HAVE_CONTACT 91 } heart_rate_service_sensor_contact_status_t; 92 93 94 /** 95 * @brief Init Battery Service Server with ATT DB 96 * @param body_sensor_location 97 * @param energy_expended_supported 98 */ 99 void heart_rate_service_server_init(heart_rate_service_body_sensor_location_t body_sensor_location, int energy_expended_supported); 100 101 102 /** 103 * @brief Add Energy Expended to the internal accumulator. 104 * @param energy_expended_kJ energy expended in kilo Joules since the last update 105 */ 106 void heart_rate_service_add_energy_expended(uint16_t energy_expended_kJ); 107 108 /** 109 * @brief Update heart rate (unit: beats per minute) 110 * @note triggers notifications if subscribed 111 * @param heart_rate_bpm beats per minute 112 * @param contact 113 * @param rr_interval_count 114 * @param rr_intervals resolution in 1/1024 seconds 115 */ 116 void heart_rate_service_server_update_heart_rate_values(uint16_t heart_rate_bpm, 117 heart_rate_service_sensor_contact_status_t contact, int rr_interval_count, uint16_t * rr_intervals); 118 119 /* API_END */ 120 121 #if defined __cplusplus 122 } 123 #endif 124 125 #endif 126 127