Bluetooth Mesh Vendor Model#

sl_btmesh_vendor_model_options_t#

sl_btmesh_vendor_model_options_t

Key values to identify vendor model configuration options.

sl_btmesh_vendor_model_send#

sl_status_t sl_btmesh_vendor_model_send (uint16_t destination_address, int8_t va_index, uint16_t appkey_index, uint16_t elem_index, uint16_t vendor_id, uint16_t model_id, uint8_t nonrelayed, uint8_t opcode, uint8_t final, size_t payload_len, const uint8_t * payload)

Send vendor-specific data.

Note that, because of the bgapi event length restrictions, the message sent may need to be fragmented into several commands. If this is the case, the application must issue the commands in the correct order and mark the command carrying the last message fragment with the final flag set to a non-zero value. The stack will not start sending the message until the complete message is provided by the application. Fragments from multiple messages must not be interleaved.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_btmesh_vendor_model_set_publication#

sl_status_t sl_btmesh_vendor_model_set_publication (uint16_t elem_index, uint16_t vendor_id, uint16_t model_id, uint8_t opcode, uint8_t final, size_t payload_len, const uint8_t * payload)

Set the vendor model publication message.

The model publication message will be sent out when the model publication occurs either periodically (if the model is configured for periodic publishing) or explicitly (see sl_btmesh_vendor_model_publish.

Note that, because of bgapi length requirements, the message may need to be fragmented over multiple commands. If this is the case, the application must issue the commands in the correct order and mark the command carrying the last message fragment with the final flag set to a non-zero value. The stack will not assign the message to the model until the complete message is provided by the application.

To disable publication, the publication message may be erased using the sl_btmesh_vendor_model_clear_publication command.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_btmesh_vendor_model_clear_publication#

sl_status_t sl_btmesh_vendor_model_clear_publication (uint16_t elem_index, uint16_t vendor_id, uint16_t model_id)

Clear the vendor model publication message.

Clearing the model publication message disables model publishing, which can be re-enabled by defining the publication message using the sl_btmesh_vendor_model_set_publication command.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_btmesh_vendor_model_publish#

sl_status_t sl_btmesh_vendor_model_publish (uint16_t elem_index, uint16_t vendor_id, uint16_t model_id)

Publish the vendor model publication message.

Sends the stored publication message to the network using the application key and destination address stored in the model publication parameters.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_btmesh_vendor_model_init#

sl_status_t sl_btmesh_vendor_model_init (uint16_t elem_index, uint16_t vendor_id, uint16_t model_id, uint8_t publish, size_t opcodes_len, const uint8_t * opcodes)

Initialize the vendor model. This function has to be called before the model can be used. Note that the model can be deinitialized if it is no longer needed. See sl_btmesh_vendor_model_deinit.

Opcodes that the model is able to receive at initialization must be defined. This enables the stack to pass only valid messages up to the model during runtime. Per Mesh specification there are up to 64 opcodes per vendor, ranging from 0 to 63. Specifying opcodes outside of that range will result in an error response. Duplicate opcodes in the array do not result in an error, but will of course be recorded only once.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_btmesh_vendor_model_deinit#

sl_status_t sl_btmesh_vendor_model_deinit (uint16_t elem_index, uint16_t vendor_id, uint16_t model_id)

Deinitialize the model. After this call, the model cannot be used until it is initialized again. See sl_btmesh_vendor_model_init.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_btmesh_vendor_model_send_tracked#

sl_status_t sl_btmesh_vendor_model_send_tracked (uint16_t destination_address, int8_t va_index, uint16_t appkey_index, uint16_t elem_index, uint16_t vendor_id, uint16_t model_id, uint8_t nonrelayed, uint8_t segment, uint8_t opcode, uint8_t final, size_t payload_len, const uint8_t * payload, uint16_t * handle)

Send vendor-specific data with a delivery report.

This command works otherwise as sl_btmesh_vendor_model_send but also provides a tracking handle if there is no immediate local error. Once the message sending completes a sl_btmesh_evt_vendor_model_send_complete event is generated, and the handle received here can be used to correlate the event to the sent message.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_btmesh_vendor_model_set_publication_tracked#

sl_status_t sl_btmesh_vendor_model_set_publication_tracked (uint16_t elem_index, uint16_t vendor_id, uint16_t model_id, uint8_t segment, uint8_t opcode, uint8_t final, size_t payload_len, const uint8_t * payload, uint16_t * handle)

Set the vendor model publication message with a delivery report.

This command works otherwise as sl_btmesh_vendor_model_set_publication but also sets up a tracking handle for monitoring message delivery. When the message publishing completes a sl_btmesh_evt_vendor_model_send_complete event is generated, and the handle received here can be used to correlate the event to the sent message.

Note that the same tracking handle will be reported multiple times in case of periodic publication or publication retransmissions.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_btmesh_vendor_model_set_option#

sl_status_t sl_btmesh_vendor_model_set_option (uint8_t option, uint32_t value)

Set global vendor model configuration options.

This command sets global configuration options for all vendor models. Options take effect when models are initialized, so this command should be called before any sl_btmesh_vendor_model_init call.

Returns

• SL_STATUS_OK if successful. Error code otherwise.

sl_btmesh_cmd_vendor_model_send_id#

#define sl_btmesh_cmd_vendor_model_send_id

0x00190028

sl_btmesh_cmd_vendor_model_set_publication_id#

#define sl_btmesh_cmd_vendor_model_set_publication_id

0x01190028

sl_btmesh_cmd_vendor_model_clear_publication_id#

#define sl_btmesh_cmd_vendor_model_clear_publication_id

0x02190028

sl_btmesh_cmd_vendor_model_publish_id#

#define sl_btmesh_cmd_vendor_model_publish_id

0x03190028

sl_btmesh_cmd_vendor_model_init_id#

#define sl_btmesh_cmd_vendor_model_init_id

0x04190028

sl_btmesh_cmd_vendor_model_deinit_id#

#define sl_btmesh_cmd_vendor_model_deinit_id

0x05190028

sl_btmesh_cmd_vendor_model_send_tracked_id#

#define sl_btmesh_cmd_vendor_model_send_tracked_id

0x06190028

sl_btmesh_cmd_vendor_model_set_publication_tracked_id#

#define sl_btmesh_cmd_vendor_model_set_publication_tracked_id

0x07190028

sl_btmesh_cmd_vendor_model_set_option_id#

#define sl_btmesh_cmd_vendor_model_set_option_id

0x08190028

sl_btmesh_rsp_vendor_model_send_id#

#define sl_btmesh_rsp_vendor_model_send_id

0x00190028

sl_btmesh_rsp_vendor_model_set_publication_id#

#define sl_btmesh_rsp_vendor_model_set_publication_id

0x01190028

sl_btmesh_rsp_vendor_model_clear_publication_id#

#define sl_btmesh_rsp_vendor_model_clear_publication_id

0x02190028

sl_btmesh_rsp_vendor_model_publish_id#

#define sl_btmesh_rsp_vendor_model_publish_id

0x03190028

sl_btmesh_rsp_vendor_model_init_id#

#define sl_btmesh_rsp_vendor_model_init_id

0x04190028

sl_btmesh_rsp_vendor_model_deinit_id#

#define sl_btmesh_rsp_vendor_model_deinit_id

0x05190028

sl_btmesh_rsp_vendor_model_send_tracked_id#

#define sl_btmesh_rsp_vendor_model_send_tracked_id

0x06190028

sl_btmesh_rsp_vendor_model_set_publication_tracked_id#

#define sl_btmesh_rsp_vendor_model_set_publication_tracked_id

0x07190028

sl_btmesh_rsp_vendor_model_set_option_id#

#define sl_btmesh_rsp_vendor_model_set_option_id

0x08190028