Zigbee Protocol Controller 1.6.0
ZigPC Gateway Component

The interface for interacting with sleepy messages. More...

Classes

struct  gateway_frame_t
 

Functions

sl_status_t zigpc_gateway_store_sleepy_frame (gateway_frame_t frame)
 zigpc_gateway_store_sleepy_frame Stores a new ZCL frame destined to a sleepy end device More...
 
sl_status_t zigpc_gateway_retrieve_sleepy_frame (const zigbee_eui64_t eui64, gateway_frame_t *frame)
 zigpc_gateway_retrieve_sleepy_frame Retrieve the next frame destined for a sleepy device Frames are retrieved in the order they are stored (FIFO) More...
 
unsigned int zigpc_gateway_retrieve_num_stored (const zigbee_eui64_t eui64)
 zigpc_gateway_retrieve_num_stored Retrieves the number of stored messages for a given sleepy device More...
 

Variables

const unsigned int MAX_SLEEPY_RETRIES = 64
 

Detailed Description

The interface for interacting with sleepy messages.

Function Documentation

◆ zigpc_gateway_retrieve_num_stored()

unsigned int zigpc_gateway_retrieve_num_stored ( const zigbee_eui64_t  eui64)

zigpc_gateway_retrieve_num_stored Retrieves the number of stored messages for a given sleepy device

Parameters
eui64- the eui64 of the device to check
Returns
the number of frames available. Returns 0 if no frames or stored or if the EUI64 could not be found

◆ zigpc_gateway_retrieve_sleepy_frame()

sl_status_t zigpc_gateway_retrieve_sleepy_frame ( const zigbee_eui64_t  eui64,
gateway_frame_t frame 
)

zigpc_gateway_retrieve_sleepy_frame Retrieve the next frame destined for a sleepy device Frames are retrieved in the order they are stored (FIFO)

Parameters
eui64- the eui64 of the sleepy end device
frame- the destination where to copy the ZCL frame
Returns
the status of the operation. Returns SL_STATUS_OK if the next frame could be retrieved and copied. Returns SL_STATUS_EMPTY when no more frames are available. Returns SL_STATUS_FAIL if something went wrong.

◆ zigpc_gateway_store_sleepy_frame()

sl_status_t zigpc_gateway_store_sleepy_frame ( gateway_frame_t  frame)

zigpc_gateway_store_sleepy_frame Stores a new ZCL frame destined to a sleepy end device

Parameters
frame- the ZCL frame, including EUI64 and endpoint info
Returns
SL_STATUS_OK if the frame could be stored

Variable Documentation

◆ MAX_SLEEPY_RETRIES

const unsigned int MAX_SLEEPY_RETRIES = 64