Zephyr API Documentation 4.0.0
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
bt_mesh_cfg_cli_hb_sub Struct Reference

Heartbeat subscription configuration parameters. More...

#include <cfg_cli.h>

Data Fields

uint16_t src
 Source address to receive Heartbeat messages from.
 
uint16_t dst
 Destination address to receive Heartbeat messages on.
 
uint8_t period
 Logarithmic subscription period to keep listening for.
 
uint8_t count
 Logarithmic Heartbeat subscription receive count.
 
uint8_t min
 Minimum hops in received messages, ie the shortest registered path from the publishing node to the subscribing node.
 
uint8_t max
 Maximum hops in received messages, ie the longest registered path from the publishing node to the subscribing node.
 

Detailed Description

Heartbeat subscription configuration parameters.

Field Documentation

◆ count

uint8_t bt_mesh_cfg_cli_hb_sub::count

Logarithmic Heartbeat subscription receive count.

The decoded Heartbeat count is (1 << (count - 1)) if count is between 1 and 0xfe, 0 if count is 0 and 0xffff if count is 0xff.

Ignored in Heartbeat subscription set.

◆ dst

uint16_t bt_mesh_cfg_cli_hb_sub::dst

Destination address to receive Heartbeat messages on.

◆ max

uint8_t bt_mesh_cfg_cli_hb_sub::max

Maximum hops in received messages, ie the longest registered path from the publishing node to the subscribing node.

A Heartbeat received from an immediate neighbor has hop count = 1.

Ignored in Heartbeat subscription set.

◆ min

uint8_t bt_mesh_cfg_cli_hb_sub::min

Minimum hops in received messages, ie the shortest registered path from the publishing node to the subscribing node.

A Heartbeat received from an immediate neighbor has hop count = 1.

Ignored in Heartbeat subscription set.

◆ period

uint8_t bt_mesh_cfg_cli_hb_sub::period

Logarithmic subscription period to keep listening for.

The decoded subscription period is (1 << (period - 1)) seconds, or 0 seconds if period is 0.

◆ src

uint16_t bt_mesh_cfg_cli_hb_sub::src

Source address to receive Heartbeat messages from.


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