Friend Request parameters. More...

#include <mesh_lpn.h>

Data Fields
uint32_t	receive_delay_ms
	Requested receive delay (in milliseconds). More...

uint32_t	poll_timeout_ms
	Poll timeout (in milliseconds). More...

friend_criteria_t	friend_criteria
	Criteria that a Friend node must support to participate in the friendship negotiation. More...

Detailed Description

Friend Request parameters.

Definition at line 105 of file mesh_lpn.h.

Field Documentation

uint32_t mesh_lpn_friend_request_t::receive_delay_ms

Requested receive delay (in milliseconds).

Definition at line 108 of file mesh_lpn.h.

uint32_t mesh_lpn_friend_request_t::poll_timeout_ms

Poll timeout (in milliseconds).

The valid range is provided by MESH_LPN_POLL_TIMEOUT_MIN_MS and MESH_LPN_POLL_TIMEOUT_MAX_MS. The poll timeout will be rounded up to the nearest 100 ms.

Note: The poll timeout sets the upper limit for two subsequent Friend Polls. However, the actual interval between each emptying of the Friend Queue (the poll_interval_ms) must be lower. Therefore, the poll_interval_ms is by default set to the largest value in accordance with limits in mesh_lpn_poll_interval_set().

Definition at line 120 of file mesh_lpn.h.

friend_criteria_t mesh_lpn_friend_request_t::friend_criteria

Criteria that a Friend node must support to participate in the friendship negotiation.

The received RSSI and Receive Window factors are used by the Friend node to calculate its local delay:

LocalDelay = ReceiveWindowFactor * ReceiveWindow - RSSIFactor * ReceivedRSS

The local delay determines how long the Friend node will wait before sending its Friend Offer.

Definition at line 131 of file mesh_lpn.h.

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