Application command request encoders and command response decoders. More...
Functions | |
uint32_t | ant_enable_req_enc (ANT_ENABLE *p_ant_enable_params, uint8_t *const p_buf, uint32_t *const p_buf_len) |
Encodes sd_ant_enable command request. More... | |
uint32_t | ant_enable_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code) |
Decodes response to sd_ant_enable command. More... | |
uint32_t | ant_channel_assign_req_enc (uint8_t channel, uint8_t channel_type, uint8_t network, uint8_t ext_assign, uint8_t *const p_buf, uint32_t *const p_buf_len) |
Encodes sd_ant_channel_assign command request. More... | |
uint32_t | ant_channel_assign_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code) |
Decodes response to sd_ant_channel_assign command. More... | |
uint32_t | ant_channel_open_with_offset_req_enc (uint8_t channel, uint16_t usOffset, uint8_t *const p_buf, uint32_t *const p_buf_len) |
Encodes sd_ant_channel_open command request. More... | |
uint32_t | ant_channel_open_with_offset_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code) |
Decodes response to sd_ant_channel_open command. More... | |
uint32_t | ant_channel_id_set_req_enc (uint8_t channel, uint16_t device_number, uint8_t device_type, uint8_t transmit_type, uint8_t *const p_buf, uint32_t *const p_buf_len) |
Encodes sd_ant_channel_id_set command request. More... | |
uint32_t | ant_channel_id_set_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code) |
Decodes response to sd_ant_channel_id_set command. More... | |
uint32_t | ant_channel_period_set_req_enc (uint8_t channel, uint16_t period, uint8_t *const p_buf, uint32_t *const p_buf_len) |
Encodes sd_ant_channel_period_set command request. More... | |
uint32_t | ant_channel_period_set_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code) |
Decodes response to sd_ant_channel_period_set command. More... | |
uint32_t | ant_channel_radio_freq_set_req_enc (uint8_t channel, uint8_t freq, uint8_t *const p_buf, uint32_t *const p_buf_len) |
Encodes sd_ant_channel_radio_freq_set command request. More... | |
uint32_t | ant_channel_radio_freq_set_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code) |
Decodes response to sd_ant_channel_radio_freq_set command. More... | |
uint32_t | ant_broadcast_message_tx_req_enc (uint8_t channel, uint8_t size, uint8_t const *const p_mesg, uint8_t *const p_buf, uint32_t *const p_buf_len) |
Encodes sd_ant_broadcast_message_tx command request. More... | |
uint32_t | ant_broadcast_message_tx_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code) |
Decodes response to sd_ant_broadcast_message_tx command. More... | |
uint32_t | ant_acknowledge_message_tx_req_enc (uint8_t channel, uint8_t size, uint8_t const *const p_mesg, uint8_t *const p_buf, uint32_t *const p_buf_len) |
Encodes sd_ant_acknowledge_message_tx command request. More... | |
uint32_t | ant_acknowledge_message_tx_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code) |
Decodes response to sd_ant_acknowledge_message_tx command. More... | |
uint32_t | ant_channel_unassign_req_enc (uint8_t channel, uint8_t *const p_buf, uint32_t *const p_buf_len) |
Encodes sd_ant_channel_unassign command request. More... | |
uint32_t | ant_channel_unassign_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code) |
Decodes response to sd_ant_channel_unassign command. More... | |
uint32_t | ant_channel_close_req_enc (uint8_t channel, uint8_t *const p_buf, uint32_t *const p_buf_len) |
Encodes sd_ant_channel_close command request. More... | |
uint32_t | ant_channel_close_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code) |
Decodes response to sd_ant_channel_close command. More... | |
uint32_t | ant_network_address_set_req_enc (uint8_t network, uint8_t const *const p_network_key, uint8_t *const p_buf, uint32_t *const p_buf_len) |
Encodes sd_ant_network_address_set command request. More... | |
uint32_t | ant_network_address_set_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code) |
Decodes response to sd_ant_network_address_set command. More... | |
uint32_t | ant_channel_radio_tx_power_set_req_enc (uint8_t channel, uint8_t tx_power, uint8_t custom_tx_power, uint8_t *const p_buf, uint32_t *const p_buf_len) |
Encodes sd_ant_channel_radio_tx_power_set command request. More... | |
uint32_t | ant_channel_radio_tx_power_set_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code) |
Decodes response to sd_ant_channel_radio_tx_power_set command. More... | |
uint32_t | ant_channel_rx_search_timeout_set_req_enc (uint8_t channel, uint8_t timeout, uint8_t *const p_buf, uint32_t *const p_buf_len) |
Encodes sd_ant_channel_rx_search_timeout_set command request. More... | |
uint32_t | ant_channel_rx_search_timeout_set_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code) |
Decodes response to sd_ant_channel_rx_search_timeout_set command. More... | |
uint32_t | ant_channel_low_priority_rx_search_timeout_set_req_enc (uint8_t channel, uint8_t timeout, uint8_t *const p_buf, uint32_t *const p_buf_len) |
Encodes sd_ant_channel_low_priority_rx_search_timeout_set command request. More... | |
uint32_t | ant_channel_low_priority_rx_search_timeout_set_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code) |
Decodes response to sd_ant_channel_low_priority_rx_search_timeout_set command. More... | |
uint32_t | ant_prox_search_set_req_enc (uint8_t channel, uint8_t prox_threshold, uint8_t custom_prox_threshold, uint8_t *const p_buf, uint32_t *const p_buf_len) |
Encodes sd_ant_prox_search_set command request. More... | |
uint32_t | ant_prox_search_set_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code) |
Decodes response to sd_ant_prox_search_set command. More... | |
uint32_t | ant_search_waveform_set_req_enc (uint8_t channel, uint16_t waveform, uint8_t *const p_buf, uint32_t *const p_buf_len) |
Encodes sd_ant_search_waveform_set command request. More... | |
uint32_t | ant_search_waveform_set_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code) |
Decodes response to sd_ant_search_waveform_set command. More... | |
uint32_t | ant_channel_id_get_req_enc (uint8_t channel, uint8_t *const p_buf, uint32_t *const p_buf_len) |
Encodes sd_ant_channel_id_get command request. More... | |
uint32_t | ant_channel_id_get_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, void *const p_device_number, void *const p_device_type, void *const p_transmit_type, uint32_t *const p_result_code) |
Decodes response to sd_ant_channel_id_get command. More... | |
uint32_t | ant_channel_radio_freq_get_req_enc (uint8_t channel, uint8_t *const p_buf, uint32_t *const p_buf_len) |
Encodes sd_ant_channel_radio_freq_get command request. More... | |
uint32_t | ant_channel_radio_freq_get_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, void *const p_r_freq, uint32_t *const p_result_code) |
Decodes response to sd_ant_channel_radio_freq_get command. More... | |
uint32_t | ant_channel_period_get_req_enc (uint8_t channel, uint8_t *const p_buf, uint32_t *const p_buf_len) |
Encodes sd_ant_channel_period_get command request. More... | |
uint32_t | ant_channel_period_get_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, void *p_period, uint32_t *const p_result_code) |
Decodes response to sd_ant_channel_period_get command. More... | |
uint32_t | ant_search_channel_priority_set_req_enc (uint8_t channel, uint8_t search_priority, uint8_t *const p_buf, uint32_t *const p_buf_len) |
Encodes sd_ant_search_channel_priority_set command request. More... | |
uint32_t | ant_search_channel_priority_set_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code) |
Decodes response to sd_ant_search_channel_priority_set command. More... | |
uint32_t | ant_active_search_sharing_cycles_set_req_enc (uint8_t channel, uint8_t cycles, uint8_t *const p_buf, uint32_t *const p_buf_len) |
Encodes sd_ant_active_search_sharing_cycles_set command request. More... | |
uint32_t | ant_active_search_sharing_cycles_set_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code) |
Decodes response to sd_ant_active_search_sharing_cycles_set command. More... | |
uint32_t | ant_lib_config_set_req_enc (uint8_t ant_lib_config, uint8_t *const p_buf, uint32_t *const p_buf_len) |
Encodes sd_ant_lib_config_set command request. More... | |
uint32_t | ant_lib_config_set_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code) |
Decodes response to sd_ant_lib_config_set command. More... | |
uint32_t | ant_active_search_sharing_cycles_get_req_enc (uint8_t channel, uint8_t *const p_buf, uint32_t *const p_buf_len) |
Encodes sd_ant_active_search_sharing_cycles_get command request. More... | |
uint32_t | ant_active_search_sharing_cycles_get_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, void *const p_cycles, uint32_t *const p_result_code) |
Decodes response to sd_ant_active_search_sharing_cycles_get command. More... | |
uint32_t | ant_lib_config_get_req_enc (uint8_t *const p_buf, uint32_t *const p_buf_len) |
Encodes sd_ant_lib_config_get command request. More... | |
uint32_t | ant_lib_config_get_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, void *const p_ant_lib_config, uint32_t *const p_result_code) |
Decodes response to sd_ant_lib_config_get command. More... | |
uint32_t | ant_lib_config_clear_req_enc (uint8_t ant_lib_config, uint8_t *const p_buf, uint32_t *const p_buf_len) |
Encodes sd_ant_lib_config_clear command request. More... | |
uint32_t | ant_lib_config_clear_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code) |
Decodes response to sd_ant_lib_config_clear command. More... | |
uint32_t | ant_stack_reset_req_enc (uint8_t *const p_buf, uint32_t *const p_buf_len) |
Encodes sd_ant_stack_reset command request. More... | |
uint32_t | ant_stack_reset_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code) |
Decodes response to sd_ant_stack_reset command. More... | |
uint32_t | ant_rx_scan_mode_start_req_enc (uint8_t sync_channel_packets_only, uint8_t *const p_buf, uint32_t *const p_buf_len) |
Encodes sd_ant_rx_scan_mode_start command request. More... | |
uint32_t | ant_rx_scan_mode_start_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code) |
Decodes response to sd_ant_rx_scan_mode_start command. More... | |
uint32_t | ant_id_list_add_req_enc (uint8_t channel, uint8_t const *const p_dev_id, uint8_t list_index, uint8_t *const p_buf, uint32_t *const p_buf_len) |
Encodes sd_ant_id_list_add command request. More... | |
uint32_t | ant_id_list_add_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code) |
Decodes response to sd_ant_id_list_add command. More... | |
uint32_t | ant_id_list_config_req_enc (uint8_t channel, uint8_t id_list_size, uint8_t inc_exc_flag, uint8_t *const p_buf, uint32_t *const p_buf_len) |
Encodes sd_ant_id_list_config command request. More... | |
uint32_t | ant_id_list_config_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code) |
Decodes response to sd_ant_id_list_config command. More... | |
uint32_t | ant_channel_status_get_req_enc (uint8_t channel, uint8_t *const p_buf, uint32_t *const p_buf_len) |
Encodes sd_ant_channel_status_get command request. More... | |
uint32_t | ant_channel_status_get_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, void *const p_status, uint32_t *const p_result_code) |
Decodes response to sd_ant_channel_status_get command. More... | |
uint32_t | ant_cw_test_mode_init_req_enc (uint8_t *const p_buf, uint32_t *const p_buf_len) |
Encodes sd_ant_cw_test_mode_init command request. More... | |
uint32_t | ant_cw_test_mode_init_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code) |
Decodes response to sd_ant_cw_test_mode_init command. More... | |
uint32_t | ant_cw_test_mode_req_enc (uint8_t radio_freq, uint8_t tx_power, uint8_t custom_tx_power, uint8_t mode, uint8_t *const p_buf, uint32_t *const p_buf_len) |
Encodes sd_ant_cw_test_mode command request. More... | |
uint32_t | ant_cw_test_mode_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code) |
Decodes response to sd_ant_cw_test_mode command. More... | |
uint32_t | ant_version_get_req_enc (uint8_t *const p_buf, uint32_t *const p_buf_len) |
Encodes sd_ant_version_get command request. More... | |
uint32_t | ant_version_get_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, void **const p_version, uint32_t *const p_result_code) |
Decodes response to sd_ant_version_get command. More... | |
uint32_t | ant_capabilities_get_req_enc (uint8_t *const p_buf, uint32_t *const p_buf_len) |
Encodes sd_ant_capabilities_get command request. More... | |
uint32_t | ant_capabilities_get_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, void **const pp_capabilities, uint32_t *const p_result_code) |
Decodes response to sd_ant_capabilities_get command. More... | |
uint32_t | ant_crypto_channel_enable_req_enc (uint8_t channel, uint8_t enable, uint8_t key_num, uint8_t decimation_rate, uint8_t *const p_buf, uint32_t *const p_buf_len) |
Encodes sd_ant_crypto_channel_enable command request. More... | |
uint32_t | ant_crypto_channel_enable_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code) |
Decodes response to sd_ant_crypto_channel_enable command. More... | |
uint32_t | ant_adv_burst_config_set_req_enc (uint8_t const *const p_config, uint8_t size, uint8_t *const p_buf, uint32_t *const p_buf_len) |
Encodes sd_ant_adv_burst_config_set command request. More... | |
uint32_t | ant_adv_burst_config_set_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code) |
Decodes response to sd_ant_adv_burst_config_set command. More... | |
uint32_t | ant_crypto_key_set_req_enc (uint8_t key_num, uint8_t const *const p_key, uint8_t *const p_buf, uint32_t *const p_buf_len) |
Encodes sd_ant_crypto_key_set command request. More... | |
uint32_t | ant_crypto_key_set_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code) |
Decodes response to sd_ant_crypto_key_set command. More... | |
uint32_t | ant_crypto_info_set_req_enc (uint8_t type, uint8_t const *const p_info, uint8_t *const p_buf, uint32_t *const p_buf_len) |
Encodes sd_ant_crypto_info_set command request. More... | |
uint32_t | ant_crypto_info_set_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code) |
Decodes response to sd_ant_crypto_info_set command. More... | |
uint32_t | ant_crypto_info_get_req_enc (uint8_t type, uint8_t *const p_buf, uint32_t *const p_buf_len) |
Encodes sd_ant_crypto_info_get command request. More... | |
uint32_t | ant_crypto_info_get_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, void *const p_info, uint32_t *const p_result_code) |
Decodes response to sd_ant_crypto_info_get command. More... | |
uint32_t | ant_coex_config_set_req_enc (uint8_t channel, ANT_BUFFER_PTR const *const p_config, ANT_BUFFER_PTR const *const p_adv_coex_config, uint8_t *const p_buf, uint32_t *const p_buf_len) |
Encodes sd_ant_coex_config_set command request. More... | |
uint32_t | ant_coex_config_set_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, uint32_t *const p_result_code) |
Decodes response to sd_ant_coex_config_set command. More... | |
uint32_t | ant_coex_config_get_req_enc (uint8_t channel, uint8_t *const p_buf, uint32_t *const p_buf_len) |
Encodes sd_ant_coex_config_get command request. More... | |
uint32_t | ant_coex_config_get_rsp_dec (uint8_t const *const p_buf, uint32_t packet_len, void *const p_coex_config, void *const p_adv_coex_config, uint32_t *const p_result_code) |
Decodes response to sd_ant_coex_config_get command. More... | |
Application command request encoders and command response decoders.
uint32_t ant_acknowledge_message_tx_req_enc | ( | uint8_t | channel, |
uint8_t | size, | ||
uint8_t const *const | p_mesg, | ||
uint8_t *const | p_buf, | ||
uint32_t *const | p_buf_len | ||
) |
Encodes sd_ant_acknowledge_message_tx command request.
[in] | channel | Channel is an unsigned char (1 octet) denoting the channel to send the data on. |
[in] | size | Size is an unsigned char (1 octet) denoting the size of the message, ucSize must be 8. |
[in] | p_mesg | Mesg is the buffer where the message is located (array must be 8 octets). |
[in] | p_buf | Pointer to buffer where encoded data command will be returned. |
[in,out] | p_buf_len | in: Size of p_buf buffer. out: Length of encoded command packet. |
NRF_SUCCESS | Encoding success. |
NRF_ERROR_NULL | Encoding failure. NULL pointer supplied. |
NRF_ERROR_INVALID_LENGTH | Encoding failure. Incorrect buffer length. |
uint32_t ant_acknowledge_message_tx_rsp_dec | ( | uint8_t const *const | p_buf, |
uint32_t | packet_len, | ||
uint32_t *const | p_result_code | ||
) |
Decodes response to sd_ant_acknowledge_message_tx command.
[in] | p_buf | Pointer to beginning of command response packet. |
[in] | packet_len | Length (in bytes) of response packet. |
[out] | p_result_code | Command result code. |
NRF_SUCCESS | Success. |
NRF_ERROR_INVALID_LENGTH | Decoding failure. Incorrect buffer length. |
NRF_ERROR_DATA_SIZE | Decoding failure. Length of p_event is too small to hold decoded event. |
uint32_t ant_active_search_sharing_cycles_get_req_enc | ( | uint8_t | channel, |
uint8_t *const | p_buf, | ||
uint32_t *const | p_buf_len | ||
) |
Encodes sd_ant_active_search_sharing_cycles_get command request.
[in] | channel | Channel is an unsigned char (1 octet) denoting the channel number. |
[in] | p_buf | Pointer to buffer where encoded data command will be returned. |
[in,out] | p_buf_len | in: Size of p_buf buffer. out: Length of encoded command packet. |
NRF_SUCCESS | Encoding success. |
NRF_ERROR_NULL | Encoding failure. NULL pointer supplied. |
NRF_ERROR_INVALID_LENGTH | Encoding failure. Incorrect buffer length. |
uint32_t ant_active_search_sharing_cycles_get_rsp_dec | ( | uint8_t const *const | p_buf, |
uint32_t | packet_len, | ||
void *const | p_cycles, | ||
uint32_t *const | p_result_code | ||
) |
Decodes response to sd_ant_active_search_sharing_cycles_get command.
[in] | p_buf | Pointer to beginning of command response packet. |
[in] | packet_len | Length (in bytes) of response packet. |
[in] | p_cycles | Pointer to cycles. |
[out] | p_result_code | Command result code. |
NRF_SUCCESS | Success. |
NRF_ERROR_INVALID_LENGTH | Decoding failure. Incorrect buffer length. |
NRF_ERROR_DATA_SIZE | Decoding failure. Length of p_event is too small to hold decoded event. |
uint32_t ant_active_search_sharing_cycles_set_req_enc | ( | uint8_t | channel, |
uint8_t | cycles, | ||
uint8_t *const | p_buf, | ||
uint32_t *const | p_buf_len | ||
) |
Encodes sd_ant_active_search_sharing_cycles_set command request.
[in] | channel | Channel is an unsigned char (1 octet) denoting the channel number. |
[in] | cycles | Cycles is an unsigned char (1 octet) denoting the number of cycles to set. |
[in] | p_buf | Pointer to buffer where encoded data command will be returned. |
[in,out] | p_buf_len | in: Size of p_buf buffer. out: Length of encoded command packet. |
NRF_SUCCESS | Encoding success. |
NRF_ERROR_NULL | Encoding failure. NULL pointer supplied. |
NRF_ERROR_INVALID_LENGTH | Encoding failure. Incorrect buffer length. |
uint32_t ant_active_search_sharing_cycles_set_rsp_dec | ( | uint8_t const *const | p_buf, |
uint32_t | packet_len, | ||
uint32_t *const | p_result_code | ||
) |
Decodes response to sd_ant_active_search_sharing_cycles_set command.
[in] | p_buf | Pointer to beginning of command response packet. |
[in] | packet_len | Length (in bytes) of response packet. |
[out] | p_result_code | Command result code. |
NRF_SUCCESS | Success. |
NRF_ERROR_INVALID_LENGTH | Decoding failure. Incorrect buffer length. |
NRF_ERROR_DATA_SIZE | Decoding failure. Length of p_event is too small to hold decoded event. |
uint32_t ant_adv_burst_config_set_req_enc | ( | uint8_t const *const | p_config, |
uint8_t | size, | ||
uint8_t *const | p_buf, | ||
uint32_t *const | p_buf_len | ||
) |
Encodes sd_ant_adv_burst_config_set command request.
[in] | p_config | Config is a buffer containing the advanced burst configuration to be set. |
[in] | size | Size is an unsigned char (1 octet) denoting the size of the configuration parameter buffer. |
[in] | p_buf | Pointer to buffer where encoded data command will be returned. |
[in,out] | p_buf_len | in: Size of p_buf buffer. out: Length of encoded command packet. |
NRF_SUCCESS | Encoding success. |
NRF_ERROR_NULL | Encoding failure. NULL pointer supplied. |
NRF_ERROR_INVALID_LENGTH | Encoding failure. Incorrect buffer length. |
uint32_t ant_adv_burst_config_set_rsp_dec | ( | uint8_t const *const | p_buf, |
uint32_t | packet_len, | ||
uint32_t *const | p_result_code | ||
) |
Decodes response to sd_ant_adv_burst_config_set command.
[in] | p_buf | Pointer to beginning of command response packet. |
[in] | packet_len | Length (in bytes) of response packet. |
[out] | p_result_code | Command result code. |
NRF_SUCCESS | Success. |
NRF_ERROR_INVALID_LENGTH | Decoding failure. Incorrect buffer length. |
NRF_ERROR_DATA_SIZE | Decoding failure. Length of p_event is too small to hold decoded event. |
uint32_t ant_broadcast_message_tx_req_enc | ( | uint8_t | channel, |
uint8_t | size, | ||
uint8_t const *const | p_mesg, | ||
uint8_t *const | p_buf, | ||
uint32_t *const | p_buf_len | ||
) |
Encodes sd_ant_broadcast_message_tx command request.
[in] | channel | Channel is an unsigned char (1 octet) denoting the channel to send the data on. |
[in] | size | Size is an unsigned char (1 octet) denoting the size of the message, ucSize must be 8. |
[in] | p_mesg | Mesg is the buffer where the message is located (array must be 8 octets). |
[in] | p_buf | Pointer to buffer where encoded data command will be returned. |
[in,out] | p_buf_len | in: Size of p_buf buffer. out: Length of encoded command packet. |
NRF_SUCCESS | Encoding success. |
NRF_ERROR_NULL | Encoding failure. NULL pointer supplied. |
NRF_ERROR_INVALID_LENGTH | Encoding failure. Incorrect buffer length. |
uint32_t ant_broadcast_message_tx_rsp_dec | ( | uint8_t const *const | p_buf, |
uint32_t | packet_len, | ||
uint32_t *const | p_result_code | ||
) |
Decodes response to sd_ant_broadcast_message_tx command.
[in] | p_buf | Pointer to beginning of command response packet. |
[in] | packet_len | Length (in bytes) of response packet. |
[out] | p_result_code | Command result code. |
NRF_SUCCESS | Success. |
NRF_ERROR_INVALID_LENGTH | Decoding failure. Incorrect buffer length. |
NRF_ERROR_DATA_SIZE | Decoding failure. Length of p_event is too small to hold decoded event. |
uint32_t ant_capabilities_get_req_enc | ( | uint8_t *const | p_buf, |
uint32_t *const | p_buf_len | ||
) |
Encodes sd_ant_capabilities_get command request.
[in] | p_buf | Pointer to buffer where encoded data command will be returned. |
[in,out] | p_buf_len | in: Size of p_buf buffer. out: Length of encoded command packet. |
NRF_SUCCESS | Encoding success. |
NRF_ERROR_NULL | Encoding failure. NULL pointer supplied. |
NRF_ERROR_INVALID_LENGTH | Encoding failure. Incorrect buffer length. |
uint32_t ant_capabilities_get_rsp_dec | ( | uint8_t const *const | p_buf, |
uint32_t | packet_len, | ||
void **const | pp_capabilities, | ||
uint32_t *const | p_result_code | ||
) |
Decodes response to sd_ant_capabilities_get command.
[in] | p_buf | Pointer to beginning of command response packet. |
[in] | packet_len | Length (in bytes) of response packet. |
[in] | pp_capabilities | Pointer to pointer to capabilities buffer. |
[out] | p_result_code | Command result code. |
NRF_SUCCESS | Success. |
NRF_ERROR_INVALID_LENGTH | Decoding failure. Incorrect buffer length. |
NRF_ERROR_DATA_SIZE | Decoding failure. Length of p_event is too small to hold decoded event. |
uint32_t ant_channel_assign_req_enc | ( | uint8_t | channel, |
uint8_t | channel_type, | ||
uint8_t | network, | ||
uint8_t | ext_assign, | ||
uint8_t *const | p_buf, | ||
uint32_t *const | p_buf_len | ||
) |
Encodes sd_ant_channel_assign command request.
[in] | channel | Channel is an unsigned char (1 octet) denoting the channel to assign. |
[in] | channel_type | Channel Type is an unsigned char (1 octet) denoting the channel type. See Assign Channel Parameters/Assign Channel Types in ant_parameters.h. |
[in] | network | Network is an unsigned char (1 octet) denoting the network key to associate with the channel. |
[in] | ext_assign | Ext Assign is a bit field (1 octet) for an extended assign. See Ext. Assign Channel Parameters in ant_parameters.h. |
[in] | p_buf | Pointer to buffer where encoded data command will be returned. |
[in,out] | p_buf_len | in: Size of p_buf buffer. out: Length of encoded command packet. |
NRF_SUCCESS | Encoding success. |
NRF_ERROR_NULL | Encoding failure. NULL pointer supplied. |
NRF_ERROR_INVALID_LENGTH | Encoding failure. Incorrect buffer length. |
uint32_t ant_channel_assign_rsp_dec | ( | uint8_t const *const | p_buf, |
uint32_t | packet_len, | ||
uint32_t *const | p_result_code | ||
) |
Decodes response to sd_ant_channel_assign command.
[in] | p_buf | Pointer to beginning of command response packet. |
[in] | packet_len | Length (in bytes) of response packet. |
[out] | p_result_code | Command result code. |
NRF_SUCCESS | Success. |
NRF_ERROR_INVALID_LENGTH | Decoding failure. Incorrect buffer length. |
NRF_ERROR_DATA_SIZE | Decoding failure. Length of p_event is too small to hold decoded event. |
uint32_t ant_channel_close_req_enc | ( | uint8_t | channel, |
uint8_t *const | p_buf, | ||
uint32_t *const | p_buf_len | ||
) |
Encodes sd_ant_channel_close command request.
[in] | channel | Channel is an unsigned char (1 octet) denoting the channel to close. |
[in] | p_buf | Pointer to buffer where encoded data command will be returned. |
[in,out] | p_buf_len | in: Size of p_buf buffer. out: Length of encoded command packet. |
NRF_SUCCESS | Encoding success. |
NRF_ERROR_NULL | Encoding failure. NULL pointer supplied. |
NRF_ERROR_INVALID_LENGTH | Encoding failure. Incorrect buffer length. |
uint32_t ant_channel_close_rsp_dec | ( | uint8_t const *const | p_buf, |
uint32_t | packet_len, | ||
uint32_t *const | p_result_code | ||
) |
Decodes response to sd_ant_channel_close command.
[in] | p_buf | Pointer to beginning of command response packet. |
[in] | packet_len | Length (in bytes) of response packet. |
[out] | p_result_code | Command result code. |
NRF_SUCCESS | Success. |
NRF_ERROR_INVALID_LENGTH | Decoding failure. Incorrect buffer length. |
NRF_ERROR_DATA_SIZE | Decoding failure. Length of p_event is too small to hold decoded event. |
uint32_t ant_channel_id_get_req_enc | ( | uint8_t | channel, |
uint8_t *const | p_buf, | ||
uint32_t *const | p_buf_len | ||
) |
Encodes sd_ant_channel_id_get command request.
[in] | channel | Channel is an unsigned char (1 octet) denoting the channel number. |
[in] | p_buf | Pointer to buffer where encoded data command will be returned. |
[in,out] | p_buf_len | in: Size of p_buf buffer. out: Length of encoded command packet. |
NRF_SUCCESS | Encoding success. |
NRF_ERROR_NULL | Encoding failure. NULL pointer supplied. |
NRF_ERROR_INVALID_LENGTH | Encoding failure. Incorrect buffer length. |
uint32_t ant_channel_id_get_rsp_dec | ( | uint8_t const *const | p_buf, |
uint32_t | packet_len, | ||
void *const | p_device_number, | ||
void *const | p_device_type, | ||
void *const | p_transmit_type, | ||
uint32_t *const | p_result_code | ||
) |
Decodes response to sd_ant_channel_id_get command.
[in] | p_buf | Pointer to beginning of command response packet. |
[in] | packet_len | Length (in bytes) of response packet. |
[in] | p_device_number | Pointer to device number. |
[in] | p_device_type | Pointer to device type. |
[in] | p_transmit_type | Pointer to transmit type. |
[out] | p_result_code | Command result code. |
NRF_SUCCESS | Success. |
NRF_ERROR_INVALID_LENGTH | Decoding failure. Incorrect buffer length. |
NRF_ERROR_DATA_SIZE | Decoding failure. Length of p_event is too small to hold decoded event. |
uint32_t ant_channel_id_set_req_enc | ( | uint8_t | channel, |
uint16_t | device_number, | ||
uint8_t | device_type, | ||
uint8_t | transmit_type, | ||
uint8_t *const | p_buf, | ||
uint32_t *const | p_buf_len | ||
) |
Encodes sd_ant_channel_id_set command request.
[in] | channel | Channel is an unsigned char (1 octet) denoting the channel number to set. |
[in] | device_number | Device Number is an unsigned short (2 octets) denoting the device number. |
[in] | device_type | Device Type is an unsigned char (1 octet) denoting the device type. |
[in] | transmit_type | Transmit Type is an unsigned char (1 octet) denoting the transmission type. |
[in] | p_buf | Pointer to buffer where encoded data command will be returned. |
[in,out] | p_buf_len | in: Size of p_buf buffer. out: Length of encoded command packet. |
NRF_SUCCESS | Encoding success. |
NRF_ERROR_NULL | Encoding failure. NULL pointer supplied. |
NRF_ERROR_INVALID_LENGTH | Encoding failure. Incorrect buffer length. |
uint32_t ant_channel_id_set_rsp_dec | ( | uint8_t const *const | p_buf, |
uint32_t | packet_len, | ||
uint32_t *const | p_result_code | ||
) |
Decodes response to sd_ant_channel_id_set command.
[in] | p_buf | Pointer to beginning of command response packet. |
[in] | packet_len | Length (in bytes) of response packet. |
[out] | p_result_code | Command result code. |
NRF_SUCCESS | Success. |
NRF_ERROR_INVALID_LENGTH | Decoding failure. Incorrect buffer length. |
NRF_ERROR_DATA_SIZE | Decoding failure. Length of p_event is too small to hold decoded event. |
uint32_t ant_channel_low_priority_rx_search_timeout_set_req_enc | ( | uint8_t | channel, |
uint8_t | timeout, | ||
uint8_t *const | p_buf, | ||
uint32_t *const | p_buf_len | ||
) |
Encodes sd_ant_channel_low_priority_rx_search_timeout_set command request.
[in] | channel | Channel is an unsigned char (1 octet) denoting the channel number to set. |
[in] | timeout | Timeout is an unsigned char (1 octet) denoting the time-out value in 2.5 seconds increments. Default = 2 (5s). |
[in] | p_buf | Pointer to buffer where encoded data command will be returned. |
[in,out] | p_buf_len | in: Size of p_buf buffer. out: Length of encoded command packet. |
NRF_SUCCESS | Encoding success. |
NRF_ERROR_NULL | Encoding failure. NULL pointer supplied. |
NRF_ERROR_INVALID_LENGTH | Encoding failure. Incorrect buffer length. |
uint32_t ant_channel_low_priority_rx_search_timeout_set_rsp_dec | ( | uint8_t const *const | p_buf, |
uint32_t | packet_len, | ||
uint32_t *const | p_result_code | ||
) |
Decodes response to sd_ant_channel_low_priority_rx_search_timeout_set command.
[in] | p_buf | Pointer to beginning of command response packet. |
[in] | packet_len | Length (in bytes) of response packet. |
[out] | p_result_code | Command result code. |
NRF_SUCCESS | Success. |
NRF_ERROR_INVALID_LENGTH | Decoding failure. Incorrect buffer length. |
NRF_ERROR_DATA_SIZE | Decoding failure. Length of p_event is too small to hold decoded event. |
uint32_t ant_channel_open_with_offset_req_enc | ( | uint8_t | channel, |
uint16_t | usOffset, | ||
uint8_t *const | p_buf, | ||
uint32_t *const | p_buf_len | ||
) |
Encodes sd_ant_channel_open command request.
[in] | channel | Channel is an unsigned char (1 octet) denoting the channel to open. |
[in] | usOffset | Denote the offset from which to start the channel. |
[in] | p_buf | Pointer to buffer where encoded data command will be returned. |
[in,out] | p_buf_len | in: Size of p_buf buffer. out: Length of encoded command packet. |
NRF_SUCCESS | Encoding success. |
NRF_ERROR_NULL | Encoding failure. NULL pointer supplied. |
NRF_ERROR_INVALID_LENGTH | Encoding failure. Incorrect buffer length. |
uint32_t ant_channel_open_with_offset_rsp_dec | ( | uint8_t const *const | p_buf, |
uint32_t | packet_len, | ||
uint32_t *const | p_result_code | ||
) |
Decodes response to sd_ant_channel_open command.
[in] | p_buf | Pointer to beginning of command response packet. |
[in] | packet_len | Length (in bytes) of response packet. |
[out] | p_result_code | Command result code. |
NRF_SUCCESS | Success. |
NRF_ERROR_INVALID_LENGTH | Decoding failure. Incorrect buffer length. |
NRF_ERROR_DATA_SIZE | Decoding failure. Length of p_event is too small to hold decoded event. |
uint32_t ant_channel_period_get_req_enc | ( | uint8_t | channel, |
uint8_t *const | p_buf, | ||
uint32_t *const | p_buf_len | ||
) |
Encodes sd_ant_channel_period_get command request.
[in] | channel | Channel is an unsigned char (1 octet) denoting the channel number. |
[in] | p_buf | Pointer to buffer where encoded data command will be returned. |
[in,out] | p_buf_len | in: Size of p_buf buffer. out: Length of encoded command packet. |
NRF_SUCCESS | Encoding success. |
NRF_ERROR_NULL | Encoding failure. NULL pointer supplied. |
NRF_ERROR_INVALID_LENGTH | Encoding failure. Incorrect buffer length. |
uint32_t ant_channel_period_get_rsp_dec | ( | uint8_t const *const | p_buf, |
uint32_t | packet_len, | ||
void * | p_period, | ||
uint32_t *const | p_result_code | ||
) |
Decodes response to sd_ant_channel_period_get command.
[in] | p_buf | Pointer to beginning of command response packet. |
[in] | packet_len | Length (in bytes) of response packet. |
[in] | p_period | Pointer to period |
[out] | p_result_code | Command result code. |
NRF_SUCCESS | Success. |
NRF_ERROR_INVALID_LENGTH | Decoding failure. Incorrect buffer length. |
NRF_ERROR_DATA_SIZE | Decoding failure. Length of p_event is too small to hold decoded event. |
uint32_t ant_channel_period_set_req_enc | ( | uint8_t | channel, |
uint16_t | period, | ||
uint8_t *const | p_buf, | ||
uint32_t *const | p_buf_len | ||
) |
Encodes sd_ant_channel_period_set command request.
[in] | channel | Channel is an unsigned char (1 octet) denoting the channel number to set the period to. |
[in] | period | Period is an unsigned short (2 octets) denoting the period in 32 kHz counts (usPeriod/32768 s). |
[in] | p_buf | Pointer to buffer where encoded data command will be returned. |
[in,out] | p_buf_len | in: Size of p_buf buffer. out: Length of encoded command packet. |
NRF_SUCCESS | Encoding success. |
NRF_ERROR_NULL | Encoding failure. NULL pointer supplied. |
NRF_ERROR_INVALID_LENGTH | Encoding failure. Incorrect buffer length. |
uint32_t ant_channel_period_set_rsp_dec | ( | uint8_t const *const | p_buf, |
uint32_t | packet_len, | ||
uint32_t *const | p_result_code | ||
) |
Decodes response to sd_ant_channel_period_set command.
[in] | p_buf | Pointer to beginning of command response packet. |
[in] | packet_len | Length (in bytes) of response packet. |
[out] | p_result_code | Command result code. |
NRF_SUCCESS | Success. |
NRF_ERROR_INVALID_LENGTH | Decoding failure. Incorrect buffer length. |
NRF_ERROR_DATA_SIZE | Decoding failure. Length of p_event is too small to hold decoded event. |
uint32_t ant_channel_radio_freq_get_req_enc | ( | uint8_t | channel, |
uint8_t *const | p_buf, | ||
uint32_t *const | p_buf_len | ||
) |
Encodes sd_ant_channel_radio_freq_get command request.
[in] | channel | Channel is an unsigned char (1 octet) denoting the channel number. |
[in] | p_buf | Pointer to buffer where encoded data command will be returned. |
[in,out] | p_buf_len | in: Size of p_buf buffer. out: Length of encoded command packet. |
NRF_SUCCESS | Encoding success. |
NRF_ERROR_NULL | Encoding failure. NULL pointer supplied. |
NRF_ERROR_INVALID_LENGTH | Encoding failure. Incorrect buffer length. |
uint32_t ant_channel_radio_freq_get_rsp_dec | ( | uint8_t const *const | p_buf, |
uint32_t | packet_len, | ||
void *const | p_r_freq, | ||
uint32_t *const | p_result_code | ||
) |
Decodes response to sd_ant_channel_radio_freq_get command.
[in] | p_buf | Pointer to beginning of command response packet. |
[in] | packet_len | Length (in bytes) of response packet. |
[in] | p_r_freq | Pointer to radio frequency. |
[out] | p_result_code | Command result code. |
NRF_SUCCESS | Success. |
NRF_ERROR_INVALID_LENGTH | Decoding failure. Incorrect buffer length. |
NRF_ERROR_DATA_SIZE | Decoding failure. Length of p_event is too small to hold decoded event. |
uint32_t ant_channel_radio_freq_set_req_enc | ( | uint8_t | channel, |
uint8_t | freq, | ||
uint8_t *const | p_buf, | ||
uint32_t *const | p_buf_len | ||
) |
Encodes sd_ant_channel_radio_freq_set command request.
[in] | channel | Channel is an unsigned char (1 octet) denoting the channel number to set to. |
[in] | freq | Freq is an unsigned char (1 octet) denoting the radio frequency offset from 2400 MHz (eg. 2466 MHz, ucFreq = 66). |
[in] | p_buf | Pointer to buffer where encoded data command will be returned. |
[in,out] | p_buf_len | in: Size of p_buf buffer. out: Length of encoded command packet. |
NRF_SUCCESS | Encoding success. |
NRF_ERROR_NULL | Encoding failure. NULL pointer supplied. |
NRF_ERROR_INVALID_LENGTH | Encoding failure. Incorrect buffer length. |
uint32_t ant_channel_radio_freq_set_rsp_dec | ( | uint8_t const *const | p_buf, |
uint32_t | packet_len, | ||
uint32_t *const | p_result_code | ||
) |
Decodes response to sd_ant_channel_radio_freq_set command.
[in] | p_buf | Pointer to beginning of command response packet. |
[in] | packet_len | Length (in bytes) of response packet. |
[out] | p_result_code | Command result code. |
NRF_SUCCESS | Success. |
NRF_ERROR_INVALID_LENGTH | Decoding failure. Incorrect buffer length. |
NRF_ERROR_DATA_SIZE | Decoding failure. Length of p_event is too small to hold decoded event. |
uint32_t ant_channel_radio_tx_power_set_req_enc | ( | uint8_t | channel, |
uint8_t | tx_power, | ||
uint8_t | custom_tx_power, | ||
uint8_t *const | p_buf, | ||
uint32_t *const | p_buf_len | ||
) |
Encodes sd_ant_channel_radio_tx_power_set command request.
[in] | channel | Channel is an unsigned char (1 octet) denoting the channel number to assign the radio TX power. |
[in] | tx_power | TX Power is an unsigned char (1 octet) denoting the ANT transmit power index. See Radio TX Power Definitions in ant_parameters.h. |
[in] | custom_tx_power | Custom TX Power is an unsigned char (1 octet) denoting the custom nRF transmit power as defined in nrf51_bitfields.h. Only applicable if tx_power is set to custom TX power selection. |
[in] | p_buf | Pointer to buffer where encoded data command will be returned. |
[in,out] | p_buf_len | in: Size of p_buf buffer. out: Length of encoded command packet. |
NRF_SUCCESS | Encoding success. |
NRF_ERROR_NULL | Encoding failure. NULL pointer supplied. |
NRF_ERROR_INVALID_LENGTH | Encoding failure. Incorrect buffer length. |
uint32_t ant_channel_radio_tx_power_set_rsp_dec | ( | uint8_t const *const | p_buf, |
uint32_t | packet_len, | ||
uint32_t *const | p_result_code | ||
) |
Decodes response to sd_ant_channel_radio_tx_power_set command.
[in] | p_buf | Pointer to beginning of command response packet. |
[in] | packet_len | Length (in bytes) of response packet. |
[out] | p_result_code | Command result code. |
NRF_SUCCESS | Success. |
NRF_ERROR_INVALID_LENGTH | Decoding failure. Incorrect buffer length. |
NRF_ERROR_DATA_SIZE | Decoding failure. Length of p_event is too small to hold decoded event. |
uint32_t ant_channel_rx_search_timeout_set_req_enc | ( | uint8_t | channel, |
uint8_t | timeout, | ||
uint8_t *const | p_buf, | ||
uint32_t *const | p_buf_len | ||
) |
Encodes sd_ant_channel_rx_search_timeout_set command request.
[in] | channel | Channel is an unsigned char (1 octet) denoting the channel number to set. |
[in] | timeout | Timeout is an unsigned char (1 octet) denoting the time-out value. When applied to an assigned slave channel, ucTimeout is in 2.5 second increments. Default = 10 (25 s) at channel assignment. When applied to an assigned master channel, ucTimeout is in 250 ms increments. Default = 0 (disabled) at channel assignment |
[in] | p_buf | Pointer to buffer where encoded data command will be returned. |
[in,out] | p_buf_len | in: Size of p_buf buffer. out: Length of encoded command packet. |
NRF_SUCCESS | Encoding success. |
NRF_ERROR_NULL | Encoding failure. NULL pointer supplied. |
NRF_ERROR_INVALID_LENGTH | Encoding failure. Incorrect buffer length. |
uint32_t ant_channel_rx_search_timeout_set_rsp_dec | ( | uint8_t const *const | p_buf, |
uint32_t | packet_len, | ||
uint32_t *const | p_result_code | ||
) |
Decodes response to sd_ant_channel_rx_search_timeout_set command.
[in] | p_buf | Pointer to beginning of command response packet. |
[in] | packet_len | Length (in bytes) of response packet. |
[out] | p_result_code | Command result code. |
NRF_SUCCESS | Success. |
NRF_ERROR_INVALID_LENGTH | Decoding failure. Incorrect buffer length. |
NRF_ERROR_DATA_SIZE | Decoding failure. Length of p_event is too small to hold decoded event. |
uint32_t ant_channel_status_get_req_enc | ( | uint8_t | channel, |
uint8_t *const | p_buf, | ||
uint32_t *const | p_buf_len | ||
) |
Encodes sd_ant_channel_status_get command request.
[in] | channel | Channel is an unsigned char (1 octet) denoting the channel number. |
[in] | p_buf | Pointer to buffer where encoded data command will be returned. |
[in,out] | p_buf_len | in: Size of p_buf buffer. out: Length of encoded command packet. |
NRF_SUCCESS | Encoding success. |
NRF_ERROR_NULL | Encoding failure. NULL pointer supplied. |
NRF_ERROR_INVALID_LENGTH | Encoding failure. Incorrect buffer length. |
uint32_t ant_channel_status_get_rsp_dec | ( | uint8_t const *const | p_buf, |
uint32_t | packet_len, | ||
void *const | p_status, | ||
uint32_t *const | p_result_code | ||
) |
Decodes response to sd_ant_channel_status_get command.
[in] | p_buf | Pointer to beginning of command response packet. |
[in] | packet_len | Length (in bytes) of response packet. |
[in] | p_status | Pointer to status |
[out] | p_result_code | Command result code. |
NRF_SUCCESS | Success. |
NRF_ERROR_INVALID_LENGTH | Decoding failure. Incorrect buffer length. |
NRF_ERROR_DATA_SIZE | Decoding failure. Length of p_event is too small to hold decoded event. |
uint32_t ant_channel_unassign_req_enc | ( | uint8_t | channel, |
uint8_t *const | p_buf, | ||
uint32_t *const | p_buf_len | ||
) |
Encodes sd_ant_channel_unassign command request.
[in] | channel | Channel is an unsigned char (1 octet) denoting the channel to unassign. |
[in] | p_buf | Pointer to buffer where encoded data command will be returned. |
[in,out] | p_buf_len | in: Size of p_buf buffer. out: Length of encoded command packet. |
NRF_SUCCESS | Encoding success. |
NRF_ERROR_NULL | Encoding failure. NULL pointer supplied. |
NRF_ERROR_INVALID_LENGTH | Encoding failure. Incorrect buffer length. |
uint32_t ant_channel_unassign_rsp_dec | ( | uint8_t const *const | p_buf, |
uint32_t | packet_len, | ||
uint32_t *const | p_result_code | ||
) |
Decodes response to sd_ant_channel_unassign command.
[in] | p_buf | Pointer to beginning of command response packet. |
[in] | packet_len | Length (in bytes) of response packet. |
[out] | p_result_code | Command result code. |
NRF_SUCCESS | Success. |
NRF_ERROR_INVALID_LENGTH | Decoding failure. Incorrect buffer length. |
NRF_ERROR_DATA_SIZE | Decoding failure. Length of p_event is too small to hold decoded event. |
uint32_t ant_coex_config_get_req_enc | ( | uint8_t | channel, |
uint8_t *const | p_buf, | ||
uint32_t *const | p_buf_len | ||
) |
Encodes sd_ant_coex_config_get command request.
[in] | channel | Channel is an unsigned char (1 octet) denoting the channel to query. |
[in] | p_buf | Pointer to buffer where encoded data command will be returned. |
[in,out] | p_buf_len | in: Size of p_buf buffer. out: Length of encoded command packet. |
NRF_SUCCESS | Encoding success. |
NRF_ERROR_NULL | Encoding failure. NULL pointer supplied. |
NRF_ERROR_INVALID_LENGTH | Encoding failure. Incorrect buffer length. |
uint32_t ant_coex_config_get_rsp_dec | ( | uint8_t const *const | p_buf, |
uint32_t | packet_len, | ||
void *const | p_coex_config, | ||
void *const | p_adv_coex_config, | ||
uint32_t *const | p_result_code | ||
) |
Decodes response to sd_ant_coex_config_get command.
[in] | p_buf | Pointer to beginning of command response packet. |
[in] | packet_len | Length (in bytes) of response packet. |
[in] | p_coex_config | Pointer to the coexistence configuration buffer. |
[in] | p_adv_coex_config | Pointer to the advanced coexistence configuration buffer. |
[out] | p_result_code | Command result code. |
NRF_SUCCESS | Success. |
NRF_ERROR_INVALID_LENGTH | Decoding failure. Incorrect buffer length. |
NRF_ERROR_DATA_SIZE | Decoding failure. Length of p_event is too small to hold decoded event. |
uint32_t ant_coex_config_set_req_enc | ( | uint8_t | channel, |
ANT_BUFFER_PTR const *const | p_config, | ||
ANT_BUFFER_PTR const *const | p_adv_coex_config, | ||
uint8_t *const | p_buf, | ||
uint32_t *const | p_buf_len | ||
) |
Encodes sd_ant_coex_config_set command request.
[in] | channel | Channel is an unsigned char (1 octet) denoting the channel for which the coexistence configuration is to be set |
[in] | p_config | Pointer to a buffer containing the configuration to be set. |
[in] | p_adv_coex_config | Pointer to a buffer containing the advanced coexistence configuration to be set. |
[in] | p_buf | Pointer to buffer where encoded data command will be returned. |
[in,out] | p_buf_len | in: Size of p_buf buffer. out: Length of encoded command packet. |
NRF_SUCCESS | Encoding success. |
NRF_ERROR_NULL | Encoding failure. NULL pointer supplied. |
NRF_ERROR_INVALID_LENGTH | Encoding failure. Incorrect buffer length. |
uint32_t ant_coex_config_set_rsp_dec | ( | uint8_t const *const | p_buf, |
uint32_t | packet_len, | ||
uint32_t *const | p_result_code | ||
) |
Decodes response to sd_ant_coex_config_set command.
[in] | p_buf | Pointer to beginning of command response packet. |
[in] | packet_len | Length (in bytes) of response packet. |
[out] | p_result_code | Command result code. |
NRF_SUCCESS | Success. |
NRF_ERROR_INVALID_LENGTH | Decoding failure. Incorrect buffer length. |
NRF_ERROR_DATA_SIZE | Decoding failure. Length of p_event is too small to hold decoded event. |
uint32_t ant_crypto_channel_enable_req_enc | ( | uint8_t | channel, |
uint8_t | enable, | ||
uint8_t | key_num, | ||
uint8_t | decimation_rate, | ||
uint8_t *const | p_buf, | ||
uint32_t *const | p_buf_len | ||
) |
Encodes sd_ant_crypto_channel_enable command request.
[in] | channel | Channel is an unsigned char (1 octet) denoting the channel in which encryption mode is set. |
[in] | enable | Enable is an unsigned char (1 octet) denoting the encryption mode. See Encrypted Channel Defines in ant_parameters.h. |
[in] | key_num | Key num is an unsigned char (1 octet) denoting the key index of the 128-bit key to be used for encryption. The key index range is bound by the number of encrypted channels configured by sd_ant_enable(). If sd_ant_enable() is not used then by default key num is 0. Range is [0 to (num encrypted channels - 1)], if 1 or more encrypted channels are configured. |
[in] | decimation_rate | Decimation rate is an unsigned char (1 octet) denoting the decimate rate to apply for encrypted slave channel. Must be > 0. |
[in] | p_buf | Pointer to buffer where encoded data command will be returned. |
[in,out] | p_buf_len | in: Size of p_buf buffer. out: Length of encoded command packet. |
NRF_SUCCESS | Encoding success. |
NRF_ERROR_NULL | Encoding failure. NULL pointer supplied. |
NRF_ERROR_INVALID_LENGTH | Encoding failure. Incorrect buffer length. |
uint32_t ant_crypto_channel_enable_rsp_dec | ( | uint8_t const *const | p_buf, |
uint32_t | packet_len, | ||
uint32_t *const | p_result_code | ||
) |
Decodes response to sd_ant_crypto_channel_enable command.
[in] | p_buf | Pointer to beginning of command response packet. |
[in] | packet_len | Length (in bytes) of response packet. |
[out] | p_result_code | Command result code. |
NRF_SUCCESS | Success. |
NRF_ERROR_INVALID_LENGTH | Decoding failure. Incorrect buffer length. |
NRF_ERROR_DATA_SIZE | Decoding failure. Length of p_event is too small to hold decoded event. |
uint32_t ant_crypto_info_get_req_enc | ( | uint8_t | type, |
uint8_t *const | p_buf, | ||
uint32_t *const | p_buf_len | ||
) |
Encodes sd_ant_crypto_info_get command request.
[in] | type | Type is an unsigned char (1 octet) denoting the type of information being set. |
[in] | p_buf | Pointer to buffer where encoded data command will be returned. |
[in,out] | p_buf_len | in: Size of p_buf buffer. out: Length of encoded command packet. |
NRF_SUCCESS | Encoding success. |
NRF_ERROR_NULL | Encoding failure. NULL pointer supplied. |
NRF_ERROR_INVALID_LENGTH | Encoding failure. Incorrect buffer length. |
uint32_t ant_crypto_info_get_rsp_dec | ( | uint8_t const *const | p_buf, |
uint32_t | packet_len, | ||
void *const | p_info, | ||
uint32_t *const | p_result_code | ||
) |
Decodes response to sd_ant_crypto_info_get command.
[in] | p_buf | Pointer to beginning of command response packet. |
[in] | packet_len | Length (in bytes) of response packet. |
[in] | p_info | Pointer to the info buffer. |
[out] | p_result_code | Command result code. |
NRF_SUCCESS | Success. |
NRF_ERROR_INVALID_LENGTH | Decoding failure. Incorrect buffer length. |
NRF_ERROR_DATA_SIZE | Decoding failure. Length of p_event is too small to hold decoded event. |
uint32_t ant_crypto_info_set_req_enc | ( | uint8_t | type, |
uint8_t const *const | p_info, | ||
uint8_t *const | p_buf, | ||
uint32_t *const | p_buf_len | ||
) |
Encodes sd_ant_crypto_info_set command request.
[in] | type | Type is an unsigned char (1 octet) denoting the type of information being set. |
[in] | p_info | Pointer to a buffer buffer containing the information being set. |
[in] | p_buf | Pointer to buffer where encoded data command will be returned. |
[in,out] | p_buf_len | in: Size of p_buf buffer. out: Length of encoded command packet. |
NRF_SUCCESS | Encoding success. |
NRF_ERROR_NULL | Encoding failure. NULL pointer supplied. |
NRF_ERROR_INVALID_LENGTH | Encoding failure. Incorrect buffer length. |
uint32_t ant_crypto_info_set_rsp_dec | ( | uint8_t const *const | p_buf, |
uint32_t | packet_len, | ||
uint32_t *const | p_result_code | ||
) |
Decodes response to sd_ant_crypto_info_set command.
[in] | p_buf | Pointer to beginning of command response packet. |
[in] | packet_len | Length (in bytes) of response packet. |
[out] | p_result_code | Command result code. |
NRF_SUCCESS | Success. |
NRF_ERROR_INVALID_LENGTH | Decoding failure. Incorrect buffer length. |
NRF_ERROR_DATA_SIZE | Decoding failure. Length of p_event is too small to hold decoded event. |
uint32_t ant_crypto_key_set_req_enc | ( | uint8_t | key_num, |
uint8_t const *const | p_key, | ||
uint8_t *const | p_buf, | ||
uint32_t *const | p_buf_len | ||
) |
Encodes sd_ant_crypto_key_set command request.
[in] | key_num | Key num is an unsigned char (1 octet) denoting the key index for assignment. |
[in] | p_key | Buffer (16 octets) containing the 128-bit AES key to be assigned to the key index. |
[in] | p_buf | Pointer to buffer where encoded data command will be returned. |
[in,out] | p_buf_len | in: Size of p_buf buffer. out: Length of encoded command packet. |
NRF_SUCCESS | Encoding success. |
NRF_ERROR_NULL | Encoding failure. NULL pointer supplied. |
NRF_ERROR_INVALID_LENGTH | Encoding failure. Incorrect buffer length. |
uint32_t ant_crypto_key_set_rsp_dec | ( | uint8_t const *const | p_buf, |
uint32_t | packet_len, | ||
uint32_t *const | p_result_code | ||
) |
Decodes response to sd_ant_crypto_key_set command.
[in] | p_buf | Pointer to beginning of command response packet. |
[in] | packet_len | Length (in bytes) of response packet. |
[out] | p_result_code | Command result code. |
NRF_SUCCESS | Success. |
NRF_ERROR_INVALID_LENGTH | Decoding failure. Incorrect buffer length. |
NRF_ERROR_DATA_SIZE | Decoding failure. Length of p_event is too small to hold decoded event. |
uint32_t ant_cw_test_mode_init_req_enc | ( | uint8_t *const | p_buf, |
uint32_t *const | p_buf_len | ||
) |
Encodes sd_ant_cw_test_mode_init command request.
[in] | p_buf | Pointer to buffer where encoded data command will be returned. |
[in,out] | p_buf_len | in: Size of p_buf buffer. out: Length of encoded command packet. |
NRF_SUCCESS | Encoding success. |
NRF_ERROR_NULL | Encoding failure. NULL pointer supplied. |
NRF_ERROR_INVALID_LENGTH | Encoding failure. Incorrect buffer length. |
uint32_t ant_cw_test_mode_init_rsp_dec | ( | uint8_t const *const | p_buf, |
uint32_t | packet_len, | ||
uint32_t *const | p_result_code | ||
) |
Decodes response to sd_ant_cw_test_mode_init command.
[in] | p_buf | Pointer to beginning of command response packet. |
[in] | packet_len | Length (in bytes) of response packet. |
[out] | p_result_code | Command result code. |
NRF_SUCCESS | Success. |
NRF_ERROR_INVALID_LENGTH | Decoding failure. Incorrect buffer length. |
NRF_ERROR_DATA_SIZE | Decoding failure. Length of p_event is too small to hold decoded event. |
uint32_t ant_cw_test_mode_req_enc | ( | uint8_t | radio_freq, |
uint8_t | tx_power, | ||
uint8_t | custom_tx_power, | ||
uint8_t | mode, | ||
uint8_t *const | p_buf, | ||
uint32_t *const | p_buf_len | ||
) |
Encodes sd_ant_cw_test_mode command request.
[in] | radio_freq | Radio freq is an unsigned char (1 octet) denoting the radio frequency offset from 2400 MHz for continuous wave mode. (eg. 2466 MHz, ucRadioFreq = 66). |
[in] | tx_power | TX Power is an unsigned char (1 octet) denoting the ANT transmit power index for continuous wave mode. See Radio TX Power Definitions in ant_parameters.h |
[in] | custom_tx_power | Custom TX power is an unsigned char (1 octet) denoting the custom nRF transmit power as defined in nrf51_bitfields.h. Only applicable if ucTxPower is set to custom TX power selection. |
[in] | mode | Mode is an unsigned char (1 octet) denoting test mode type where 0 = cw tx carrier transmission, 1 = cw tx modulated transmission. |
[in] | p_buf | Pointer to buffer where encoded data command will be returned. |
[in,out] | p_buf_len | in: Size of p_buf buffer. out: Length of encoded command packet. |
NRF_SUCCESS | Encoding success. |
NRF_ERROR_NULL | Encoding failure. NULL pointer supplied. |
NRF_ERROR_INVALID_LENGTH | Encoding failure. Incorrect buffer length. |
uint32_t ant_cw_test_mode_rsp_dec | ( | uint8_t const *const | p_buf, |
uint32_t | packet_len, | ||
uint32_t *const | p_result_code | ||
) |
Decodes response to sd_ant_cw_test_mode command.
[in] | p_buf | Pointer to beginning of command response packet. |
[in] | packet_len | Length (in bytes) of response packet. |
[out] | p_result_code | Command result code. |
NRF_SUCCESS | Success. |
NRF_ERROR_INVALID_LENGTH | Decoding failure. Incorrect buffer length. |
NRF_ERROR_DATA_SIZE | Decoding failure. Length of p_event is too small to hold decoded event. |
uint32_t ant_enable_req_enc | ( | ANT_ENABLE * | p_ant_enable_params, |
uint8_t *const | p_buf, | ||
uint32_t *const | p_buf_len | ||
) |
Encodes sd_ant_enable command request.
[in] | p_ant_enable_params | Pointer to an ANT_ENABLE structure. |
[in] | p_buf | Pointer to buffer where encoded data command will be returned. |
[in,out] | p_buf_len | in: Size of p_buf buffer. out: Length of encoded command packet. |
NRF_SUCCESS | Encoding success. |
NRF_ERROR_NULL | Encoding failure. NULL pointer supplied. |
NRF_ERROR_INVALID_LENGTH | Encoding failure. Incorrect buffer length. |
uint32_t ant_enable_rsp_dec | ( | uint8_t const *const | p_buf, |
uint32_t | packet_len, | ||
uint32_t *const | p_result_code | ||
) |
Decodes response to sd_ant_enable command.
[in] | p_buf | Pointer to beginning of command response packet. |
[in] | packet_len | Length (in bytes) of response packet. |
[out] | p_result_code | Command result code. |
NRF_SUCCESS | Success. |
NRF_ERROR_INVALID_LENGTH | Decoding failure. Incorrect buffer length. |
NRF_ERROR_DATA_SIZE | Decoding failure. Length of p_event is too small to hold decoded event. |
uint32_t ant_id_list_add_req_enc | ( | uint8_t | channel, |
uint8_t const *const | p_dev_id, | ||
uint8_t | list_index, | ||
uint8_t *const | p_buf, | ||
uint32_t *const | p_buf_len | ||
) |
Encodes sd_ant_id_list_add command request.
[in] | channel | Channel is an unsigned char (1 octet) denoting the channel number to add the list entry to. |
[in] | p_dev_id | Dev ID is the pointer to the buffer (4 octets) containing device ID information with the following format: Byte0 = DeviceNumber_LSB Byte1 = DeviceNumber_MSB Byte2 = DeviceType Byte3 = TransType |
[in] | list_index | List index is an unsigned char (1 octet) denoting the index where the specified channel ID is to be placed in the list (0-3). |
[in] | p_buf | Pointer to buffer where encoded data command will be returned. |
[in,out] | p_buf_len | in: Size of p_buf buffer. out: Length of encoded command packet. |
NRF_SUCCESS | Encoding success. |
NRF_ERROR_NULL | Encoding failure. NULL pointer supplied. |
NRF_ERROR_INVALID_LENGTH | Encoding failure. Incorrect buffer length. |
uint32_t ant_id_list_add_rsp_dec | ( | uint8_t const *const | p_buf, |
uint32_t | packet_len, | ||
uint32_t *const | p_result_code | ||
) |
Decodes response to sd_ant_id_list_add command.
[in] | p_buf | Pointer to beginning of command response packet. |
[in] | packet_len | Length (in bytes) of response packet. |
[out] | p_result_code | Command result code. |
NRF_SUCCESS | Success. |
NRF_ERROR_INVALID_LENGTH | Decoding failure. Incorrect buffer length. |
NRF_ERROR_DATA_SIZE | Decoding failure. Length of p_event is too small to hold decoded event. |
uint32_t ant_id_list_config_req_enc | ( | uint8_t | channel, |
uint8_t | id_list_size, | ||
uint8_t | inc_exc_flag, | ||
uint8_t *const | p_buf, | ||
uint32_t *const | p_buf_len | ||
) |
Encodes sd_ant_id_list_config command request.
[in] | channel | Channel is an unsigned char (1 octet) denoting the channel number of the device ID list. |
[in] | id_list_size | ID list size is an unsigned char (1 octet) denoting the size of the inclusion or exclusion list (0-4). |
[in] | inc_exc_flag | Inc exc flag is an unsigned char (1 octet) denoting the type of list as Include(0) or Exclude(1). |
[in] | channel | |
[in] | p_buf | Pointer to buffer where encoded data command will be returned. |
[in,out] | p_buf_len | in: Size of p_buf buffer. out: Length of encoded command packet. |
NRF_SUCCESS | Encoding success. |
NRF_ERROR_NULL | Encoding failure. NULL pointer supplied. |
NRF_ERROR_INVALID_LENGTH | Encoding failure. Incorrect buffer length. |
uint32_t ant_id_list_config_rsp_dec | ( | uint8_t const *const | p_buf, |
uint32_t | packet_len, | ||
uint32_t *const | p_result_code | ||
) |
Decodes response to sd_ant_id_list_config command.
[in] | p_buf | Pointer to beginning of command response packet. |
[in] | packet_len | Length (in bytes) of response packet. |
[out] | p_result_code | Command result code. |
NRF_SUCCESS | Success. |
NRF_ERROR_INVALID_LENGTH | Decoding failure. Incorrect buffer length. |
NRF_ERROR_DATA_SIZE | Decoding failure. Length of p_event is too small to hold decoded event. |
uint32_t ant_lib_config_clear_req_enc | ( | uint8_t | ant_lib_config, |
uint8_t *const | p_buf, | ||
uint32_t *const | p_buf_len | ||
) |
Encodes sd_ant_lib_config_clear command request.
[in] | ant_lib_config | ANT lib config is an unsigned char (1 octet) denoting the ANT lib config bit(s) to clear. See ANT Library Config in ant_parameters.h. |
[in] | p_buf | Pointer to buffer where encoded data command will be returned. |
[in,out] | p_buf_len | in: Size of p_buf buffer. out: Length of encoded command packet. |
NRF_SUCCESS | Encoding success. |
NRF_ERROR_NULL | Encoding failure. NULL pointer supplied. |
NRF_ERROR_INVALID_LENGTH | Encoding failure. Incorrect buffer length. |
uint32_t ant_lib_config_clear_rsp_dec | ( | uint8_t const *const | p_buf, |
uint32_t | packet_len, | ||
uint32_t *const | p_result_code | ||
) |
Decodes response to sd_ant_lib_config_clear command.
[in] | p_buf | Pointer to beginning of command response packet. |
[in] | packet_len | Length (in bytes) of response packet. |
[out] | p_result_code | Command result code. |
NRF_SUCCESS | Success. |
NRF_ERROR_INVALID_LENGTH | Decoding failure. Incorrect buffer length. |
NRF_ERROR_DATA_SIZE | Decoding failure. Length of p_event is too small to hold decoded event. |
uint32_t ant_lib_config_get_req_enc | ( | uint8_t *const | p_buf, |
uint32_t *const | p_buf_len | ||
) |
Encodes sd_ant_lib_config_get command request.
[in] | p_buf | Pointer to buffer where encoded data command will be returned. |
[in,out] | p_buf_len | in: Size of p_buf buffer. out: Length of encoded command packet. |
NRF_SUCCESS | Encoding success. |
NRF_ERROR_NULL | Encoding failure. NULL pointer supplied. |
NRF_ERROR_INVALID_LENGTH | Encoding failure. Incorrect buffer length. |
uint32_t ant_lib_config_get_rsp_dec | ( | uint8_t const *const | p_buf, |
uint32_t | packet_len, | ||
void *const | p_ant_lib_config, | ||
uint32_t *const | p_result_code | ||
) |
Decodes response to sd_ant_lib_config_get command.
[in] | p_buf | Pointer to beginning of command response packet. |
[in] | packet_len | Length (in bytes) of response packet. |
[in] | p_ant_lib_config | Pointer to the ANT library configuration. |
[out] | p_result_code | Command result code. |
NRF_SUCCESS | Success. |
NRF_ERROR_INVALID_LENGTH | Decoding failure. Incorrect buffer length. |
NRF_ERROR_DATA_SIZE | Decoding failure. Length of p_event is too small to hold decoded event. |
uint32_t ant_lib_config_set_req_enc | ( | uint8_t | ant_lib_config, |
uint8_t *const | p_buf, | ||
uint32_t *const | p_buf_len | ||
) |
Encodes sd_ant_lib_config_set command request.
[in] | ant_lib_config | ANT Lib Config an unsigned char (1 octet) denoting the ANT lib config bit flags. See ANT Library Config in ant_parameters.h. |
[in] | p_buf | Pointer to buffer where encoded data command will be returned. |
[in,out] | p_buf_len | in: Size of p_buf buffer. out: Length of encoded command packet. |
NRF_SUCCESS | Encoding success. |
NRF_ERROR_NULL | Encoding failure. NULL pointer supplied. |
NRF_ERROR_INVALID_LENGTH | Encoding failure. Incorrect buffer length. |
uint32_t ant_lib_config_set_rsp_dec | ( | uint8_t const *const | p_buf, |
uint32_t | packet_len, | ||
uint32_t *const | p_result_code | ||
) |
Decodes response to sd_ant_lib_config_set command.
[in] | p_buf | Pointer to beginning of command response packet. |
[in] | packet_len | Length (in bytes) of response packet. |
[out] | p_result_code | Command result code. |
NRF_SUCCESS | Success. |
NRF_ERROR_INVALID_LENGTH | Decoding failure. Incorrect buffer length. |
NRF_ERROR_DATA_SIZE | Decoding failure. Length of p_event is too small to hold decoded event. |
uint32_t ant_network_address_set_req_enc | ( | uint8_t | network, |
uint8_t const *const | p_network_key, | ||
uint8_t *const | p_buf, | ||
uint32_t *const | p_buf_len | ||
) |
Encodes sd_ant_network_address_set command request.
[in] | network | Network is an unsigned char (1 octet) denoting the network number to assign the network address to. |
[in] | p_network_key | Network key is the pointer to location of the Network Key (8 octets in length). |
[in] | p_buf | Pointer to buffer where encoded data command will be returned. |
[in,out] | p_buf_len | in: Size of p_buf buffer. out: Length of encoded command packet. |
NRF_SUCCESS | Encoding success. |
NRF_ERROR_NULL | Encoding failure. NULL pointer supplied. |
NRF_ERROR_INVALID_LENGTH | Encoding failure. Incorrect buffer length. |
uint32_t ant_network_address_set_rsp_dec | ( | uint8_t const *const | p_buf, |
uint32_t | packet_len, | ||
uint32_t *const | p_result_code | ||
) |
Decodes response to sd_ant_network_address_set command.
[in] | p_buf | Pointer to beginning of command response packet. |
[in] | packet_len | Length (in bytes) of response packet. |
[out] | p_result_code | Command result code. |
NRF_SUCCESS | Success. |
NRF_ERROR_INVALID_LENGTH | Decoding failure. Incorrect buffer length. |
NRF_ERROR_DATA_SIZE | Decoding failure. Length of p_event is too small to hold decoded event. |
uint32_t ant_prox_search_set_req_enc | ( | uint8_t | channel, |
uint8_t | prox_threshold, | ||
uint8_t | custom_prox_threshold, | ||
uint8_t *const | p_buf, | ||
uint32_t *const | p_buf_len | ||
) |
Encodes sd_ant_prox_search_set command request.
[in] | channel | Channel is an unsigned char (1 octet) denoting the channel number. |
[in] | prox_threshold | Prox threshold is an unsigned char (1 octet) denoting the minimum RSSI threshold required for acquisition during a search. See Radio Proximity Search Threshold in ant_parameters.h. |
[in] | custom_prox_threshold | Custom prox threshold is an unsigned char (1 octet) denoting the custom minimum RSSI threshold for acquisition during a search. Only applicable if ucProxThreshold is set to custom proximity selection. |
[in] | p_buf | Pointer to buffer where encoded data command will be returned. |
[in,out] | p_buf_len | in: Size of p_buf buffer. out: Length of encoded command packet. |
NRF_SUCCESS | Encoding success. |
NRF_ERROR_NULL | Encoding failure. NULL pointer supplied. |
NRF_ERROR_INVALID_LENGTH | Encoding failure. Incorrect buffer length. |
uint32_t ant_prox_search_set_rsp_dec | ( | uint8_t const *const | p_buf, |
uint32_t | packet_len, | ||
uint32_t *const | p_result_code | ||
) |
Decodes response to sd_ant_prox_search_set command.
[in] | p_buf | Pointer to beginning of command response packet. |
[in] | packet_len | Length (in bytes) of response packet. |
[out] | p_result_code | Command result code. |
NRF_SUCCESS | Success. |
NRF_ERROR_INVALID_LENGTH | Decoding failure. Incorrect buffer length. |
NRF_ERROR_DATA_SIZE | Decoding failure. Length of p_event is too small to hold decoded event. |
uint32_t ant_rx_scan_mode_start_req_enc | ( | uint8_t | sync_channel_packets_only, |
uint8_t *const | p_buf, | ||
uint32_t *const | p_buf_len | ||
) |
Encodes sd_ant_rx_scan_mode_start command request.
[in] | sync_channel_packets_only | Sync channel packets only is an unsigned char (1 octet) denoting synchronous channel only scanning mode. 0 = disable, 1 = enable. |
[in] | p_buf | Pointer to buffer where encoded data command will be returned. |
[in,out] | p_buf_len | in: Size of p_buf buffer. out: Length of encoded command packet. |
NRF_SUCCESS | Encoding success. |
NRF_ERROR_NULL | Encoding failure. NULL pointer supplied. |
NRF_ERROR_INVALID_LENGTH | Encoding failure. Incorrect buffer length. |
uint32_t ant_rx_scan_mode_start_rsp_dec | ( | uint8_t const *const | p_buf, |
uint32_t | packet_len, | ||
uint32_t *const | p_result_code | ||
) |
Decodes response to sd_ant_rx_scan_mode_start command.
[in] | p_buf | Pointer to beginning of command response packet. |
[in] | packet_len | Length (in bytes) of response packet. |
[out] | p_result_code | Command result code. |
NRF_SUCCESS | Success. |
NRF_ERROR_INVALID_LENGTH | Decoding failure. Incorrect buffer length. |
NRF_ERROR_DATA_SIZE | Decoding failure. Length of p_event is too small to hold decoded event. |
uint32_t ant_search_channel_priority_set_req_enc | ( | uint8_t | channel, |
uint8_t | search_priority, | ||
uint8_t *const | p_buf, | ||
uint32_t *const | p_buf_len | ||
) |
Encodes sd_ant_search_channel_priority_set command request.
[in] | channel | Channel is an unsigned char (1 octet) denoting the channel number. |
[in] | search_priority | Search Priority is an unsigned char (1 octet) denoting the search priority value. 0 to 7 (Default = 0). |
[in] | p_buf | Pointer to buffer where encoded data command will be returned. |
[in,out] | p_buf_len | in: Size of p_buf buffer. out: Length of encoded command packet. |
NRF_SUCCESS | Encoding success. |
NRF_ERROR_NULL | Encoding failure. NULL pointer supplied. |
NRF_ERROR_INVALID_LENGTH | Encoding failure. Incorrect buffer length. |
uint32_t ant_search_channel_priority_set_rsp_dec | ( | uint8_t const *const | p_buf, |
uint32_t | packet_len, | ||
uint32_t *const | p_result_code | ||
) |
Decodes response to sd_ant_search_channel_priority_set command.
[in] | p_buf | Pointer to beginning of command response packet. |
[in] | packet_len | Length (in bytes) of response packet. |
[out] | p_result_code | Command result code. |
NRF_SUCCESS | Success. |
NRF_ERROR_INVALID_LENGTH | Decoding failure. Incorrect buffer length. |
NRF_ERROR_DATA_SIZE | Decoding failure. Length of p_event is too small to hold decoded event. |
uint32_t ant_search_waveform_set_req_enc | ( | uint8_t | channel, |
uint16_t | waveform, | ||
uint8_t *const | p_buf, | ||
uint32_t *const | p_buf_len | ||
) |
Encodes sd_ant_search_waveform_set command request.
[in] | channel | Channel is an unsigned char (1 octet) denoting the channel number. |
[in] | waveform | Waveform is an unsigned short (2 octets) denoting the channel waveform period (usWaveform/32768 s). Default = 316. |
[in] | p_buf | Pointer to buffer where encoded data command will be returned. |
[in,out] | p_buf_len | in: Size of p_buf buffer. out: Length of encoded command packet. |
NRF_SUCCESS | Encoding success. |
NRF_ERROR_NULL | Encoding failure. NULL pointer supplied. |
NRF_ERROR_INVALID_LENGTH | Encoding failure. Incorrect buffer length. |
uint32_t ant_search_waveform_set_rsp_dec | ( | uint8_t const *const | p_buf, |
uint32_t | packet_len, | ||
uint32_t *const | p_result_code | ||
) |
Decodes response to sd_ant_search_waveform_set command.
[in] | p_buf | Pointer to beginning of command response packet. |
[in] | packet_len | Length (in bytes) of response packet. |
[out] | p_result_code | Command result code. |
NRF_SUCCESS | Success. |
NRF_ERROR_INVALID_LENGTH | Decoding failure. Incorrect buffer length. |
NRF_ERROR_DATA_SIZE | Decoding failure. Length of p_event is too small to hold decoded event. |
uint32_t ant_stack_reset_req_enc | ( | uint8_t *const | p_buf, |
uint32_t *const | p_buf_len | ||
) |
Encodes sd_ant_stack_reset command request.
[in] | p_buf | Pointer to buffer where encoded data command will be returned. |
[in,out] | p_buf_len | in: Size of p_buf buffer. out: Length of encoded command packet. |
NRF_SUCCESS | Encoding success. |
NRF_ERROR_NULL | Encoding failure. NULL pointer supplied. |
NRF_ERROR_INVALID_LENGTH | Encoding failure. Incorrect buffer length. |
uint32_t ant_stack_reset_rsp_dec | ( | uint8_t const *const | p_buf, |
uint32_t | packet_len, | ||
uint32_t *const | p_result_code | ||
) |
Decodes response to sd_ant_stack_reset command.
[in] | p_buf | Pointer to beginning of command response packet. |
[in] | packet_len | Length (in bytes) of response packet. |
[out] | p_result_code | Command result code. |
NRF_SUCCESS | Success. |
NRF_ERROR_INVALID_LENGTH | Decoding failure. Incorrect buffer length. |
NRF_ERROR_DATA_SIZE | Decoding failure. Length of p_event is too small to hold decoded event. |
uint32_t ant_version_get_req_enc | ( | uint8_t *const | p_buf, |
uint32_t *const | p_buf_len | ||
) |
Encodes sd_ant_version_get command request.
[in] | p_buf | Pointer to buffer where encoded data command will be returned. |
[in,out] | p_buf_len | in: Size of p_buf buffer. out: Length of encoded command packet. |
NRF_SUCCESS | Encoding success. |
NRF_ERROR_NULL | Encoding failure. NULL pointer supplied. |
NRF_ERROR_INVALID_LENGTH | Encoding failure. Incorrect buffer length. |
uint32_t ant_version_get_rsp_dec | ( | uint8_t const *const | p_buf, |
uint32_t | packet_len, | ||
void **const | p_version, | ||
uint32_t *const | p_result_code | ||
) |
Decodes response to sd_ant_version_get command.
[in] | p_buf | Pointer to beginning of command response packet. |
[in] | packet_len | Length (in bytes) of response packet. |
[in] | p_version | Pointer to version string buffer. |
[out] | p_result_code | Command result code. |
NRF_SUCCESS | Success. |
NRF_ERROR_INVALID_LENGTH | Decoding failure. Incorrect buffer length. |
NRF_ERROR_DATA_SIZE | Decoding failure. Length of p_event is too small to hold decoded event. |