cfg_cli.h File Reference

Configuration Client Model APIs. More...

#include <stdint.h>
#include <stdbool.h>

Go to the source code of this file.

Data Structures
struct	bt_mesh_cfg_cli_cb
	Mesh Configuration Client Status messages callback. More...
struct	bt_mesh_cfg_cli
	Mesh Configuration Client Model Context. More...
struct	bt_mesh_cfg_cli_mod_pub
	Model publication configuration parameters. More...
struct	bt_mesh_cfg_cli_hb_sub
	Heartbeat subscription configuration parameters. More...
struct	bt_mesh_cfg_cli_hb_pub
	Heartbeat publication configuration parameters. More...
struct	bt_mesh_comp_p0
	Parsed Composition data page 0 representation. More...
struct	bt_mesh_comp_p0_elem
	Composition data page 0 element representation. More...
struct	bt_mesh_comp_p1_elem
	Composition data page 1 element representation. More...
struct	bt_mesh_comp_p1_model_item
	Composition data page 1 model item representation. More...
struct	bt_mesh_comp_p1_item_short
	Extended Model Item in short representation. More...
struct	bt_mesh_comp_p1_item_long
	Extended Model Item in long representation. More...
struct	bt_mesh_comp_p1_ext_item
	Extended Model Item. More...
struct	bt_mesh_comp_p2_record
	Composition data page 2 record parsing structure. More...

Macros
#define	BT_MESH_MODEL_CFG_CLI(cli_data)
	Generic Configuration Client model composition data entry.
#define	BT_MESH_PUB_PERIOD_100MS(steps)   ((steps) & BIT_MASK(6))
	Helper macro to encode model publication period in units of 100ms.
#define	BT_MESH_PUB_PERIOD_SEC(steps)   (((steps) & BIT_MASK(6)) | (1 << 6))
	Helper macro to encode model publication period in units of 1 second.
#define	BT_MESH_PUB_PERIOD_10SEC(steps)   (((steps) & BIT_MASK(6)) | (2 << 6))
	Helper macro to encode model publication period in units of 10 seconds.
#define	BT_MESH_PUB_PERIOD_10MIN(steps)   (((steps) & BIT_MASK(6)) | (3 << 6))
	Helper macro to encode model publication period in units of 10 minutes.

Functions
int	bt_mesh_cfg_cli_node_reset (uint16_t net_idx, uint16_t addr, bool *status)
	Reset the target node and remove it from the network.
int	bt_mesh_cfg_cli_comp_data_get (uint16_t net_idx, uint16_t addr, uint8_t page, uint8_t *rsp, struct net_buf_simple *comp)
	Get the target node's composition data.
int	bt_mesh_cfg_cli_beacon_get (uint16_t net_idx, uint16_t addr, uint8_t *status)
	Get the target node's network beacon state.
int	bt_mesh_cfg_cli_krp_get (uint16_t net_idx, uint16_t addr, uint16_t key_net_idx, uint8_t *status, uint8_t *phase)
	Get the target node's network key refresh phase state.
int	bt_mesh_cfg_cli_krp_set (uint16_t net_idx, uint16_t addr, uint16_t key_net_idx, uint8_t transition, uint8_t *status, uint8_t *phase)
	Set the target node's network key refresh phase parameters.
int	bt_mesh_cfg_cli_beacon_set (uint16_t net_idx, uint16_t addr, uint8_t val, uint8_t *status)
	Set the target node's network beacon state.
int	bt_mesh_cfg_cli_ttl_get (uint16_t net_idx, uint16_t addr, uint8_t *ttl)
	Get the target node's Time To Live value.
int	bt_mesh_cfg_cli_ttl_set (uint16_t net_idx, uint16_t addr, uint8_t val, uint8_t *ttl)
	Set the target node's Time To Live value.
int	bt_mesh_cfg_cli_friend_get (uint16_t net_idx, uint16_t addr, uint8_t *status)
	Get the target node's Friend feature status.
int	bt_mesh_cfg_cli_friend_set (uint16_t net_idx, uint16_t addr, uint8_t val, uint8_t *status)
	Set the target node's Friend feature state.
int	bt_mesh_cfg_cli_gatt_proxy_get (uint16_t net_idx, uint16_t addr, uint8_t *status)
	Get the target node's Proxy feature state.
int	bt_mesh_cfg_cli_gatt_proxy_set (uint16_t net_idx, uint16_t addr, uint8_t val, uint8_t *status)
	Set the target node's Proxy feature state.
int	bt_mesh_cfg_cli_net_transmit_get (uint16_t net_idx, uint16_t addr, uint8_t *transmit)
	Get the target node's network_transmit state.
int	bt_mesh_cfg_cli_net_transmit_set (uint16_t net_idx, uint16_t addr, uint8_t val, uint8_t *transmit)
	Set the target node's network transmit parameters.
int	bt_mesh_cfg_cli_relay_get (uint16_t net_idx, uint16_t addr, uint8_t *status, uint8_t *transmit)
	Get the target node's Relay feature state.
int	bt_mesh_cfg_cli_relay_set (uint16_t net_idx, uint16_t addr, uint8_t new_relay, uint8_t new_transmit, uint8_t *status, uint8_t *transmit)
	Set the target node's Relay parameters.
int	bt_mesh_cfg_cli_net_key_add (uint16_t net_idx, uint16_t addr, uint16_t key_net_idx, const uint8_t net_key[16], uint8_t *status)
	Add a network key to the target node.
int	bt_mesh_cfg_cli_net_key_get (uint16_t net_idx, uint16_t addr, uint16_t *keys, size_t *key_cnt)
	Get a list of the target node's network key indexes.
int	bt_mesh_cfg_cli_net_key_del (uint16_t net_idx, uint16_t addr, uint16_t key_net_idx, uint8_t *status)
	Delete a network key from the target node.
int	bt_mesh_cfg_cli_app_key_add (uint16_t net_idx, uint16_t addr, uint16_t key_net_idx, uint16_t key_app_idx, const uint8_t app_key[16], uint8_t *status)
	Add an application key to the target node.
int	bt_mesh_cfg_cli_app_key_get (uint16_t net_idx, uint16_t addr, uint16_t key_net_idx, uint8_t *status, uint16_t *keys, size_t *key_cnt)
	Get a list of the target node's application key indexes for a specific network key.
int	bt_mesh_cfg_cli_app_key_del (uint16_t net_idx, uint16_t addr, uint16_t key_net_idx, uint16_t key_app_idx, uint8_t *status)
	Delete an application key from the target node.
int	bt_mesh_cfg_cli_mod_app_bind (uint16_t net_idx, uint16_t addr, uint16_t elem_addr, uint16_t mod_app_idx, uint16_t mod_id, uint8_t *status)
	Bind an application to a SIG model on the target node.
int	bt_mesh_cfg_cli_mod_app_unbind (uint16_t net_idx, uint16_t addr, uint16_t elem_addr, uint16_t mod_app_idx, uint16_t mod_id, uint8_t *status)
	Unbind an application from a SIG model on the target node.
int	bt_mesh_cfg_cli_mod_app_bind_vnd (uint16_t net_idx, uint16_t addr, uint16_t elem_addr, uint16_t mod_app_idx, uint16_t mod_id, uint16_t cid, uint8_t *status)
	Bind an application to a vendor model on the target node.
int	bt_mesh_cfg_cli_mod_app_unbind_vnd (uint16_t net_idx, uint16_t addr, uint16_t elem_addr, uint16_t mod_app_idx, uint16_t mod_id, uint16_t cid, uint8_t *status)
	Unbind an application from a vendor model on the target node.
int	bt_mesh_cfg_cli_mod_app_get (uint16_t net_idx, uint16_t addr, uint16_t elem_addr, uint16_t mod_id, uint8_t *status, uint16_t *apps, size_t *app_cnt)
	Get a list of all applications bound to a SIG model on the target node.
int	bt_mesh_cfg_cli_mod_app_get_vnd (uint16_t net_idx, uint16_t addr, uint16_t elem_addr, uint16_t mod_id, uint16_t cid, uint8_t *status, uint16_t *apps, size_t *app_cnt)
	Get a list of all applications bound to a vendor model on the target node.
int	bt_mesh_cfg_cli_mod_pub_get (uint16_t net_idx, uint16_t addr, uint16_t elem_addr, uint16_t mod_id, struct bt_mesh_cfg_cli_mod_pub *pub, uint8_t *status)
	Get publish parameters for a SIG model on the target node.
int	bt_mesh_cfg_cli_mod_pub_get_vnd (uint16_t net_idx, uint16_t addr, uint16_t elem_addr, uint16_t mod_id, uint16_t cid, struct bt_mesh_cfg_cli_mod_pub *pub, uint8_t *status)
	Get publish parameters for a vendor model on the target node.
int	bt_mesh_cfg_cli_mod_pub_set (uint16_t net_idx, uint16_t addr, uint16_t elem_addr, uint16_t mod_id, struct bt_mesh_cfg_cli_mod_pub *pub, uint8_t *status)
	Set publish parameters for a SIG model on the target node.
int	bt_mesh_cfg_cli_mod_pub_set_vnd (uint16_t net_idx, uint16_t addr, uint16_t elem_addr, uint16_t mod_id, uint16_t cid, struct bt_mesh_cfg_cli_mod_pub *pub, uint8_t *status)
	Set publish parameters for a vendor model on the target node.
int	bt_mesh_cfg_cli_mod_sub_add (uint16_t net_idx, uint16_t addr, uint16_t elem_addr, uint16_t sub_addr, uint16_t mod_id, uint8_t *status)
	Add a group address to a SIG model's subscription list.
int	bt_mesh_cfg_cli_mod_sub_add_vnd (uint16_t net_idx, uint16_t addr, uint16_t elem_addr, uint16_t sub_addr, uint16_t mod_id, uint16_t cid, uint8_t *status)
	Add a group address to a vendor model's subscription list.
int	bt_mesh_cfg_cli_mod_sub_del (uint16_t net_idx, uint16_t addr, uint16_t elem_addr, uint16_t sub_addr, uint16_t mod_id, uint8_t *status)
	Delete a group address in a SIG model's subscription list.
int	bt_mesh_cfg_cli_mod_sub_del_vnd (uint16_t net_idx, uint16_t addr, uint16_t elem_addr, uint16_t sub_addr, uint16_t mod_id, uint16_t cid, uint8_t *status)
	Delete a group address in a vendor model's subscription list.
int	bt_mesh_cfg_cli_mod_sub_overwrite (uint16_t net_idx, uint16_t addr, uint16_t elem_addr, uint16_t sub_addr, uint16_t mod_id, uint8_t *status)
	Overwrite all addresses in a SIG model's subscription list with a group address.
int	bt_mesh_cfg_cli_mod_sub_overwrite_vnd (uint16_t net_idx, uint16_t addr, uint16_t elem_addr, uint16_t sub_addr, uint16_t mod_id, uint16_t cid, uint8_t *status)
	Overwrite all addresses in a vendor model's subscription list with a group address.
int	bt_mesh_cfg_cli_mod_sub_va_add (uint16_t net_idx, uint16_t addr, uint16_t elem_addr, const uint8_t label[16], uint16_t mod_id, uint16_t *virt_addr, uint8_t *status)
	Add a virtual address to a SIG model's subscription list.
int	bt_mesh_cfg_cli_mod_sub_va_add_vnd (uint16_t net_idx, uint16_t addr, uint16_t elem_addr, const uint8_t label[16], uint16_t mod_id, uint16_t cid, uint16_t *virt_addr, uint8_t *status)
	Add a virtual address to a vendor model's subscription list.
int	bt_mesh_cfg_cli_mod_sub_va_del (uint16_t net_idx, uint16_t addr, uint16_t elem_addr, const uint8_t label[16], uint16_t mod_id, uint16_t *virt_addr, uint8_t *status)
	Delete a virtual address in a SIG model's subscription list.
int	bt_mesh_cfg_cli_mod_sub_va_del_vnd (uint16_t net_idx, uint16_t addr, uint16_t elem_addr, const uint8_t label[16], uint16_t mod_id, uint16_t cid, uint16_t *virt_addr, uint8_t *status)
	Delete a virtual address in a vendor model's subscription list.
int	bt_mesh_cfg_cli_mod_sub_va_overwrite (uint16_t net_idx, uint16_t addr, uint16_t elem_addr, const uint8_t label[16], uint16_t mod_id, uint16_t *virt_addr, uint8_t *status)
	Overwrite all addresses in a SIG model's subscription list with a virtual address.
int	bt_mesh_cfg_cli_mod_sub_va_overwrite_vnd (uint16_t net_idx, uint16_t addr, uint16_t elem_addr, const uint8_t label[16], uint16_t mod_id, uint16_t cid, uint16_t *virt_addr, uint8_t *status)
	Overwrite all addresses in a vendor model's subscription list with a virtual address.
int	bt_mesh_cfg_cli_mod_sub_get (uint16_t net_idx, uint16_t addr, uint16_t elem_addr, uint16_t mod_id, uint8_t *status, uint16_t *subs, size_t *sub_cnt)
	Get the subscription list of a SIG model on the target node.
int	bt_mesh_cfg_cli_mod_sub_get_vnd (uint16_t net_idx, uint16_t addr, uint16_t elem_addr, uint16_t mod_id, uint16_t cid, uint8_t *status, uint16_t *subs, size_t *sub_cnt)
	Get the subscription list of a vendor model on the target node.
int	bt_mesh_cfg_cli_hb_sub_set (uint16_t net_idx, uint16_t addr, struct bt_mesh_cfg_cli_hb_sub *sub, uint8_t *status)
	Set the target node's Heartbeat subscription parameters.
int	bt_mesh_cfg_cli_hb_sub_get (uint16_t net_idx, uint16_t addr, struct bt_mesh_cfg_cli_hb_sub *sub, uint8_t *status)
	Get the target node's Heartbeat subscription parameters.
int	bt_mesh_cfg_cli_hb_pub_set (uint16_t net_idx, uint16_t addr, const struct bt_mesh_cfg_cli_hb_pub *pub, uint8_t *status)
	Set the target node's Heartbeat publication parameters.
int	bt_mesh_cfg_cli_hb_pub_get (uint16_t net_idx, uint16_t addr, struct bt_mesh_cfg_cli_hb_pub *pub, uint8_t *status)
	Get the target node's Heartbeat publication parameters.
int	bt_mesh_cfg_cli_mod_sub_del_all (uint16_t net_idx, uint16_t addr, uint16_t elem_addr, uint16_t mod_id, uint8_t *status)
	Delete all group addresses in a SIG model's subscription list.
int	bt_mesh_cfg_cli_mod_sub_del_all_vnd (uint16_t net_idx, uint16_t addr, uint16_t elem_addr, uint16_t mod_id, uint16_t cid, uint8_t *status)
	Delete all group addresses in a vendor model's subscription list.
int	bt_mesh_cfg_cli_net_key_update (uint16_t net_idx, uint16_t addr, uint16_t key_net_idx, const uint8_t net_key[16], uint8_t *status)
	Update a network key to the target node.
int	bt_mesh_cfg_cli_app_key_update (uint16_t net_idx, uint16_t addr, uint16_t key_net_idx, uint16_t key_app_idx, const uint8_t app_key[16], uint8_t *status)
	Update an application key to the target node.
int	bt_mesh_cfg_cli_node_identity_set (uint16_t net_idx, uint16_t addr, uint16_t key_net_idx, uint8_t new_identity, uint8_t *status, uint8_t *identity)
	Set the Node Identity parameters.
int	bt_mesh_cfg_cli_node_identity_get (uint16_t net_idx, uint16_t addr, uint16_t key_net_idx, uint8_t *status, uint8_t *identity)
	Get the Node Identity parameters.
int	bt_mesh_cfg_cli_lpn_timeout_get (uint16_t net_idx, uint16_t addr, uint16_t unicast_addr, int32_t *polltimeout)
	Get the Low Power Node Polltimeout parameters.
int32_t	bt_mesh_cfg_cli_timeout_get (void)
	Get the current transmission timeout value.
void	bt_mesh_cfg_cli_timeout_set (int32_t timeout)
	Set the transmission timeout value.
int	bt_mesh_comp_p0_get (struct bt_mesh_comp_p0 *comp, struct net_buf_simple *buf)
	Create a composition data page 0 representation from a buffer.
struct bt_mesh_comp_p0_elem *	bt_mesh_comp_p0_elem_pull (const struct bt_mesh_comp_p0 *comp, struct bt_mesh_comp_p0_elem *elem)
	Pull a composition data page 0 element from a composition data page 0 instance.
uint16_t	bt_mesh_comp_p0_elem_mod (struct bt_mesh_comp_p0_elem *elem, int idx)
	Get a SIG model from the given composition data page 0 element.
struct bt_mesh_mod_id_vnd	bt_mesh_comp_p0_elem_mod_vnd (struct bt_mesh_comp_p0_elem *elem, int idx)
	Get a vendor model from the given composition data page 0 element.
struct bt_mesh_comp_p1_elem *	bt_mesh_comp_p1_elem_pull (struct net_buf_simple *buf, struct bt_mesh_comp_p1_elem *elem)
	Pull a Composition Data Page 1 Element from a composition data page 1 instance.
struct bt_mesh_comp_p1_model_item *	bt_mesh_comp_p1_item_pull (struct bt_mesh_comp_p1_elem *elem, struct bt_mesh_comp_p1_model_item *item)
	Pull a Composition Data Page 1 Model Item from a Composition Data Page 1 Element.
struct bt_mesh_comp_p1_ext_item *	bt_mesh_comp_p1_pull_ext_item (struct bt_mesh_comp_p1_model_item *item, struct bt_mesh_comp_p1_ext_item *ext_item)
	Pull Extended Model Item contained in Model Item.
struct bt_mesh_comp_p2_record *	bt_mesh_comp_p2_record_pull (struct net_buf_simple *buf, struct bt_mesh_comp_p2_record *record)
	Pull a Composition Data Page 2 Record from a composition data page 2 instance.
int	bt_mesh_key_idx_unpack_list (struct net_buf_simple *buf, uint16_t *dst_arr, size_t *dst_cnt)
	Unpack a list of key index entries from a buffer.

Detailed Description

Configuration Client Model APIs.