bt_mesh_cfg_cli_hb_pub Struct Reference

Heartbeat publication configuration parameters. More...

#include <cfg_cli.h>

Data Fields
uint16_t	dst
	Heartbeat destination address.
uint8_t	count
	Logarithmic Heartbeat count.
uint8_t	period
	Logarithmic Heartbeat publication transmit interval in seconds.
uint8_t	ttl
	Publication message Time To Live value.
uint16_t	feat
	Bitmap of features that trigger Heartbeat publications.
uint16_t	net_idx
	Network index to publish with.

Detailed Description

Heartbeat publication configuration parameters.

Field Documentation

count

uint8_t bt_mesh_cfg_cli_hb_pub::count

Logarithmic Heartbeat count.

Decoded as (1 << (count - 1)) if count is between 1 and 0x11, 0 if count is 0, or "indefinitely" if count is 0xff.

When used in Heartbeat publication set, this parameter denotes the number of Heartbeat messages to send.

When returned from Heartbeat publication get, this parameter denotes the number of Heartbeat messages remaining to be sent.

dst

uint16_t bt_mesh_cfg_cli_hb_pub::dst

Heartbeat destination address.

feat

uint16_t bt_mesh_cfg_cli_hb_pub::feat

Bitmap of features that trigger Heartbeat publications.

Legal values are BT_MESH_FEAT_RELAY, BT_MESH_FEAT_PROXY, BT_MESH_FEAT_FRIEND and BT_MESH_FEAT_LOW_POWER

net_idx

uint16_t bt_mesh_cfg_cli_hb_pub::net_idx

Network index to publish with.

period

uint8_t bt_mesh_cfg_cli_hb_pub::period

Logarithmic Heartbeat publication transmit interval in seconds.

Decoded as (1 << (period - 1)) if period is between 1 and 0x11. If period is 0, Heartbeat publication is disabled.

ttl

uint8_t bt_mesh_cfg_cli_hb_pub::ttl

Publication message Time To Live value.

---

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

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