Core mesh type definitions. More...
Data Structures | |
| struct | nrf_mesh_rx_metadata_scanner_t |
| Metadata structure for packets received with the scanner. More... | |
| struct | nrf_mesh_instaburst_event_id_t |
| Event ID for an extended advertising event with Instaburst. More... | |
| struct | nrf_mesh_rx_metadata_instaburst_t |
| Metadata structure for packets received with Instaburst. More... | |
| struct | nrf_mesh_rx_metadata_gatt_t |
| struct | nrf_mesh_rx_metadata_loopback_t |
| Metadata structure for packets that originated on this device. More... | |
| struct | nrf_mesh_rx_metadata_t |
| RX packet metadata. More... | |
| struct | nrf_mesh_adv_packet_rx_data_t |
| Arguments structure for the RX callback function. More... | |
| struct | nrf_mesh_application_secmat_t |
| Application security material structure. More... | |
| struct | nrf_mesh_network_secmat_t |
| Network security material structure. More... | |
| struct | nrf_mesh_beacon_secmat_t |
| Security material for the Bluetooth Mesh network beacons. More... | |
| struct | nrf_mesh_beacon_tx_info_t |
| Run-time transmission information for individual beacons. More... | |
| struct | nrf_mesh_beacon_info_t |
| Information structure for the Bluetooth Mesh network beacons. More... | |
| struct | nrf_mesh_secmat_t |
| Bluetooth Mesh security material structure. More... | |
| struct | nrf_mesh_address_t |
| Bluetooth Mesh address. More... | |
| struct | nrf_mesh_tx_params_t |
| Mesh packet transmission parameters. More... | |
| struct | nrf_mesh_init_params_t |
| Initialization parameters structure. More... | |
Typedefs | |
| typedef void(* | nrf_mesh_assertion_handler_t) (uint32_t pc) |
| Mesh assertion handler type. More... | |
| typedef uint32_t | nrf_mesh_tx_token_t |
| TX Token type, used as a context parameter to notify the application of ended transmissions. More... | |
| typedef bool(* | nrf_mesh_relay_check_cb_t) (uint16_t src, uint16_t dst, uint8_t ttl) |
| Callback function type for checking if a given packet should be relayed on to other nodes. More... | |
| typedef void(* | nrf_mesh_rx_cb_t) (const nrf_mesh_adv_packet_rx_data_t *p_rx_data) |
| Advertisement received callback function type. More... | |
Enumerations | |
| enum | nrf_mesh_rx_source_t { NRF_MESH_RX_SOURCE_SCANNER, NRF_MESH_RX_SOURCE_GATT, NRF_MESH_RX_SOURCE_INSTABURST, NRF_MESH_RX_SOURCE_LOOPBACK } |
| RX packet type. More... | |
| enum | nrf_mesh_key_refresh_phase_t { NRF_MESH_KEY_REFRESH_PHASE_0, NRF_MESH_KEY_REFRESH_PHASE_1, NRF_MESH_KEY_REFRESH_PHASE_2, NRF_MESH_KEY_REFRESH_PHASE_3 } |
| Key refresh phase. More... | |
| enum | net_state_iv_update_t { NET_STATE_IV_UPDATE_NORMAL, NET_STATE_IV_UPDATE_IN_PROGRESS } |
| State of IV update procedure. More... | |
| enum | nrf_mesh_address_type_t { NRF_MESH_ADDRESS_TYPE_INVALID, NRF_MESH_ADDRESS_TYPE_UNICAST, NRF_MESH_ADDRESS_TYPE_VIRTUAL, NRF_MESH_ADDRESS_TYPE_GROUP } |
| Bluetooth Mesh address types. More... | |
| enum | nrf_mesh_transmic_size_t { NRF_MESH_TRANSMIC_SIZE_SMALL, NRF_MESH_TRANSMIC_SIZE_LARGE, NRF_MESH_TRANSMIC_SIZE_DEFAULT, NRF_MESH_TRANSMIC_SIZE_INVALID } |
| Message MIC size selection. More... | |
Core mesh type definitions.
| typedef void(* nrf_mesh_assertion_handler_t) (uint32_t pc) |
Mesh assertion handler type.
When an unexpected, fatal error occurs within the Mesh stack, it will call the Mesh assertion handler callback. The Mesh stack will be in an undefined state when this happens and the only way to recover will be to perform a reset, e.g. by using CMSIS NVIC_SystemReset().
| [in] | pc | The program counter of the failed assertion. |
Definition at line 102 of file nrf_mesh.h.
| typedef uint32_t nrf_mesh_tx_token_t |
TX Token type, used as a context parameter to notify the application of ended transmissions.
Definition at line 105 of file nrf_mesh.h.
| typedef bool(* nrf_mesh_relay_check_cb_t) (uint16_t src, uint16_t dst, uint8_t ttl) |
Callback function type for checking if a given packet should be relayed on to other nodes.
The mesh can be initialized with this callback if the application wants to have control over which packets should be relayed to other nodes. This is done by passing the function pointer to nrf_mesh_init via the nrf_mesh_init_params_t struct.
With the default behavior, the mesh will only relay new packets with a TTL larger than 1. This behavior is always applied in addition to the callback function.
| [in] | src | The packet source address. |
| [in] | dst | The packet destination address. |
| [in] | ttl | The time-to-live value for the packet (6-bits). |
true if the packet received should be relayed on to the other mesh nodes, false otherwise. Definition at line 198 of file nrf_mesh.h.
| typedef void(* nrf_mesh_rx_cb_t) (const nrf_mesh_adv_packet_rx_data_t *p_rx_data) |
Advertisement received callback function type.
This callback can be used to receive raw advertisement packets. This can be useful to listen for specific packets that are not handled by the mesh, such as beacon packets or regular BLE advertisements.
| [in] | p_rx_data | Received advertisement packet data and metadata. |
Definition at line 218 of file nrf_mesh.h.
| enum nrf_mesh_rx_source_t |
RX packet type.
Definition at line 108 of file nrf_mesh.h.
Key refresh phase.
Definition at line 225 of file nrf_mesh.h.
State of IV update procedure.
| Enumerator | |
|---|---|
| NET_STATE_IV_UPDATE_NORMAL | In normal operation. |
| NET_STATE_IV_UPDATE_IN_PROGRESS | IV update procedure in progress. |
Definition at line 341 of file nrf_mesh.h.
Bluetooth Mesh address types.
Bluetooth Mesh defines 3 address types:
0xxx xxxx xxxx xxxx
10xx xxxx xxxx xxxx
11xx xxxx xxxx xxxx
| Enumerator | |
|---|---|
| NRF_MESH_ADDRESS_TYPE_INVALID | Invalid address. |
| NRF_MESH_ADDRESS_TYPE_UNICAST | Unicast address. |
| NRF_MESH_ADDRESS_TYPE_VIRTUAL | Virtual address. |
| NRF_MESH_ADDRESS_TYPE_GROUP | Group address. |
Definition at line 357 of file nrf_mesh.h.
Message MIC size selection.
Definition at line 385 of file nrf_mesh.h.