Zephyr API Documentation  3.7.0-rc3
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
bt_mesh_friend_cb Struct Reference

Friend Node callback functions. More...

#include <main.h>

Data Fields

void(* established )(uint16_t net_idx, uint16_t lpn_addr, uint8_t recv_delay, uint32_t polltimeout)
 Friendship established.
 
void(* terminated )(uint16_t net_idx, uint16_t lpn_addr)
 Friendship terminated.
 
void(* polled )(uint16_t net_idx, uint16_t lpn_addr)
 Friend Poll Request.
 

Detailed Description

Friend Node callback functions.

Field Documentation

◆ established

void(* bt_mesh_friend_cb::established) (uint16_t net_idx, uint16_t lpn_addr, uint8_t recv_delay, uint32_t polltimeout)

Friendship established.

This callback notifies the application that friendship has been successfully established.

Parameters
net_idxNetKeyIndex used during friendship establishment.
lpn_addrLow Power Node address.
recv_delayReceive Delay in units of 1 millisecond.
polltimeoutPollTimeout in units of 1 millisecond.

◆ polled

void(* bt_mesh_friend_cb::polled) (uint16_t net_idx, uint16_t lpn_addr)

Friend Poll Request.

This callback notifies the application that the low power node has polled the friend node.

This callback will be called before bt_mesh_friend_cb::established when attempting to establish a friendship.

Parameters
net_idxNetKeyIndex used during friendship establishment.
lpn_addrLPN address.

◆ terminated

void(* bt_mesh_friend_cb::terminated) (uint16_t net_idx, uint16_t lpn_addr)

Friendship terminated.

This callback notifies the application that friendship has been terminated.

Parameters
net_idxNetKeyIndex used during friendship establishment.
lpn_addrLow Power Node address.

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