xref: /btstack/src/mesh/gatt-service/mesh_provisioning_service_server.h (revision d567aeb32398f2a708611c446bcd9bad85a152cd)
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 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 Mesh Provisioning Service Server
40  *
41  */
42 
43 #ifndef __MESH_PROVISIONING_SERVICE_SERVER_H
44 #define __MESH_PROVISIONING_SERVICE_SERVER_H
45 
46 #include <stdint.h>
47 
48 #include "hci.h"
49 
50 #if defined __cplusplus
51 extern "C" {
52 #endif
53 
54 /**
55  * @text The Mesh Provisioning Service allows a Provisioning Client to provision a device to participate in the mesh network.
56  *
57  * To use with your application, add `#import <mesh_provisioning_service.gatt>` to your .gatt file.
58  */
59 
60 /* API_START */
61 
62 /**
63  * @brief Init Mesh Provisioning Service Server with ATT DB
64  */
65 void mesh_provisioning_service_server_init(void);
66 
67 /**
68  * @brief Send a Proxy PDU message containing Provisioning PDU from a Provisioning Server to a Provisioning Client.
69  * @param con_handle
70  * @param proxy_pdu
71  * @param proxy_pdu_size max lenght MESH_PROV_MAX_PROXY_PDU
72  */
73 void mesh_provisioning_service_server_send_proxy_pdu(uint16_t con_handle, const uint8_t * proxy_pdu, uint16_t proxy_pdu_size);
74 
75 /**
76  * @brief Register callback for the PB-GATT.
77  * @param callback
78  */
79 void mesh_provisioning_service_server_register_packet_handler(btstack_packet_handler_t callback);
80 
81 /**
82  * @brief Request can send now event to send PDU
83  * Generates an MESH_SUBEVENT_CAN_SEND_NOW subevent
84  * @param con_handle
85  */
86 void mesh_provisioning_service_server_request_can_send_now(hci_con_handle_t con_handle);
87 /* API_END */
88 
89 #if defined __cplusplus
90 }
91 #endif
92 
93 #endif
94 
95