Merge branch 'current' into grove_gas_mc_v2-update-doc

esphome · Jan 7, 2025 · ba51d80 · ba51d80
2 parents f9ac5a9 + ca2f4be
commit ba51d80
Show file tree

Hide file tree

Showing 9 changed files with 64 additions and 25 deletions.
diff --git a/components/cover/endstop.rst b/components/cover/endstop.rst
@@ -62,7 +62,7 @@ Configuration variables:
   :ref:`Binary Sensor <config-binary_sensor>` that turns on when the closed position is reached.
 
 - **stop_action** (**Required**, :ref:`Action <config-action>`): The action that should
-  be performed when the remote requests the cover to be closed or an endstop is reached.
+  be performed when the remote requests the cover to stop or an endstop is reached.
 - **max_duration** (*Optional*, :ref:`config-time`): The maximum duration the cover should be opening
   or closing. Useful for protecting from dysfunctional endstops.
 - All other options from :ref:`Cover <config-cover>`.

diff --git a/components/esphome.rst b/components/esphome.rst
@@ -100,10 +100,9 @@ is already set up. You can however change this using the ``priority`` parameter.
     esphome:
       # ...
       on_boot:
-        priority: 600
-        # ...
-        then:
-          - switch.turn_off: switch_1
+        - priority: 600
+          then:
+            - switch.turn_off: switch_1
 
 Configuration variables:
 
@@ -138,9 +137,9 @@ too many WiFi/MQTT connection attempts, Over-The-Air updates being applied or th
     esphome:
       # ...
       on_shutdown:
-        priority: 700
-        then:
-          - switch.turn_off: switch_1
+        - priority: 700
+          then:
+            - switch.turn_off: switch_1
 
 Configuration variables:
 

diff --git a/components/font.rst b/components/font.rst
@@ -52,12 +52,13 @@ Next, create a ``font:`` section in your configuration:
         size: 28
         bpp: 4
         glyphs: [
-          a,A,á,Á,e,E,é,É,
+          0123456789aAáÁeEéÉ,
           (,),+,-,_,.,°,•,µ,
-          "\u0020", #space
-          "\u0021", #!
-          "\u0022", #"
-          "\u0027", #'
+          "\u0020", # space
+          "\u002C", # ,
+          "\u0021", # !
+          "\u0022", # "
+          "\u0027", # '
           ]
 
       - file: "fonts/RobotoCondensed-Regular.ttf"

diff --git a/components/http_request.rst b/components/http_request.rst
@@ -291,16 +291,19 @@ whose ``id`` is  set to ``player_volume``:
                 then:
                     - lambda: |-
                         json::parse_json(body, [](JsonObject root) -> bool {
-                          if (root["vol"]) {
-                              id(player_volume).publish_state(root["vol"]);
-                          } else {
-                            ESP_LOGD(TAG,"No 'vol' key in this json!");
-                          }
+                            if (root["vol"]) {
+                                id(player_volume).publish_state(root["vol"]);
+                                return true;
+                            }
+                            else {
+                              ESP_LOGI(TAG,"No 'vol' key in this json!");
+                              return false;
+                            }
                         });
                 else:
                     - logger.log:
                         format: "Error: Response status: %d, message %s"
-                        args: [response->status_code, body.c_str()];
+                        args: [ 'response->status_code', 'body.c_str()' ]
 
 See Also
 --------

diff --git a/components/light/esp32_rmt_led_strip.rst b/components/light/esp32_rmt_led_strip.rst
@@ -54,6 +54,7 @@ Configuration variables
   A time interval used to limit the number of commands a light can handle per second. For example
   16ms will limit the light to a refresh rate of about 60Hz. Defaults to sending commands as quickly as
   changes are made to the lights.
+- **use_psram** (*Optional*, boolean): Set to ``false`` to force internal RAM allocation even if you have the the PSRAM component enabled. This can be useful if you're experiencing issues like flickering with your leds strip. Defaults to ``true``.
 
 - All other options from :ref:`Light <config-light>`.
 

diff --git a/components/remote_receiver.rst b/components/remote_receiver.rst
@@ -469,7 +469,7 @@ Remote code selection (exactly one of these has to be included):
 
 .. note::
 
-    For the Sonoff RF Bridge, you can bypass the EFM8BB1 microcontroller handling RF signals with
+    For the black Sonoff RF Bridge, you can bypass the EFM8BB1 microcontroller handling RF signals with
     `this hack <https://github.com/xoseperez/espurna/wiki/Hardware-Itead-Sonoff-RF-Bridge---Direct-Hack>`__
     created by the GitHub user wildwiz. Then use this configuration for the remote receiver/transmitter hubs:
 
@@ -483,7 +483,25 @@ Remote code selection (exactly one of these has to be included):
           pin: 5
           carrier_duty_percent: 100%
 
+    There's also a software `"hack" <https://github.com/mightymos/RF-Bridge-OB38S003>`__ that allows the radio chip to mirror all the voltages to the ESP to do the decoding,
+    rendering the hardware hack uncessary. This software passthrough mode can be used for the OB38S003 (white) and EFM8BB1 (black) sonoff RF bridge. Then use this configuration for the remote receiver/transmitter hubs:
 
+    .. code-block:: yaml
+
+        remote_receiver:
+          pin:
+            # sonoff and wemos board
+            number: GPIO3
+            mode:
+              input: true
+              pullup: false
+          tolerance: 60%
+          filter: 4us
+          idle: 4ms
+       
+        remote_transmitter:
+          pin: 1
+          carrier_duty_percent: 100%
 
 See Also
 --------

diff --git a/components/sensor/as7341.rst b/components/sensor/as7341.rst
@@ -7,7 +7,7 @@ AS7341 Spectral Color Sensor
     :keywords: AS7341
 
 The ``as7341`` sensor platform allows you to use your AS7341 spectral color sensor
-(`datasheet <https://ams.com/documents/20143/36005/AS7341_DS000504_3-00.pdf/5eca1f59-46e2-6fc5-daf5-d71ad90c9b2b>`__,
+(`datasheet <https://look.ams-osram.com/m/24266a3e584de4db/original/AS7341-DS000504.pdf>`__,
 `Adafruit`_) with ESPHome. The :ref:`I²C Bus <i2c>` is required to be set up in
 your configuration for this sensor to work.
 

diff --git a/guides/getting_started_command_line.rst b/guides/getting_started_command_line.rst
@@ -224,8 +224,10 @@ To start the ESPHome dashboard, simply start ESPHome with the following command
 .. code-block:: bash
 
     # Install dashboard dependencies
-    pip install tornado esptool \
-     esphome dashboard config
+    pip install tornado esptool
+
+    # Start the dashboard
+    esphome dashboard config
 
     # On Docker, host networking mode is required for online status indicators
     docker run --rm --net=host -v "${PWD}":/config -it ghcr.io/esphome/esphome

diff --git a/index.rst b/index.rst
@@ -75,6 +75,11 @@ ESPHome is a system to control your microcontrollers by simple yet powerful conf
                         Configuration types
                     </a>
                 </li>
+                <li>
+                    <a class="reference" href="https://devices.esphome.io/">
+                        Device configuration examples
+                    </a>
+                </li>
                 <li>
                     <a class="reference" href="/guides/creators.html">
                         Sharing ESPHome devices
@@ -1195,11 +1200,21 @@ Cookbook
     Arduino Port Extender, cookbook/arduino_port_extender, arduino_logo.svg
     EHMTX a matrix status/text display, cookbook/ehmtx, ehmtx.jpg
 
+.. _device_database:
+
+Device Database
+---------------
+
+You will find configurations for specific devices in our `ESPHome Devices <https://devices.esphome.io/>`__ database.
+
+.. _contributing:
+
+Contributing
+------------
+
 Do you have other awesome automations or cool setups? Please feel free to add them to the
 documentation for others to copy. See :doc:`Contributing </guides/contributing>`.
 
-If you'd like to share configurations for specific devices, please contribute to our `ESPHome Devices <https://devices.esphome.io/>`__ database.
-
 .. toctree::
     :hidden: