Michel2/ESPEasy
1
0
Fork 0
mirror of https://github.com/letscontrolit/ESPEasy.git synced 2026-07-27 19:57:38 +00:00
Code Issues Releases Activity

[Docs] Documentation updates, README.md updates

Browse Source
This commit is contained in:
Ton Huisman
2024-07-07 23:21:04 +02:00
parent 6c16228697
commit 26d3a1afb6
4 changed files with 36 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+14 -14
View File
@@ -110,7 +110,7 @@ Flash size | Description |
16M1M | 16 MB with 1 MB filesystem |
16M8M | 16 MB with 8 MB filesystem |
N.B. Starting with release 2023/12/25, All ESP32 LittleFS builds use IDF 5.1, to support newer ESP32 chips like ESP32-C2 and ESP32-C6. Other SPIFFS based ESP32 builds will be migrated to LittleFS as SPIFFS is no longer available in IDF 5 and later. A migration plan will be made available in 2024.
N.B. Starting with release 2023/12/25, All ESP32 LittleFS builds use IDF 5.1, to support newer ESP32 chips like ESP32-C2 and ESP32-C6 and SPI Ethernet. Other SPIFFS based ESP32 builds will be migrated to LittleFS as SPIFFS is no longer available in IDF 5 and later. A migration plan will be made available in 2024.
*[opt-build-features]* can be any of:
Build features | Description |
@@ -121,24 +121,24 @@ OTA | Arduino OTA (Over The Air) update feature enabled
Domoticz | Only Domoticz controllers (HTTP) and plugins included |
Domoticz_MQTT | Only Domoticz controllers (MQTT) and plugins included |
FHEM_HA | Only FHEM/OpenHAB/Home Assistant (MQTT) controllers and plugins included |
ETH | Ethernet interface enabled (ESP32-classic only) |
ETH | Ethernet interface enabled (ESP32-classic and IDF 5.x based builds) |
OPI_PSRAM | Specific configuration to enable PSRAM detection, ESP32-S3 only |
CDC | Support USBCDC/HWCDC-serial console on ESP32-C3, ESP32-S2, ESP32-S3 and ESP32-C6 |
noOTA/NO_OTA | Does not support OTA (Over The Air-updating of the firmware) Use [the flash page](https://td-er.nl/ESPEasy/) or ESPTool via USB Serial |
Some example firmware names:
Firmware name | Hardware | Included plugins |
------------------------------------------------------------------|---------------------------------------|----------------------------------|
ESPEasy_mega-20230822_normal_ESP8266_1M.bin | ESP8266/ESP8285 with 1MB flash | Stable |
ESPEasy_mega-20230822_normal_ESP8266_4M1M.bin | ESP8266 with 4MB flash | Stable |
ESPEasy_mega-20230822_collection_A_ESP8266_4M1M.bin | ESP8266 with 4MB flash | Stable + Collection base + set A |
ESPEasy_mega-20230822_normal_ESP32_4M316k.bin | ESP32 with 4MB flash | Stable |
ESPEasy_mega-20230822_collection_A_ESP32_4M316k.bin | ESP32 with 4MB flash | Stable + Collection base + set A |
ESPEasy_mega-20230822_collection_B_ESP32_4M316k.bin | ESP32 with 4MB flash | Stable + Collection base + set B |
ESPEasy_mega-20230822_max_ESP32s3_8M1M_LittleFS_CDC.bin | ESP32-S3 with 8MB flash, CDC-serial | All available plugins |
ESPEasy_mega-20230822_max_ESP32s3_8M1M_LittleFS_OPI_PSRAM_CDC.bin | ESP32-S3 8MB flash, PSRAM, CDC-serial | All available plugins |
ESPEasy_mega-20230822_max_ESP32_16M1M.bin | ESP32 with 16MB flash | All available plugins |
ESPEasy_mega-20230822_max_ESP32_16M8M_LittleFS.bin | ESP32 with 16MB flash | All available plugins |
Firmware name | Hardware | Included plugins |
----------------------------------------------------------------------|-------------------------------------------------|----------------------------------|
ESPEasy_mega-20230822_normal_ESP8266_1M.bin | ESP8266/ESP8285 with 1MB flash | Stable |
ESPEasy_mega-20230822_normal_ESP8266_4M1M.bin | ESP8266 with 4MB flash | Stable |
ESPEasy_mega-20230822_collection_A_ESP8266_4M1M.bin | ESP8266 with 4MB flash | Stable + Collection base + set A |
ESPEasy_mega-20230822_normal_ESP32_4M316k.bin | ESP32 with 4MB flash | Stable |
ESPEasy_mega-20230822_collection_A_ESP32_4M316k.bin | ESP32 with 4MB flash | Stable + Collection base + set A |
ESPEasy_mega-20230822_collection_B_ESP32_4M316k.bin | ESP32 with 4MB flash | Stable + Collection base + set B |
ESPEasy_mega-20230822_max_ESP32s3_8M1M_LittleFS_CDC_ETH.bin | ESP32-S3 with 8MB flash, CDC-serial, Ethernet | All available plugins |
ESPEasy_mega-20230822_max_ESP32s3_8M1M_LittleFS_OPI_PSRAM_CDC_ETH.bin | ESP32-S3 8MB flash, PSRAM, CDC-serial, Ethernet | All available plugins |
ESPEasy_mega-20230822_max_ESP32_16M1M.bin | ESP32 with 16MB flash | All available plugins |
ESPEasy_mega-20230822_max_ESP32_16M8M_LittleFS_ETH.bin | ESP32 with 16MB flash, Ethernet | All available plugins |
The binary files for the different ESP32 variants (S2, C3, S3, C2, C6, 'Classic') are available in separate archives.
docs/source/Plugin/P001_commands_GPIO.repl
+9 -7
View File
@@ -11,7 +11,7 @@ Supported hardware: |P000_usedby_GPIO|
"
``GPIO,<GPIO>,<state>``
GPIO: 0 ... 16
GPIO: 0 ... <max supported GPIO pin>
State:
@@ -28,12 +28,12 @@ Supported hardware: |P000_usedby_GPIO|
"
``GPIOtoggle,<GPIO>``
GPIO: 0 ... 16
GPIO: 0 ... <max supported GPIO pin>
","
**Toggle on/off.**.
Toggle the current (output) state of the given GPIO pin.
When executed, it changes the pin mode to output.
When executed, it changes the pin mode to output, for output-capable GPIO pins.
"
"
``LongPulse,<GPIO>,<state>,<duration>``
@@ -130,7 +130,9 @@ Supported hardware: |P000_usedby_GPIO|
"
``Servo,<servo ID>,<GPIO>,<position>``
GPIO: 0 ... **15**
ESP8266 GPIO: 0 ... **15**
ESP32 GPIO: All GPIO pins with output capabilities
Servo: 1/2
@@ -149,7 +151,7 @@ Supported hardware: |P000_usedby_GPIO|
"
``Monitor,G,<GPIO>``
GPIO: 0 ... 16
GPIO: 0 ... <max supported GPIO pin>
","
**To monitor a GPIO state.**
By the use of the command you will receive events when the GPIO state of that pin is changed from 1 to 0 and from 0 to 1.
@@ -157,7 +159,7 @@ Supported hardware: |P000_usedby_GPIO|
"
``UnMonitor,G,<GPIO>``
GPIO: 0 ... 16
GPIO: 0 ... <max supported GPIO pin>
","
**To cancel the monitor of a GPIO state.**
By the use of the command you will stop receiving events when the GPIO state of that pin is changed from 1 to 0 and from 0 to 1.
@@ -165,7 +167,7 @@ Supported hardware: |P000_usedby_GPIO|
"
``Status,G,<GPIO>``
GPIO: 0 ... 16
GPIO: 0 ... <max supported GPIO pin>
","
**Returns the status of a pin.**
By the use of the command you will receive the status of the relevant pin.
docs/source/Plugin/P001_commands_RTTTL.repl
+10 -6
View File
@@ -11,13 +11,16 @@ Supported hardware: |P000_usedby_RTTTL| (Ringtones etc.)
"
``tone,<gpio>,<tone>,<duration>``
GPIO: 12 ... 16
ESP8266 GPIO: 0 ... 16
ESP32 GPIO: All GPIO pins with output capabilities
Tone: 20 ... 13000 Hz
Duration: 100 ... 15000 msec
","
You should try to use GPIO 12...16 since these generally aren't used.
ESP8266: You should try to use GPIO 12...16 since these generally aren't used.
The recommended tone range is 20 Hz ... 13 kHz.
Up-to 40 kHz should be possible to generate, but will be inaudible for humans.
Frequencies above 30 kHz are not stable and will likely crash the ESP.
@@ -30,13 +33,14 @@ Supported hardware: |P000_usedby_RTTTL| (Ringtones etc.)
"
``rtttl,<gpio>,<value>``
GPIO: 12 ... 16
ESP8266 GPIO: 0 ... 16
ESP32 GPIO: All GPIO pins with output capabilities
Value: d=<duration>,o=<octave>,b=<tempo>,<notes...>
","
You should try to use GPIO 12...16 since these generally aren't used by ESP internal functions.
N.B. Playing a tune is blocking for as long as the tune is playing.
ESP8266: You should try to use GPIO 12...16 since these generally aren't used by ESP internal functions.
Value can be defined like <name_of_melody:duration,octave,beat,notes....>
For example:
docs/source/Plugin/_Plugin.rst
+3 -3
View File
@@ -222,13 +222,13 @@ There are different released versions of ESP Easy:
:green:`NORMAL` is the regular set of plugins, this is the base set of plugins, and with all secondary features enabled, like I2C multiplexer, RTTTL, DEBUG logging, etc.
:yellow:`COLLECTION` (split into sets A..x) with plugins that don't fit into the NORMAL builds. Because of space limitations, this collection is split into a number of sets. When only :yellow:`COLLECTION` is mentioned, the plugin is available in **all** :yellow:`COLLECTION` builds. Also, some features are disabled to save space in the .bin files, like RTTTL, tooltips, and DEBUG-level logging.
:yellow:`COLLECTION` (split into sets A..x) with plugins that don't fit into the NORMAL builds. Because of space limitations, this collection is split into a number of sets. When only :yellow:`COLLECTION` is mentioned, the plugin is available in **all** :yellow:`COLLECTION` builds, though some exceptions may be applied. Also, some features are disabled to save space in the .bin files, like RTTTL, Servo, tooltips, and DEBUG-level logging.
:red:`DEVELOPMENT` is used for plugins that are still being developed and are not considered stable at all. Currently there are no DEVELOPMENT builds available.
:yellow:`ENERGY` :yellow:`DISPLAY` :yellow:`IR` :yellow:`IRext` :yellow:`NEOPIXEL` :yellow:`CLIMATE` are specialized builds holding all Energy-, Display-, Infra Red- (extended), NeoPixel- and Climate- related plugins.
:yellow:`MAX` is the build that has all plugins that are available in the ESPEasy repository. Available for ESP32 16MB and ESP32-s3 8MB Flash units.
:yellow:`MAX` is the build that has all plugins that are available in the ESPEasy repository. Available for ESP32 16MB and ESP32 8MB Flash units (available for ESP32 Classic, ESP32-S3 and ESP32-C6).
:gray:`RETIRED` plugin has been retired and removed from ESPEasy.
@@ -333,7 +333,7 @@ There are different released versions of ESP Easy:
":ref:`P092_page`","|P092_status|","P092"
":ref:`P093_page`","|P093_status|","P093"
":ref:`P094_page`","|P094_status|","P094"
":ref:`P095_page`","|P095_status|","P095"
":ref:`P095_page`","|P095_status| (ESP32)","P095"
":ref:`P097_page`","|P097_status|","P097"
":ref:`P098_page`","|P098_status|","P098"
":ref:`P099_page`","|P099_status|","P099"