Add support to LN882X family (#4967)

Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>

all_automations.json

@@ -496,6 +496,7 @@
     "esp32",
     "esp8266",
     "host",
+    "ln882x",
     "max6956",
     "mcp23016",
     "mcp23xxx",

components/index.rst

@@ -35,6 +35,7 @@ Supported Microcontrollers
     RP2040, components/rp2040, rp2040.svg
     BK72xx, components/libretiny, bk72xx.svg
     RTL87xx, components/libretiny, rtl87xx.svg
+    LN882x, components/libretiny, ln882x.svg
     Host, components/host, host.svg, dark-invert
 
 Microcontroller Peripherals

components/libretiny.rst

@@ -10,6 +10,7 @@ It provides support for the following microcontrollers, commonly used in Tuya de
 
 - **BK72xx**: BK7231T, BK7231N
 - **RTL87xx**: RTL8710BN, RTL8710BX
+- **LN882x**: LN882HKI
 
 Since different microcontrollers are supported, you need to include the appropriate ESPHome component,
 depending on which processor your device has.
@@ -26,6 +27,10 @@ Refer to `LibreTiny/Boards <https://docs.libretiny.eu/link/boards>`__ to find yo
     rtl87xx:
       board: generic-rtl8710bn-2mb-788k
 
+    # Example configuration entry for LN882x
+    ln882x:
+      board: generic-ln882hki
+
 Configuration variables:
 ------------------------
 
@@ -50,7 +55,7 @@ Configuration variables:
   - :ref:`Advanced options <advanced-options>`
 
 - **family** (*Optional*, string): The family of LibreTiny-supported microcontrollers that is used on this board.
-  One of ``bk7231n``, ``bk7231t``, ``rtl8710b``, ``rtl8720c``, ``bk7251``, ``bk7231q``.
+  One of ``bk7231n``, ``bk7231t``, ``rtl8710b``, ``rtl8720c``, ``bk7251``, ``bk7231q``, ``ln882hki``.
   Defaults to the variant that is detected from the board, if a board that's unknown to ESPHome is used,
   this option is mandatory. **It's recommended not to include this option**.
 
@@ -77,6 +82,7 @@ Here are a few useful links:
 
 - `Flashing BK72xx by UART <https://docs.libretiny.eu/link/flashing-beken-72xx>`__
 - `Flashing RTL8710B by UART <https://docs.libretiny.eu/link/flashing-realtek-ambz>`__
+- `Flashing LN882x by UART <https://docs.libretiny.eu/docs/platform/lightning-ln882x/#flashing>`__
 - `UPK2ESPHome <https://upk.libretiny.eu/>`__ - generating ESPHome YAML automatically, from Cloudcutter profiles or Kickstart firmware (also BK72xx only)
 
 GPIO Pin Numbering
@@ -109,6 +115,13 @@ Some notes about the pins on RTL8710BN/BX:
 - ``TX2 (PA30)`` is additionally used to determine the boot mode on startup (similar to ESP32).
   Pulling it LOW on startup will enter "download mode".
 
+Some notes about the pins on LN882H:
+
+- ``TX0 (PA2)`` and ``RX0 (PA3)`` are used for flashing the firmware,
+  as well as the default :doc:`/components/logger` UART port.
+- ``BOOT1 (PA9)`` is additionally used to determine the boot mode on startup (similar to ESP32).
+  Pulling it LOW on startup will enter "download mode".
+
 Example configuration entries using various naming styles:
 
 .. code-block:: yaml

images/ln882x.svg

@@ -0,0 +1 @@
+<svg viewBox="0 0 115 25" id="svg5" xmlns="http://www.w3.org/2000/svg" xmlns:svg="http://www.w3.org/2000/svg"><defs id="defs9"/><path d="M5 0H110a5 5 0 015 5v15a5 5 0 01-5 5H5a5 5 0 01-5-5V5a5 5 0 015-5z" style="fill:#000" id="path2"/><g aria-label="LN882x" id="component-text" style="font-weight:900;font-size:25px;font-family:Montserrat;letter-spacing:1.1px;fill:#fffffc"><path d="M6.425 21V3.5h5.9v12.925h7.9V21z" id="path11"/><path d="M22.950015 21V3.5h4.85l8.9 10.65h-2.25V3.5h5.75V21h-4.85l-8.9-10.65h2.25V21z" id="path13"/><path d="m51.200037 21.4q-2.325.0-4.1-.675-1.75-.7-2.75-1.95-1-1.275-1-2.975.0-1.7 1.025-2.9 1.025-1.2 2.8-1.825t4.025-.625 4.025.625 2.8 1.825 1.025 2.9-1 2.975q-1 1.25-2.775 1.95-1.75.675-4.075.675zm0-3.975q.85.0 1.375-.475.55-.5.55-1.35t-.55-1.325q-.525-.5-1.375-.5t-1.4.5q-.525.475-.525 1.325t.525 1.35q.55.475 1.4.475zm0-4.125q-2.05.0-3.7-.575-1.625-.6-2.575-1.7-.95-1.125-.95-2.7.0-1.6.925-2.75.925-1.175 2.55-1.825 1.625-.65 3.75-.65t3.75.65q1.625.65 2.55 1.825.925 1.15.925 2.75.0 1.575-.95 2.7-.95 1.1-2.575 1.7-1.625.575-3.7.575zm0-3.225q.6.0 1-.4t.4-1.1q0-.725-.4-1.1-.4-.4-1-.4t-1 .4q-.4.375-.4 1.1.0.7.4 1.1t1 .4z" id="path15"/><path d="m69.250024 21.4q-2.325.0-4.1-.675-1.75-.7-2.75-1.95-1-1.275-1-2.975.0-1.7 1.025-2.9 1.025-1.2 2.8-1.825t4.025-.625 4.025.625 2.8 1.825q1.025 1.2 1.025 2.9t-1 2.975q-1 1.25-2.775 1.95-1.75.675-4.075.675zm0-3.975q.85.0 1.375-.475.55-.5.55-1.35t-.55-1.325q-.525-.5-1.375-.5t-1.4.5q-.525.475-.525 1.325t.525 1.35q.55.475 1.4.475zm0-4.125q-2.05.0-3.7-.575-1.625-.6-2.575-1.7-.95-1.125-.95-2.7.0-1.6.925-2.75.925-1.175 2.55-1.825 1.625-.65 3.75-.65t3.75.65q1.625.65 2.55 1.825.925 1.15.925 2.75.0 1.575-.95 2.7-.95 1.1-2.575 1.7-1.625.575-3.7.575zm0-3.225q.6.0 1-.4t.4-1.1q0-.725-.4-1.1-.4-.4-1-.4t-1 .4q-.4.375-.4 1.1.0.7.4 1.1t1 .4z" id="path17"/><path d="m79.525012 21v-3.625l6.325-5.85q.6-.575.875-1 .3-.425.4-.75.1-.35.1-.65.0-.65-.425-1-.425-.375-1.275-.375-.775.0-1.475.425-.7.4-1.1 1.2l-4.45-2.225q.95-1.8 2.85-2.925 1.9-1.125 4.725-1.125 2.075.0 3.675.675t2.5 1.9q.9 1.225.9 2.9.0.85-.225 1.7-.2.85-.85 1.8-.65.925-1.925 2.075l-4.75 4.325-.925-2.05h9.075V21z" id="path19"/><path d="m94.900008 21 6.450002-8.45-.15 3.25-6.150002-8.475h6.375002l3.025 4.525-2.35.175 3.325-4.7h5.925l-6.175 8.2V12.4l6.3 8.6h-6.475l-3.125-4.825 2.375.325-3.225 4.5z" id="path21"/></g></svg>

index.rst

@@ -182,7 +182,7 @@ Which microcontrollers does ESPHome support?
         <div class="feature-card">
             <div class="feature-icon"><i aria-hidden="true" class="fas fa-bolt"></i></div>
             <div class="feature-text">Others</div>
-            <p>Realtek RTL87xx and Beken BK72xx chips are supported.</p>
+            <p>Realtek RTL87xx and Beken BK72xx and Lightning LN882H chips are supported.</p>
         </div>
         <div class="feature-card">
             <div class="feature-icon"><i aria-hidden="true" class="fas fa-computer"></i></div>