Microcontroller Wireless Solutions


ZRC command discovery API Functions

Functions

bool zrc_cmd_disc_request (uint8_t PairingRef, FUNC_PTR confirm_cb)
 Sends the ZRC command discovery request.
void zrc_cmd_disc_confirm (nwk_enum_t Status, uint8_t PairingRef, uint8_t *SupportedCmd)
 Callback ZRC command discovery confirm.
void zrc_cmd_disc_indication (uint8_t PairingRef)
 Callback ZRC command discovery indication.
bool zrc_cmd_disc_response (uint8_t PairingRef, uint8_t *SupportedCmd)
 ZRC command discovery response.

Detailed Description

With this group of functions, the stack provides the API functions that handle functionality regarding the ZRC command discovery procedure. The command discovery feature is an optional feature, but supported by RF4Control.


Function Documentation

void zrc_cmd_disc_confirm ( nwk_enum_t  Status,
uint8_t  PairingRef,
uint8_t *  SupportedCmd 
)

Callback ZRC command discovery confirm.

The command discovery confirm callback provides information about the sent command discovery request.

Parameters:
StatusStatus of the sent command discovery request
PairingRefPairing reference used for the command discovery request
SupportedCmdPointer to 32 byte array containing the supported commands
void zrc_cmd_disc_indication ( uint8_t  PairingRef)

Callback ZRC command discovery indication.

The command discovery indication callback indicates that a command discovery request command was receiced.

Parameters:
PairingRefPairing reference used for the command discovery request
bool zrc_cmd_disc_request ( uint8_t  PairingRef,
FUNC_PTR  confirm_cb 
)

Sends the ZRC command discovery request.

The command discovery request allows a node to query which user control commands are supported on a remote node, i.e. those specified in the user control pressed command frame.

Parameters:
PairingRefPairing reference of the device to address the request.
confirm_cbCall back pointer for the confirmation.
Returns:
true if request has been added to NHLE-NWK queue successfully; else false
bool zrc_cmd_disc_response ( uint8_t  PairingRef,
uint8_t *  SupportedCmd 
)

ZRC command discovery response.

The command discovery response allows a device to answer to an incoming command discovery request.

Parameters:
PairingRefPairing reference used for the command discovery request
SupportedCmdPointer to 32 byte array containing supported CEC commands
Returns:
true if request has been added to NHLE-NWK queue successfully; else false