xref: /btstack/src/ble/gatt-service/heart_rate_service_server.h (revision adc3e7d5ae4cbeda6d621005a3013da03973a855)
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  * Implementation of the GATT Heart Rate Server
48  * To use with your application, add '#import <heart_rate_service.gatt' to your .gatt file
49  */
50 
51 /* API_START */
52 
53 typedef enum {
54 	HEART_RATE_SERVICE_BODY_SENSOR_LOCATION_OTHER,
55 	HEART_RATE_SERVICE_BODY_SENSOR_LOCATION_CHEST,
56 	HEART_RATE_SERVICE_BODY_SENSOR_LOCATION_WRIST,
57 	HEART_RATE_SERVICE_BODY_SENSOR_LOCATION_FINGER,
58 	HEART_RATE_SERVICE_BODY_SENSOR_LOCATION_HAND,
59 	HEART_RATE_SERVICE_BODY_SENSOR_LOCATION_EAR_LOBE,
60 	HEART_RATE_SERVICE_BODY_SENSOR_LOCATION_FOOT
61 } heart_rate_service_body_sensor_location_t;
62 
63 typedef enum {
64 	HEART_RATE_SERVICE_SENSOR_CONTACT_UNKNOWN,
65 	HEART_RATE_SERVICE_SENSOR_CONTACT_UNSUPPORTED,
66 	HEART_RATE_SERVICE_SENSOR_CONTACT_NO_CONTACT,
67 	HEART_RATE_SERVICE_SENSOR_CONTACT_HAVE_CONTACT
68 } heart_rate_service_sensor_contact_t;
69 
70 
71 /**
72  * @brief Init Battery Service Server with ATT DB
73  * @param heart_rate in range 0-255
74  */
75 void heart_rate_service_server_init(heart_rate_service_body_sensor_location_t location);
76 
77 
78 /**
79  * @brief Register callback to receive event "Reset Energy Expended"
80  * @param heart_rate in range 0-8
81  */
82 void heart_rate_service_register_reset_energy_expended_callback(btstack_packet_handler_t callback);
83 
84 /**
85  * @brief Update heart rate (unit: beats per minute)
86  * @note triggers notifications if subscribed
87  * @param heart_rate 		beats per second, range 0-255
88  * @param contact
89  * @param energy_expended   accumulated energy expended in kilo Joules since the last time it was reset
90  * @param rr_interval_count
91  * @param rr_intervals      resolution in 1/1024 seconds
92  * @return status           ERROR_CODE_SUCCESS if succesfully queued
93  */
94 uint8_t heart_rate_service_server_update_heart_rate_values(uint16_t heart_rate,
95 	heart_rate_service_sensor_contact_t contact, uint16_t energy_expended,
96 	int rr_interval_count, uint16_t * rr_intervals);
97 
98 
99 /* API_END */
100 
101 #if defined __cplusplus
102 }
103 #endif
104 
105 #endif
106 
107