ESP-IDF
Select one of the symbols to view example projects that use it.
 
Outline
#define _GENERIC_SERVER_H_
#include "mesh/server_common.h"
bt_mesh_gen_onoff_state
bt_mesh_gen_onoff_srv
bt_mesh_gen_level_state
bt_mesh_gen_level_srv
bt_mesh_gen_def_trans_time_state
bt_mesh_gen_def_trans_time_srv
bt_mesh_gen_onpowerup_state
bt_mesh_gen_power_onoff_srv
bt_mesh_gen_power_onoff_setup_srv
bt_mesh_gen_power_level_state
bt_mesh_gen_power_level_srv
bt_mesh_gen_power_level_setup_srv
bt_mesh_gen_battery_state
bt_mesh_gen_battery_srv
bt_mesh_gen_location_state
bt_mesh_gen_location_srv
bt_mesh_gen_location_setup_srv
bt_mesh_gen_user_prop_access
bt_mesh_gen_admin_prop_access
bt_mesh_gen_manu_prop_access
bt_mesh_generic_property
bt_mesh_gen_user_prop_srv
bt_mesh_gen_admin_prop_srv
bt_mesh_gen_manu_prop_srv
bt_mesh_gen_client_prop_srv
bt_mesh_gen_server_state_change_t
bt_mesh_gen_server_recv_get_msg_t
bt_mesh_gen_server_recv_set_msg_t
bt_mesh_generic_server_lock();
bt_mesh_generic_server_unlock();
gen_onoff_publish(struct bt_mesh_model *);
gen_level_publish(struct bt_mesh_model *);
gen_onpowerup_publish(struct bt_mesh_model *);
gen_power_level_publish(struct bt_mesh_model *, uint16_t);
Files
loading (4/5)...
SourceVuESP-IDF Framework and ExamplesESP-IDFcomponents/bt/esp_ble_mesh/models/server/include/mesh/generic_server.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
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
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
/* Bluetooth: Mesh Generic OnOff, Generic Level, Lighting & Vendor Models * * SPDX-FileCopyrightText: 2018 Vikrant More * SPDX-FileContributor: 2018-2021 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 *//* ... */ #ifndef _GENERIC_SERVER_H_ #define _GENERIC_SERVER_H_ #include "mesh/server_common.h" #ifdef __cplusplus extern "C" { #endif struct bt_mesh_gen_onoff_state { uint8_t onoff; uint8_t target_onoff; }{ ... }; struct bt_mesh_gen_onoff_srv { struct bt_mesh_model *model; struct bt_mesh_server_rsp_ctrl rsp_ctrl; struct bt_mesh_gen_onoff_state state; struct bt_mesh_last_msg_info last; struct bt_mesh_state_transition transition; }{ ... }; struct bt_mesh_gen_level_state { int16_t level; int16_t target_level; int16_t last_level; int32_t last_delta; bool move_start; bool positive; }{ ... }; struct bt_mesh_gen_level_srv { struct bt_mesh_model *model; struct bt_mesh_server_rsp_ctrl rsp_ctrl; struct bt_mesh_gen_level_state state; struct bt_mesh_last_msg_info last; struct bt_mesh_state_transition transition; int32_t tt_delta_level; }{ ... }; struct bt_mesh_gen_def_trans_time_state { uint8_t trans_time; }{ ... }; struct bt_mesh_gen_def_trans_time_srv { struct bt_mesh_model *model; struct bt_mesh_server_rsp_ctrl rsp_ctrl; struct bt_mesh_gen_def_trans_time_state state; }{ ... }; struct bt_mesh_gen_onpowerup_state { uint8_t onpowerup; }{ ... }; struct bt_mesh_gen_power_onoff_srv { struct bt_mesh_model *model; struct bt_mesh_server_rsp_ctrl rsp_ctrl; struct bt_mesh_gen_onpowerup_state *state; }{ ... }; struct bt_mesh_gen_power_onoff_setup_srv { struct bt_mesh_model *model; struct bt_mesh_server_rsp_ctrl rsp_ctrl; struct bt_mesh_gen_onpowerup_state *state; }{ ... }; struct bt_mesh_gen_power_level_state { uint16_t power_actual; uint16_t target_power_actual; uint16_t power_last; uint16_t power_default; uint8_t status_code; uint16_t power_range_min; uint16_t power_range_max; }{ ... }; struct bt_mesh_gen_power_level_srv { struct bt_mesh_model *model; struct bt_mesh_server_rsp_ctrl rsp_ctrl; struct bt_mesh_gen_power_level_state *state; struct bt_mesh_last_msg_info last; struct bt_mesh_state_transition transition; int32_t tt_delta_level; }{ ... }; struct bt_mesh_gen_power_level_setup_srv { struct bt_mesh_model *model; struct bt_mesh_server_rsp_ctrl rsp_ctrl; struct bt_mesh_gen_power_level_state *state; }{ ... }; struct bt_mesh_gen_battery_state { uint32_t battery_level : 8, time_to_discharge : 24; uint32_t time_to_charge : 24, battery_flags : 8; }{ ... }; struct bt_mesh_gen_battery_srv { struct bt_mesh_model *model; struct bt_mesh_server_rsp_ctrl rsp_ctrl; struct bt_mesh_gen_battery_state state; }{ ... }; struct bt_mesh_gen_location_state { int32_t global_latitude; int32_t global_longitude; int16_t global_altitude; int16_t local_north; int16_t local_east; int16_t local_altitude; uint8_t floor_number; uint16_t uncertainty; }{ ... }; struct bt_mesh_gen_location_srv { struct bt_mesh_model *model; struct bt_mesh_server_rsp_ctrl rsp_ctrl; struct bt_mesh_gen_location_state *state; }{ ... }; struct bt_mesh_gen_location_setup_srv { struct bt_mesh_model *model; struct bt_mesh_server_rsp_ctrl rsp_ctrl; struct bt_mesh_gen_location_state *state; }{ ... }; /** * According to the hierarchy of Generic Property states (Model Spec section 3.1.8), * the Manufacturer Properties and Admin Properties may contain multiple Property * states. User Properties just a collection of which can be accessed. * * property_count: Number of the properties contained in the table * properties: Table of the properties * * These variables need to be initialized in the application layer, the precise * number of the properties should be set and memories used to store the property * values should be allocated. *//* ... */ enum bt_mesh_gen_user_prop_access { USER_ACCESS_PROHIBIT, USER_ACCESS_READ, USER_ACCESS_WRITE, USER_ACCESS_READ_WRITE, }{ ... }; enum bt_mesh_gen_admin_prop_access { ADMIN_NOT_USER_PROP, ADMIN_ACCESS_READ, ADMIN_ACCESS_WRITE, ADMIN_ACCESS_READ_WRITE, }{ ... }; enum bt_mesh_gen_manu_prop_access { MANU_NOT_USER_PROP, MANU_ACCESS_READ, }{ ... }; struct bt_mesh_generic_property { uint16_t id; uint8_t user_access; uint8_t admin_access; uint8_t manu_access; struct net_buf_simple *val; }{ ... }; struct bt_mesh_gen_user_prop_srv { struct bt_mesh_model *model; struct bt_mesh_server_rsp_ctrl rsp_ctrl; uint8_t property_count; struct bt_mesh_generic_property *properties; }{ ... }; struct bt_mesh_gen_admin_prop_srv { struct bt_mesh_model *model; struct bt_mesh_server_rsp_ctrl rsp_ctrl; uint8_t property_count; struct bt_mesh_generic_property *properties; }{ ... }; struct bt_mesh_gen_manu_prop_srv { struct bt_mesh_model *model; struct bt_mesh_server_rsp_ctrl rsp_ctrl; uint8_t property_count; struct bt_mesh_generic_property *properties; }{ ... }; struct bt_mesh_gen_client_prop_srv { struct bt_mesh_model *model; struct bt_mesh_server_rsp_ctrl rsp_ctrl; uint8_t id_count; uint16_t *property_ids; }{ ... }; typedef union { struct { uint8_t onoff; }{ ... } gen_onoff_set; struct { int16_t level; }{ ... } gen_level_set; struct { int16_t level; }{ ... } gen_delta_set; struct { int16_t level; }{ ... } gen_move_set; struct { uint8_t trans_time; }{ ... } gen_def_trans_time_set; struct { uint8_t onpowerup; }{ ... } gen_onpowerup_set; struct { uint16_t power; }{ ... } gen_power_level_set; struct { uint16_t power; }{ ... } gen_power_default_set; struct { uint16_t range_min; uint16_t range_max; }{ ... } gen_power_range_set; struct { int32_t latitude; int32_t longitude; int16_t altitude; }{ ... } gen_loc_global_set; struct { int16_t north; int16_t east; int16_t altitude; uint8_t floor_number; uint16_t uncertainty; }{ ... } gen_loc_local_set; struct { uint16_t id; struct net_buf_simple *value; }{ ... } gen_user_prop_set; struct { uint16_t id; uint8_t access; struct net_buf_simple *value; }{ ... } gen_admin_prop_set; struct { uint16_t id; uint8_t access; }{ ... } gen_manu_prop_set; }{ ... } bt_mesh_gen_server_state_change_t; typedef union { struct { uint16_t id; }{ ... } user_property_get; struct { uint16_t id; }{ ... } admin_property_get; struct { uint16_t id; }{ ... } manu_property_get; struct { uint16_t id; }{ ... } client_properties_get; }{ ... } bt_mesh_gen_server_recv_get_msg_t; typedef union { struct { bool op_en; uint8_t onoff; uint8_t tid; uint8_t trans_time; uint8_t delay; }{ ... } onoff_set; struct { bool op_en; int16_t level; uint8_t tid; uint8_t trans_time; uint8_t delay; }{ ... } level_set; struct { bool op_en; int32_t delta_level; uint8_t tid; uint8_t trans_time; uint8_t delay; }{ ... } delta_set; struct { bool op_en; int16_t delta_level; uint8_t tid; uint8_t trans_time; uint8_t delay; }{ ... } move_set; struct { uint8_t trans_time; }{ ... } def_trans_time_set; struct { uint8_t onpowerup; }{ ... } onpowerup_set; struct { bool op_en; uint16_t power; uint8_t tid; uint8_t trans_time; uint8_t delay; }{ ... } power_level_set; struct { uint16_t power; }{ ... } power_default_set; struct { uint16_t range_min; uint16_t range_max; }{ ... } power_range_set; struct { int32_t latitude; int32_t longitude; int16_t altitude; }{ ... } loc_global_set; struct { int16_t north; int16_t east; int16_t altitude; uint8_t floor_number; uint16_t uncertainty; }{ ... } loc_local_set; struct { uint16_t id; struct net_buf_simple *value; }{ ... } user_property_set; struct { uint16_t id; uint8_t access; struct net_buf_simple *value; }{ ... } admin_property_set; struct { uint16_t id; uint8_t access; }{ ... } manu_property_set; }{ ... } bt_mesh_gen_server_recv_set_msg_t; void bt_mesh_generic_server_lock(void); void bt_mesh_generic_server_unlock(void); void gen_onoff_publish(struct bt_mesh_model *model); void gen_level_publish(struct bt_mesh_model *model); void gen_onpowerup_publish(struct bt_mesh_model *model); void gen_power_level_publish(struct bt_mesh_model *model, uint16_t opcode); #ifdef __cplusplus }{...} #endif /* ... */ #endif /* _GENERIC_SERVER_H_ */
Details
Show:
from
Types: Columns:
This file uses the notable symbols shown below. Click anywhere in the file to view more details.