nRF5 SDK  v14.1.0
Choose documentation:
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
Connectivity codecs for S212

Modules

 Connectivity command request decoders and command response encoders
 Connectivity command request decoders and command response encoders.
 

Functions

uint32_t ant_event_enc (ant_evt_t const *const p_event, uint32_t event_len, uint8_t *const p_buf, uint32_t *const p_buf_len)
 Event encoding dispatcher. More...
 
uint32_t ant_event_rx_enc (ant_evt_t const *const p_event, uint32_t event_len, uint8_t *const p_buf, uint32_t *const p_buf_len)
 Encodes ant_event_rx event. More...
 

Detailed Description

Function Documentation

uint32_t ant_event_enc ( ant_evt_t const *const  p_event,
uint32_t  event_len,
uint8_t *const  p_buf,
uint32_t *const  p_buf_len 
)

Event encoding dispatcher.

The event encoding dispatcher will route the event packet to the correct encoder which in turn encodes the contents of the event and updates the p_buf buffer.

Parameters
[in]p_eventPointer to the ant_evt_t buffer that shall be encoded.
[in]event_lenSize (in bytes) of p_event buffer.
[out]p_bufPointer to the beginning of a buffer for encoded event packet.
[in,out]p_buf_lenin: Size (in bytes) of p_buf buffer. out: Length of encoded contents in p_buf.
Return values
NRF_SUCCESSEncoding success.
NRF_ERROR_NULLEncoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTHEncoding failure. Incorrect buffer length.
NRF_ERROR_NOT_SUPPORTEDEvent encoder is not implemented.
uint32_t ant_event_rx_enc ( ant_evt_t const *const  p_event,
uint32_t  event_len,
uint8_t *const  p_buf,
uint32_t *const  p_buf_len 
)

Encodes ant_event_rx event.

Parameters
[in]p_eventPointer to the ant_evt_t buffer that shall be encoded.
[in]event_lenSize (in bytes) of p_event buffer.
[out]p_bufPointer to the beginning of a buffer for encoded event packet.
[in,out]p_buf_lenin: Size (in bytes) of p_buf buffer. out: Length of encoded contents in p_buf.
Return values
NRF_SUCCESSEncoding success.
NRF_ERROR_NULLEncoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTHEncoding failure. Incorrect buffer length.