nRF5 SDK for Mesh v3.2.0  08c60f6
Mesh friendship types

Data Structures

struct  mesh_friendship_lpn_t
 
struct  mesh_friendship_t
 

Enumerations

enum  mesh_friendship_rssi_factor_t { MESH_FRIENDSHIP_RSSI_FACTOR_1_0 = 0, MESH_FRIENDSHIP_RSSI_FACTOR_1_5 = 1, MESH_FRIENDSHIP_RSSI_FACTOR_2_0 = 2, MESH_FRIENDSHIP_RSSI_FACTOR_2_5 = 3 }
 Weight factor applied to the received RSSI by the Friend node. More...
 
enum  mesh_friendship_receive_window_factor_t { MESH_FRIENDSHIP_RECEIVE_WINDOW_FACTOR_1_0 = 0, MESH_FRIENDSHIP_RECEIVE_WINDOW_FACTOR_1_5 = 1, MESH_FRIENDSHIP_RECEIVE_WINDOW_FACTOR_2_0 = 2, MESH_FRIENDSHIP_RECEIVE_WINDOW_FACTOR_2_5 = 3 }
 Weight factor applied to the offered Receive Window by the Friend node. More...
 
enum  mesh_friendship_min_friend_queue_size_t {
  MESH_FRIENDSHIP_MIN_FRIEND_QUEUE_SIZE_PROHIBITED = 0, MESH_FRIENDSHIP_MIN_FRIEND_QUEUE_SIZE_2 = 1, MESH_FRIENDSHIP_MIN_FRIEND_QUEUE_SIZE_4 = 2, MESH_FRIENDSHIP_MIN_FRIEND_QUEUE_SIZE_8 = 3,
  MESH_FRIENDSHIP_MIN_FRIEND_QUEUE_SIZE_16 = 4, MESH_FRIENDSHIP_MIN_FRIEND_QUEUE_SIZE_32 = 5, MESH_FRIENDSHIP_MIN_FRIEND_QUEUE_SIZE_64 = 6, MESH_FRIENDSHIP_MIN_FRIEND_QUEUE_SIZE_128 = 7
}
 Minimum size of the Friend Queue. More...
 

Detailed Description

A collection of types common to both the Low Power node (LPN) and the Friend role.

Enumeration Type Documentation

◆ mesh_friendship_rssi_factor_t

Weight factor applied to the received RSSI by the Friend node.

Available factors are 1.0, 1.5, 2.0, and 2.5. The lower the factor, the less a low received RSSI increases the delay of the Friend Offer. See the equation in mesh_lpn_friend_request_t::friend_criteria.

Definition at line 58 of file mesh_friendship_types.h.

◆ mesh_friendship_receive_window_factor_t

Weight factor applied to the offered Receive Window by the Friend node.

Available factors are 1.0, 1.5, 2.0, and 2.5. The lower the factor, the less a long offered Receive Window increases the delay of the Friend Offer. See the equation in mesh_lpn_friend_request_t::friend_criteria.

Definition at line 73 of file mesh_friendship_types.h.

◆ mesh_friendship_min_friend_queue_size_t

Minimum size of the Friend Queue.

This is the minimum number of Lower Transport PDUs that the Friend node can store.

Definition at line 86 of file mesh_friendship_types.h.