Core Mesh API

Initial value of tokens.

Definition at line 63 of file nrf_mesh.h.

The upper border of the token values which are used for general communication.

Definition at line 65 of file nrf_mesh.h.

Reserved token values.

Beginning of the reserved friendship token range.

Used by the Core TX Friend to resolve the Friend Bearer.

Definition at line 73 of file nrf_mesh.h.

End of the reserved friendship token range.

Definition at line 75 of file nrf_mesh.h.

Initializes the Bluetooth Mesh stack.

Note

The Nordic Semiconductor SoftDevice must be initialized by the application before this function is called.

Calling this function only initializes the Mesh stack. To start transmitting and receiving messages, nrf_mesh_enable() must also be called. In addition, network and application keys must be added for the device to participate in a mesh network.

The Mesh is initialized with default parameters for the radio. To change these, use the options API, nrf_mesh_opt_set().

Warning

Enabling any proprietary extensions will break Bluetooth Mesh compatibility.

See also

nrf_mesh_enable(), nrf_mesh_opt_set()

Parameters

[in]

p_init_params

Pointer to initialization parameter structure.

Return values

NRF_SUCCESS	The mesh system was successfully initialized.
NRF_ERROR_SOFTDEVICE_NOT_ENABLED	The SoftDevice has not been enabled.
NRF_ERROR_INVALID_STATE	The mesh stack has already been initialized.
NRF_ERROR_NULL	The p_init_params parameter was NULL.

Enables the Mesh.

Note

Calling this function alone will not generate any events unless:

• Network and application keys have been added.
• At least one RX address has been added.

See also

nrf_mesh_rx_addr_add()

Return values

NRF_SUCCESS	The Mesh was started successfully.
NRF_ERROR_INVALID_STATE	The mesh was not initialized, see nrf_mesh_init().

Starts disabling the Mesh.

Calling this function will stop the Mesh, i.e, it will stop ordering time slots from the SoftDevice and will not generate events.

The mesh will produce an NRF_MESH_EVT_DISABLED once it has been fully disabled.

Warning

The mesh should be fully disabled before the Softdevice is disabled. If the application uses the Softdevice Handler module from the nRF5 SDK, this will be handled automatically. Otherwise, the application should wait for NRF_MESH_EVT_DISABLED before disabling the Softdevice.

Return values

NRF_SUCCESS	The Mesh was stopped successfully.
NRF_ERROR_INVALID_STATE	The mesh was already disabled.

Queues a mesh packet for transmission.

Note

Calling this function will give an NRF_MESH_EVT_TX_COMPLETE event when the packet has been sent on air. The parameter given with the event is the same reference as returned in p_packet_reference.

If the length of the message is greater than NRF_MESH_UNSEG_PAYLOAD_SIZE_MAX, the message will be sent as a segmented message and reassembled on the peer side.

Parameters

[in]	p_params	Pointer to a structure containing the parameters for the message to send.
[out]	p_packet_reference	Pointer to store a reference to the packet queued for transmission. This parameter may be set to NULL for ignoring the reference.

Return values

NRF_SUCCESS	The message was successfully queued for transmission.
NRF_ERROR_NO_MEM	A packet buffer could not be allocated for the packet. The application should try to send the packet again at a later point.
NRF_ERROR_INVALID_ADDR	The source address is not a unicast address, or the destination is invalid.
NRF_ERROR_INVALID_PARAM	TTL was larger than NRF_MESH_TTL_MAX.
NRF_ERROR_NULL	p_params is a NULL pointer or a required field of the struct (other than p_data) is NULL.
NRF_ERROR_FORBIDDEN	Failed to allocate a sequence number from network.
NRF_ERROR_INVALID_STATE	There's already a segmented packet that is being to sent to this destination. Wait for the transmission to finish before sending new segmented packets.

Runs the mesh packet processing process.

Calling this function allows the mesh to run. The mesh stack will process buffered incoming packets and send outgoing messages.

Note

This function must be called from the main loop if the mesh is configured to be running in NRF_MESH_IRQ_PRIORITY_THREAD, and only then. If the mesh in running in IRQ level, the processing will be triggered from inside the mesh, and this function must not be called.

During nrf_mesh_process(), all events generated by the Mesh will be directly forwarded to the application if it has registered an event callback using nrf_mesh_evt_handler_add().

Warning

The Mesh will discard any data as soon as it has passed it on to the application.

Return values

true	Processing is done, i.e. no more packets are pending. It is safe to go to sleep by calling sd_app_evt_wait().
false	Processing is not done, i.e. packets are still pending.

Pass SoftDevice SoC events to the Mesh.

Add this function in the SoC event dispatcher function used with the SoftDevice handler module (see softdevice_sys_evt_handler_set() softdevice_handler.h in the SDK).

Warning

It is vital for the Mesh to retrieve SoC events for it to function.

Parameters

[in]

sd_evt

SoftDevice SoC event.

Return values

NRF_SUCCESS

Event successfully received.

Set a callback which will be called for every received non-filtered packet.

The main BT Mesh packets are not filtered and will be passed to the callback.

See Packet filtering for the details about packet's filtering.

This function must be called after nrf_mesh_init().

Parameters

[in]

rx_cb

Receive callback function.

Notify the core stack that a subnet was added to the device.

Parameters

[in]	net_key_index	Key index of the added subnet.
[in]	p_network_id	Network ID of the added subnet.

Get unique token to be able to recognize tx complete events.

The function guarantees that the given token will no be intersected with tokens of services from the mesh stack.

Return values

32bits

unique token value.