Provisioning Decorator#
The Provisioning Decorator is an application-level software module that ensures callbacks at main provisioning process steps. There are callbacks for initialization phase, for starting and successful finishing or for failed provisioning. A general callback for handling Provisioning Decorator events is also available. This component is prepared for integration into SOC applications. This is a No-Code component, it automatically handles retries after failed provisioning attempts. Additionally, the following weak callbacks can be implemented in Low-Code fashion to handle different stages of the provisioning process: - void sl_btmesh_on_provision_init_status(bool provisioned, uint16_t address, uint32_t iv_index) - void sl_btmesh_on_node_provisioning_started(uint16_t result) - void sl_btmesh_on_node_provisioned(uint16_t address, uint32_t iv_index) - void sl_btmesh_on_node_provisioning_failed(uint16_t result)
Functions#
Function Documentation#
sl_btmesh_on_provision_init_status#
void sl_btmesh_on_provision_init_status (bool provisioned, uint16_t address, uint32_t iv_index)
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| bool | [in] | provisioned | true: provisioned, false: unprovisioned |
| uint16_t | [in] | address | Unicast address of the primary element of the node. Ignored if unprovisioned. |
| uint32_t | [in] | iv_index | IV index for the first network of the node Ignored if unprovisioned. |
Callbacks Called at node initialization time to provide provisioning information
This is a callback which can be implemented in the application. Note
If no implementation is provided in the application, then the default weak implementation will be an empty function.
sl_btmesh_on_node_provisioning_started#
void sl_btmesh_on_node_provisioning_started (uint16_t result)
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint16_t | [in] | result | Result code. 0: success, non-zero: error |
Called when the Provisioning starts
This is a callback which can be implemented in the application. Note
If no implementation is provided in the application, then the default weak implementation will be an empty function.
sl_btmesh_on_node_provisioned#
void sl_btmesh_on_node_provisioned (uint16_t address, uint32_t iv_index)
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint16_t | [in] | address | Unicast address of the primary element of the node. Ignored if unprovisioned. |
| uint32_t | [in] | iv_index | IV index for the first network of the node Ignored if unprovisioned. |
Called when the Provisioning finishes successfully
This is a callback which can be implemented in the application. Note
If no implementation is provided in the application, then the default weak implementation will be an empty function.
sl_btmesh_on_node_provisioning_failed#
void sl_btmesh_on_node_provisioning_failed (uint16_t result)
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint16_t | [in] | result | Result code. 0: success, non-zero: error |
Called when the Provisioning fails
This is a callback which can be implemented in the application. Note
If no implementation is provided in the application, then the default weak implementation will be an empty function.
sl_btmesh_handle_provisioning_decorator_event#
void sl_btmesh_handle_provisioning_decorator_event (sl_btmesh_msg_t * evt)
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_btmesh_msg_t * | [in] | evt | Pointer to the event type |
Functions which are automatically called when the component is selected Handling of Provisioning Decorator stack events.