bt_mesh_cfg_cli_cb Struct Reference

Mesh Configuration Client Status messages callback. More...

#include <cfg_cli.h>

Data Fields
void(*	comp_data )(struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t page, struct net_buf_simple *buf)
	Optional callback for Composition data messages.
void(*	mod_pub_status )(struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status, uint16_t elem_addr, uint16_t mod_id, uint16_t cid, struct bt_mesh_cfg_cli_mod_pub *pub)
	Optional callback for Model Pub status messages.
void(*	mod_sub_status )(struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status, uint16_t elem_addr, uint16_t sub_addr, uint32_t mod_id)
	Optional callback for Model Sub Status messages.
void(*	mod_sub_list )(struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status, uint16_t elem_addr, uint16_t mod_id, uint16_t cid, struct net_buf_simple *buf)
	Optional callback for Model Sub list messages.
void(*	node_reset_status )(struct bt_mesh_cfg_cli *cli, uint16_t addr)
	Optional callback for Node Reset Status messages.
void(*	beacon_status )(struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status)
	Optional callback for Beacon Status messages.
void(*	ttl_status )(struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status)
	Optional callback for Default TTL Status messages.
void(*	friend_status )(struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status)
	Optional callback for Friend Status messages.
void(*	gatt_proxy_status )(struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status)
	Optional callback for GATT Proxy Status messages.
void(*	network_transmit_status )(struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status)
	Optional callback for Network Transmit Status messages.
void(*	relay_status )(struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status, uint8_t transmit)
	Optional callback for Relay Status messages.
void(*	net_key_status )(struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status, uint16_t net_idx)
	Optional callback for NetKey Status messages.
void(*	net_key_list )(struct bt_mesh_cfg_cli *cli, uint16_t addr, struct net_buf_simple *buf)
	Optional callback for Netkey list messages.
void(*	app_key_status )(struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status, uint16_t net_idx, uint16_t app_idx)
	Optional callback for AppKey Status messages.
void(*	app_key_list )(struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status, uint16_t net_idx, struct net_buf_simple *buf)
	Optional callback for Appkey list messages.
void(*	mod_app_status )(struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status, uint16_t elem_addr, uint16_t app_idx, uint32_t mod_id)
	Optional callback for Model App Status messages.
void(*	mod_app_list )(struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status, uint16_t elem_addr, uint16_t mod_id, uint16_t cid, struct net_buf_simple *buf)
	Optional callback for Model App list messages.
void(*	node_identity_status )(struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status, uint16_t net_idx, uint8_t identity)
	Optional callback for Node Identity Status messages.
void(*	lpn_timeout_status )(struct bt_mesh_cfg_cli *cli, uint16_t addr, uint16_t elem_addr, uint32_t timeout)
	Optional callback for LPN PollTimeout Status messages.
void(*	krp_status )(struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status, uint16_t net_idx, uint8_t phase)
	Optional callback for Key Refresh Phase status messages.
void(*	hb_pub_status )(struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status, struct bt_mesh_cfg_cli_hb_pub *pub)
	Optional callback for Heartbeat pub status messages.
void(*	hb_sub_status )(struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status, struct bt_mesh_cfg_cli_hb_sub *sub)
	Optional callback for Heartbeat Sub status messages.

Detailed Description

Mesh Configuration Client Status messages callback.

Field Documentation

app_key_list

void(* bt_mesh_cfg_cli_cb::app_key_list) (struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status, uint16_t net_idx, struct net_buf_simple *buf)

Optional callback for Appkey list messages.

Handles received Appkey list messages from a server.

Note

The buf parameter should be decoded using the bt_mesh_key_idx_unpack_list helper function.

Parameters

cli	Client that received the status message.
addr	Address of the sender.
status	Status code for the message.
net_idx	The index of the NetKey.
buf	Message buffer containing key indexes.

app_key_status

void(* bt_mesh_cfg_cli_cb::app_key_status) (struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status, uint16_t net_idx, uint16_t app_idx)

Optional callback for AppKey Status messages.

Handles received AppKey Status messages from a server.

Parameters

cli	Client that received the status message.
addr	Address of the sender.
status	Status Code for requesting message.
net_idx	The index of the NetKey.
app_idx	The index of the AppKey.

beacon_status

void(* bt_mesh_cfg_cli_cb::beacon_status) (struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status)

Optional callback for Beacon Status messages.

Handles received Beacon Status messages from a server.

Parameters

cli	Client that received the status message.
addr	Address of the sender.
status	Status Code for requesting message.

comp_data

void(* bt_mesh_cfg_cli_cb::comp_data) (struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t page, struct net_buf_simple *buf)

Optional callback for Composition data messages.

Handles received Composition data messages from a server.

Note

For decoding buf, please refer to bt_mesh_comp_p0_get and bt_mesh_comp_p1_elem_pull.

Parameters

cli	Client that received the status message.
addr	Address of the sender.
page	Composition data page.
buf	Composition data buffer.

friend_status

void(* bt_mesh_cfg_cli_cb::friend_status) (struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status)

Optional callback for Friend Status messages.

Handles received Friend Status messages from a server.

Parameters

cli	Client that received the status message.
addr	Address of the sender.
status	Status Code for requesting message.

gatt_proxy_status

void(* bt_mesh_cfg_cli_cb::gatt_proxy_status) (struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status)

Optional callback for GATT Proxy Status messages.

Handles received GATT Proxy Status messages from a server.

Parameters

cli	Client that received the status message.
addr	Address of the sender.
status	Status Code for requesting message.

hb_pub_status

void(* bt_mesh_cfg_cli_cb::hb_pub_status) (struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status, struct bt_mesh_cfg_cli_hb_pub *pub)

Optional callback for Heartbeat pub status messages.

Handles received Heartbeat pub status messages from a server.

Parameters

cli	Client that received the status message.
addr	Address of the sender.
status	Status code for the message.
pub	HB publication configuration parameters.

hb_sub_status

void(* bt_mesh_cfg_cli_cb::hb_sub_status) (struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status, struct bt_mesh_cfg_cli_hb_sub *sub)

Optional callback for Heartbeat Sub status messages.

Handles received Heartbeat Sub status messages from a server.

Parameters

cli	Client that received the status message.
addr	Address of the sender.
status	Status code for the message.
sub	HB subscription configuration parameters.

krp_status

void(* bt_mesh_cfg_cli_cb::krp_status) (struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status, uint16_t net_idx, uint8_t phase)

Optional callback for Key Refresh Phase status messages.

Handles received Key Refresh Phase status messages from a server.

Parameters

cli	Client that received the status message.
addr	Address of the sender.
status	Status code for the message.
net_idx	The index of the NetKey.
phase	Phase of the KRP.

lpn_timeout_status

void(* bt_mesh_cfg_cli_cb::lpn_timeout_status) (struct bt_mesh_cfg_cli *cli, uint16_t addr, uint16_t elem_addr, uint32_t timeout)

Optional callback for LPN PollTimeout Status messages.

Handles received LPN PollTimeout Status messages from a server.

Parameters

cli	Client that received the status message.
addr	Address of the sender.
elem_addr	The unicast address of the LPN.
timeout	Current value of PollTimeout timer of the LPN.

mod_app_list

void(* bt_mesh_cfg_cli_cb::mod_app_list) (struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status, uint16_t elem_addr, uint16_t mod_id, uint16_t cid, struct net_buf_simple *buf)

Optional callback for Model App list messages.

Handles received Model App list messages from a server.

Note

The buf parameter should be decoded using the bt_mesh_key_idx_unpack_list helper function.

Parameters

cli	Client that received the status message.
addr	Address of the sender.
status	Status code for the message.
elem_addr	Address of the element.
mod_id	Model ID.
cid	Company ID.
buf	Message buffer containing key indexes.

mod_app_status

void(* bt_mesh_cfg_cli_cb::mod_app_status) (struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status, uint16_t elem_addr, uint16_t app_idx, uint32_t mod_id)

Optional callback for Model App Status messages.

Handles received Model App Status messages from a server.

Parameters

cli	Client that received the status message.
addr	Address of the sender.
status	Status Code for requesting message.
elem_addr	The unicast address of the element.
app_idx	The sub address.
mod_id	The model ID within the element.

mod_pub_status

void(* bt_mesh_cfg_cli_cb::mod_pub_status) (struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status, uint16_t elem_addr, uint16_t mod_id, uint16_t cid, struct bt_mesh_cfg_cli_mod_pub *pub)

Optional callback for Model Pub status messages.

Handles received Model Pub status messages from a server.

Parameters

cli	Client that received the status message.
addr	Address of the sender.
status	Status code for the message.
elem_addr	Address of the element.
mod_id	Model ID.
cid	Company ID.
pub	Publication configuration parameters.

mod_sub_list

void(* bt_mesh_cfg_cli_cb::mod_sub_list) (struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status, uint16_t elem_addr, uint16_t mod_id, uint16_t cid, struct net_buf_simple *buf)

Optional callback for Model Sub list messages.

Handles received Model Sub list messages from a server.

Note

The buf parameter should be decoded using net_buf_simple_pull_le16 in iteration, as long as buf->len is greater than or equal to 2.

Parameters

cli	Client that received the status message.
addr	Address of the sender.
status	Status code for the message.
elem_addr	Address of the element.
mod_id	Model ID.
cid	Company ID.
buf	Message buffer containing subscription addresses.

mod_sub_status

void(* bt_mesh_cfg_cli_cb::mod_sub_status) (struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status, uint16_t elem_addr, uint16_t sub_addr, uint32_t mod_id)

Optional callback for Model Sub Status messages.

Handles received Model Sub Status messages from a server.

Parameters

cli	Client that received the status message.
addr	Address of the sender.
status	Status Code for requesting message.
elem_addr	The unicast address of the element.
sub_addr	The sub address.
mod_id	The model ID within the element.

net_key_list

void(* bt_mesh_cfg_cli_cb::net_key_list) (struct bt_mesh_cfg_cli *cli, uint16_t addr, struct net_buf_simple *buf)

Optional callback for Netkey list messages.

Handles received Netkey list messages from a server.

Note

The buf parameter should be decoded using the bt_mesh_key_idx_unpack_list helper function.

Parameters

cli	Client that received the status message.
addr	Address of the sender.
buf	Message buffer containing key indexes.

net_key_status

void(* bt_mesh_cfg_cli_cb::net_key_status) (struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status, uint16_t net_idx)

Optional callback for NetKey Status messages.

Handles received NetKey Status messages from a server.

Parameters

cli	Client that received the status message.
addr	Address of the sender.
status	Status Code for requesting message.
net_idx	The index of the NetKey.

network_transmit_status

void(* bt_mesh_cfg_cli_cb::network_transmit_status) (struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status)

Optional callback for Network Transmit Status messages.

Handles received Network Transmit Status messages from a server.

Parameters

cli	Client that received the status message.
addr	Address of the sender.
status	Status Code for requesting message.

node_identity_status

void(* bt_mesh_cfg_cli_cb::node_identity_status) (struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status, uint16_t net_idx, uint8_t identity)

Optional callback for Node Identity Status messages.

Handles received Node Identity Status messages from a server.

Parameters

cli	Client that received the status message.
addr	Address of the sender.
status	Status Code for requesting message.
net_idx	The index of the NetKey.
identity	The node identity state.

node_reset_status

void(* bt_mesh_cfg_cli_cb::node_reset_status) (struct bt_mesh_cfg_cli *cli, uint16_t addr)

Optional callback for Node Reset Status messages.

Handles received Node Reset Status messages from a server.

Parameters

cli	Client that received the status message.
addr	Address of the sender.

relay_status

void(* bt_mesh_cfg_cli_cb::relay_status) (struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status, uint8_t transmit)

Optional callback for Relay Status messages.

Handles received Relay Status messages from a server.

Parameters

cli	Client that received the status message.
addr	Address of the sender.
status	Status Code for requesting message.
transmit	The relay retransmit count and interval steps.

ttl_status

void(* bt_mesh_cfg_cli_cb::ttl_status) (struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status)

Optional callback for Default TTL Status messages.

Handles received Default TTL Status messages from a server.

Parameters

cli	Client that received the status message.
addr	Address of the sender.
status	Status Code for requesting message.

---

The documentation for this struct was generated from the following file:

• include/zephyr/bluetooth/mesh/cfg_cli.h