Connectivity codecs for S212

nRF5 SDK v15.0.0

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_event Pointer to the ant_evt_t buffer that shall be encoded.
[in] event_len Size (in bytes) of p_event buffer.
[out] p_buf Pointer to the beginning of a buffer for encoded event packet.
[in,out] p_buf_len in: Size (in bytes) of p_buf buffer. out: Length of encoded contents in p_buf .
Return values
NRF_SUCCESS Encoding success.
NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.
NRF_ERROR_NOT_SUPPORTED Event 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_event Pointer to the ant_evt_t buffer that shall be encoded.
[in] event_len Size (in bytes) of p_event buffer.
[out] p_buf Pointer to the beginning of a buffer for encoded event packet.
[in,out] p_buf_len in: Size (in bytes) of p_buf buffer. out: Length of encoded contents in p_buf .
Return values
NRF_SUCCESS Encoding success.
NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.