mirror of
https://github.com/letscontrolit/ESPEasy.git
synced 2026-07-27 19:57:38 +00:00
[Docs] Document the Network overview tab
This commit is contained in:
TD-er
@@ -32,3 +32,30 @@ This does not require any extra parameters. It only needs a direct connection to
|
||||
Either via the WiFi module itself, or via Ethernet.
|
||||
|
||||
This will then try to download the matching firmware version from GitHub.
|
||||
|
||||
|
||||
Update ESP-Hosted-MCU fw. version 0.0.6
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
The ESP32-C6 is running the ESP-Hosted-MCU firmware from Espressif.
|
||||
Typically new boards are running version 0.0.6 of that firmware, which doesn't yet support a lot of WiFi commands.
|
||||
And even worse, when trying to call unsupported commands, the whole ESP32-P4 board may crash.
|
||||
One of those commands not yet supported in this early version is to query the firmware version.
|
||||
|
||||
As soon as ESPEasy is installed on a new ESP32-P4 board and a network connection is active (with access to the internet), it is strongly adviced to run the command wifiotahostedmcu via the console. This will then install the most recent ESP-Hosted-MCU firmware matching the installed build of ESPEasy.
|
||||
Typically this will be the Ethernet network interface which is present on most ESP32-P4 boards.
|
||||
|
||||
Since the state the WiFi firmware of a freshly installed ESP32-P4 is unknown,
|
||||
the wifi STA adapter is set to 'disabled' by default.
|
||||
The Ethernet interface will be set active. (as long as there aren't any new boards with a different Ethernet chip)
|
||||
To set the WiFi STA interface to enabled, enter the following command via the serial console:
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
networkenable,1
|
||||
|
||||
Don't forget to save the settings using the ``save`` command, or else the network interface will be disabled again after a reboot.
|
||||
|
||||
This is also why WiFi STA is always index 1 and WiFi AP is index 2.
|
||||
|
||||
N.B. There is of course also the ``networkdisable`` command.
|
||||
|
||||
@@ -44,6 +44,15 @@ The fallback order can be tweaked using the Delay Startup and Route Priority.
|
||||
|
||||
N.B. Network interfaces which should be started at boot, should not be marked as Fallback Interface.
|
||||
|
||||
Example use cases
|
||||
"""""""""""""""""
|
||||
|
||||
* Disable fallback on the WiFi AP and have it active continuously, allowing other nodes/devices to use the ESP node to act as a router/gateway using "NAPT".
|
||||
* Have WiFi STA set as fallback for Ethernet (or PPP for a LTE modem). When there is no connection via Ethernet (or PPP) you can try using WiFi STA as backup.
|
||||
* Have PPP (for connection via LTE) as fallback, so it will only be used if any of the other interfaces failed to get a connection.
|
||||
* Have Ethernet set to lowest startup delay, WiFi STA as fallback with longer startup delay and PPP as fallback with the longest startup delay. This way the preferred interface is Ethernet, WiFi the second and as last resort the LTE modem.
|
||||
|
||||
|
||||
|
||||
Delay Startup
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
@@ -38,6 +38,107 @@ Network Plugins
|
||||
":ref:`NW005_page`","|NW005_status|","|NW005_status_lb|","NW005"
|
||||
|
||||
|
||||
Network Overview Tab
|
||||
====================
|
||||
|
||||
.. image:: NetworkOverviewTab.png
|
||||
|
||||
Overview of the Network tab on an ESP32-P4.
|
||||
|
||||
As shown above, there are several networks.
|
||||
|
||||
* Nr. 1 is always WiFi STA (station)
|
||||
* Nr. 2 is always WiFi AP (Access Point)
|
||||
|
||||
There are 2 types of Ethernet plugins:
|
||||
|
||||
* RMII, only available on ESP32-classic and ESP32-P4 (and ESP32-S31 when supported in the future)
|
||||
* SPI, Possible on all supported ESP32 variants except ESP32-C2.
|
||||
|
||||
Active
|
||||
^^^^^^
|
||||
|
||||
Indicates whether a network adapter has been 'started'.
|
||||
This is related to "Fallback" and "Delay Startup".
|
||||
|
||||
This "Active" concept is needed to allow for another concept called the "Fallback Interface".
|
||||
|
||||
For example, on a standard ESP board with only WiFi, the WiFi AP interface can be considered a fallback interface.
|
||||
Meaning the AP is "Enabled" but no need to set it "Active" as long as you can connect to your normal WiFi network.
|
||||
|
||||
The conditions on when to start the WiFi AP interface can be configured as well.
|
||||
|
||||
Only when one or more set conditions are met, then the AP will be activated.
|
||||
|
||||
|
||||
Name
|
||||
^^^^
|
||||
|
||||
A single word describing the network interface.
|
||||
This can be appended to the hostname and is also referred to in network events to be used in rules.
|
||||
|
||||
Route Prio
|
||||
^^^^^^^^^^
|
||||
(ESP32 only)
|
||||
|
||||
The active and connected interface with the highest 'route prio' value is the default interface for new outgoing connections.
|
||||
The current default interface is marked with an asterisk.
|
||||
|
||||
This means the ESP is still reachable via other interfaces when needed, but new connections will be made only via the default route.
|
||||
|
||||
N.B. it is possible to block web access per interface via the checkbox for Block Web Access
|
||||
|
||||
.. note:: Do not set two interfaces active to same route prio as this may lead to undefined behavior.
|
||||
|
||||
Connected
|
||||
^^^^^^^^^
|
||||
|
||||
Show basic information about the connection, or a red cross if not connected.
|
||||
|
||||
The shown duration is the duration since the last connected/disconnected status change.
|
||||
|
||||
|
||||
Hostname/SSID
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
Shows the hostname as used for that specific network interface.
|
||||
|
||||
This hostname is used in the DHCP request and when mDNS is being used.
|
||||
|
||||
For the WiFi AP interface, the SSID is shown.
|
||||
|
||||
|
||||
HW Address
|
||||
^^^^^^^^^^
|
||||
|
||||
Lists the MAC address and some basic description of the network interface when applicable.
|
||||
|
||||
Description examples:
|
||||
|
||||
* WiFi interface on an ESP32-P4 lists the ESP32-variant used as external wifi adapter and the ESP-Hosted-MCU firmware version running.
|
||||
* Ethernet will list the network adapter chip model.
|
||||
|
||||
For the PPP interface, the IMEI number is listed instead of the MAC address.
|
||||
|
||||
IP
|
||||
^^
|
||||
|
||||
Shows the IPv4-address as it is currently in use on the network interface.
|
||||
|
||||
More detailed info on IPv6-addresses is listed on the page where the network interface can be configured and on the sysinfo page.
|
||||
|
||||
Port
|
||||
^^^^
|
||||
|
||||
When applicable, the GPIO pins will be listed here.
|
||||
|
||||
* External WiFi module on ESP32-P4: SDIO bus
|
||||
* Ethernet: GPIO pins
|
||||
* PPP: Serial port + GPIO pins
|
||||
|
||||
|
||||
|
||||
|
||||
Export/Import Network Parameters
|
||||
================================
|
||||
|
||||
@@ -112,10 +213,10 @@ Allowed Parameters
|
||||
"baudrate","int","Baudrate","","","","","✔ (115200 default)"
|
||||
"apn","string","Access Point Name (APN)","","","","","✔"
|
||||
"pin","string","PIN of SIM card","","","","","✔"
|
||||
"IP","string","IP address","✔","✔","✔","✔","✔"
|
||||
"gw","string","Gateway IP address","✔","✔","✔","✔","✔"
|
||||
"sn","string","Subnet mask","✔","✔","✔","✔","✔"
|
||||
"DNS","string","DNS server IP address","✔","✔","✔","✔","✔"
|
||||
"IP","string","IP address","","","✔","✔","✔"
|
||||
"gw","string","Gateway IP address","","","✔","✔","✔"
|
||||
"sn","string","Subnet mask","","","✔","✔","✔"
|
||||
"DNS","string","DNS server IP address","","","✔","✔","✔"
|
||||
|
||||
Phy Types
|
||||
---------
|
||||
|
||||
Reference in New Issue
Block a user