xref: /btstack/src/ble/gatt-service/cycling_speed_and_cadence_service_server.h (revision 0561b2d8d5dba972c7daa57d5e677f7a1327edfd)
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 CYCLING_SPEED_AND_CADENCE_SERVICE_SERVER_H
38 #define CYCLING_SPEED_AND_CADENCE_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 Cycling Speed and Cadence Service Server
48  */
49 
50 // *****************************************************************************
51 /* GATT_SERVICE_SERVER_START(cycling_speed_and_cadence_service_server){Cycling Speed and Cadence Service}
52  *
53  */
54 // *****************************************************************************
55 /* GATT_SERVICE_SERVER_END */
56 
57 /* API_START */
58 
59 typedef enum {
60 	CSC_SERVICE_SENSOR_LOCATION_OTHER = 0,
61 	CSC_SERVICE_SENSOR_LOCATION_TOP_OF_SHOE,
62 	CSC_SERVICE_SENSOR_LOCATION_IN_SHOE,
63 	CSC_SERVICE_SENSOR_LOCATION_HIP,
64 	CSC_SERVICE_SENSOR_LOCATION_FRONT_WHEEL,
65 	CSC_SERVICE_SENSOR_LOCATION_LEFT_CRANK,
66 	CSC_SERVICE_SENSOR_LOCATION_RIGHT_CRANK,
67 	CSC_SERVICE_SENSOR_LOCATION_LEFT_PEDAL,
68 	CSC_SERVICE_SENSOR_LOCATION_RIGHT_PEDAL,
69 	CSC_SERVICE_SENSOR_LOCATION_FRONT_HUB,
70 	CSC_SERVICE_SENSOR_LOCATION_REAR_DROPOUT,
71 	CSC_SERVICE_SENSOR_LOCATION_CHAINSTAY,
72 	CSC_SERVICE_SENSOR_LOCATION_REAR_WHEEL,
73 	CSC_SERVICE_SENSOR_LOCATION_REAR_HUB,
74 	CSC_SERVICE_SENSOR_LOCATION_CHEST,
75 	CSC_SERVICE_SENSOR_LOCATION_SPIDER,
76 	CSC_SERVICE_SENSOR_LOCATION_CHAIN_RING,
77 	CSC_SERVICE_SENSOR_LOCATION_RESERVED
78 } cycling_speed_and_cadence_sensor_location_t;
79 
80 typedef enum {
81 	CSC_FLAG_WHEEL_REVOLUTION_DATA_SUPPORTED = 0,
82 	CSC_FLAG_CRANK_REVOLUTION_DATA_SUPPORTED,
83 	CSC_FLAG_MULTIPLE_SENSOR_LOCATIONS_SUPPORTED
84 } csc_feature_flag_bit_t;
85 
86 typedef enum {
87 	CSC_OPCODE_IDLE = 0,
88 	CSC_OPCODE_SET_CUMULATIVE_VALUE = 1,
89 	CSC_OPCODE_START_SENSOR_CALIBRATION,
90 	CSC_OPCODE_UPDATE_SENSOR_LOCATION,
91 	CSC_OPCODE_REQUEST_SUPPORTED_SENSOR_LOCATIONS,
92 	CSC_OPCODE_RESPONSE_CODE = 16
93 } csc_opcode_t;
94 
95 /**
96  * @brief Init Server with ATT DB
97  */
98 void cycling_speed_and_cadence_service_server_init(uint32_t supported_sensor_locations,
99 	uint8_t multiple_sensor_locations_supported, uint8_t wheel_revolution_data_supported, uint8_t crank_revolution_data_supported);
100 
101 /**
102  * @brief Update heart rate (unit: beats per minute)
103  * @note triggers notifications if subscribed
104  */
105 void cycling_speed_and_cadence_service_server_update_values(int32_t wheel_revolutions, uint16_t last_wheel_event_time, uint16_t crank_revolutions, uint16_t last_crank_event_time);
106 
107 /* API_END */
108 
109 #if defined __cplusplus
110 }
111 #endif
112 
113 #endif
114 
115