Select one of the symbols to view example projects that use it.
 
Outline
#include "gap.h"
#include "common.h"
#include "gatt_svc.h"
own_addr_type
addr_val
esp_uri
format_addr(char *, uint8_t *)
print_conn_desc(struct ble_gap_conn_desc *)
set_random_addr()
start_advertising()
gap_event_handler(struct ble_gap_event *, void *)
adv_init()
is_connection_encrypted(uint16_t)
gap_init()
Files
loading (2/4)...
SourceVuESP-IDF Framework and ExamplesNimBLE_Security samplemain/src/gap.c
 
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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
/* * SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Unlicense OR CC0-1.0 *//* ... */ /* Includes */ #include "gap.h" #include "common.h" #include "gatt_svc.h" /* Private function declarations */ inline static void format_addr(char *addr_str, uint8_t addr[]); static void print_conn_desc(struct ble_gap_conn_desc *desc); static void start_advertising(void); static void set_random_addr(void); static int gap_event_handler(struct ble_gap_event *event, void *arg); /* Private variables */ static uint8_t own_addr_type; static uint8_t addr_val[6] = {0}; static uint8_t esp_uri[] = {BLE_GAP_URI_PREFIX_HTTPS, '/', '/', 'e', 's', 'p', 'r', 'e', 's', 's', 'i', 'f', '.', 'c', 'o', 'm'}; /* Private functions */ inline static void format_addr(char *addr_str, uint8_t addr[]) { sprintf(addr_str, "%02X:%02X:%02X:%02X:%02X:%02X", addr[0], addr[1], addr[2], addr[3], addr[4], addr[5]); }{ ... } static void print_conn_desc(struct ble_gap_conn_desc *desc) { /* Local variables */ char addr_str[18] = {0}; /* Connection handle */ ESP_LOGI(TAG, "connection handle: %d", desc->conn_handle); /* Local ID address */ format_addr(addr_str, desc->our_id_addr.val); ESP_LOGI(TAG, "device id address: type=%d, value=%s", desc->our_id_addr.type, addr_str); /* Peer ID address */ format_addr(addr_str, desc->peer_id_addr.val); ESP_LOGI(TAG, "peer id address: type=%d, value=%s", desc->peer_id_addr.type, addr_str); /* Connection info */ ESP_LOGI(TAG, "conn_itvl=%d, conn_latency=%d, supervision_timeout=%d, " "encrypted=%d, authenticated=%d, bonded=%d\n", desc->conn_itvl, desc->conn_latency, desc->supervision_timeout, desc->sec_state.encrypted, desc->sec_state.authenticated, desc->sec_state.bonded); }{ ... } static void set_random_addr(void) { /* Local variables */ int rc = 0; ble_addr_t addr; /* Generate new non-resolvable private address */ rc = ble_hs_id_gen_rnd(0, &addr); assert(rc == 0); /* Set address */ rc = ble_hs_id_set_rnd(addr.val); assert(rc == 0); }{ ... } static void start_advertising(void) { /* Local variables */ int rc = 0; const char *name; struct ble_hs_adv_fields adv_fields = {0}; struct ble_hs_adv_fields rsp_fields = {0}; struct ble_gap_adv_params adv_params = {0}; /* Set advertising flags */ adv_fields.flags = BLE_HS_ADV_F_DISC_GEN | BLE_HS_ADV_F_BREDR_UNSUP; /* Set device name */ name = ble_svc_gap_device_name(); adv_fields.name = (uint8_t *)name; adv_fields.name_len = strlen(name); adv_fields.name_is_complete = 1; /* Set device tx power */ adv_fields.tx_pwr_lvl = BLE_HS_ADV_TX_PWR_LVL_AUTO; adv_fields.tx_pwr_lvl_is_present = 1; /* Set device appearance */ adv_fields.appearance = BLE_GAP_APPEARANCE_GENERIC_TAG; adv_fields.appearance_is_present = 1; /* Set device LE role */ adv_fields.le_role = BLE_GAP_LE_ROLE_PERIPHERAL; adv_fields.le_role_is_present = 1; /* Set advertiement fields */ rc = ble_gap_adv_set_fields(&adv_fields); if (rc != 0) { ESP_LOGE(TAG, "failed to set advertising data, error code: %d", rc); return; }{...} /* Set device address */ rsp_fields.device_addr = addr_val; rsp_fields.device_addr_type = own_addr_type; rsp_fields.device_addr_is_present = 1; /* Set URI */ rsp_fields.uri = esp_uri; rsp_fields.uri_len = sizeof(esp_uri); /* Set advertising interval */ rsp_fields.adv_itvl = BLE_GAP_ADV_ITVL_MS(500); rsp_fields.adv_itvl_is_present = 1; /* Set scan response fields */ rc = ble_gap_adv_rsp_set_fields(&rsp_fields); if (rc != 0) { ESP_LOGE(TAG, "failed to set scan response data, error code: %d", rc); return; }{...} /* Set non-connetable and general discoverable mode to be a beacon */ adv_params.conn_mode = BLE_GAP_CONN_MODE_UND; adv_params.disc_mode = BLE_GAP_DISC_MODE_GEN; /* Set advertising interval */ adv_params.itvl_min = BLE_GAP_ADV_ITVL_MS(500); adv_params.itvl_max = BLE_GAP_ADV_ITVL_MS(510); /* Start advertising */ rc = ble_gap_adv_start(own_addr_type, NULL, BLE_HS_FOREVER, &adv_params, gap_event_handler, NULL); if (rc != 0) { ESP_LOGE(TAG, "failed to start advertising, error code: %d", rc); return; }{...} ESP_LOGI(TAG, "advertising started!"); }{ ... } /* * NimBLE applies an event-driven model to keep GAP service going * gap_event_handler is a callback function registered when calling * ble_gap_adv_start API and called when a GAP event arrives *//* ... */ static int gap_event_handler(struct ble_gap_event *event, void *arg) { /* Local variables */ int rc = 0; struct ble_gap_conn_desc desc; /* Handle different GAP event */ switch (event->type) { /* Connect event */ case BLE_GAP_EVENT_CONNECT: /* A new connection was established or a connection attempt failed. */ ESP_LOGI(TAG, "connection %s; status=%d", event->connect.status == 0 ? "established" : "failed", event->connect.status); /* Connection succeeded */ if (event->connect.status == 0) { /* Check connection handle */ rc = ble_gap_conn_find(event->connect.conn_handle, &desc); if (rc != 0) { ESP_LOGE(TAG, "failed to find connection by handle, error code: %d", rc); return rc; }{...} /* Print connection descriptor */ print_conn_desc(&desc); /* Try to update connection parameters */ struct ble_gap_upd_params params = {.itvl_min = desc.conn_itvl, .itvl_max = desc.conn_itvl, .latency = 3, .supervision_timeout = desc.supervision_timeout}{...}; rc = ble_gap_update_params(event->connect.conn_handle, &params); if (rc != 0) { ESP_LOGE( TAG, "failed to update connection parameters, error code: %d", rc); return rc; }{...} }{...} /* Connection failed, restart advertising */ else { start_advertising(); }{...} return rc; /* Disconnect event */... case BLE_GAP_EVENT_DISCONNECT: /* A connection was terminated, print connection descriptor */ ESP_LOGI(TAG, "disconnected from peer; reason=%d", event->disconnect.reason); /* Restart advertising */ start_advertising(); return rc; /* Connection parameters update event */... case BLE_GAP_EVENT_CONN_UPDATE: /* The central has updated the connection parameters. */ ESP_LOGI(TAG, "connection updated; status=%d", event->conn_update.status); /* Print connection descriptor */ rc = ble_gap_conn_find(event->conn_update.conn_handle, &desc); if (rc != 0) { ESP_LOGE(TAG, "failed to find connection by handle, error code: %d", rc); return rc; }{...} print_conn_desc(&desc); return rc; /* Advertising complete event */... case BLE_GAP_EVENT_ADV_COMPLETE: /* Advertising completed, restart advertising */ ESP_LOGI(TAG, "advertise complete; reason=%d", event->adv_complete.reason); start_advertising(); return rc; /* Notification sent event */... case BLE_GAP_EVENT_NOTIFY_TX: if ((event->notify_tx.status != 0) && (event->notify_tx.status != BLE_HS_EDONE)) { /* Print notification info on error */ ESP_LOGI(TAG, "notify event; conn_handle=%d attr_handle=%d " "status=%d is_indication=%d", event->notify_tx.conn_handle, event->notify_tx.attr_handle, event->notify_tx.status, event->notify_tx.indication); }{...} return rc; /* Subscribe event */... case BLE_GAP_EVENT_SUBSCRIBE: /* Print subscription info to log */ ESP_LOGI(TAG, "subscribe event; conn_handle=%d attr_handle=%d " "reason=%d prevn=%d curn=%d previ=%d curi=%d", event->subscribe.conn_handle, event->subscribe.attr_handle, event->subscribe.reason, event->subscribe.prev_notify, event->subscribe.cur_notify, event->subscribe.prev_indicate, event->subscribe.cur_indicate); /* GATT subscribe event callback */ rc = gatt_svr_subscribe_cb(event); if (rc == BLE_ATT_ERR_INSUFFICIENT_AUTHEN) { /* Request connection encryption */ return ble_gap_security_initiate(event->subscribe.conn_handle); }{...} return rc; /* MTU update event */... case BLE_GAP_EVENT_MTU: /* Print MTU update info to log */ ESP_LOGI(TAG, "mtu update event; conn_handle=%d cid=%d mtu=%d", event->mtu.conn_handle, event->mtu.channel_id, event->mtu.value); return rc; /* Encryption change event */... case BLE_GAP_EVENT_ENC_CHANGE: /* Encryption has been enabled or disabled for this connection. */ if (event->enc_change.status == 0) { ESP_LOGI(TAG, "connection encrypted!"); }{...} else { ESP_LOGE(TAG, "connection encryption failed, status: %d", event->enc_change.status); }{...} return rc; /* Repeat pairing event */... case BLE_GAP_EVENT_REPEAT_PAIRING: /* Delete the old bond */ rc = ble_gap_conn_find(event->repeat_pairing.conn_handle, &desc); if (rc != 0) { ESP_LOGE(TAG, "failed to find connection, error code %d", rc); return rc; }{...} ble_store_util_delete_peer(&desc.peer_id_addr); /* Return BLE_GAP_REPEAT_PAIRING_RETRY to indicate that the host should * continue with pairing operation *//* ... */ ESP_LOGI(TAG, "repairing..."); return BLE_GAP_REPEAT_PAIRING_RETRY; /* Passkey action event */... case BLE_GAP_EVENT_PASSKEY_ACTION: /* Display action */ if (event->passkey.params.action == BLE_SM_IOACT_DISP) { /* Generate passkey */ struct ble_sm_io pkey = {0}; pkey.action = event->passkey.params.action; pkey.passkey = 100000 + esp_random() % 900000; ESP_LOGI(TAG, "enter passkey %" PRIu32 " on the peer side", pkey.passkey); rc = ble_sm_inject_io(event->passkey.conn_handle, &pkey); if (rc != 0) { ESP_LOGE(TAG, "failed to inject security manager io, error code: %d", rc); return rc; }{...} }{...} return rc;... }{...} return rc; }{ ... } /* Public functions */ void adv_init(void) { /* Local variables */ int rc = 0; char addr_str[18] = {0}; /* Make sure we have proper BT identity address set */ set_random_addr(); rc = ble_hs_util_ensure_addr(1); if (rc != 0) { ESP_LOGE(TAG, "device does not have any available bt address!"); return; }{...} /* Figure out BT address to use while advertising */ rc = ble_hs_id_infer_auto(0, &own_addr_type); if (rc != 0) { ESP_LOGE(TAG, "failed to infer address type, error code: %d", rc); return; }{...} /* Copy device address to addr_val */ rc = ble_hs_id_copy_addr(own_addr_type, addr_val, NULL); if (rc != 0) { ESP_LOGE(TAG, "failed to copy device address, error code: %d", rc); return; }{...} format_addr(addr_str, addr_val); ESP_LOGI(TAG, "device address: %s", addr_str); /* Start advertising. */ start_advertising(); }{ ... } bool is_connection_encrypted(uint16_t conn_handle) { /* Local variables */ int rc = 0; struct ble_gap_conn_desc desc; /* Print connection descriptor */ rc = ble_gap_conn_find(conn_handle, &desc); if (rc != 0) { ESP_LOGE(TAG, "failed to find connection by handle, error code: %d", rc); return false; }{...} return desc.sec_state.encrypted; }{ ... } int gap_init(void) { /* Local variables */ int rc = 0; /* Call NimBLE GAP initialization API */ ble_svc_gap_init(); /* Set GAP device name */ rc = ble_svc_gap_device_name_set(DEVICE_NAME); if (rc != 0) { ESP_LOGE(TAG, "failed to set device name to %s, error code: %d", DEVICE_NAME, rc); return rc; }{...} return rc; }{ ... }
Details
Show:
from
Types: Columns:
This file uses the notable symbols shown below. Click anywhere in the file to view more details.