ESP-IDF
Select one of the symbols to view example projects that use it.
 
Outline
#include <protocomm.h>
#include "esp_event.h"
PROTOCOMM_TRANSPORT_BLE_EVENT;
protocomm_transport_ble_event_t
#define MAX_BLE_DEVNAME_LEN
#define BLE_UUID128_VAL_LENGTH
#define MAX_BLE_MANUFACTURER_DATA_LEN
#define BLE_ADDR_LEN
name_uuid
protocomm_ble_event_t
protocomm_ble_config
protocomm_ble_start(protocomm_t *, const protocomm_ble_config_t *);
protocomm_ble_stop(protocomm_t *);
Files
loading...
SourceVuESP-IDF Framework and ExamplesESP-IDFcomponents/protocomm/include/transports/protocomm_ble.h
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
/* * SPDX-FileCopyrightText: 2018-2024 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 *//* ... */ #pragma once #include <protocomm.h> #include "esp_event.h" #ifdef __cplusplus extern "C" { #endif ESP_EVENT_DECLARE_BASE(PROTOCOMM_TRANSPORT_BLE_EVENT); /** * @brief Events generated by BLE transport * * These events are generated when the BLE transport is paired * and disconnected. *//* ... */ typedef enum { PROTOCOMM_TRANSPORT_BLE_CONNECTED, PROTOCOMM_TRANSPORT_BLE_DISCONNECTED, }{ ... } protocomm_transport_ble_event_t; /** * BLE device name cannot be larger than this value * 31 bytes (max scan response size) - 1 byte (length) - 1 byte (type) = 29 bytes *//* ... */ #define MAX_BLE_DEVNAME_LEN 29 #define BLE_UUID128_VAL_LENGTH 16 /** * Theoretically, the limit for max manufacturer length remains same as BLE * device name i.e. 31 bytes (max scan response size) - 1 byte (length) - 1 * byte (type) = 29 bytes * However, manufacturer data goes along with BLE device name in scan response. * So, it is important to understand the actual length should be smaller than * (29 - (BLE device name length) - 2). *//* ... */ #define MAX_BLE_MANUFACTURER_DATA_LEN 29 #define BLE_ADDR_LEN 6 /** * @brief This structure maps handler required by protocomm layer to * UUIDs which are used to uniquely identify BLE characteristics * from a smartphone or a similar client device. *//* ... */ typedef struct name_uuid { /** * Name of the handler, which is passed to protocomm layer *//* ... */ const char *name; /** * UUID to be assigned to the BLE characteristic which is * mapped to the handler *//* ... */ uint16_t uuid; }{ ... } protocomm_ble_name_uuid_t; /** * @brief Structure for BLE events in Protocomm. *//* ... */ typedef struct { /** * This field indicates the type of BLE event that occurred. *//* ... */ uint16_t evt_type; /** * The handle of the relevant connection. *//* ... */ uint16_t conn_handle; union { /** * The status of the connection attempt; * o 0: the connection was successfully established. * o BLE host error code: the connection attempt failed for * the specified reason. *//* ... */ uint16_t conn_status; /** * Return code indicating the reason for the disconnect. *//* ... */ uint16_t disconnect_reason; }{ ... }; }{ ... } protocomm_ble_event_t; /** * @brief Config parameters for protocomm BLE service *//* ... */ typedef struct protocomm_ble_config { /** * BLE device name being broadcast at the time of provisioning *//* ... */ char device_name[MAX_BLE_DEVNAME_LEN + 1]; /** * 128 bit UUID of the provisioning service *//* ... */ uint8_t service_uuid[BLE_UUID128_VAL_LENGTH]; /** * BLE device manufacturer data pointer in advertisement *//* ... */ uint8_t *manufacturer_data; /** * BLE device manufacturer data length in advertisement *//* ... */ ssize_t manufacturer_data_len; /** * Number of entries in the Name-UUID lookup table *//* ... */ ssize_t nu_lookup_count; /** * Pointer to the Name-UUID lookup table *//* ... */ protocomm_ble_name_uuid_t *nu_lookup; /** * BLE bonding *//* ... */ unsigned ble_bonding:1; /** * BLE security flag *//* ... */ unsigned ble_sm_sc:1; /** * BLE security flag *//* ... */ unsigned ble_link_encryption:1; /** * BLE address *//* ... */ uint8_t *ble_addr; /** * Flag to keep BLE on *//* ... */ unsigned keep_ble_on:1; /** * BLE characteristic notify flag *//* ... */ unsigned ble_notify:1; }{ ... } protocomm_ble_config_t; /** * @brief Start Bluetooth Low Energy based transport layer for provisioning * * Initialize and start required BLE service for provisioning. This includes * the initialization for characteristics/service for BLE. * * @param[in] pc Protocomm instance pointer obtained from protocomm_new() * @param[in] config Pointer to config structure for initializing BLE * * @return * - ESP_OK : Success * - ESP_FAIL : Simple BLE start error * - ESP_ERR_NO_MEM : Error allocating memory for internal resources * - ESP_ERR_INVALID_STATE : Error in ble config * - ESP_ERR_INVALID_ARG : Null arguments *//* ... */ esp_err_t protocomm_ble_start(protocomm_t *pc, const protocomm_ble_config_t *config); /** * @brief Stop Bluetooth Low Energy based transport layer for provisioning * * Stops service/task responsible for BLE based interactions for provisioning * * @note You might want to optionally reclaim memory from Bluetooth. * Refer to the documentation of `esp_bt_mem_release` in that case. * * @param[in] pc Same protocomm instance that was passed to protocomm_ble_start() * * @return * - ESP_OK : Success * - ESP_FAIL : Simple BLE stop error * - ESP_ERR_INVALID_ARG : Null / incorrect protocomm instance *//* ... */ esp_err_t protocomm_ble_stop(protocomm_t *pc); #ifdef __cplusplus }{...} #endif
Details
Show:
from
Types: Columns: