Zephyr API Documentation 4.0.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
bt_mesh_hb_sub Struct Reference

Heartbeat Subscription parameters. More...

#include <heartbeat.h>

Data Fields

uint32_t period
 Subscription period in seconds.
 
uint32_t remaining
 Remaining subscription time in seconds.
 
uint16_t src
 Source address to receive Heartbeats from.
 
uint16_t dst
 Destination address to received Heartbeats on.
 
uint16_t count
 The number of received Heartbeat messages so far.
 
uint8_t min_hops
 Minimum hops in received messages, ie the shortest registered path from the publishing node to the subscribing node.
 
uint8_t max_hops
 Maximum hops in received messages, ie the longest registered path from the publishing node to the subscribing node.
 

Detailed Description

Heartbeat Subscription parameters.

Field Documentation

◆ count

uint16_t bt_mesh_hb_sub::count

The number of received Heartbeat messages so far.

◆ dst

uint16_t bt_mesh_hb_sub::dst

Destination address to received Heartbeats on.

◆ max_hops

uint8_t bt_mesh_hb_sub::max_hops

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.

◆ min_hops

uint8_t bt_mesh_hb_sub::min_hops

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.

◆ period

uint32_t bt_mesh_hb_sub::period

Subscription period in seconds.

◆ remaining

uint32_t bt_mesh_hb_sub::remaining

Remaining subscription time in seconds.

◆ src

uint16_t bt_mesh_hb_sub::src

Source address to receive Heartbeats from.


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