xref: /btstack/src/ble/gatt-service/tx_power_service_server.h (revision 2fca4dad957cd7b88f4657ed51e89c12615dda72)
1 /*
2  * Copyright (C) 2014 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 BLUEKITCHEN
24  * GMBH 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 
38 /**
39  * @title TX Power Service Server
40  *
41  */
42 
43 #ifndef TX_POWER_SERVICE_SERVER_H
44 #define TX_POWER_SERVICE_SERVER_H
45 
46 #include <stdint.h>
47 
48 #if defined __cplusplus
49 extern "C" {
50 #endif
51 
52 /**
53  * @text The TX Power service exposes a device’s current transmit power level when in a connection.
54  * There shall only be one instance of the Tx Power service on a device.
55  *
56  * To use with your application, add `#import <tx_power_service.gatt>` to your .gatt file.
57  * After adding it to your .gatt file, you call *tx_power_service_server_init(value)* with the
58  * device’s current transmit power level value.
59  *
60  * If the power level value changes, you can call *tx_power_service_server_set_level(tx_power_level_dBm)*.
61  * The service does not support sending Notifications.
62  */
63 
64 /* API_START */
65 
66 /**
67  * @brief Init TX Power Service Server with ATT DB
68  * @param tx_power_level
69  */
70 void tx_power_service_server_init(int8_t tx_power_level);
71 
72 /**
73  * @brief Update TX power level
74  * @param tx_power_level_dBm range [-100,20]
75  */
76 void tx_power_service_server_set_level(int8_t tx_power_level_dBm);
77 
78 /* API_END */
79 
80 #if defined __cplusplus
81 }
82 #endif
83 
84 #endif
85 
86