Microchip® Advanced Software Framework

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Direct test Mode APIs (DTM)

This group includes all Direct test mode APIs.

Data Structures

struct  at_ble_dtm_t
 data type of DMT status and report, "number_of_packets" will be used only in case of receiving the event AT_BLE_LE_PACKET_REPORT after calling the API More...
 

Enumerations

enum  at_ble_dtm_payload_type_t {
  PAYL_PSEUDO_RAND_9 = 0x00,
  PAYL_11110000,
  PAYL_10101010,
  PAYL_PSEUDO_RAND_15,
  PAYL_ALL_1,
  PAYL_ALL_0,
  PAYL_00001111,
  PAYL_01010101,
  PAYL_END
}
 Direct test mode Transmitter test Packet Payload Type (DTM) More...
 

Functions

at_ble_status_t at_ble_dtm_reset (void)
 pack and send Direct test mode reset command, after calling this API you should wait for AT_BLE_LE_TEST_STATUS event More...
 
at_ble_status_t at_ble_dtm_rx_test_start (uint8_t frequency_index)
 pack and send Direct test mode RX test start command, after calling this API you should wait for AT_BLE_LE_TEST_STATUS event More...
 
at_ble_status_t at_ble_dtm_stop_test (void)
 pack and send Direct test mode stop test command, after calling this API you should wait for AT_BLE_LE_PACKET_REPORT event More...
 
at_ble_status_t at_ble_dtm_tx_test_start (uint8_t frequency_index, uint8_t data_length, at_ble_dtm_payload_type_t payload)
 Pack and send Direct test mode TX test start command, after calling this API you should wait for AT_BLE_LE_TEST_STATUS event. More...
 

Direct test mode Transmitter test Packet Payload Type (DTM)

Enumerator
PAYL_PSEUDO_RAND_9 

Pseudo-random 9 TX test payload type.

PAYL_11110000 

11110000 TX test payload type

PAYL_10101010 

10101010 TX test payload type

PAYL_PSEUDO_RAND_15 

Pseudo-random 15 TX test payload type.

PAYL_ALL_1 

All 1s TX test payload type.

PAYL_ALL_0 

All 0s TX test payload type.

PAYL_00001111 

00001111 TX test payload type

PAYL_01010101 

01010101 TX test payload type

PAYL_END 

Enumeration end value for TX test payload type value check.

at_ble_status_t at_ble_dtm_reset ( void  )

pack and send Direct test mode reset command, after calling this API you should wait for AT_BLE_LE_TEST_STATUS event

Returns
Upon successful completion the function shall return AT_BLE_SUCCESS, Otherwise the function shall return at_ble_status_t
at_ble_status_t at_ble_dtm_rx_test_start ( uint8_t  frequency_index)

pack and send Direct test mode RX test start command, after calling this API you should wait for AT_BLE_LE_TEST_STATUS event

Parameters
[in]frequency_indexfrequency index to do RX test on (from 0 to 39)
Returns
Upon successful completion the function shall return AT_BLE_SUCCESS, Otherwise the function shall return at_ble_status_t
at_ble_status_t at_ble_dtm_stop_test ( void  )

pack and send Direct test mode stop test command, after calling this API you should wait for AT_BLE_LE_PACKET_REPORT event

Returns
Upon successful completion the function shall return AT_BLE_SUCCESS, Otherwise the function shall return at_ble_status_t
at_ble_status_t at_ble_dtm_tx_test_start ( uint8_t  frequency_index,
uint8_t  data_length,
at_ble_dtm_payload_type_t  payload 
)

Pack and send Direct test mode TX test start command, after calling this API you should wait for AT_BLE_LE_TEST_STATUS event.

Parameters
[in]frequency_indexfrequency index to do TX test on (from 0 to 39)
[in]data_lengthpayload length (from 0 to 36)
[in]payloadpacket payload type (from 0 to 7)
Returns
Upon successful completion the function shall return AT_BLE_SUCCESS, Otherwise the function shall return at_ble_status_t