mirror of
https://github.com/letscontrolit/ESPEasy.git
synced 2026-07-27 19:57:38 +00:00
[Docs] Add stubs for documenting new Network design
This commit is contained in:
TD-er
@@ -0,0 +1,39 @@
|
||||
.. include:: _network_substitutions.repl
|
||||
|
||||
.. _NW001_page:
|
||||
|
||||
|NW001_typename|
|
||||
==================================================
|
||||
|
||||
|NW001_shortinfo|
|
||||
|
||||
Network details
|
||||
---------------
|
||||
|
||||
Type: |NW001_type|
|
||||
|
||||
Name: |NW001_name|
|
||||
|
||||
Status: |NW001_status|
|
||||
|
||||
GitHub: |NW001_github|_
|
||||
|
||||
Maintainer: |NW001_maintainer|
|
||||
|
||||
Change log
|
||||
----------
|
||||
|
||||
.. versionchanged:: 2.0
|
||||
...
|
||||
|
||||
|added|
|
||||
Major overhaul for 2.0 release.
|
||||
|
||||
.. versionadded:: 1.0
|
||||
...
|
||||
|
||||
|added|
|
||||
Initial release version.
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -0,0 +1,39 @@
|
||||
.. include:: _network_substitutions.repl
|
||||
|
||||
.. _NW002_page:
|
||||
|
||||
|NW002_typename|
|
||||
==================================================
|
||||
|
||||
|NW002_shortinfo|
|
||||
|
||||
Network details
|
||||
---------------
|
||||
|
||||
Type: |NW002_type|
|
||||
|
||||
Name: |NW002_name|
|
||||
|
||||
Status: |NW002_status|
|
||||
|
||||
GitHub: |NW002_github|_
|
||||
|
||||
Maintainer: |NW002_maintainer|
|
||||
|
||||
Change log
|
||||
----------
|
||||
|
||||
.. versionchanged:: 2.0
|
||||
...
|
||||
|
||||
|added|
|
||||
Major overhaul for 2.0 release.
|
||||
|
||||
.. versionadded:: 1.0
|
||||
...
|
||||
|
||||
|added|
|
||||
Initial release version.
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -0,0 +1,39 @@
|
||||
.. include:: _network_substitutions.repl
|
||||
|
||||
.. _NW003_page:
|
||||
|
||||
|NW003_typename|
|
||||
==================================================
|
||||
|
||||
|NW003_shortinfo|
|
||||
|
||||
Network details
|
||||
---------------
|
||||
|
||||
Type: |NW003_type|
|
||||
|
||||
Name: |NW003_name|
|
||||
|
||||
Status: |NW003_status|
|
||||
|
||||
GitHub: |NW003_github|_
|
||||
|
||||
Maintainer: |NW003_maintainer|
|
||||
|
||||
Change log
|
||||
----------
|
||||
|
||||
.. versionchanged:: 2.0
|
||||
...
|
||||
|
||||
|added|
|
||||
Major overhaul for 2.0 release.
|
||||
|
||||
.. versionadded:: 1.0
|
||||
...
|
||||
|
||||
|added|
|
||||
Initial release version.
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -0,0 +1,39 @@
|
||||
.. include:: _network_substitutions.repl
|
||||
|
||||
.. _NW004_page:
|
||||
|
||||
|NW004_typename|
|
||||
==================================================
|
||||
|
||||
|NW004_shortinfo|
|
||||
|
||||
Network details
|
||||
---------------
|
||||
|
||||
Type: |NW004_type|
|
||||
|
||||
Name: |NW004_name|
|
||||
|
||||
Status: |NW004_status|
|
||||
|
||||
GitHub: |NW004_github|_
|
||||
|
||||
Maintainer: |NW004_maintainer|
|
||||
|
||||
Change log
|
||||
----------
|
||||
|
||||
.. versionchanged:: 2.0
|
||||
...
|
||||
|
||||
|added|
|
||||
Major overhaul for 2.0 release.
|
||||
|
||||
.. versionadded:: 1.0
|
||||
...
|
||||
|
||||
|added|
|
||||
Initial release version.
|
||||
|
||||
Description
|
||||
-----------
|
||||
@@ -0,0 +1,56 @@
|
||||
.. include:: _network_substitutions.repl
|
||||
|
||||
.. _NW005_page:
|
||||
|
||||
|NW005_typename|
|
||||
==================================================
|
||||
|
||||
|NW005_shortinfo|
|
||||
|
||||
Network details
|
||||
---------------
|
||||
|
||||
Type: |NW005_type|
|
||||
|
||||
Name: |NW005_name|
|
||||
|
||||
Status: |NW005_status|
|
||||
|
||||
GitHub: |NW005_github|_
|
||||
|
||||
Maintainer: |NW005_maintainer|
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
|
||||
Configuration
|
||||
-------------
|
||||
|
||||
|
||||
Device Settings
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
|
||||
|
||||
Connection Settings
|
||||
^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
|
||||
Change log
|
||||
----------
|
||||
|
||||
.. versionchanged:: 2.0
|
||||
...
|
||||
|
||||
|added|
|
||||
Major overhaul for 2.0 release.
|
||||
|
||||
.. versionadded:: 1.0
|
||||
...
|
||||
|
||||
|added|
|
||||
Initial release version.
|
||||
|
||||
Description
|
||||
-----------
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 59 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 37 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 37 KiB |
@@ -0,0 +1,31 @@
|
||||
.. include:: _network_substitutions.repl
|
||||
|
||||
Network
|
||||
*******
|
||||
|
||||
A Network plugin is compable with a 'driver' for a network adapter.
|
||||
|
||||
The first 2 entries will be the same for every ESPEasy setup and these cannot be removed.
|
||||
|
||||
- Wi-Fi Station: To connect the ESP board to an access point.
|
||||
- Wi-Fi AP: To let the ESP board act as an access point.
|
||||
|
||||
|
||||
|
||||
.. _Network Plugins:
|
||||
|
||||
Network Plugins
|
||||
==================
|
||||
|
||||
.. csv-table::
|
||||
:header: "Plugin name", "Plugin status", "Plugin number"
|
||||
:widths: 10, 8, 5
|
||||
|
||||
":ref:`NW001_page`","|NW001_status|","NW001"
|
||||
":ref:`NW002_page`","|NW002_status|","NW002"
|
||||
":ref:`NW003_page`","|NW003_status|","NW003"
|
||||
":ref:`NW004_page`","|NW004_status|","NW004"
|
||||
":ref:`NW005_page`","|NW005_status|","NW005"
|
||||
|
||||
Network Parameters
|
||||
=====================
|
||||
@@ -0,0 +1,58 @@
|
||||
|
||||
|
||||
|
||||
.. |NW001_name| replace:: :cyan:`WiFi Station`
|
||||
.. |NW001_type| replace:: :cyan:`Network`
|
||||
.. |NW001_typename| replace:: :cyan:`Network - WiFi Station`
|
||||
.. |NW001_status| replace:: :green:`NORMAL`
|
||||
.. |NW001_github| replace:: _NW001_WiFi_STA.cpp
|
||||
.. _NW001_github: https://github.com/letscontrolit/ESPEasy/blob/mega/src/ESPEasy/net/_NW001_WiFi_STA.cpp
|
||||
.. |NW001_usedby| replace:: `.`
|
||||
.. |NW001_shortinfo| replace:: `.`
|
||||
.. |NW001_maintainer| replace:: `TD-er`
|
||||
.. |NW001_compileinfo| replace:: `.`
|
||||
|
||||
.. |NW002_name| replace:: :cyan:`WiFi AP`
|
||||
.. |NW002_type| replace:: :cyan:`Network`
|
||||
.. |NW002_typename| replace:: :cyan:`Network - WiFi AP`
|
||||
.. |NW002_status| replace:: :green:`NORMAL`
|
||||
.. |NW002_github| replace:: _NW002_WiFi_AP.cpp
|
||||
.. _NW002_github: https://github.com/letscontrolit/ESPEasy/blob/mega/src/ESPEasy/net/_NW002_WiFi_AP.cpp
|
||||
.. |NW002_usedby| replace:: `.`
|
||||
.. |NW002_shortinfo| replace:: `.`
|
||||
.. |NW002_maintainer| replace:: `TD-er`
|
||||
.. |NW002_compileinfo| replace:: `.`
|
||||
|
||||
.. |NW003_name| replace:: :cyan:`Ethernet (RMII)`
|
||||
.. |NW003_type| replace:: :cyan:`Network`
|
||||
.. |NW003_typename| replace:: :cyan:`Network - Ethernet (RMII)`
|
||||
.. |NW003_status| replace:: :green:`NORMAL`
|
||||
.. |NW003_github| replace:: _NW003_ETH_RMII.cpp
|
||||
.. _NW003_github: https://github.com/letscontrolit/ESPEasy/blob/mega/src/ESPEasy/net/_NW003_ETH_RMII.cpp
|
||||
.. |NW003_usedby| replace:: `.`
|
||||
.. |NW003_shortinfo| replace:: `.`
|
||||
.. |NW003_maintainer| replace:: `TD-er`
|
||||
.. |NW003_compileinfo| replace:: `.`
|
||||
|
||||
.. |NW004_name| replace:: :cyan:`Ethernet (SPI)`
|
||||
.. |NW004_type| replace:: :cyan:`Network`
|
||||
.. |NW004_typename| replace:: :cyan:`Network - Ethernet (SPI)`
|
||||
.. |NW004_status| replace:: :green:`NORMAL`
|
||||
.. |NW004_github| replace:: _NW004_ETH_SPI.cpp
|
||||
.. _NW004_github: https://github.com/letscontrolit/ESPEasy/blob/mega/src/ESPEasy/net/_NW004_ETH_SPI.cpp
|
||||
.. |NW004_usedby| replace:: `.`
|
||||
.. |NW004_shortinfo| replace:: `.`
|
||||
.. |NW004_maintainer| replace:: `TD-er`
|
||||
.. |NW004_compileinfo| replace:: `.`
|
||||
|
||||
.. |NW005_name| replace:: :cyan:`PPP Modem`
|
||||
.. |NW005_type| replace:: :cyan:`Network`
|
||||
.. |NW005_typename| replace:: :cyan:`Network - PPP Modem`
|
||||
.. |NW005_status| replace:: :green:`NORMAL`
|
||||
.. |NW005_github| replace:: _NW005_PPP_modem.cpp
|
||||
.. _NW005_github: https://github.com/letscontrolit/ESPEasy/blob/mega/src/ESPEasy/net/_NW005_PPP_modem.cpp
|
||||
.. |NW005_usedby| replace:: `.`
|
||||
.. |NW005_shortinfo| replace:: `.`
|
||||
.. |NW005_maintainer| replace:: `TD-er`
|
||||
.. |NW005_compileinfo| replace:: `.`
|
||||
|
||||
@@ -14,8 +14,9 @@ Welcome to ESP Easy's documentation!
|
||||
ESPEasy/ESPchips.rst
|
||||
ESPEasy/FunctionBlocks.rst
|
||||
Config/Config.rst
|
||||
Controller/_Controller.rst
|
||||
Hardware/Hardware.rst
|
||||
Network/_Network.rst
|
||||
Controller/_Controller.rst
|
||||
Plugin/_Plugin.rst
|
||||
Rules/Rules.rst
|
||||
Notify/_Notifications.rst
|
||||
|
||||
Reference in New Issue
Block a user