nRF5 SDK for Mesh v5.0.0
Data Structures | Macros | Enumerations | Functions
RSSI monitor util model interface

Data Structures

struct  rssi_util_t
 Rssi util instance structure. More...
 

Macros

#define RSSI_UTIL_MODEL_ID   0x0007
 Model ID for the RSSI Util model. More...
 

Enumerations

enum  rssi_util_opcode_t { RSSI_OPCODE_REQUEST_DATABASE_BEACON = 0xC7, RSSI_OPCODE_SEND_DATABASE_BEACON = 0xC8 }
 Rssi model opcodes. More...
 

Functions

uint32_t rssi_util_init (rssi_util_t *p_util)
 Initializes the rssi util model. More...
 
uint32_t rssi_util_mac_to_element_addr_find (rssi_util_t *p_util, const uint8_t *p_mac_addr, dsm_local_unicast_address_t *p_element_addr)
 Searches for a corresponding element address to a ingoing mac address. More...
 

Detailed Description

Macro Definition Documentation

◆ RSSI_UTIL_MODEL_ID

#define RSSI_UTIL_MODEL_ID   0x0007

Model ID for the RSSI Util model.

Definition at line 52 of file rssi_util.h.

Enumeration Type Documentation

◆ rssi_util_opcode_t

Rssi model opcodes.

Definition at line 64 of file rssi_util.h.

Function Documentation

◆ rssi_util_init()

uint32_t rssi_util_init ( rssi_util_t *  p_util)

Initializes the rssi util model.

Parameters
[in,out]p_utilPointer to the rssi util instance structure.
Return values
NRF_SUCCESSThe model was successfully initialized.
See also
access_model_add()

◆ rssi_util_mac_to_element_addr_find()

uint32_t rssi_util_mac_to_element_addr_find ( rssi_util_t *  p_util,
const uint8_t *  p_mac_addr,
dsm_local_unicast_address_t p_element_addr 
)

Searches for a corresponding element address to a ingoing mac address.

Starts the process of gathering mac/element address pairs from nearby nodes if the corresponding element address is not found

Parameters
[in]p_utilPointer to the rssi util instance structure.
[in]p_mac_addrpointer to the ingoing mac address.
[in,out]p_element_addrpointer to where the corresponding element address is to be stored.
Return values
NRF_SUCCESSA corresponding element address was found.
NRF_ERROR_NULLNULL pointer in function arguments
NRF_ERROR_NOT_FOUNDA corresponding element address was not found.

Documentation feedback | Developer Zone | Subscribe | Updated