Skip to content

Commit

Permalink
Improve feature descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
@bugadani
bugadani committed Nov 29, 2023
1 parent c899f2f commit c32fc5a
Showing 1 changed file with 18 additions and 16 deletions.
34 changes: 18 additions & 16 deletions esp-wifi/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,25 +68,27 @@ Don't use this feature if your are _not_ using USB-SERIAL-JTAG as it might reduc

| Feature | Meaning |
| -------------- | ---------------------------------------------------------------------------------------------------- |
| wifi-logs | logs the WiFi logs from the driver at log level info |
| dump-packets | dumps packet info at log level info |
| utils | Provide utilities for smoltcp initialization; adds `smoltcp` dependency |
| wifi-logs | logs the WiFi logs from the driver at log level `info` |
| dump-packets | dumps packet info at log level `info` |
| utils | Provide utilities for smoltcp initialization. Adds `smoltcp` dependency |
| ble | Enable BLE support |
| wifi | Enable WiFi support |
| esp-now | Enable esp-now support |
| coex | Enable coex support |
| ipv4 | IPv4 support: includes `utils` feature |
| ipv6 | IPv6 support: includes `utils` feature |
| tcp | TCP socket support: includes `ipv4` feature |
| udp | UDP socket support: includes `ipv4` feature |
| igmp | IGMP (multicast) support: includes `ipv4` feature |
| dns | DNS support: includes `udp` feature |
| dhcpv4 | DHCPv4 support, both creating sockets and autoconfiguring network settings: includes `utils` feature |
| phy-enable-usb | See _USB-SERIAL-JTAG_ below |
| ps-min-modem | Enable minimum modem sleep. Only for STA mode |
| ps-max-modem | Enable maximum modem sleep. Only for STA mode |
| esp-now | Enable [esp-now](https://www.espressif.com/en/solutions/low-power-solutions/esp-now) support |
| coex | Enable WiFi-BLE coexistence support |
| ipv4 | IPv4 support. Includes `utils` feature |
| ipv6 | IPv6 support. Includes `utils` feature |
| tcp | TCP socket support. Includes `ipv4` feature |
| udp | UDP socket support. Includes `ipv4` feature |
| igmp | IGMP (multicast) support. Includes `ipv4` feature |
| dns | DNS support. Includes `udp` feature |
| dhcpv4 | DHCPv4 support, both creating sockets and autoconfiguring network settings. Includes `utils` feature |
| phy-enable-usb | See [USB-SERIAL-JTAG](#usb-serial-jtag) above |
| ps-min-modem | Enable minimum modem sleep. Only affects STA mode |
| ps-max-modem | Enable maximum modem sleep. Only affects STA mode |
| log | Route log output to the `log` crate |
| defmt | Add `defmt::Format` implementation |
| defmt | Add `defmt::Format` implementation and output logs via `defmt` |

Note that not all features are available on every MCU. For example, `ble` (and thus, `coex`) is not available on ESP32-S2.

When using the `dump-packets` feature you can use the extcap in `extras/esp-wifishark` to analyze the frames in Wireshark.
For more information see [extras/esp-wifishark/README.md](../extras/esp-wifishark/README.md)
Expand Down

0 comments on commit c32fc5a

Please sign in to comment.