Configuring Antenna Diversity Command Line Interface#
OpenThread SDK releases beginning with 1.1.0.0 provide a means to query and set Rx and Tx diversity modes using the Antenna Diversity CLI. Support for the Antenna Diversity CLI is:
Enabled by default.
Available as a configuration option on the OpenThread Antenna Diversity component.
Requires the OpenThread CLI and Antenna Diversity components installed in your project.
Note: For Silicon Labs OpenThread SDK releases prior to 1.2.0.0, the Antenna Diversity CLI is available as a configuration option on the OpenThread CLI component.
The complete list of supported Antenna Diversity CLI commands is summarized in the following table.
| Command | Command Description | API Function | Arguments | ||
|---|---|---|---|---|---|
| Name | Type | Description | |||
| antenna get- tx-mode | Returns the current setting for the Antenna Tx Diversity mode. | sl_rail_util_ant_div_ get_tx_antenna_mo de | N/A | N/A | Interpretation of returned results for get operations and permissible values for set operations are as follows: SL_RAIL_UTIL_ANTENNA_MODE_DISABLED: 0 (Don't alter antenna selection) SL_RAIL_UTIL_ANTENNA_MODE_ENABLE1: 1 (Use antenna 1) SL_RAIL_UTIL_ANTENNA_MODE_ENABLE2: 2 (Use antenna 2) SL_RAIL_UTIL_ANTENNA_MODE_DIVERSITY: 3 (Choose antenna 1 or 2 dynamically) |
| antenna set- tx-mode | Sets Tx Diversity mode to argument. | sl_rail_util_ant_div_ set_tx_antenna_mo de | Tx Antenna Mode | uint8_t | |
| antenna get- rx-mode | Returns the current setting for Antenna Rx Diversity mode. | sl_rail_util_ant_div_ get_rx_antenna_mo de | N/A | N/A | |
| antenna set- rx-mode | Sets Rx Diversity mode to argument. | sl_rail_util_ant_div_ set_rx_antenna_mo de | Rx Antenna Mode | uint8_t | |
| antenna get- active-phy | Returns the current PHY being used. | sl_rail_util_get_acti ve_radio_config | N/A | N/A | - |
Tx diversity settings can be changed using the CLI without any restriction. However, Rx Diversity options that require switching from standard PHY to diversity PHY or vice-versa are only permitted when the Runtime PHY Select configuration option on the RAIL Utility Antenna Diversity Configuration component is enabled, as shown in the following figure:
Disable Antenna Diversity CLI Support#
Open the configuration options of the OpenThread Antenna Diversity component.
Disable the option.
Note: For Silicon Labs OpenThread SDK releases prior to 1.2.0.0, disable the Antenna Diversity CLI configuration option on the OpenThread CLI component.