From 6f80107eeae416e85b7880b8e6d8383df43e2998 Mon Sep 17 00:00:00 2001 From: Matthew Garrett Date: Tue, 10 May 2022 02:35:49 -0700 Subject: [PATCH] Document the update_interval support and requirements for PMSX003 (#1803) Co-authored-by: Otto Winter Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com> --- components/sensor/pmsx003.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/components/sensor/pmsx003.rst b/components/sensor/pmsx003.rst index e7fb05fa9..39a799b47 100644 --- a/components/sensor/pmsx003.rst +++ b/components/sensor/pmsx003.rst @@ -26,6 +26,7 @@ value: # Example configuration entry uart: rx_pin: GPIO23 + tx_pin: GPIO22 baud_rate: 9600 sensor: @@ -37,6 +38,7 @@ value: name: "Particulate Matter <2.5µm Concentration" pm_10_0: name: "Particulate Matter <10.0µm Concentration" + update_interval: 60000ms Configuration variables: ------------------------ @@ -71,6 +73,8 @@ Configuration variables: All options from :ref:`Sensor `. - **formaldehyde** (*Optional*): Use the formaldehyde (HCHO) concentration in µg per cubic meter for the ``PMS5003S`` and ``PMS5003ST``. All options from :ref:`Sensor `. +- **update_interval** (*Optional*): Amount of time to wait between generating measurements. If this is longer than 30 + seconds, and if ``tx_pin`` is set in the UART configuration, the fan will be spun down between measurements. Default to ``0s`` (forward data as it's coming in from the sensor). - **uart_id** (*Optional*, :ref:`config-id`): Manually specify the ID of the :ref:`UART Component ` if you want to use multiple UART buses.