DTM Application command request encoders and command response decoders

nRF5 SDK v12.1.0

DTM Application command request encoders and command response decoders. More...

Functions

uint32_t ble_dtm_init_req_enc ( app_uart_stream_comm_params_t const *const p_uart_comm_params, uint8_t *const p_buf, uint32_t *const p_buf_len)
Encodes the ble_dtm_init command request. More...
uint32_t ble_dtm_init_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code)
Decodes the response ble_dtm_init command. More...
uint32_t ble_dtm_init ( app_uart_stream_comm_params_t *p_uart_comm_params)
Function to initializing the DTM mode. More...

Detailed Description

DTM Application command request encoders and command response decoders.

Enumeration Type Documentation

Enumeration of supported baud rates.

Enumerator
UART_BAUD_RATE_1200

Baud rate 1200.

UART_BAUD_RATE_2400

Baud rate 2400.

UART_BAUD_RATE_4800

Baud rate 4800.

UART_BAUD_RATE_9600

Baud rate 9600.

UART_BAUD_RATE_14400

Baud rate 14400.

UART_BAUD_RATE_19200

Baud rate 19200.

UART_BAUD_RATE_28800

Baud rate 28800.

UART_BAUD_RATE_38400

Baud rate 38400.

UART_BAUD_RATE_57600

Baud rate 57600.

UART_BAUD_RATE_76800

Baud rate 76800.

UART_BAUD_RATE_115200

Baud rate 115200.

UART_BAUD_RATE_230400

Baud rate 230400.

UART_BAUD_RATE_250000

Baud rate 250000.

UART_BAUD_RATE_460800

Baud rate 460800.

UART_BAUD_RATE_921600

Baud rate 921600.

UART_BAUD_RATE_1000000

Baud rate 1000000.

UART_BAUD_RATE_MAX

Enumeration upper bound.

Function Documentation

uint32_t ble_dtm_init ( app_uart_stream_comm_params_t * p_uart_comm_params )

Function to initializing the DTM mode.

Parameters
[in] p_uart_comm_params Pointer to the DTM UART configuration parameters.
Return values
NRF_SUCCESS Encoding success.
NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
uint32_t ble_dtm_init_req_enc ( app_uart_stream_comm_params_t const *const p_uart_comm_params ,
uint8_t *const p_buf ,
uint32_t *const p_buf_len
)

Encodes the ble_dtm_init command request.

See Also
General rules for encoding data for packet format, ble_dtm_init_rsp_dec for command response decoder.
Parameters
[in] p_uart_comm_params Pointer to the UART configuration parameters.
[in] p_buf Pointer to the buffer where encoded data command will be returned.
[in,out] p_buf_len in: Size of p_buf buffer. out: Length of the encoded command packet.
Return values
NRF_SUCCESS Encoding success.
NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.
uint32_t ble_dtm_init_rsp_dec ( uint8_t const *const p_buf ,
uint32_t packet_len ,
uint32_t *const p_result_code
)

Decodes the response ble_dtm_init command.

See Also
General rules for encoding data for packet format, ble_dtm_init_req_enc for command request encoder.
Parameters
[in] p_buf Pointer to the beginning of a command response packet.
[in] packet_len Length (in bytes) of the response packet.
[out] p_result_code Command result code.
Return values
NRF_SUCCESS Decoding success.
NRF_ERROR_NULL Decoding failure. NULL pointer supplied.
NRF_ERROR_INVALID_LENGTH Decoding failure. Incorrect buffer length.