diff --git a/docs/source/Controller/C005.rst b/docs/source/Controller/C005.rst index b02b8fd051..897a613710 100644 --- a/docs/source/Controller/C005.rst +++ b/docs/source/Controller/C005.rst @@ -122,6 +122,8 @@ MQTT - Auto Discovery (AutoDiscovery related settings added 2025/06/28) +.. note:: The **MQTT Auto Discovery** feature is not included in ESP8266 builds by default, see: :ref:`esp8266-feature-complete` + * **Enable Auto Discovery**: When checked, the controller will send discovery data for all connected and enabled tasks to the MQTT server on first startup, and when receiving an ``online`` message in the Discovery Trigger Topic, when configured. * **Discovery Trigger topic**: Default for Home assistant: ``homeassistant/status`` diff --git a/docs/source/ESPEasy/ESPchips.rst b/docs/source/ESPEasy/ESPchips.rst index 0e325609d6..c698687c6d 100644 --- a/docs/source/ESPEasy/ESPchips.rst +++ b/docs/source/ESPEasy/ESPchips.rst @@ -1,6 +1,8 @@ Supported ESP Chips ******************* +.. _esp8266-feature-complete: + ESP8266 is Feature Complete! ============================ @@ -19,7 +21,7 @@ The consequences of this decision are that: * To enable some of the new features (many are still useable) for ESP8266, a Custom build can be configured and built by the user, as documented in :ref:`PlatformIO_page`. * A notable exception is support for TLS: That's *not* possible to enable on ESPEasy in ESP8266 builds as it doesn't fit in the limited available RAM memory. -For new projects, it is strongly advised to select one of the many available ESP32 boards, or chips when designing a custom board. Some of the ESP32 variants are available with 16 MB Flash (ESP32 Classic, ESP32-C3, ESP32-C6 and ESP32-S3), and have 1 or more MAX builds available in ESPEasy, that include all plugins and features available, and also a larger selection of fonts for displays (TFT/LCD, OLed and 7-segment). +For new projects, it is strongly advised to select one of the many available ESP32 boards, or chips when designing a custom board. Some of the ESP32 variants are available with 8MB, 16 MB, and 32MB, Flash (ESP32 Classic, ESP32-C3, ESP32-C5, ESP32-C6/C61, ESP32-S3 and ESP32-P4), and have 1 or more MAX builds available in ESPEasy, that include all plugins and features available, and also a larger selection of fonts for displays (TFT/LCD, OLed and 7-segment). Overview of supported chips =========================== diff --git a/docs/source/Participate/PlatformIO.rst b/docs/source/Participate/PlatformIO.rst index 22b5b5d2e6..0a75659ecc 100644 --- a/docs/source/Participate/PlatformIO.rst +++ b/docs/source/Participate/PlatformIO.rst @@ -83,7 +83,7 @@ Optional, but highly recommended: * C/C++ DevTools (by Microsoft) * Bookmarks (by Alessandro Fragnani) * GitLens - Git supercharged (by Gitkraken) -* TODO Highlight (by Wayou Liu) +* TODO Highlight v2 (by Jonathan Clark) * All Autocomplete (by Atishay Jain) * Excel Viewer (by GrapeCity) * Esbonio - An extension for editing sphinx projects (by Swyddfa) diff --git a/docs/source/Plugin/_Plugin.rst b/docs/source/Plugin/_Plugin.rst index 87f3366f5e..beee4d1d38 100644 --- a/docs/source/Plugin/_Plugin.rst +++ b/docs/source/Plugin/_Plugin.rst @@ -325,13 +325,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, 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. +:yellow:`COLLECTION` (split into sets A..x) with plugins that don't all fit into the NORMAL builds, but including (nearly) everything from NORMAL. 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` (split into sets A..B) :yellow:`IR` :yellow:`IRext` :yellow:`NEOPIXEL` :yellow:`CLIMATE` (split into sets A..B) 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 8MB Flash units (available for ESP32-Classic, ESP32-S3, ESP32-C3, ESP32-C5, ESP32-C6, ESP32-C61 and ESP32-P4). +:yellow:`MAX` is the build that has all plugins that are available in the ESPEasy repository. Available for ESP32 16MB, 8MB and 32MB Flash units (available for ESP32-Classic, ESP32-S3, ESP32-C3, ESP32-C5, ESP32-C6, ESP32-C61 and ESP32-P4). :gray:`RETIRED` plugin has been retired and removed from ESPEasy. diff --git a/docs/source/Plugin/_plugin_substitutions_p12x.repl b/docs/source/Plugin/_plugin_substitutions_p12x.repl index 30c437db86..81211d091f 100644 --- a/docs/source/Plugin/_plugin_substitutions_p12x.repl +++ b/docs/source/Plugin/_plugin_substitutions_p12x.repl @@ -60,7 +60,7 @@ .. |P124_porttype| replace:: `.` .. |P124_status| replace:: :yellow:`COLLECTION D` .. |P124_status_lb| replace:: :yellow:`COLLECTION D` -.. |P124_github| replace:: P124_MultiTelay.ino +.. |P124_github| replace:: P124_MultiRelay.ino .. _P124_github: https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P124_MyltiRelay.ino .. |P124_usedby| replace:: `.` .. |P124_shortinfo| replace:: `Seeed Studio I2C Multi Relay boards`