CTE Transmitter (cte_transmitter)#
Commands and events in this class can be used to manage Constant Tone Extension (CTE) transmission.
CTE feature is only supported by specific devices. Commands from this class will return bg_err_not_supported on devices that do not support CTE.
cte_transmitter commands#
cte_transmitter_clear_dtm_parameters#
This command can be used to clear CTE related parameters that were previously set for LE transmitter test. Default values will be restored for these parameters.
Command#
Byte | Type | Name | Description |
|---|---|---|---|
0 | 0x20 | hilen | Message type: Command |
1 | 0x00 | lolen | Minimum payload length |
2 | 0x44 | class | Message class:CTE Transmitter |
3 | 0x05 | method | Message ID |
Response#
Byte | Type | Name | Description |
|---|---|---|---|
0 | 0x20 | hilen | Message type: Response |
1 | 0x02 | lolen | Minimum payload length |
2 | 0x44 | class | Message class:CTE Transmitter |
3 | 0x05 | method | Message ID |
4-5 | uint16 | result | Result code |
0: success
Non-zero: an error occurred
For other values refer to the Error codes(error-codes)
API#
/* Function */
struct gecko_msg_cte_transmitter_clear_dtm_parameters_rsp_t *gecko_cmd_cte_transmitter_clear_dtm_parameters();
/* Response id */
gecko_rsp_cte_transmitter_clear_dtm_parameters_id
/* Response structure */
struct gecko_msg_cte_transmitter_clear_dtm_parameters_rsp_t
{
uint16 result
} cte_transmitter_disable_cte_response#
This command can be used to disable CTE responses on a connection.
Command#
Byte | Type | Name | Description |
|---|---|---|---|
0 | 0x20 | hilen | Message type: Command |
1 | 0x01 | lolen | Minimum payload length |
2 | 0x44 | class | Message class:CTE Transmitter |
3 | 0x01 | method | Message ID |
4 | uint8 | connection | Connection handle |
Response#
Byte | Type | Name | Description |
|---|---|---|---|
0 | 0x20 | hilen | Message type: Response |
1 | 0x02 | lolen | Minimum payload length |
2 | 0x44 | class | Message class:CTE Transmitter |
3 | 0x01 | method | Message ID |
4-5 | uint16 | result | Result code |
0: success
Non-zero: an error occurred
For other values refer to the Error codes(error-codes)
API#
/* Function */
struct gecko_msg_cte_transmitter_disable_cte_response_rsp_t *gecko_cmd_cte_transmitter_disable_cte_response(uint8 connection);
/* Response id */
gecko_rsp_cte_transmitter_disable_cte_response_id
/* Response structure */
struct gecko_msg_cte_transmitter_disable_cte_response_rsp_t
{
uint16 result
} cte_transmitter_enable_cte_response#
This command can be used to enable CTE responses on a connection.
Command#
Byte | Type | Name | Description |
|---|---|---|---|
0 | 0x20 | hilen | Message type: Command |
1 | 0x03 | lolen | Minimum payload length |
2 | 0x44 | class | Message class:CTE Transmitter |
3 | 0x00 | method | Message ID |
4 | uint8 | connection | Connection handle |
5 | uint8 | cte_types | CTE types. Bitmask of followings, |
Bit 0: AoA CTE response
Bit 1: AoD CTE response with 1us slots
Bit 2: AoD CTE response with 2us slots
6 | uint8array | switching_pattern | Antenna switching pattern
Response#
Byte | Type | Name | Description |
|---|---|---|---|
0 | 0x20 | hilen | Message type: Response |
1 | 0x02 | lolen | Minimum payload length |
2 | 0x44 | class | Message class:CTE Transmitter |
3 | 0x00 | method | Message ID |
4-5 | uint16 | result | Result code |
0: success
Non-zero: an error occurred
For other values refer to the Error codes(error-codes)
API#
/* Function */
struct gecko_msg_cte_transmitter_enable_cte_response_rsp_t *gecko_cmd_cte_transmitter_enable_cte_response(uint8 connection, uint8 cte_types, uint8 switching_pattern_len, const uint8 *switching_pattern_data);
/* Response id */
gecko_rsp_cte_transmitter_enable_cte_response_id
/* Response structure */
struct gecko_msg_cte_transmitter_enable_cte_response_rsp_t
{
uint16 result
} cte_transmitter_set_dtm_parameters#
This command can be used to set CTE related parameters of LE transmitter test.
Command#
Byte | Type | Name | Description |
|---|---|---|---|
0 | 0x20 | hilen | Message type: Command |
1 | 0x03 | lolen | Minimum payload length |
2 | 0x44 | class | Message class:CTE Transmitter |
3 | 0x04 | method | Message ID |
4 | uint8 | cte_length | Expected length of the Constant Tone Extension in |
8 us units | |||
5 | uint8 | cte_type | CTE type |
0: AoA CTE
1: AoD CTE with 1 us slots
2: AoD CTE with 2 us slots
6 | uint8array | switching_pattern | Antenna switching pattern
Response#
Byte | Type | Name | Description |
|---|---|---|---|
0 | 0x20 | hilen | Message type: Response |
1 | 0x02 | lolen | Minimum payload length |
2 | 0x44 | class | Message class:CTE Transmitter |
3 | 0x04 | method | Message ID |
4-5 | uint16 | result | Result code |
0: success
Non-zero: an error occurred
For other values refer to the Error codes(error-codes)
API#
/* Function */
struct gecko_msg_cte_transmitter_set_dtm_parameters_rsp_t *gecko_cmd_cte_transmitter_set_dtm_parameters(uint8 cte_length, uint8 cte_type, uint8 switching_pattern_len, const uint8 *switching_pattern_data);
/* Response id */
gecko_rsp_cte_transmitter_set_dtm_parameters_id
/* Response structure */
struct gecko_msg_cte_transmitter_set_dtm_parameters_rsp_t
{
uint16 result
}