From a28947177dae8fa72c7bd4144d9a7b267382d5d2 Mon Sep 17 00:00:00 2001 From: Gabriel Sieben Date: Sat, 2 Jul 2022 23:46:15 +0200 Subject: [PATCH 01/27] Missing entry --- components/output/pca9685.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/components/output/pca9685.rst b/components/output/pca9685.rst index 20ae7408f..cbd154cb3 100644 --- a/components/output/pca9685.rst +++ b/components/output/pca9685.rst @@ -25,6 +25,7 @@ global ``pca9685`` hub and give it an id, and then define the # Example configuration entry pca9685: frequency: 500 + id: 'pca9685_hub1' # Individual outputs output: From 72bdc625cee2bb919e1fa98cf7e00cbe273020ad Mon Sep 17 00:00:00 2001 From: Gabriel Sieben Date: Sun, 3 Jul 2022 19:33:06 +0200 Subject: [PATCH 02/27] Update pca9685.rst --- components/output/pca9685.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/components/output/pca9685.rst b/components/output/pca9685.rst index cbd154cb3..5862cbca4 100644 --- a/components/output/pca9685.rst +++ b/components/output/pca9685.rst @@ -82,6 +82,27 @@ Configuration variables: Use this if you have multiple PCA9685s you want to use at the same time. - All other options from :ref:`Output `. + +Note +---- + +This output can be used for different functions. E.g. output for light, ventiator etc. + +.. code-block:: yaml + + pca9685: + frequency: 500 + + output: + - platform: pca9685 + channel: 0 + id: pwm01 + + light: + - platform: monochromatic + name: 'main light' + output: pwm01 + See Also -------- From 7a3c6db65ca6a8688f42247e8539f22c76b5dfb1 Mon Sep 17 00:00:00 2001 From: Philippe FOUQUET Date: Mon, 5 Sep 2022 17:29:51 +0200 Subject: [PATCH 03/27] Add Sonoff THR316D description --- devices/sonoff.rst | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/devices/sonoff.rst b/devices/sonoff.rst index 8214b7be0..d61d213ca 100644 --- a/devices/sonoff.rst +++ b/devices/sonoff.rst @@ -350,6 +350,28 @@ Sonoff Mini GPIO16, Optional sensor +Sonoff THR316D +----------- + +.. pintable:: + + GPIO0, Button, + GPIO21, Relay 1, + GPIO4, Relay 2, + GPIO27, Optionnal sensor power ON/OFF, + GPIO25, sensor, + GPIO16, Power LED, + GPIO15, Wifi LED (inverted), + GPIO13, Cycle LED (inverted), + GPIO23, Display Read, + GPIO18, Display Write, + GPIO5, Display Data, + GPIO17, Display CS, + + GPIO1, UART TX pin (for log) + GPIO3, UART RX pin (for log) + + Shelly 1 -------- From 463ef50e44cd7d03a5521751f00c9d4cf3afeb4b Mon Sep 17 00:00:00 2001 From: Philippe FOUQUET Date: Mon, 5 Sep 2022 17:33:57 +0200 Subject: [PATCH 04/27] title undurline too short --- devices/sonoff.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/devices/sonoff.rst b/devices/sonoff.rst index d61d213ca..3f0409b29 100644 --- a/devices/sonoff.rst +++ b/devices/sonoff.rst @@ -351,7 +351,7 @@ Sonoff Mini Sonoff THR316D ------------ +-------------- .. pintable:: From 728bb6ccf0ce1c2d76bd6d9992f0c1519de837ca Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Gir=C3=B3n?= Date: Wed, 28 Sep 2022 21:36:30 +0200 Subject: [PATCH 05/27] Update YAML indent of mpl3115a2 --- components/sensor/mpl3115a2.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/components/sensor/mpl3115a2.rst b/components/sensor/mpl3115a2.rst index 8bbb69c1e..6c06c22a5 100644 --- a/components/sensor/mpl3115a2.rst +++ b/components/sensor/mpl3115a2.rst @@ -23,12 +23,12 @@ required to be set up in your configuration for this sensor to work. # Example configuration entry sensor: - - platform: mpl3115a2 - temperature: - name: "MPL3115A2 Temperature" - pressure: - name: "MPL3115A2 Pressure" - update_interval: 10s + - platform: mpl3115a2 + temperature: + name: "MPL3115A2 Temperature" + pressure: + name: "MPL3115A2 Pressure" + update_interval: 10s Configuration variables: ------------------------ From 10b2abc4500b540c32a481438f99fbb0f747f4b7 Mon Sep 17 00:00:00 2001 From: briangunderson Date: Thu, 29 Sep 2022 09:09:44 -0500 Subject: [PATCH 06/27] update bedjet.rst The Bedjet app (iOS) no longer exposes MAC addresses of connected devices. --- components/climate/bedjet.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/components/climate/bedjet.rst b/components/climate/bedjet.rst index 9fd6c9473..7e4c3ee57 100644 --- a/components/climate/bedjet.rst +++ b/components/climate/bedjet.rst @@ -18,8 +18,7 @@ This component supports the following functionality: This component uses the BLE peripheral on an ESP32, so you also need to enable this component. Please see the :doc:`/components/ble_client` docs for how to discover the MAC -address of your BedJet device, or you can find the list of paired MAC addresses in -the "DEVICE LIST" section of the BedJet mobile application. +address of your BedJet device. Component/Hub ------------- From e7d8e75dd841a196394e842962f30fdbb8ca0310 Mon Sep 17 00:00:00 2001 From: "Francisco J. Solis" Date: Tue, 4 Oct 2022 23:27:02 -0500 Subject: [PATCH 07/27] docs: update the quantile link The quantile link has been updated to a more descriptive one, which gives a better idea of the quantile function. Refs: https://github.com/esphome/issues/issues/3622 --- components/sensor/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/components/sensor/index.rst b/components/sensor/index.rst index ea1714255..515b09762 100644 --- a/components/sensor/index.rst +++ b/components/sensor/index.rst @@ -392,7 +392,7 @@ Configuration variables: ****************************** A simple `exponential moving average -`__ over the last few +`__ over the last few values. It can be used to have a short update interval on the sensor but only push out an average on a specific interval (thus increasing resolution). From e04f22b2718e945ecaf77ab43f72acaf5f8e5f26 Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Wed, 19 Oct 2022 08:10:12 +1300 Subject: [PATCH 08/27] Update components/output/pca9685.rst --- components/output/pca9685.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/components/output/pca9685.rst b/components/output/pca9685.rst index 5862cbca4..429e72d50 100644 --- a/components/output/pca9685.rst +++ b/components/output/pca9685.rst @@ -83,7 +83,7 @@ Configuration variables: - All other options from :ref:`Output `. -Note +Examples ---- This output can be used for different functions. E.g. output for light, ventiator etc. From 98394994f7f5b80a1213f2663e20e61eb9b16119 Mon Sep 17 00:00:00 2001 From: Jesse Hills <3060199+jesserockz@users.noreply.github.com> Date: Wed, 19 Oct 2022 08:10:38 +1300 Subject: [PATCH 09/27] Update components/output/pca9685.rst --- components/output/pca9685.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/components/output/pca9685.rst b/components/output/pca9685.rst index 429e72d50..37a5982cc 100644 --- a/components/output/pca9685.rst +++ b/components/output/pca9685.rst @@ -84,7 +84,7 @@ Configuration variables: Examples ----- +-------- This output can be used for different functions. E.g. output for light, ventiator etc. From 50eb076c70537ea9ae435a273ba6f454c2723fc2 Mon Sep 17 00:00:00 2001 From: rlowens <35885181+rlowens@users.noreply.github.com> Date: Wed, 19 Oct 2022 01:18:09 -0500 Subject: [PATCH 10/27] Add example workaround for static uniqueid Since the sensor's uniqueid is static you have to use the copy sensor instead. Here's an example of doing that. --- components/sensor/wifi_signal.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/components/sensor/wifi_signal.rst b/components/sensor/wifi_signal.rst index 1fa639678..1458b0cbc 100644 --- a/components/sensor/wifi_signal.rst +++ b/components/sensor/wifi_signal.rst @@ -23,6 +23,26 @@ measured in decibel-milliwatts (dBm). These values are always negative and the c name: "WiFi Signal Sensor" update_interval: 60s +Note: since this sensor has a static uniqueid reported to Home Assistant, you can only have one sensor of this type in a device. If you want to have another, use the :ref:`copy-sensor`: + +.. code-block:: yaml + + # Example configuration entry with 2 sensors and filter + sensor: + - platform: wifi_signal # Reports the WiFi signal strength/RSSI in dB + name: "WiFi Signal dB" + id: wifi_signal_db + update_interval: 60s + entity_category: "diagnostic" + + - platform: copy # Reports the WiFi signal strength in % + source_id: wifi_signal_db + name: "WiFi Signal Percent" + filters: + - lambda: return min(max(2 * (x + 100.0), 0.0), 100.0); + unit_of_measurement: "Signal %" + entity_category: "diagnostic" + Configuration variables: ------------------------ From 7b0df82b1693b021d8c4e4a9c4319555275b79d9 Mon Sep 17 00:00:00 2001 From: rlowens <35885181+rlowens@users.noreply.github.com> Date: Wed, 19 Oct 2022 02:18:07 -0500 Subject: [PATCH 11/27] Add copy-sensor anchor --- components/copy.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/components/copy.rst b/components/copy.rst index 3035d41b9..8f6ed593f 100644 --- a/components/copy.rst +++ b/components/copy.rst @@ -137,6 +137,8 @@ Configuration variables: - **name** (**Required**, string): The name of the select. - All other options from :ref:`Select `. +.. _copy_sensor: + Copy Sensor ----------- From 7da3ff04cdfc595efa688fc2e620365b5b94b88c Mon Sep 17 00:00:00 2001 From: Brian Kaufman Date: Fri, 21 Oct 2022 09:27:17 -0700 Subject: [PATCH 12/27] Fix color temp units for strobe effect Re-sending PR --- components/light/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/components/light/index.rst b/components/light/index.rst index 083af218b..26f680a33 100644 --- a/components/light/index.rst +++ b/components/light/index.rst @@ -551,7 +551,7 @@ Configuration variables: - **green** (*Optional*, percentage): The green channel of the light, if applicable. Defaults to ``100%``. - **blue** (*Optional*, percentage): The blue channel of the light, if applicable. Defaults to ``100%``. - **white** (*Optional*, percentage): The white channel of the light, if applicable. Defaults to ``100%``. - - **color_temperature** (*Optional*, percentage): The color temperature of the light, if applicable. Defaults to ``100%``. + - **color_temperature** (*Optional*, float): The color temperature (in `mireds `__ or Kelvin) of the light, if applicable. - **cold_white** (*Optional*, percentage): The cold white channel of the light, if applicable. Defaults to ``100%``. - **warm_white** (*Optional*, percentage): The warm white channel of the light, if applicable. Defaults to ``100%``. - **duration** (**Required**, :ref:`config-time`): The duration this color should be active. From c0579f928e21e21fe6f1519684a709b1fdfcb197 Mon Sep 17 00:00:00 2001 From: whnr Date: Thu, 27 Oct 2022 19:02:18 -0400 Subject: [PATCH 13/27] Update max31856.rst Added note that only K type is supported at the moment. --- components/sensor/max31856.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/components/sensor/max31856.rst b/components/sensor/max31856.rst index c656f24f3..9ccfc707e 100644 --- a/components/sensor/max31856.rst +++ b/components/sensor/max31856.rst @@ -6,7 +6,9 @@ MAX31856 Thermocouple Temperature Sensor :image: max31856.jpg The ``MAX31856`` temperature sensor allows you to use your MAX31856 Thermocouple -temperature sensor (`datasheet `__) with ESPHome +temperature sensor (`datasheet `__) with ESPHome. +Multiple types of thermocouples supported by the chip. +Currently only the K type is implemented here. .. figure:: images/max31856-full.jpg :align: center From 87ccff42970f812577feec7f74299d1b44cab4e8 Mon Sep 17 00:00:00 2001 From: Dennis Date: Sun, 30 Oct 2022 18:39:07 +0100 Subject: [PATCH 14/27] Added note about decimal accuracy of other sensors Any sensors other than the DHT11 has at least one digit of accuracy. The default is 0, so this accuracy is lost and it's not obvious that the default masks the possibly higher resolution. --- components/sensor/dht.rst | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/components/sensor/dht.rst b/components/sensor/dht.rst index ef4455b22..b89b00ce2 100644 --- a/components/sensor/dht.rst +++ b/components/sensor/dht.rst @@ -6,17 +6,14 @@ DHT Temperature+Humidity Sensor :image: dht.jpg :keywords: DHT11, DHT21, DHT22, AMS2301, AM2302, RHT03, SI7021 -The DHT Temperature+Humidity sensor allows you to use your DHT11 -(`datasheet `__, -`Adafruit `__), DHT21/DHT22 -(`datasheet `__, -`Adafruit `__), AMS2301/AM2302 -(`datasheet `__, -`Adafruit `__), RHT03 -(`datasheet `__, -`SparkFun `__) and SI7021 (one wire Sonoff version) -(`datasheet `__, -`SparkFun `__) +The DHT Temperature+Humidity sensor allows you to use your + +- DHT11 (`datasheet `__, `Adafruit `__), +- DHT21/DHT22 (`datasheet `__, `Adafruit `__), +- AMS2301/AM2302 (`datasheet `__, `Adafruit `__), +- RHT03 (`datasheet `__, `SparkFun `__) and +- SI7021 (one wire Sonoff version) (`datasheet `__, `SparkFun `__) + sensors with ESPHome. .. figure:: images/dht-full.jpg @@ -62,6 +59,7 @@ Configuration variables: - **name** (**Required**, string): The name for the humidity sensor. - **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas. - All other options from :ref:`Sensor `. + - **model** (*Optional*, int): Manually specify the DHT model, can be one of ``AUTO_DETECT``, ``DHT11``, ``DHT22``, ``DHT22_TYPE2``, ``AM2302``, ``RHT03``, ``SI7021`` @@ -74,6 +72,8 @@ Configuration variables: If you're seeing lots of invalid temperature/humidity warnings in the logs, try manually setting the DHT model with the ``model:`` configuration variable. Other problems could be wrong pull-up resistor values on the DATA pin or too long cables. + + Also, the default ``accuracy_decimals`` value of the humidity levels is set to 0, as the DHT11 for which this was originally written does not have a higher resolution. All other DHT sensors have a higher resolution, and thus should be configured with ``accuracy_decimals: 1``. See Also -------- From 19ef5b8ec7703bfc95d726bbf424362f6beae252 Mon Sep 17 00:00:00 2001 From: Piotr Kubiak Date: Sun, 13 Nov 2022 19:07:15 +0100 Subject: [PATCH 15/27] Fixed syntax --- components/select/tuya.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/components/select/tuya.rst b/components/select/tuya.rst index 670adbd4b..1b0b9d5e3 100644 --- a/components/select/tuya.rst +++ b/components/select/tuya.rst @@ -42,9 +42,9 @@ Based on this, you can create the select as follows: enum_datapoint: 2 optimistic: true options: - 0: Internal: - 1: Floor: - 2: Both: + 0: Internal + 1: Floor + 2: Both Configuration variables: ------------------------ From 5536822b4b6a32e6ccd67b77b1f432c858b604c1 Mon Sep 17 00:00:00 2001 From: Mikkel Jeppesen <2756925+Duckle29@users.noreply.github.com> Date: Sun, 13 Nov 2022 19:50:17 +0100 Subject: [PATCH 16/27] Update description on temperature offset This clarifies the "polarity" of the temperature offset setting --- components/sensor/bme680_bsec.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/components/sensor/bme680_bsec.rst b/components/sensor/bme680_bsec.rst index 21f2c8425..a218d9730 100644 --- a/components/sensor/bme680_bsec.rst +++ b/components/sensor/bme680_bsec.rst @@ -65,6 +65,7 @@ Configuration variables: - **address** (*Optional*, int): Manually specify the I^2C address of the sensor. Defaults to ``0x76``. Another address can be ``0x77``. - **temperature_offset** (*Optional*, float): Temperature offset if device is in enclosure and reads too high. + This value is subtracted from the reading. If the sensor reads 5°C too high, set this to ``5``. Defaults to ``0``. - **iaq_mode** (*Optional*, string): IAQ calculation mode. Default is ``static`` for static applications (e.g. fixed indoor devices). @@ -174,6 +175,7 @@ For each sensor all other options from :ref:`Sensor ` and :ref:`T # Temperature offset # ------------------ # Useful if device is in enclosure and reads too high + # For example if it reads 5C too high, set this to 5 # Default: 0 temperature_offset: 0 From b1369317410166c2c8ffdd3d92dc7bac2f1bc527 Mon Sep 17 00:00:00 2001 From: Mikkel Jeppesen <2756925+Duckle29@users.noreply.github.com> Date: Mon, 14 Nov 2022 23:00:10 +0100 Subject: [PATCH 17/27] Update bme680_bsec.rst --- components/sensor/bme680_bsec.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/components/sensor/bme680_bsec.rst b/components/sensor/bme680_bsec.rst index a218d9730..3503e9b70 100644 --- a/components/sensor/bme680_bsec.rst +++ b/components/sensor/bme680_bsec.rst @@ -65,7 +65,8 @@ Configuration variables: - **address** (*Optional*, int): Manually specify the I^2C address of the sensor. Defaults to ``0x76``. Another address can be ``0x77``. - **temperature_offset** (*Optional*, float): Temperature offset if device is in enclosure and reads too high. - This value is subtracted from the reading. If the sensor reads 5°C too high, set this to ``5``. + This value is subtracted from the reading. If the sensor reads 5°C too high, set this to ``5``. + This also corrects the relative humidity readings. Defaults to ``0``. - **iaq_mode** (*Optional*, string): IAQ calculation mode. Default is ``static`` for static applications (e.g. fixed indoor devices). @@ -176,6 +177,7 @@ For each sensor all other options from :ref:`Sensor ` and :ref:`T # ------------------ # Useful if device is in enclosure and reads too high # For example if it reads 5C too high, set this to 5 + # This also corrects the relative humidity readings # Default: 0 temperature_offset: 0 From 913f9175c6ff38423504c83c331594f1b01d4880 Mon Sep 17 00:00:00 2001 From: swifty99 Date: Mon, 21 Nov 2022 14:09:31 +0100 Subject: [PATCH 18/27] update clean-mqtt commandline order update clean-mqtt to current esphome commandline order --- components/mqtt.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/components/mqtt.rst b/components/mqtt.rst index 03468b841..de651271e 100644 --- a/components/mqtt.rst +++ b/components/mqtt.rst @@ -166,7 +166,7 @@ retained messages for you: .. code-block:: bash - esphome configuration.yaml clean-mqtt + esphome clean-mqtt configuration.yaml With Docker: From 21da19bdfa8ea5a9170e230a0e96e7dd02a8361a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=2E=20=C3=81rkosi=20R=C3=B3bert?= Date: Mon, 28 Nov 2022 09:29:07 +0100 Subject: [PATCH 19/27] Update pca9685.rst --- components/output/pca9685.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/components/output/pca9685.rst b/components/output/pca9685.rst index ccb6a265f..e5326967b 100644 --- a/components/output/pca9685.rst +++ b/components/output/pca9685.rst @@ -86,7 +86,7 @@ Configuration variables: Examples -------- -This output can be used for different functions. E.g. output for light, ventiator etc. +This output can be used for different PWM functions. E.g. output for light, fan etc. .. code-block:: yaml From b0b8fc583676ca08751c93535171fe9ab0bcaa7c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=2E=20=C3=81rkosi=20R=C3=B3bert?= Date: Mon, 28 Nov 2022 09:54:12 +0100 Subject: [PATCH 20/27] Update mirabella-genio-bulb.rst No need for external component warning, it's built-in. Fix for https://github.com/esphome/esphome-docs/pull/2306 --- cookbook/mirabella-genio-bulb.rst | 4 ---- 1 file changed, 4 deletions(-) diff --git a/cookbook/mirabella-genio-bulb.rst b/cookbook/mirabella-genio-bulb.rst index 6d428f2b5..aca96b8d0 100644 --- a/cookbook/mirabella-genio-bulb.rst +++ b/cookbook/mirabella-genio-bulb.rst @@ -248,10 +248,6 @@ variable ``output_component1``. 3.4 CWWW Mirabella Genio Downlights *********************************** -Kmart also sell a `downlight option `__, which works quite well however the PWM method that is used is different to the way the CWWW lights in ESPHome works. - -A `project by ssieb `__ resolves this using a custom component. - .. code-block:: yaml esphome: From 0ef29ca6482b9e8aaf8d7cc9a667f61935648f05 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=2E=20=C3=81rkosi=20R=C3=B3bert?= Date: Mon, 28 Nov 2022 10:06:10 +0100 Subject: [PATCH 21/27] Update dht.rst --- components/sensor/dht.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/components/sensor/dht.rst b/components/sensor/dht.rst index b89b00ce2..6c54c47d5 100644 --- a/components/sensor/dht.rst +++ b/components/sensor/dht.rst @@ -69,11 +69,13 @@ Configuration variables: .. note:: + The default ``accuracy_decimals`` value of the *humidity* levels is ``0``, as the DHT11 for which this was + originally written does not have a higher resolution. All other DHT sensors have a higher resolution, it's worth + to configure them with ``accuracy_decimals: 1``. + If you're seeing lots of invalid temperature/humidity warnings in the logs, try manually setting the DHT model with the ``model:`` configuration variable. Other problems could be wrong pull-up resistor values on the DATA pin or too long cables. - - Also, the default ``accuracy_decimals`` value of the humidity levels is set to 0, as the DHT11 for which this was originally written does not have a higher resolution. All other DHT sensors have a higher resolution, and thus should be configured with ``accuracy_decimals: 1``. See Also -------- From 52af335ce51b3f243873aedcc0934e5551eee521 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=2E=20=C3=81rkosi=20R=C3=B3bert?= Date: Mon, 28 Nov 2022 10:09:32 +0100 Subject: [PATCH 22/27] Update max31856.rst --- components/sensor/max31856.rst | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/components/sensor/max31856.rst b/components/sensor/max31856.rst index 9ccfc707e..1d203e67e 100644 --- a/components/sensor/max31856.rst +++ b/components/sensor/max31856.rst @@ -7,8 +7,7 @@ MAX31856 Thermocouple Temperature Sensor The ``MAX31856`` temperature sensor allows you to use your MAX31856 Thermocouple temperature sensor (`datasheet `__) with ESPHome. -Multiple types of thermocouples supported by the chip. -Currently only the K type is implemented here. +Although the chip supports multiple thermocouple types, this component only implements the ``K`` type. .. figure:: images/max31856-full.jpg :align: center @@ -22,14 +21,14 @@ As the communication with the MAX31856 is done using SPI, you need to have an :ref:`spi bus ` in your configuration with both **miso_pin** and **mosi_pin** set. - ``VIN`` connects to 5V (``3V3`` will output 3.3V), or directly connect ``3V3`` to 3.3V -- ``3Vo`` is not used by ESPHome +- ``3Vo`` not used by ESPHome - ``GND`` connects to ground - ``CLK`` connects to the SPI **clk_pin** - ``SDO`` connects to the SPI **miso_pin** - ``SDI`` connects to the SPI **mosi_pin** - ``CS`` connects to a free GPIO pin -- ``FLT`` is not used by ESPHome -- ``DRDY`` is not used by ESPHome +- ``FLT`` not used by ESPHome +- ``DRDY`` not used by ESPHome .. code:: yaml From 75a204059ff564676af484a5c1e3f7465f2f653d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=2E=20=C3=81rkosi=20R=C3=B3bert?= Date: Mon, 28 Nov 2022 10:45:40 +0100 Subject: [PATCH 23/27] Update bme680_bsec.rst --- components/sensor/bme680_bsec.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/components/sensor/bme680_bsec.rst b/components/sensor/bme680_bsec.rst index 3503e9b70..dacaf8bd1 100644 --- a/components/sensor/bme680_bsec.rst +++ b/components/sensor/bme680_bsec.rst @@ -64,9 +64,8 @@ Configuration variables: - **address** (*Optional*, int): Manually specify the I^2C address of the sensor. Defaults to ``0x76``. Another address can be ``0x77``. -- **temperature_offset** (*Optional*, float): Temperature offset if device is in enclosure and reads too high. - This value is subtracted from the reading. If the sensor reads 5°C too high, set this to ``5``. - This also corrects the relative humidity readings. +- **temperature_offset** (*Optional*, float): Temperature offset if device is in enclosure and reads too high. This value is subtracted +from the reading (e.g. if the sensor reads 5°C higher than expected, set this to ``5``) and also corrects the relative humidity readings. Defaults to ``0``. - **iaq_mode** (*Optional*, string): IAQ calculation mode. Default is ``static`` for static applications (e.g. fixed indoor devices). From 09de4bbd2c26d8217981175a0bc6dfb84e5381f8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=2E=20=C3=81rkosi=20R=C3=B3bert?= Date: Mon, 28 Nov 2022 10:50:08 +0100 Subject: [PATCH 24/27] Update bme680_bsec.rst --- components/sensor/bme680_bsec.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/components/sensor/bme680_bsec.rst b/components/sensor/bme680_bsec.rst index dacaf8bd1..1f4499195 100644 --- a/components/sensor/bme680_bsec.rst +++ b/components/sensor/bme680_bsec.rst @@ -64,9 +64,8 @@ Configuration variables: - **address** (*Optional*, int): Manually specify the I^2C address of the sensor. Defaults to ``0x76``. Another address can be ``0x77``. -- **temperature_offset** (*Optional*, float): Temperature offset if device is in enclosure and reads too high. This value is subtracted -from the reading (e.g. if the sensor reads 5°C higher than expected, set this to ``5``) and also corrects the relative humidity readings. - Defaults to ``0``. +- **temperature_offset** (*Optional*, float): Temperature offset if device is in enclosure and reads too high. This value is subtracted + from the reading (e.g. if the sensor reads 5°C higher than expected, set this to ``5``) and also corrects the relative humidity readings. Defaults to ``0``. - **iaq_mode** (*Optional*, string): IAQ calculation mode. Default is ``static`` for static applications (e.g. fixed indoor devices). Can be ``mobile`` for mobile applications (e.g. carry-on devices). From d0a95ef5af060e8acb1289464ae5149756a982fc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=2E=20=C3=81rkosi=20R=C3=B3bert?= Date: Mon, 28 Nov 2022 11:02:41 +0100 Subject: [PATCH 25/27] Update wifi_signal.rst --- components/sensor/wifi_signal.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/components/sensor/wifi_signal.rst b/components/sensor/wifi_signal.rst index 1458b0cbc..79b9e9412 100644 --- a/components/sensor/wifi_signal.rst +++ b/components/sensor/wifi_signal.rst @@ -23,7 +23,7 @@ measured in decibel-milliwatts (dBm). These values are always negative and the c name: "WiFi Signal Sensor" update_interval: 60s -Note: since this sensor has a static uniqueid reported to Home Assistant, you can only have one sensor of this type in a device. If you want to have another, use the :ref:`copy-sensor`: +Note: since this sensor has a static uniqueid reported to Home Assistant, you can only have one sensor of this type in a device. If you want to have another, use the :ref:`_copy_sensor`: .. code-block:: yaml From 214425385f5f6c846c11e6cc635d48ab30d4c664 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=2E=20=C3=81rkosi=20R=C3=B3bert?= Date: Mon, 28 Nov 2022 11:06:38 +0100 Subject: [PATCH 26/27] Fix anchor --- components/copy.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/components/copy.rst b/components/copy.rst index 8f6ed593f..3e4fe4a46 100644 --- a/components/copy.rst +++ b/components/copy.rst @@ -137,7 +137,7 @@ Configuration variables: - **name** (**Required**, string): The name of the select. - All other options from :ref:`Select `. -.. _copy_sensor: +.. _copy-sensor: Copy Sensor ----------- From ecd9c97f57d0fdd36a7c5168b977fcc8aec26774 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=2E=20=C3=81rkosi=20R=C3=B3bert?= Date: Mon, 28 Nov 2022 11:11:15 +0100 Subject: [PATCH 27/27] Update wifi_signal.rst --- components/sensor/wifi_signal.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/components/sensor/wifi_signal.rst b/components/sensor/wifi_signal.rst index 79b9e9412..710902806 100644 --- a/components/sensor/wifi_signal.rst +++ b/components/sensor/wifi_signal.rst @@ -23,7 +23,7 @@ measured in decibel-milliwatts (dBm). These values are always negative and the c name: "WiFi Signal Sensor" update_interval: 60s -Note: since this sensor has a static uniqueid reported to Home Assistant, you can only have one sensor of this type in a device. If you want to have another, use the :ref:`_copy_sensor`: +To additionally display signal strength in percentage use the :ref:`copy-sensor` (it's not possible to add the same sensor twice, because it has a static ``uniqueid`` reported to Home Assistant): .. code-block:: yaml