Add xxtea docs (#4640)

* Add xxtea docs * Update index.rst --------- Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>
esphome · Feb 4, 2025 · bffe03c · bffe03c
1 parent c3e0d97
commit bffe03c
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 0 deletions.
diff --git a/components/xxtea.rst b/components/xxtea.rst
@@ -0,0 +1,22 @@
+XXTEA Component
+===============
+
+.. seo::
+    :description: Lightweight encryption algorithm for ESPHome
+    :keywords: xxtea
+
+This component cannot be used directly in YAML, but can be used in lambdas to encrypt and decrypt data.
+
+The encryption used is `XXTEA <https://en.wikipedia.org/wiki/XXTEA>`_ which is fast and compact. XXTEA is known
+to be susceptible to a chosen-plaintext attack, so it should not be used where plain-text injection is possible.
+
+The algorithm has been modified from the original to use a 256 bit key instead of the original 128 bit key.
+
+See the API docs for more information on how to use this component.
+
+See Also
+--------
+
+- :doc:`index`
+- :apiref:`xxtea/xxtea.h`
+- :ghedit:`Edit`
diff --git a/images/xxtea.svg b/images/xxtea.svg
diff --git a/index.rst b/index.rst
@@ -178,6 +178,7 @@ ESPHome-specific components or components supporting ESPHome device provisioning
     Improv via Serial, components/improv_serial, improv.svg, dark-invert
     Interval, components/interval, description.svg, dark-invert
     JSON, components/json, json.svg, dark-invert
+    XXTEA, components/xxtea, xxtea.svg
     Script, components/script, description.svg, dark-invert
 
 ESPHome Configuration