Bluetooth Mesh Sensor Setup Server Model#

Bluetooth Mesh Sensor Setup Server Model.

This class provides the commands and messages to interface with the Sensor Setup Server model. Elements containing sensor model must have a setup server model attached. Therefore, it is initialized/deinitialized internally together with the server model.

Modules#

sl_btmesh_evt_sensor_setup_server_get_cadence_request

sl_btmesh_evt_sensor_setup_server_set_cadence_request

sl_btmesh_evt_sensor_setup_server_get_settings_request

sl_btmesh_evt_sensor_setup_server_get_setting_request

sl_btmesh_evt_sensor_setup_server_set_setting_request

sl_btmesh_evt_sensor_setup_server_publish

Functions#

sl_status_t
sl_btmesh_sensor_setup_server_send_cadence_status(uint16_t client_address, uint16_t elem_index, uint16_t appkey_index, uint8_t flags, uint16_t property_id, size_t params_len, const uint8_t *params)
sl_status_t
sl_btmesh_sensor_setup_server_send_settings_status(uint16_t client_address, uint16_t elem_index, uint16_t appkey_index, uint8_t flags, uint16_t property_id, size_t setting_ids_len, const uint8_t *setting_ids)
sl_status_t
sl_btmesh_sensor_setup_server_send_setting_status(uint16_t client_address, uint16_t elem_index, uint16_t appkey_index, uint8_t flags, uint16_t property_id, uint16_t setting_id, size_t raw_value_len, const uint8_t *raw_value)

Macros#

Function Documentation#

sl_btmesh_sensor_setup_server_send_cadence_status#

sl_status_t sl_btmesh_sensor_setup_server_send_cadence_status (uint16_t client_address, uint16_t elem_index, uint16_t appkey_index, uint8_t flags, uint16_t property_id, size_t params_len, const uint8_t * params)
Parameters
[in]client_address

Destination client address The address 0x0000 can be used to publish the message according model configuration instead of a direct reply.

[in]elem_index

Client model element index

[in]appkey_index

The application key index to use

[in]flags

No flags defined currently

[in]property_id

Property ID for the sensor. Range: 0x0001 - 0x0ffff for a specific device property, the value 0x0000 is prohibited.

[in]params_len

Length of data in params

[in]params

Optional byte array containing the serialized Sensor Cadence state, excluding the property ID. If not empty, the state consists of the following fields:

  • Fast Cadence Period Divisor, 7 bits

  • Status Trigger type, 1 bits (0 = discrete value, 1 = percentage)

  • Status Trigger Delta Down, variable length

  • Status Trigger Delta Up, variable length

  • Status Min Interval, 8 bits, representing a power of 2 milliseconds. Valid range is 0-26

  • Fast Cadence Low, variable length, lower bound for the fast cadence range

  • Low Cadence Low, variable length, higher bound for the fast cadence range

Reply to a Get/Set Cadence client request with a Cadence Status message. Only Cadence Set (acknowledged) must be answered by sending the status message to the client. In addition, configuration changes must be published according to model publishing configuration.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.


Definition at line 12320 of file /mnt/raid/workspaces/ws.cynwT2I6w/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h

sl_btmesh_sensor_setup_server_send_settings_status#

sl_status_t sl_btmesh_sensor_setup_server_send_settings_status (uint16_t client_address, uint16_t elem_index, uint16_t appkey_index, uint8_t flags, uint16_t property_id, size_t setting_ids_len, const uint8_t * setting_ids)
Parameters
[in]client_address

Destination client model address

[in]elem_index

Client model element index

[in]appkey_index

The application key index to use

[in]flags

No flags defined currently

[in]property_id

Property ID for the sensor. Range: 0x0001 - 0x0ffff for a specific device property, the value 0x0000 is prohibited.

[in]setting_ids_len

Length of data in setting_ids

[in]setting_ids

Array of 16-bit Setting Property IDs of the settings the given sensor has

Reply to a Get Settings client request with a Settings Status message.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.


Definition at line 12345 of file /mnt/raid/workspaces/ws.cynwT2I6w/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h

sl_btmesh_sensor_setup_server_send_setting_status#

sl_status_t sl_btmesh_sensor_setup_server_send_setting_status (uint16_t client_address, uint16_t elem_index, uint16_t appkey_index, uint8_t flags, uint16_t property_id, uint16_t setting_id, size_t raw_value_len, const uint8_t * raw_value)
Parameters
[in]client_address

Destination client model address

[in]elem_index

Client model element index

[in]appkey_index

The application key index to use

[in]flags

No flags defined currently

[in]property_id

Property ID for the sensor. Range: 0x0001 - 0x0ffff for a specific device property, the value 0x0000 is prohibited.

[in]setting_id

Sensor Setting Property ID field identifying the device property of a setting. Range: 0x0001 - 0xffff, 0x0000 is prohibited.

[in]raw_value_len

Length of data in raw_value

[in]raw_value

Sensor Setting raw value. Size and representation depends on the type defined by the Sensor Setting Property ID.

Reply to a Get/Set Setting client request with a Setting Status message. Only Set Setting (acknowledged) request must be answered by sending a reply to the unicast address of the sender. In addition, configuration changes must be published if model publishing is set up.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.


Definition at line 12375 of file /mnt/raid/workspaces/ws.cynwT2I6w/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h

Macro Definition Documentation#

sl_btmesh_cmd_sensor_setup_server_send_cadence_status_id#

#define sl_btmesh_cmd_sensor_setup_server_send_cadence_status_id
Value:
0x00480028

Definition at line 12053 of file /mnt/raid/workspaces/ws.cynwT2I6w/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h

sl_btmesh_cmd_sensor_setup_server_send_settings_status_id#

#define sl_btmesh_cmd_sensor_setup_server_send_settings_status_id
Value:
0x01480028

Definition at line 12054 of file /mnt/raid/workspaces/ws.cynwT2I6w/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h

sl_btmesh_cmd_sensor_setup_server_send_setting_status_id#

#define sl_btmesh_cmd_sensor_setup_server_send_setting_status_id
Value:
0x02480028

Definition at line 12055 of file /mnt/raid/workspaces/ws.cynwT2I6w/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h

sl_btmesh_rsp_sensor_setup_server_send_cadence_status_id#

#define sl_btmesh_rsp_sensor_setup_server_send_cadence_status_id
Value:
0x00480028

Definition at line 12056 of file /mnt/raid/workspaces/ws.cynwT2I6w/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h

sl_btmesh_rsp_sensor_setup_server_send_settings_status_id#

#define sl_btmesh_rsp_sensor_setup_server_send_settings_status_id
Value:
0x01480028

Definition at line 12057 of file /mnt/raid/workspaces/ws.cynwT2I6w/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h

sl_btmesh_rsp_sensor_setup_server_send_setting_status_id#

#define sl_btmesh_rsp_sensor_setup_server_send_setting_status_id
Value:
0x02480028

Definition at line 12058 of file /mnt/raid/workspaces/ws.cynwT2I6w/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h