doc: add hint for feature flag in wifi examples (#2365)

This commit is contained in:
akesser 2024-10-18 16:14:21 +02:00 committed by GitHub
parent f0d0dd92c4
commit 326e006335
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
12 changed files with 12 additions and 1 deletions

View File

@ -1,6 +1,7 @@
//! WiFi frame injection example //! WiFi frame injection example
//! //!
//! Periodically transmits a beacon frame. //! Periodically transmits a beacon frame.
//! When using USB-SERIAL-JTAG you may have to activate the feature `phy-enable-usb` in the esp-wifi crate.
//% FEATURES: esp-wifi esp-wifi/wifi-default esp-wifi/wifi esp-wifi/utils esp-wifi/sniffer //% FEATURES: esp-wifi esp-wifi/wifi-default esp-wifi/wifi esp-wifi/utils esp-wifi/sniffer
//% CHIPS: esp32 esp32s2 esp32s3 esp32c2 esp32c3 esp32c6 //% CHIPS: esp32 esp32s2 esp32s3 esp32c2 esp32c3 esp32c6

View File

@ -6,6 +6,7 @@
//! Open http://192.168.2.1:8080/ in your browser //! Open http://192.168.2.1:8080/ in your browser
//! //!
//! On Android you might need to choose _Keep Accesspoint_ when it tells you the WiFi has no internet connection, Chrome might not want to load the URL - you can use a shell and try `curl` and `ping` //! On Android you might need to choose _Keep Accesspoint_ when it tells you the WiFi has no internet connection, Chrome might not want to load the URL - you can use a shell and try `curl` and `ping`
//! When using USB-SERIAL-JTAG you may have to activate the feature `phy-enable-usb` in the esp-wifi crate.
//% FEATURES: esp-wifi esp-wifi/wifi-default esp-wifi/wifi esp-wifi/utils //% FEATURES: esp-wifi esp-wifi/wifi-default esp-wifi/wifi esp-wifi/utils
//% CHIPS: esp32 esp32s2 esp32s3 esp32c2 esp32c3 esp32c6 //% CHIPS: esp32 esp32s2 esp32s3 esp32c2 esp32c3 esp32c6

View File

@ -7,6 +7,7 @@
//! Open http://192.168.2.1:8080/ in your browser - the example will perform an HTTP get request to some "random" server //! Open http://192.168.2.1:8080/ in your browser - the example will perform an HTTP get request to some "random" server
//! //!
//! On Android you might need to choose _Keep Accesspoint_ when it tells you the WiFi has no internet connection, Chrome might not want to load the URL - you can use a shell and try `curl` and `ping` //! On Android you might need to choose _Keep Accesspoint_ when it tells you the WiFi has no internet connection, Chrome might not want to load the URL - you can use a shell and try `curl` and `ping`
//! When using USB-SERIAL-JTAG you may have to activate the feature `phy-enable-usb` in the esp-wifi crate.
//% FEATURES: esp-wifi esp-wifi/wifi-default esp-wifi/wifi esp-wifi/utils //% FEATURES: esp-wifi esp-wifi/wifi-default esp-wifi/wifi esp-wifi/utils
//% CHIPS: esp32 esp32s2 esp32s3 esp32c2 esp32c3 esp32c6 //% CHIPS: esp32 esp32s2 esp32s3 esp32c2 esp32c3 esp32c6

View File

@ -6,6 +6,7 @@
//! cargo run --release //! cargo run --release
//! ``` //! ```
//! Ensure you have set the IP of your local machine in the `HOST_IP` env variable. E.g `HOST_IP="192.168.0.24"` and also set SSID and PASSWORD env variable before running this example. //! Ensure you have set the IP of your local machine in the `HOST_IP` env variable. E.g `HOST_IP="192.168.0.24"` and also set SSID and PASSWORD env variable before running this example.
//! When using USB-SERIAL-JTAG you may have to activate the feature `phy-enable-usb` in the esp-wifi crate.
//% FEATURES: esp-wifi esp-wifi/wifi-default esp-wifi/wifi esp-wifi/utils //% FEATURES: esp-wifi esp-wifi/wifi-default esp-wifi/wifi esp-wifi/utils
//% CHIPS: esp32 esp32s2 esp32s3 esp32c2 esp32c3 esp32c6 //% CHIPS: esp32 esp32s2 esp32s3 esp32c2 esp32c3 esp32c6

View File

@ -6,6 +6,7 @@
//! - does BLE advertising (you cannot connect to it - it's just not implemented in the example) //! - does BLE advertising (you cannot connect to it - it's just not implemented in the example)
//! //!
//! Note: On ESP32-C2 and ESP32-C3 you need a wifi-heap size of 70000, on ESP32-C6 you need 80000 and a tx_queue_size of 10 //! Note: On ESP32-C2 and ESP32-C3 you need a wifi-heap size of 70000, on ESP32-C6 you need 80000 and a tx_queue_size of 10
//! When using USB-SERIAL-JTAG you may have to activate the feature `phy-enable-usb` in the esp-wifi crate.
//% FEATURES: esp-wifi esp-wifi/wifi-default esp-wifi/wifi esp-wifi/utils esp-wifi/ble esp-wifi/coex //% FEATURES: esp-wifi esp-wifi/wifi-default esp-wifi/wifi esp-wifi/utils esp-wifi/ble esp-wifi/coex
//% CHIPS: esp32 esp32s3 esp32c2 esp32c3 esp32c6 //% CHIPS: esp32 esp32s3 esp32c2 esp32c3 esp32c6

View File

@ -4,6 +4,7 @@
//! Set SSID and PASSWORD env variable before running this example. //! Set SSID and PASSWORD env variable before running this example.
//! //!
//! This gets an ip address via DHCP then performs an HTTP get request to some "random" server //! This gets an ip address via DHCP then performs an HTTP get request to some "random" server
//! When using USB-SERIAL-JTAG you may have to activate the feature `phy-enable-usb` in the esp-wifi crate.
//% FEATURES: esp-wifi esp-wifi/wifi-default esp-wifi/wifi esp-wifi/utils //% FEATURES: esp-wifi esp-wifi/wifi-default esp-wifi/wifi esp-wifi/utils
//% CHIPS: esp32 esp32s2 esp32s3 esp32c2 esp32c3 esp32c6 //% CHIPS: esp32 esp32s2 esp32s3 esp32c2 esp32c3 esp32c6

View File

@ -7,6 +7,7 @@
//! On Android you might need to choose _Keep Accesspoint_ when it tells you the WiFi has no internet connection, Chrome might not want to load the URL - you can use a shell and try `curl` and `ping` //! On Android you might need to choose _Keep Accesspoint_ when it tells you the WiFi has no internet connection, Chrome might not want to load the URL - you can use a shell and try `curl` and `ping`
//! //!
//! Because of the huge task-arena size configured this won't work on ESP32-S2 //! Because of the huge task-arena size configured this won't work on ESP32-S2
//! When using USB-SERIAL-JTAG you may have to activate the feature `phy-enable-usb` in the esp-wifi crate.
//% FEATURES: embassy embassy-generic-timers esp-wifi esp-wifi/async esp-wifi/embassy-net esp-wifi/wifi-default esp-wifi/wifi esp-wifi/utils //% FEATURES: embassy embassy-generic-timers esp-wifi esp-wifi/async esp-wifi/embassy-net esp-wifi/wifi-default esp-wifi/wifi esp-wifi/utils
//% CHIPS: esp32 esp32s2 esp32s3 esp32c2 esp32c3 esp32c6 //% CHIPS: esp32 esp32s2 esp32s3 esp32c2 esp32c3 esp32c6

View File

@ -10,6 +10,7 @@
//! On Android you might need to choose _Keep Accesspoint_ when it tells you the WiFi has no internet connection, Chrome might not want to load the URL - you can use a shell and try `curl` and `ping` //! On Android you might need to choose _Keep Accesspoint_ when it tells you the WiFi has no internet connection, Chrome might not want to load the URL - you can use a shell and try `curl` and `ping`
//! //!
//! Because of the huge task-arena size configured this won't work on ESP32-S2 //! Because of the huge task-arena size configured this won't work on ESP32-S2
//! When using USB-SERIAL-JTAG you may have to activate the feature `phy-enable-usb` in the esp-wifi crate.
//% FEATURES: embassy embassy-generic-timers esp-wifi esp-wifi/async esp-wifi/embassy-net esp-wifi/wifi-default esp-wifi/wifi esp-wifi/utils //% FEATURES: embassy embassy-generic-timers esp-wifi esp-wifi/async esp-wifi/embassy-net esp-wifi/wifi-default esp-wifi/wifi esp-wifi/utils
//% CHIPS: esp32 esp32s2 esp32s3 esp32c2 esp32c3 esp32c6 //% CHIPS: esp32 esp32s2 esp32s3 esp32c2 esp32c3 esp32c6

View File

@ -8,7 +8,7 @@
//! Ensure you have set the IP of your local machine in the `HOST_IP` env variable. E.g `HOST_IP="192.168.0.24"` and also set SSID and PASSWORD env variable before running this example. //! Ensure you have set the IP of your local machine in the `HOST_IP` env variable. E.g `HOST_IP="192.168.0.24"` and also set SSID and PASSWORD env variable before running this example.
//! //!
//! Because of the huge task-arena size configured this won't work on ESP32-S2 and ESP32-C2 //! Because of the huge task-arena size configured this won't work on ESP32-S2 and ESP32-C2
//! //! When using USB-SERIAL-JTAG you may have to activate the feature `phy-enable-usb` in the esp-wifi crate.
//% FEATURES: embassy embassy-generic-timers esp-wifi esp-wifi/async esp-wifi/embassy-net esp-wifi/wifi-default esp-wifi/wifi esp-wifi/utils //% FEATURES: embassy embassy-generic-timers esp-wifi esp-wifi/async esp-wifi/embassy-net esp-wifi/wifi-default esp-wifi/wifi esp-wifi/utils
//% CHIPS: esp32 esp32s2 esp32s3 esp32c3 esp32c6 //% CHIPS: esp32 esp32s2 esp32s3 esp32c3 esp32c6

View File

@ -6,6 +6,7 @@
//! This gets an ip address via DHCP then performs an HTTP get request to some "random" server //! This gets an ip address via DHCP then performs an HTTP get request to some "random" server
//! //!
//! Because of the huge task-arena size configured this won't work on ESP32-S2 //! Because of the huge task-arena size configured this won't work on ESP32-S2
//! When using USB-SERIAL-JTAG you have to activate the feature `phy-enable-usb` in the esp-wifi crate.
//% FEATURES: embassy embassy-generic-timers esp-wifi esp-wifi/async esp-wifi/embassy-net esp-wifi/wifi-default esp-wifi/wifi esp-wifi/utils //% FEATURES: embassy embassy-generic-timers esp-wifi esp-wifi/async esp-wifi/embassy-net esp-wifi/wifi-default esp-wifi/wifi esp-wifi/utils
//% CHIPS: esp32 esp32s2 esp32s3 esp32c2 esp32c3 esp32c6 //% CHIPS: esp32 esp32s2 esp32s3 esp32c2 esp32c3 esp32c6

View File

@ -1,6 +1,7 @@
//! WiFi sniffer example //! WiFi sniffer example
//! //!
//! Sniffs for beacon frames. //! Sniffs for beacon frames.
//! When using USB-SERIAL-JTAG you may have to activate the feature `phy-enable-usb` in the esp-wifi crate.
//% FEATURES: esp-wifi esp-wifi/wifi-default esp-wifi/wifi esp-wifi/utils esp-wifi/sniffer //% FEATURES: esp-wifi esp-wifi/wifi-default esp-wifi/wifi esp-wifi/utils esp-wifi/sniffer
//% CHIPS: esp32 esp32s2 esp32s3 esp32c2 esp32c3 esp32c6 //% CHIPS: esp32 esp32s2 esp32s3 esp32c2 esp32c3 esp32c6

View File

@ -5,6 +5,7 @@
//! - might be necessary to configure your WiFi access point accordingly //! - might be necessary to configure your WiFi access point accordingly
//! - uses the given static IP //! - uses the given static IP
//! - responds with some HTML content when connecting to port 8080 //! - responds with some HTML content when connecting to port 8080
//! When using USB-SERIAL-JTAG you may have to activate the feature `phy-enable-usb` in the esp-wifi crate.
//% FEATURES: esp-wifi esp-wifi/wifi-default esp-wifi/wifi esp-wifi/utils //% FEATURES: esp-wifi esp-wifi/wifi-default esp-wifi/wifi esp-wifi/utils
//% CHIPS: esp32 esp32s2 esp32s3 esp32c2 esp32c3 esp32c6 //% CHIPS: esp32 esp32s2 esp32s3 esp32c2 esp32c3 esp32c6