Skip to content

Commit fd5ddfd

Browse files
MaxwellAlanMaxwellAlan
committed
Merge branch 'feat/update_docs_v2' into 'master'
docs: update wifi supported apis and features See merge request espressif/esp-extconn!7
2 parents ddb0924 + b925ddb commit fd5ddfd

File tree

1 file changed

+157
-45
lines changed

1 file changed

+157
-45
lines changed

‎README.md‎

Lines changed: 157 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,67 @@
33
This component provides external wireless connectivity(Wi-Fi & Bluetooth) for ESP chips that do not have built-in wireless capabilities. The APIs used by this component are compatible with the Wi-Fi and Bluetooth component APIs in the ESP-IDF.
44

55
## Supported Features
6-
7-
- Wi-Fi Features:
8-
- 802.11b/g/n
9-
- Operating Mode: STA, SoftAP
10-
- Security Mode: Open, WPA, WPA2, WPA3
11-
12-
- BT/BLE
13-
- Classic Bluetooth
14-
- BLE 4.2
6+
<table>
7+
<tr>
8+
<th>Features</th>
9+
<th>Supported</th>
10+
<th>Sill not Supported </th>
11+
</tr>
12+
<tr>
13+
<td>Virtual Wi-Fi interfaces</td>
14+
<td>Station, SoftAP</td>
15+
<td>Sniffer, Wi-Fi Aware (NAN)</td>
16+
</tr>
17+
<tr>
18+
<td>Wi-Fi Modes</td>
19+
<td>Station, SoftAP, Station/AP-coexistence mode</td>
20+
<td></td>
21+
</tr>
22+
<tr>
23+
<td>Wi-Fi Protocols</td>
24+
<td>802.11 b/g/n</td>
25+
<td></td>
26+
</tr>
27+
<tr>
28+
<td>Wi-Fi Security Modes</td>
29+
<td>Open / WPA / WPA2 / WPA3 / WPA2-Enterprise / WPA3-Enterprise / WPS</td>
30+
<td>WAPI / DPP</td>
31+
</tr>
32+
<tr>
33+
<td>Power Save</td>
34+
<td></td>
35+
<td>Modem-sleep</td>
36+
</tr>
37+
<tr>
38+
<td>Wi-Fi Data Transmission</td>
39+
<td>AMSDU, AMPDU, HT40, QoS</td>
40+
<td></td>
41+
</tr>
42+
<tr>
43+
<td>Vendor Features</td>
44+
<td></td>
45+
<td>ESP-NOW, Long Range mode, SmartConfig, Channel State Information</td>
46+
</tr>
47+
<tr>
48+
<td>Scan</td>
49+
<td>Fast scan, All-channel scan</td>
50+
<td></td>
51+
</tr>
52+
<tr>
53+
<td>Antennas</td>
54+
<td></td>
55+
<td>Multiple</td>
56+
</tr>
57+
<tr>
58+
<td>Bluetooth features</td>
59+
<td>Classic Bluetooth, BLE 4.2</td>
60+
<td></td>
61+
</tr>
62+
</table>
1563

1664
## Supported ESP Chips
17-
18-
| Supported Hosts | ESP32P4 |
19-
| ----------------- | ----- |
20-
21-
| Supported Targets | ESP8689 |
22-
| ----------------- | ------- |
65+
* Supported Host : **ESP32P4**
66+
* Supported Target : **ESP8689**
2367

2468
## Supported Boards
2569

@@ -39,36 +83,104 @@ This component provides external wireless connectivity(Wi-Fi & Bluetooth) for ES
3983
* Wi-Fi and Bluetooth, traffic for both runs over SDIO
4084

4185
## Supported APIs
42-
1. **Initialization**
43-
* esp_wifi_init
44-
* esp_wifi_deinit
45-
* esp_wifi_start
46-
* esp_wifi_stop
47-
2. **Configuration**
48-
* esp_wifi_set_mode
49-
* esp_wifi_get_mode
50-
* esp_wifi_set_config
51-
* esp_wifi_get_config
52-
* esp_wifi_set_storage
53-
* esp_wifi_set_protocol
54-
* esp_wifi_get_protocol
55-
* esp_wifi_set_country
56-
* esp_wifi_get_country
57-
* esp_wifi_set_country_code
58-
* esp_wifi_get_country_code
59-
* esp_wifi_set_bandwidth
60-
* esp_wifi_get_bandwidth
61-
* esp_wifi_set_channel
62-
* esp_wifi_get_channel
63-
* esp_wifi_get_mac
64-
3. **Connection**
65-
* esp_wifi_connect
66-
* esp_wifi_disconnect
67-
4. **Scan**
68-
* esp_wifi_scan_start
69-
* esp_wifi_scan_get_ap_num
70-
* esp_wifi_scan_get_ap_records
71-
* esp_wifi_sta_get_ap_info
86+
<table>
87+
<tr>
88+
<th>Classification</th>
89+
<th>Supported APIs</th>
90+
</tr>
91+
<tr>
92+
<td rowspan="2">Initialization</td>
93+
<td>esp_wifi_<b>init</b> / esp_wifi_<b>deinit</b></td>
94+
</tr>
95+
<tr>
96+
<td>esp_wifi_<b>start</b> / esp_wifi_<b>stop</b></td>
97+
</tr>
98+
<tr>
99+
<td rowspan="13">Configuration</td>
100+
<td>esp_wifi_<b>set_mode</b> / esp_wifi_<b>get_mode</b></td>
101+
</tr>
102+
<tr>
103+
<td>esp_wifi_<b>set_config</b> / esp_wifi_<b>get_config</b></td>
104+
</tr>
105+
<tr>
106+
<td>esp_wifi_<b>set_storage</b></td>
107+
</tr>
108+
<tr>
109+
<td>esp_wifi_<b>set_protocol</b> / esp_wifi_<b>get_protocol</b></td>
110+
</tr>
111+
<tr>
112+
<td>esp_wifi_<b>set_country</b> / esp_wifi_<b>get_country</b></td>
113+
</tr>
114+
<tr>
115+
<td> esp_wifi_<b>set_country_code</b> / esp_wifi_<b>get_country_code</b></td>
116+
</tr>
117+
<tr>
118+
<td> esp_wifi_<b>set_bandwidth</b> / esp_wifi_<b>get_bandwidth</b></td>
119+
</tr>
120+
<tr>
121+
<td> esp_wifi_<b>set_mac</b> / esp_wifi_<b>get_mac</b></td>
122+
</tr>
123+
<tr>
124+
<td> esp_wifi_<b>restore</b></td>
125+
</tr>
126+
<tr>
127+
<td> esp_wifi_<b>set_vendor_ie</b> / esp_wifi_<b>set_vendor_ie_cb</b></td>
128+
</tr>
129+
<tr>
130+
<td> esp_wifi_<b>set_channel</b> / esp_wifi_<b>get_channel</b></td>
131+
</tr>
132+
<tr>
133+
<td> esp_wifi_<b>set_inactive_time</b> / esp_wifi_<b>get_inactive_time</b></td>
134+
</tr>
135+
<tr>
136+
<td> esp_wifi_<b>set_rssi_threshold</b>
137+
</tr>
138+
<tr>
139+
<td rowspan="7">Connection</td>
140+
<td>esp_wifi_<b>connect</b> / esp_wifi_<b>disconnect</b></td>
141+
</tr>
142+
<tr>
143+
<td>esp_wifi_<b>sta_get_aid</b> / esp_wifi_<b>ap_get_sta_aid</b></td>
144+
</tr>
145+
<tr>
146+
<td>esp_wifi_<b>sta_get_ap_info</b></td>
147+
</tr>
148+
<tr>
149+
<td>esp_wifi_ap_<b>get_sta_list_with_ip</b> / esp_wifi_ap_<b>get_sta_list</b></td>
150+
</tr>
151+
<tr>
152+
<td>esp_wifi_<b>deauth_sta</b></td>
153+
</tr>
154+
<tr>
155+
<td>esp_wifi_<b>sta_get_rssi</b></td>
156+
</tr>
157+
<tr>
158+
<td>esp_wifi_<b>sta_get_negotiated_phymode</b></td>
159+
</tr>
160+
<tr>
161+
<td rowspan="5">Scan</td>
162+
<td>esp_wifi_<b>scan_start</b> / esp_wifi_<b>scan_stop</b></td>
163+
</tr>
164+
<tr>
165+
<td>esp_wifi_<b>set_scan_parameters</b> / esp_wifi_<b>get_scan_parameters</b></td>
166+
</tr>
167+
<tr>
168+
<td>esp_wifi_<b>scan_get_ap_num</b></td>
169+
</tr>
170+
<tr>
171+
<td>esp_wifi_scan_get_ap_<b>records</b> / esp_wifi_scan_get_ap_<b>record</b></td>
172+
</tr>
173+
<tr>
174+
<td>esp_wifi_<b>clear_ap_list</b></td>
175+
</tr>
176+
<tr>
177+
<td rowspan="2">Others</td>
178+
<td>esp_wifi_<b>80211_tx</b></td>
179+
</tr>
180+
<tr>
181+
<td>esp_wifi_<b>statis_dump</b></td>
182+
</tr>
183+
</table>
72184

73185
## Step to enable this component in an example code:
74186

0 commit comments

Comments
 (0)