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 ------------- diff --git a/components/copy.rst b/components/copy.rst index 3035d41b9..3e4fe4a46 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 ----------- 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. 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: diff --git a/components/output/pca9685.rst b/components/output/pca9685.rst index 8c07a7df0..e5326967b 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 `. + +Examples +-------- + +This output can be used for different PWM functions. E.g. output for light, fan etc. + +.. code-block:: yaml + + pca9685: + frequency: 500 + + output: + - platform: pca9685 + channel: 0 + id: pwm01 + + light: + - platform: monochromatic + name: 'main light' + output: pwm01 + See Also -------- 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: ------------------------ diff --git a/components/sensor/bme680_bsec.rst b/components/sensor/bme680_bsec.rst index 21f2c8425..1f4499195 100644 --- a/components/sensor/bme680_bsec.rst +++ b/components/sensor/bme680_bsec.rst @@ -64,8 +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. - 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). @@ -174,6 +174,8 @@ 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 + # This also corrects the relative humidity readings # Default: 0 temperature_offset: 0 diff --git a/components/sensor/dht.rst b/components/sensor/dht.rst index ef4455b22..6c54c47d5 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`` @@ -71,6 +69,10 @@ 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. 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). diff --git a/components/sensor/max31856.rst b/components/sensor/max31856.rst index c656f24f3..1d203e67e 100644 --- a/components/sensor/max31856.rst +++ b/components/sensor/max31856.rst @@ -6,7 +6,8 @@ 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. +Although the chip supports multiple thermocouple types, this component only implements the ``K`` type. .. figure:: images/max31856-full.jpg :align: center @@ -20,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 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: ------------------------ diff --git a/components/sensor/wifi_signal.rst b/components/sensor/wifi_signal.rst index 1fa639678..710902806 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 +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 + + # 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: ------------------------ 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: diff --git a/devices/sonoff.rst b/devices/sonoff.rst index a7eaf3ce0..733a5c77e 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 --------