BT Mesh Configuration Task#

btmesh_conf_task_id_t#

btmesh_conf_task_id_t

BT Mesh Configuration Task identifiers.

btmesh_conf_task_id_t#

typedef enum btmesh_conf_task_id_t btmesh_conf_task_id_t

BT Mesh Configuration Task identifiers.

btmesh_conf_task_ext_t#

typedef union btmesh_conf_task_ext_t btmesh_conf_task_ext_t

Union of BT Mesh Configuration Task specific data structures.

btmesh_conf_task_t#

typedef struct btmesh_conf_task_t btmesh_conf_task_t

btmesh_conf_task_create#

btmesh_conf_task_t * btmesh_conf_task_create (btmesh_conf_task_id_t task_id)

Create generic BT Mesh Configuration Task

Returns

• Created configuration task.

Return values

• NULL: If the configuration task creation fails.

Allocates and initializes a generic configuration task. Warnings

• This function shall be called from derived (specific) configuration task create functions only to create an initialized task instance which is further customized by the specific configuration task create function. For example btmesh_conf_task_appkey_add_create.

btmesh_conf_task_destroy#

void btmesh_conf_task_destroy (btmesh_conf_task_t * self)

Deallocates the BT Mesh Configuration Task instance

If btmesh_conf_task_t::next_on_success or btmesh_conf_task_t::next_on_failure is set then those tasks are destroyed as well.

btmesh_conf_task_set_next_unconditional#

sl_status_t btmesh_conf_task_set_next_unconditional (btmesh_conf_task_t * self, btmesh_conf_task_t *const next_task)

Set next task pointers of the BT Mesh Configuration Task to the specified other task.

Returns

• Status of next task setup.

Return values

• SL_STATUS_OK: If the next task is set successfully.

• SL_STATUS_NULL_POINTER: If

• SL_STATUS_INVALID_PARAMETER: If the

The task which shall be executed after the end of self task is set to next_task. The next_task is independent from the result of self task.

Warnings

• It is expected that the next_task does not have any next task when this function is called in order to guarantee that there will be no cyclic references in the task tree. Therefore, the task tree shall be built in the order of execution. This is enforced by the implementation and SL_STATUS_INVALID_PARAMETER is returned if this rule is not respected.

btmesh_conf_task_set_next_on_success#

sl_status_t btmesh_conf_task_set_next_on_success (btmesh_conf_task_t * self, btmesh_conf_task_t *const next_task)

Set next task pointer of the BT Mesh Configuration Task to the specified other task if this task is completed successfully.

Returns

• Status of next task setup.

Return values

• SL_STATUS_OK: If the next task is set successfully.

• SL_STATUS_NULL_POINTER: If

• SL_STATUS_INVALID_PARAMETER: If the

Warnings

• It is expected that the next_task does not have any next task when this function is called in order to guarantee that there will be no cyclic references in the task tree. Therefore, the task tree shall be built in the order of execution. This is enforced by the implementation and SL_STATUS_INVALID_PARAMETER is returned if this rule is not respected.

btmesh_conf_task_set_next_on_failure#

sl_status_t btmesh_conf_task_set_next_on_failure (btmesh_conf_task_t * self, btmesh_conf_task_t *const next_task)

Set next task pointer of the BT Mesh Configuration Task to the specified other task if this task fails.

Returns

• Status of next task setup.

Return values

• SL_STATUS_OK: If the next task is set successfully.

• SL_STATUS_NULL_POINTER: If

• SL_STATUS_INVALID_PARAMETER: If the

Warnings

• It is expected that the next_task does not have any next task when this function is called in order to guarantee that there will be no cyclic references in the task tree. Therefore, the task tree shall be built in the order of execution. This is enforced by the implementation and SL_STATUS_INVALID_PARAMETER is returned if this rule is not respected.

btmesh_conf_task_appkey_add_create#

btmesh_conf_task_t * btmesh_conf_task_appkey_add_create (uint16_t appkey_index, uint16_t netkey_index)

Create BT Mesh Configuration Task to add an application key to a node.

Returns

• Created configuration task.

Return values

• NULL: If the configuration task creation fails.

btmesh_conf_task_appkey_add_destroy#

void btmesh_conf_task_appkey_add_destroy (btmesh_conf_task_t * self)

Deallocation of Add Application Key BT Mesh Configuration Task instance.

If btmesh_conf_task_t::next_on_success or btmesh_conf_task_t::next_on_failure is set then those tasks are destroyed as well.

btmesh_conf_task_appkey_remove_create#

btmesh_conf_task_t * btmesh_conf_task_appkey_remove_create (uint16_t appkey_index, uint16_t netkey_index)

Create BT Mesh Configuration Task to remove an application key from a node.

Returns

• Created configuration task.

Return values

• NULL: If the configuration task creation fails.

btmesh_conf_task_appkey_remove_destroy#

void btmesh_conf_task_appkey_remove_destroy (btmesh_conf_task_t * self)

Deallocation of Remove Application Key BT Mesh Configuration Task instance.

If btmesh_conf_task_t::next_on_success or btmesh_conf_task_t::next_on_failure is set then those tasks are destroyed as well.

btmesh_conf_task_appkey_list_create#

btmesh_conf_task_t * btmesh_conf_task_appkey_list_create (uint16_t netkey_index)

Create BT Mesh Configuration Task to list the application keys on a node.

Returns

• Created configuration task.

Return values

• NULL: If the configuration task creation fails.

btmesh_conf_task_appkey_list_destroy#

void btmesh_conf_task_appkey_list_destroy (btmesh_conf_task_t * self)

Deallocation of List Application Keys BT Mesh Configuration Task instance.

If btmesh_conf_task_t::next_on_success or btmesh_conf_task_t::next_on_failure is set then those tasks are destroyed as well.

btmesh_conf_task_model_bind_create#

btmesh_conf_task_t * btmesh_conf_task_model_bind_create (uint8_t elem_index, uint16_t vendor_id, uint16_t model_id, uint16_t appkey_index)

Create BT Mesh Configuration Task to bind an application key to a model.

Returns

• Created configuration task.

Return values

• NULL: If the configuration task creation fails.

btmesh_conf_task_model_bind_destroy#

void btmesh_conf_task_model_bind_destroy (btmesh_conf_task_t * self)

Deallocation of Bind Model BT Mesh Configuration Task instance.

If btmesh_conf_task_t::next_on_success or btmesh_conf_task_t::next_on_failure is set then those tasks are destroyed as well.

btmesh_conf_task_model_unbind_create#

btmesh_conf_task_t * btmesh_conf_task_model_unbind_create (uint8_t elem_index, uint16_t vendor_id, uint16_t model_id, uint16_t appkey_index)

Create BT Mesh Configuration Task to unbind an application key from a model.

Returns

• Created configuration task.

Return values

• NULL: If the configuration task creation fails.

btmesh_conf_task_model_unbind_destroy#

void btmesh_conf_task_model_unbind_destroy (btmesh_conf_task_t * self)

Deallocation of Unbind Model BT Mesh Configuration Task instance.

If btmesh_conf_task_t::next_on_success or btmesh_conf_task_t::next_on_failure is set then those tasks are destroyed as well.

btmesh_conf_task_model_bindings_list_create#

btmesh_conf_task_t * btmesh_conf_task_model_bindings_list_create (uint8_t elem_index, uint16_t vendor_id, uint16_t model_id)

Create BT Mesh Configuration Task to list application key bindings of a model.

Returns

• Created configuration task.

Return values

• NULL: If the configuration task creation fails.

btmesh_conf_task_model_bindings_list_destroy#

void btmesh_conf_task_model_bindings_list_destroy (btmesh_conf_task_t * self)

Deallocation of BT List Model Bindings Mesh Configuration Task instance.

If btmesh_conf_task_t::next_on_success or btmesh_conf_task_t::next_on_failure is set then those tasks are destroyed as well.

btmesh_conf_task_model_pub_set_create#

btmesh_conf_task_t * btmesh_conf_task_model_pub_set_create (uint8_t elem_index, uint16_t vendor_id, uint16_t model_id, uint16_t address, uint16_t appkey_index, uint8_t credentials, uint8_t ttl, uint32_t period_ms, uint8_t retransmit_count, uint16_t retransmit_interval_ms)

Create BT Mesh Configuration Task to set the model publication state.

Returns

• Created configuration task.

Return values

• NULL: If the configuration task creation fails.

btmesh_conf_task_model_pub_set_destroy#

void btmesh_conf_task_model_pub_set_destroy (btmesh_conf_task_t * self)

Deallocation of Set Model Publication BT Mesh Configuration Task instance.

If btmesh_conf_task_t::next_on_success or btmesh_conf_task_t::next_on_failure is set then those tasks are destroyed as well.

btmesh_conf_task_model_pub_get_create#

btmesh_conf_task_t * btmesh_conf_task_model_pub_get_create (uint8_t elem_index, uint16_t vendor_id, uint16_t model_id)

Create BT Mesh Configuration Task to get the model publication state.

Returns

• Created configuration task.

Return values

• NULL: If the configuration task creation fails.

btmesh_conf_task_model_pub_get_destroy#

void btmesh_conf_task_model_pub_get_destroy (btmesh_conf_task_t * self)

Deallocation of Get Model Publication BT Mesh Configuration Task instance.

If btmesh_conf_task_t::next_on_success or btmesh_conf_task_t::next_on_failure is set then those tasks are destroyed as well.

btmesh_conf_task_model_sub_add_create#

btmesh_conf_task_t * btmesh_conf_task_model_sub_add_create (uint8_t elem_index, uint16_t vendor_id, uint16_t model_id, uint16_t sub_address)

Create BT Mesh Configuration Task to add an address to the model subscription list.

Returns

• Created configuration task.

Return values

• NULL: If the configuration task creation fails.

btmesh_conf_task_model_sub_add_destroy#

void btmesh_conf_task_model_sub_add_destroy (btmesh_conf_task_t * self)

Deallocation of Add Model Subscription BT Mesh Configuration Task instance.

If btmesh_conf_task_t::next_on_success or btmesh_conf_task_t::next_on_failure is set then those tasks are destroyed as well.

btmesh_conf_task_model_sub_set_create#

btmesh_conf_task_t * btmesh_conf_task_model_sub_set_create (uint8_t elem_index, uint16_t vendor_id, uint16_t model_id, uint16_t sub_address)

Create BT Mesh Configuration Task to set (overwrite) model subscription address list to a single address. See Config Model Subscription Overwrite BT Mesh message in foundation models chapter of BT Mesh Profile Specification.

Returns

• Created configuration task.

Return values

• NULL: If the configuration task creation fails.

btmesh_conf_task_model_sub_set_destroy#

void btmesh_conf_task_model_sub_set_destroy (btmesh_conf_task_t * self)

Deallocation of Set Model Subscription BT Mesh Configuration Task instance.

If btmesh_conf_task_t::next_on_success or btmesh_conf_task_t::next_on_failure is set then those tasks are destroyed as well.

btmesh_conf_task_model_sub_remove_create#

btmesh_conf_task_t * btmesh_conf_task_model_sub_remove_create (uint8_t elem_index, uint16_t vendor_id, uint16_t model_id, uint16_t sub_address)

Create BT Mesh Configuration Task to remove an address from the model subscription list.

Returns

• Created configuration task.

Return values

• NULL: If the configuration task creation fails.

btmesh_conf_task_model_sub_remove_destroy#

void btmesh_conf_task_model_sub_remove_destroy (btmesh_conf_task_t * self)

Deallocation of Remove Model Subscription BT Mesh Configuration Task instance.

If btmesh_conf_task_t::next_on_success or btmesh_conf_task_t::next_on_failure is set then those tasks are destroyed as well.

btmesh_conf_task_model_sub_clear_create#

btmesh_conf_task_t * btmesh_conf_task_model_sub_clear_create (uint8_t elem_index, uint16_t vendor_id, uint16_t model_id)

Create BT Mesh Configuration Task to clear (empty) the model subscription address list.

Returns

• Created configuration task.

Return values

• NULL: If the configuration task creation fails.

btmesh_conf_task_model_sub_clear_destroy#

void btmesh_conf_task_model_sub_clear_destroy (btmesh_conf_task_t * self)

Deallocation of Clear Model Subscription List BT Mesh Configuration Task instance.

If btmesh_conf_task_t::next_on_success or btmesh_conf_task_t::next_on_failure is set then those tasks are destroyed as well.

btmesh_conf_task_model_sub_list_create#

btmesh_conf_task_t * btmesh_conf_task_model_sub_list_create (uint8_t elem_index, uint16_t vendor_id, uint16_t model_id)

Create BT Mesh Configuration Task to get the subscription address list of a model.

Returns

• Created configuration task.

Return values

• NULL: If the configuration task creation fails.

btmesh_conf_task_model_sub_list_destroy#

void btmesh_conf_task_model_sub_list_destroy (btmesh_conf_task_t * self)

Deallocation of List Model Subscription BT Mesh Configuration Task instance.

If btmesh_conf_task_t::next_on_success or btmesh_conf_task_t::next_on_failure is set then those tasks are destroyed as well.

btmesh_conf_task_beacon_set_create#

btmesh_conf_task_t * btmesh_conf_task_beacon_set_create (uint8_t value)

Create BT Mesh Configuration Task to set node beacon state.

Returns

• Created configuration task.

Return values

• NULL: If the configuration task creation fails.

btmesh_conf_task_beacon_set_destroy#

void btmesh_conf_task_beacon_set_destroy (btmesh_conf_task_t * self)

Deallocation of Set Beacon BT Mesh Configuration Task instance.

If btmesh_conf_task_t::next_on_success or btmesh_conf_task_t::next_on_failure is set then those tasks are destroyed as well.

btmesh_conf_task_beacon_get_create#

btmesh_conf_task_t * btmesh_conf_task_beacon_get_create (void )

Create BT Mesh Configuration Task to get node beacon state.

Returns

• Created configuration task.

Return values

• NULL: If the configuration task creation fails.

btmesh_conf_task_beacon_get_destroy#

void btmesh_conf_task_beacon_get_destroy (btmesh_conf_task_t * self)

Deallocation of Get Beacon BT Mesh Configuration Task instance.

If btmesh_conf_task_t::next_on_success or btmesh_conf_task_t::next_on_failure is set then those tasks are destroyed as well.

btmesh_conf_task_default_ttl_set_create#

btmesh_conf_task_t * btmesh_conf_task_default_ttl_set_create (uint8_t default_ttl)

Create BT Mesh Configuration Task to set node default TTL state.

Returns

• Created configuration task.

Return values

• NULL: If the configuration task creation fails.

btmesh_conf_task_default_ttl_set_destroy#

void btmesh_conf_task_default_ttl_set_destroy (btmesh_conf_task_t * self)

Deallocation of Set Default TTL BT Mesh Configuration Task instance.

If btmesh_conf_task_t::next_on_success or btmesh_conf_task_t::next_on_failure is set then those tasks are destroyed as well.

btmesh_conf_task_default_ttl_get_create#

btmesh_conf_task_t * btmesh_conf_task_default_ttl_get_create (void )

Create BT Mesh Configuration Task to get node default TTL state.

Returns

• Created configuration task.

Return values

• NULL: If the configuration task creation fails.

btmesh_conf_task_default_ttl_get_destroy#

void btmesh_conf_task_default_ttl_get_destroy (btmesh_conf_task_t * self)

Deallocation of Get Default TTL BT Mesh Configuration Task instance.

If btmesh_conf_task_t::next_on_success or btmesh_conf_task_t::next_on_failure is set then those tasks are destroyed as well.

btmesh_conf_task_gatt_proxy_set_create#

btmesh_conf_task_t * btmesh_conf_task_gatt_proxy_set_create (uint8_t value)

Create BT Mesh Configuration Task to set node GATT proxy state.

Returns

• Created configuration task.

Return values

• NULL: If the configuration task creation fails.

btmesh_conf_task_gatt_proxy_set_destroy#

void btmesh_conf_task_gatt_proxy_set_destroy (btmesh_conf_task_t * self)

Deallocation of Set GATT Proxy BT Mesh Configuration Task instance.

If btmesh_conf_task_t::next_on_success or btmesh_conf_task_t::next_on_failure is set then those tasks are destroyed as well.

btmesh_conf_task_gatt_proxy_get_create#

btmesh_conf_task_t * btmesh_conf_task_gatt_proxy_get_create (void )

Create BT Mesh Configuration Task to get node GATT proxy state.

Returns

• Created configuration task.

Return values

• NULL: If the configuration task creation fails.

btmesh_conf_task_gatt_proxy_get_destroy#

void btmesh_conf_task_gatt_proxy_get_destroy (btmesh_conf_task_t * self)

Deallocation of Get GATT Proxy BT Mesh Configuration Task instance.

If btmesh_conf_task_t::next_on_success or btmesh_conf_task_t::next_on_failure is set then those tasks are destroyed as well.

btmesh_conf_task_relay_set_create#

btmesh_conf_task_t * btmesh_conf_task_relay_set_create (uint8_t value, uint8_t retransmit_count, uint16_t retransmit_interval_ms)

Create BT Mesh Configuration Task to set node relay state.

Returns

• Created configuration task.

Return values

• NULL: If the configuration task creation fails.

btmesh_conf_task_relay_set_destroy#

void btmesh_conf_task_relay_set_destroy (btmesh_conf_task_t * self)

Deallocation of Set Relay BT Mesh Configuration Task instance.

If btmesh_conf_task_t::next_on_success or btmesh_conf_task_t::next_on_failure is set then those tasks are destroyed as well.

btmesh_conf_task_relay_get_create#

btmesh_conf_task_t * btmesh_conf_task_relay_get_create (void )

Create BT Mesh Configuration Task to get node relay state.

Returns

• Created configuration task.

Return values

• NULL: If the configuration task creation fails.

btmesh_conf_task_relay_get_destroy#

void btmesh_conf_task_relay_get_destroy (btmesh_conf_task_t * self)

Deallocation of Get Relay BT Mesh Configuration Task instance.

If btmesh_conf_task_t::next_on_success or btmesh_conf_task_t::next_on_failure is set then those tasks are destroyed as well.

btmesh_conf_task_network_transmit_set_create#

btmesh_conf_task_t * btmesh_conf_task_network_transmit_set_create (uint8_t transmit_count, uint16_t transmit_interval_ms)

Create BT Mesh Configuration Task to set node network transmit state.

Returns

• Created configuration task.

Return values

• NULL: If the configuration task creation fails.

btmesh_conf_task_network_transmit_set_destroy#

void btmesh_conf_task_network_transmit_set_destroy (btmesh_conf_task_t * self)

Deallocation of Set Network Transmit BT Mesh Configuration Task instance.

If btmesh_conf_task_t::next_on_success or btmesh_conf_task_t::next_on_failure is set then those tasks are destroyed as well.

btmesh_conf_task_network_transmit_get_create#

btmesh_conf_task_t * btmesh_conf_task_network_transmit_get_create (void )

Create BT Mesh Configuration Task to get node network transmit state.

Returns

• Created configuration task.

Return values

• NULL: If the configuration task creation fails.

btmesh_conf_task_network_transmit_get_destroy#

void btmesh_conf_task_network_transmit_get_destroy (btmesh_conf_task_t * self)

Deallocation of Get Network Transmit BT Mesh Configuration Task instance.

If btmesh_conf_task_t::next_on_success or btmesh_conf_task_t::next_on_failure is set then those tasks are destroyed as well.

btmesh_conf_task_friend_set_create#

btmesh_conf_task_t * btmesh_conf_task_friend_set_create (uint8_t value)

Create BT Mesh Configuration Task to set node friend state.

Returns

• Created configuration task.

Return values

• NULL: If the configuration task creation fails.

btmesh_conf_task_friend_set_destroy#

void btmesh_conf_task_friend_set_destroy (btmesh_conf_task_t * self)

Deallocation of Set Friend BT Mesh Configuration Task instance.

If btmesh_conf_task_t::next_on_success or btmesh_conf_task_t::next_on_failure is set then those tasks are destroyed as well.

btmesh_conf_task_friend_get_create#

btmesh_conf_task_t * btmesh_conf_task_friend_get_create (void )

Create BT Mesh Configuration Task to get node friend state.

Returns

• Created configuration task.

Return values

• NULL: If the configuration task creation fails.

btmesh_conf_task_friend_get_destroy#

void btmesh_conf_task_friend_get_destroy (btmesh_conf_task_t * self)

Deallocation of Get Friend BT Mesh Configuration Task instance.

If btmesh_conf_task_t::next_on_success or btmesh_conf_task_t::next_on_failure is set then those tasks are destroyed as well.

btmesh_conf_task_dcd_get_create#

btmesh_conf_task_t * btmesh_conf_task_dcd_get_create (uint8_t page)

Create BT Mesh Configuration Task to get composition data of a device.

Returns

• Created configuration task.

Return values

• NULL: If the configuration task creation fails.

btmesh_conf_task_dcd_get_destroy#

void btmesh_conf_task_dcd_get_destroy (btmesh_conf_task_t * self)

Deallocation of Get DCD BT Mesh Configuration Task instance.

If btmesh_conf_task_t::next_on_success or btmesh_conf_task_t::next_on_failure is set then those tasks are destroyed as well.

btmesh_conf_task_reset_node_create#

btmesh_conf_task_t * btmesh_conf_task_reset_node_create (void )

Create BT Mesh Configuration Task to request a node to unprovision itself. Use this function when a node shall be removed from the network.

Returns

• Created configuration task.

Return values

• NULL: If the configuration task creation fails.

btmesh_conf_task_reset_node_destroy#

void btmesh_conf_task_reset_node_destroy (btmesh_conf_task_t * self)

Deallocation of Reset Node BT Mesh Configuration Task instance.

If btmesh_conf_task_t::next_on_success or btmesh_conf_task_t::next_on_failure is set then those tasks are destroyed as well.