From 758e18509041eaf71e9f5fe236b6d9c5b8c76e9d Mon Sep 17 00:00:00 2001 From: muhaidong Date: Thu, 14 Jul 2022 16:36:46 +0800 Subject: [PATCH 1/3] docs: update wifi multiple antennas docs --- docs/en/api-guides/wifi.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/en/api-guides/wifi.rst b/docs/en/api-guides/wifi.rst index 711cc4c687..2722b3a390 100644 --- a/docs/en/api-guides/wifi.rst +++ b/docs/en/api-guides/wifi.rst @@ -1662,6 +1662,8 @@ The Wi-Fi multiple antennas selecting can be depicted as following picture:: Up to four GPIOs are connected to the four active high antenna_select pins. {IDF_TARGET_NAME} can select the antenna by control the GPIO[0:3]. The API :cpp:func:`esp_wifi_set_ant_gpio()` is used to configure which GPIOs are connected to antenna_selects. If GPIO[x] is connected to antenna_select[x], then gpio_config->gpio_cfg[x].gpio_select should be set to 1 and gpio_config->gpio_cfg[x].gpio_num should be provided. +For the specific implementation of Antenna Switch, there may be illegal values in antenna_select[0:3]. Which means that {IDF_TARGET_NAME} may supports less then sixteen antennas through external antenna switch. For example, ESP32-WROOM-DA supports two antennas which uses RTC6603SP as Antenna Switch. two GPIOs are connected to the two active high antenna_select pins. The value '0b00' and '0b11' are illegal values, the value '0b01' means the antenna 0 is selected, the value '0b10' means the antenna 1 is selected. + Although up to sixteen anteenas are supported, only one or two antennas can be simultaneously enabled for RX/TX. The API :cpp:func:`esp_wifi_set_ant()` is used to configure which antennas are enabled. The enabled antennas selecting algorithm is also configured by :cpp:func:`esp_wifi_set_ant()`. The RX/TX antenna mode can be WIFI_ANT_MODE_ANT0, WIFI_ANT_MODE_ANT1 or WIFI_ANT_MODE_AUTO. If the antenna mode is WIFI_ANT_MODE_ANT0, the enabled antenna 0 is selected for RX/TX data. If the antenna mode is WIFI_ANT_MODE_ANT1, the enabled antenna 1 is selected for RX/TX data. Otherwise, WiFi automatically selects the antenna that has better signal from the enabled antennas. From 6ceabe794e92a5701ee9c5fb93fbb41487f52bc8 Mon Sep 17 00:00:00 2001 From: muhaidong Date: Thu, 14 Jul 2022 16:42:55 +0800 Subject: [PATCH 2/3] Apply 2 suggestions by Marius Vikhammer --- docs/en/api-guides/wifi.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/en/api-guides/wifi.rst b/docs/en/api-guides/wifi.rst index 2722b3a390..8d421bc26e 100644 --- a/docs/en/api-guides/wifi.rst +++ b/docs/en/api-guides/wifi.rst @@ -1662,9 +1662,9 @@ The Wi-Fi multiple antennas selecting can be depicted as following picture:: Up to four GPIOs are connected to the four active high antenna_select pins. {IDF_TARGET_NAME} can select the antenna by control the GPIO[0:3]. The API :cpp:func:`esp_wifi_set_ant_gpio()` is used to configure which GPIOs are connected to antenna_selects. If GPIO[x] is connected to antenna_select[x], then gpio_config->gpio_cfg[x].gpio_select should be set to 1 and gpio_config->gpio_cfg[x].gpio_num should be provided. -For the specific implementation of Antenna Switch, there may be illegal values in antenna_select[0:3]. Which means that {IDF_TARGET_NAME} may supports less then sixteen antennas through external antenna switch. For example, ESP32-WROOM-DA supports two antennas which uses RTC6603SP as Antenna Switch. two GPIOs are connected to the two active high antenna_select pins. The value '0b00' and '0b11' are illegal values, the value '0b01' means the antenna 0 is selected, the value '0b10' means the antenna 1 is selected. +For the specific implementation of Antenna Switch, there may be illegal values in antenna_select[0:3]. Which means that {IDF_TARGET_NAME} may supports less then sixteen antennas through external antenna switch. For example, ESP32-WROOM-DA supports two antennas which uses RTC6603SP as Antenna Switch. Two GPIOs are connected to the two active high antenna_select pins. The value '0b00' and '0b11' are illegal values, the value '0b01' means the antenna 0 is selected, the value '0b10' means the antenna 1 is selected. -Although up to sixteen anteenas are supported, only one or two antennas can be simultaneously enabled for RX/TX. The API :cpp:func:`esp_wifi_set_ant()` is used to configure which antennas are enabled. +Although up to sixteen antennas are supported, only one or two antennas can be simultaneously enabled for RX/TX. The API :cpp:func:`esp_wifi_set_ant()` is used to configure which antennas are enabled. The enabled antennas selecting algorithm is also configured by :cpp:func:`esp_wifi_set_ant()`. The RX/TX antenna mode can be WIFI_ANT_MODE_ANT0, WIFI_ANT_MODE_ANT1 or WIFI_ANT_MODE_AUTO. If the antenna mode is WIFI_ANT_MODE_ANT0, the enabled antenna 0 is selected for RX/TX data. If the antenna mode is WIFI_ANT_MODE_ANT1, the enabled antenna 1 is selected for RX/TX data. Otherwise, WiFi automatically selects the antenna that has better signal from the enabled antennas. From 15480c49e31d4652c2b75861ed4dc18d340690a6 Mon Sep 17 00:00:00 2001 From: Krzysztof Budzynski Date: Sat, 7 May 2022 16:21:06 +0800 Subject: [PATCH 3/3] Apply 1 suggestion(s) to 1 file(s) --- docs/en/api-guides/wifi.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/api-guides/wifi.rst b/docs/en/api-guides/wifi.rst index 8d421bc26e..d66c8fe3d1 100644 --- a/docs/en/api-guides/wifi.rst +++ b/docs/en/api-guides/wifi.rst @@ -1662,7 +1662,7 @@ The Wi-Fi multiple antennas selecting can be depicted as following picture:: Up to four GPIOs are connected to the four active high antenna_select pins. {IDF_TARGET_NAME} can select the antenna by control the GPIO[0:3]. The API :cpp:func:`esp_wifi_set_ant_gpio()` is used to configure which GPIOs are connected to antenna_selects. If GPIO[x] is connected to antenna_select[x], then gpio_config->gpio_cfg[x].gpio_select should be set to 1 and gpio_config->gpio_cfg[x].gpio_num should be provided. -For the specific implementation of Antenna Switch, there may be illegal values in antenna_select[0:3]. Which means that {IDF_TARGET_NAME} may supports less then sixteen antennas through external antenna switch. For example, ESP32-WROOM-DA supports two antennas which uses RTC6603SP as Antenna Switch. Two GPIOs are connected to the two active high antenna_select pins. The value '0b00' and '0b11' are illegal values, the value '0b01' means the antenna 0 is selected, the value '0b10' means the antenna 1 is selected. +For the specific implementation of the antenna switch, there may be illegal values in `antenna_select[0:3]`. It means that {IDF_TARGET_NAME} may support less than sixteen antennas through the switch. For example, ESP32-WROOM-DA which uses RTC6603SP as the antenna switch, supports two antennas. Two GPIOs are connected to two active high antenna selection inputs. The value '0b01' means the antenna 0 is selected, the value '0b10' means the antenna 1 is selected. Values '0b00' and '0b11' are illegal. Although up to sixteen antennas are supported, only one or two antennas can be simultaneously enabled for RX/TX. The API :cpp:func:`esp_wifi_set_ant()` is used to configure which antennas are enabled.