nRF5 SDK for Mesh v4.0.0
Data Fields
nrf_mesh_evt_hb_message_t Struct Reference

Heartbeat received event structure. More...

#include <nrf_mesh_events.h>

Data Fields

uint8_t init_ttl
 Initial TTL value used for sending the heartbeat message. More...
 
uint8_t hops
 Calculated hop value. More...
 
uint16_t features
 Features' state bitmap. More...
 
uint16_t src
 Metadata for the received packet. More...
 

Detailed Description

Heartbeat received event structure.

This event structure is formatted as recommended by the Mesh Profile Specification v1.0, section 3.6.7.3.

Definition at line 192 of file nrf_mesh_events.h.

Field Documentation

◆ init_ttl

uint8_t nrf_mesh_evt_hb_message_t::init_ttl

Initial TTL value used for sending the heartbeat message.

Definition at line 195 of file nrf_mesh_events.h.

◆ hops

uint8_t nrf_mesh_evt_hb_message_t::hops

Calculated hop value.

Number of hops = Initial TTL - Received message TTL + 1.

Definition at line 197 of file nrf_mesh_events.h.

◆ features

uint16_t nrf_mesh_evt_hb_message_t::features

Features' state bitmap.

See Heartbeat definitions to interpret bit fields.

Definition at line 199 of file nrf_mesh_events.h.

◆ src

uint16_t nrf_mesh_evt_hb_message_t::src

Metadata for the received packet.

In case of a segmented message, the metadata represents the last packet.

Definition at line 202 of file nrf_mesh_events.h.


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

Documentation feedback | Developer Zone | Subscribe | Updated