nRF5 SDK for Mesh v5.0.0
config_server_events.h
1 /* Copyright (c) 2010 - 2020, Nordic Semiconductor ASA
2  * All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without modification,
5  * are permitted provided that the following conditions are met:
6  *
7  * 1. Redistributions of source code must retain the above copyright notice, this
8  * list of conditions and the following disclaimer.
9  *
10  * 2. Redistributions in binary form, except as embedded into a Nordic
11  * Semiconductor ASA integrated circuit in a product or a software update for
12  * such product, must reproduce the above copyright notice, this list of
13  * conditions and the following disclaimer in the documentation and/or other
14  * materials provided with the distribution.
15  *
16  * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
17  * contributors may be used to endorse or promote products derived from this
18  * software without specific prior written permission.
19  *
20  * 4. This software, with or without modification, must only be used with a
21  * Nordic Semiconductor ASA integrated circuit.
22  *
23  * 5. Any software provided in binary form under this license must not be reverse
24  * engineered, decompiled, modified and/or disassembled.
25  *
26  * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
27  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
28  * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
29  * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
30  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
32  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
35  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36  */
37 
38 #ifndef CONFIG_SERVER_EVENTS_H__
39 #define CONFIG_SERVER_EVENTS_H__
40 
41 #include <stdint.h>
42 #include "device_state_manager.h"
43 #include "access.h"
44 #include "heartbeat.h"
45 #include "config_messages.h"
46 
53 typedef enum
54 {
150 
152 typedef struct
153 {
157 
159 typedef struct
160 {
162  uint8_t page_number;
164 
166 typedef struct
167 {
169  uint8_t default_ttl;
171 
173 typedef struct
174 {
178 
180 typedef struct
181 {
187  uint8_t interval_steps;
189 
191 typedef struct
192 {
196 
198 typedef struct
199 {
203 
205 typedef struct
206 {
212 
214 typedef struct
215 {
221 
223 typedef struct
224 {
230 
232 typedef struct
233 {
237 
239 typedef struct
240 {
244 
246 typedef struct
247 {
251 
253 typedef struct
254 {
258 
260 typedef struct
261 {
265 
267 typedef struct
268 {
272 
274 typedef struct
275 {
279 
281 typedef struct
282 {
286 
288 typedef struct
289 {
293 
295 typedef struct
296 {
300 
302 typedef struct
303 {
307 
309 typedef struct
310 {
316 
318 typedef struct
319 {
325 
327 typedef struct
328 {
332 
334 typedef struct
335 {
339 
341 typedef struct
342 {
346 
348 typedef struct
349 {
355 
357 typedef struct
358 {
359  const heartbeat_publication_state_t * p_publication_state;
361 
363 typedef struct
364 {
365  const heartbeat_subscription_state_t * p_subscription_state;
367 
369 typedef struct
370 {
374  uint8_t interval_steps;
376 
378 typedef struct
379 {
381  uint16_t lpn_address;
383 
385 typedef struct
386 {
390  union
391  {
393  config_server_evt_composition_data_get_t composition_data_get;
394  config_server_evt_default_ttl_set_t default_ttl_set;
398  config_server_evt_model_publication_set_t model_publication_set;
399  config_server_evt_model_subscription_add_t model_subscription_add;
400  config_server_evt_model_subscription_delete_t model_subscription_delete;
401  config_server_evt_model_subscription_overwrite_t model_subscription_overwrite;
402  config_server_evt_model_subscription_delete_all_t model_subscription_delete_all;
403  config_server_evt_model_subscription_get_t model_subscription_get;
405  config_server_evt_netkey_update_t netkey_update;
406  config_server_evt_netkey_delete_t netkey_delete;
408  config_server_evt_appkey_update_t appkey_update;
409  config_server_evt_appkey_delete_t appkey_delete;
413  config_server_evt_model_app_bind_t model_app_bind;
414  config_server_evt_model_app_unbind_t model_app_unbind;
415  config_server_evt_model_app_get_t model_app_get;
417  config_server_evt_key_refresh_phase_get_t key_refresh_phase_get;
418  config_server_evt_key_refresh_phase_set_t key_refresh_phase_set;
419  config_server_evt_heartbeat_publication_set_t heartbeat_publication_set;
420  config_server_evt_heartbeat_subscription_set_t heartbeat_subscription_set;
421  config_server_evt_network_transmit_set_t network_transmit_set;
423  } params;
425 
430 typedef void (*config_server_evt_cb_t)(const config_server_evt_t * p_evt);
431 
434 #endif /* CONFIG_SERVER_EVENTS_H__ */
Application key data was requested.
Heartbeat publication parameters was set.
The publication paremeters for a given model was set.
uint8_t default_ttl
Default TTL value used for publishing messages.
dsm_handle_t address_handle
DSM address handle.
Config server event Subscription Add parameter structure.
uint8_t interval_steps
Number of interval steps between each re-transmission (10 ms/step).
dsm_handle_t appkey_handle
Application key handle.
config_net_beacon_state_t beacon_state
Current state of the secure network broadcast beacon.
uint16_t access_model_handle_t
Access layer handle type.
Definition: access.h:162
dsm_handle_t netkey_handle
New network key&#39;s handle.
Config server identity get parameter structure.
uint8_t retransmit_count
Number of re-transmissions per relayed message.
All subscriptions was deleted for the given model.
access_model_handle_t model_handle
Access model handle.
dsm_handle_t netkey_handle
Updated network key&#39;s handle.
access_model_handle_t model_handle
Access model handle.
Config server friend set parameter structure.
dsm_handle_t netkey_handle
Deleted network key&#39;s handle.
A network key was deleted.
All subscriptions was overwritten by a new subscription to a virtual address for the given model...
config_relay_state_t relay_state
The relay state.
access_model_handle_t model_handle
Access model handle.
config_gatt_proxy_state_t
Possible values for the GATT Proxy state.
Config server Model Application Unbind event parameter structure.
config_net_beacon_state_t
Possible values for the network beacon state.
Config server Network Transmit Set event parameter structure.
config_server_evt_type_t type
Type of event.
uint8_t page_number
Page-number for the composition data page to retrieve.
Config server Relay Set event parameter structure.
Config server GATT Proxy set event parameter structure.
config_friend_state_t
Possible values for the Friend state.
Config server Beacon State event parameter structure.
A vendor model subscription list was requested.
config_gatt_proxy_state_t proxy_state
The desired state of the GATT proxy service.
A subscription was added to the given model.
Configuration server event structure.
The given model was unbound from an application key.
Config server key refresh get parameter structure.
A new network key was added.
Config server identity set parameter structure.
uint16_t lpn_address
The unicast address of the Low Power node.
access_model_handle_t model_handle
Access model handle.
dsm_handle_t subnet_handle
Dsm subnet handle.
Secure network beacon state was requested.
A subscription to a virtual address was removed from the given model.
dsm_handle_t appkey_handle
Application key handle.
Config server Appkey Update event parameter structure.
uint16_t dsm_handle_t
DSM handle type, used for the handles returned for the each set of data added.
Config server Network Key Update event parameter structure.
dsm_handle_t address_handle
DSM address handle.
Received an vendor model application get request.
Key refresh state was requested.
Publication to a virtual address for a given model was set.
Config server Heartbeat Subscription Set event parameter structure.
The given application key was deleted.
GATT proxy parameters was set (not supported).
The node was reset, i.e., all mesh state cleared.
access_model_handle_t model_handle
Access model handle.
All subscriptions was overwritten by a new subscription for the given model.
Config server low power node polltimeout get event parameter structure.
The Node Identity was set (not supported).
Core relay parameters was set.
Config server Appkey Delete event parameter structure.
Config server model app get parameter structure.
Recieved a low power node poll timeout request (not supported).
access_model_handle_t model_handle
Access model handle.
config_friend_state_t friend_state
Friendship state.
Config server publication get parameter structure.
Model publication parameters was requested.
A subscription to a virtual address was added to the given model.
access_model_handle_t model_handle
Access model handle.
All network key info was requested.
Received a network transmit get request.
access_model_handle_t model_handle
Access model handle.
A model subscription list was requested.
config_msg_key_index_12_t netkey_index
Network key to report application keys for.
dsm_handle_t appkey_handle
Application key handle.
Config server Network Key Add event parameter structure.
access_model_handle_t model_handle
Access model handle.
void(* config_server_evt_cb_t)(const config_server_evt_t *p_evt)
Config server event callback type.
Config server composition data get parameter structure.
Default TTL value was requested.
uint8_t interval_steps
Number of interval steps between each re-transmission (10 ms/step).
A network key was updated.
config_relay_state_t
Values for the relay state.
dsm_handle_t appkey_handle
Application key handle.
Heartbeat subscription parameters was set.
nrf_mesh_key_refresh_phase_t
Key refresh phase.
Definition: nrf_mesh.h:225
GATT proxy state was requested (not supported).
Heartbeat publication parameters was requested.
Config server Subscription Delete event parameter structure.
dsm_handle_t appkey_handle
Application key handle.
Config server Subscription Overwrite event parameter structure.
config_msg_key_index_12_t netkey_index
Subnet index.
Config server model subscription get parameter structure.
Friendship parameters was requested (not supported).
Received a node identify get request (not supported).
config_msg_key_index_12_t netkey_index
Subnet index.
Config server Subscription Delete All event parameter structure.
Config server Key Refresh Phase Set event parameter structure.
Config server appkey get parameter structure.
uint8_t retransmit_count
Number of retransmissions for each network PDU.
Core network transmission parameters was set.
The given model was bound to a new application key.
dsm_handle_t subnet_handle
Dsm subnet handle.
access_model_handle_t model_handle
Access model handle.
A new default TTL value was set.
Config server Model Publication Set event parameter structure.
Config server Appkey Add event parameter structure.
Secure network beacon parameters was set.
Friendship parameters was set (not supported).
Config server Default TTL Set event parameter structure.
Config server Model Application Bind event parameter structure.
config_server_evt_type_t
Relay parameters was requested.
Config server Network Key delete event parameter structure.
Config server Heartbeat Publication Set event parameter structure.
A subscription was deleted from the given model.
Received an SIG model application get request.
Heartbeat subscription parameters was requested.
Composition data was requested.
uint16_t config_msg_key_index_12_t
12-bit key index type.
A new application key was added.
nrf_mesh_key_refresh_phase_t kr_phase
Current key refresh phase.
An existing application key was updated.

Documentation feedback | Developer Zone | Subscribe | Updated