mirror of
https://github.com/esphome/esphome-docs.git
synced 2024-11-04 09:10:02 +01:00
Merge branch 'current' into patch-5
This commit is contained in:
H. Árkosi Róbert
GitHub
commit
d714d08dad
@ -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
|
||||
-------------
|
||||
|
||||
@ -137,6 +137,8 @@ Configuration variables:
|
||||
- **name** (**Required**, string): The name of the select.
|
||||
- All other options from :ref:`Select <config-select>`.
|
||||
|
||||
.. _copy-sensor:
|
||||
|
||||
Copy Sensor
|
||||
-----------
|
||||
|
||||
|
||||
@ -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 <https://en.wikipedia.org/wiki/Mired>`__ 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.
|
||||
|
||||
@ -166,7 +166,7 @@ retained messages for you:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
esphome configuration.yaml clean-mqtt
|
||||
esphome clean-mqtt configuration.yaml
|
||||
|
||||
With Docker:
|
||||
|
||||
|
||||
@ -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 <config-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
|
||||
--------
|
||||
|
||||
|
||||
@ -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:
|
||||
------------------------
|
||||
|
||||
@ -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 <config-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
|
||||
|
||||
|
||||
|
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 11 KiB |
@ -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 <https://akizukidenshi.com/download/ds/aosong/DHT11.pdf>`__,
|
||||
`Adafruit <https://www.adafruit.com/product/386>`__), DHT21/DHT22
|
||||
(`datasheet <https://www.sparkfun.com/datasheets/Sensors/Temperature/DHT22.pdf>`__,
|
||||
`Adafruit <https://www.adafruit.com/product/385>`__), AMS2301/AM2302
|
||||
(`datasheet <https://cdn-shop.adafruit.com/datasheets/Digital+humidity+and+temperature+sensor+AM2302.pdf>`__,
|
||||
`Adafruit <https://www.adafruit.com/product/393>`__), RHT03
|
||||
(`datasheet <https://cdn.sparkfun.com/datasheets/Sensors/Weather/RHT03.pdf>`__,
|
||||
`SparkFun <https://cdn.sparkfun.com/datasheets/Sensors/Weather/RHT03.pdf>`__) and SI7021 (one wire Sonoff version)
|
||||
(`datasheet <https://cdn.sparkfun.com/assets/b/1/b/8/5/Si7021-A20.pdf>`__,
|
||||
`SparkFun <https://cdn.sparkfun.com/assets/b/1/b/8/5/Si7021-A20.pdf>`__)
|
||||
The DHT Temperature+Humidity sensor allows you to use your
|
||||
|
||||
- DHT11 (`datasheet <https://akizukidenshi.com/download/ds/aosong/DHT11.pdf>`__, `Adafruit <https://www.adafruit.com/product/386>`__),
|
||||
- DHT21/DHT22 (`datasheet <https://www.sparkfun.com/datasheets/Sensors/Temperature/DHT22.pdf>`__, `Adafruit <https://www.adafruit.com/product/385>`__),
|
||||
- AMS2301/AM2302 (`datasheet <https://cdn-shop.adafruit.com/datasheets/Digital+humidity+and+temperature+sensor+AM2302.pdf>`__, `Adafruit <https://www.adafruit.com/product/393>`__),
|
||||
- RHT03 (`datasheet <https://cdn.sparkfun.com/datasheets/Sensors/Weather/RHT03.pdf>`__, `SparkFun <https://cdn.sparkfun.com/datasheets/Sensors/Weather/RHT03.pdf>`__) and
|
||||
- SI7021 (one wire Sonoff version) (`datasheet <https://cdn.sparkfun.com/assets/b/1/b/8/5/Si7021-A20.pdf>`__, `SparkFun <https://cdn.sparkfun.com/assets/b/1/b/8/5/Si7021-A20.pdf>`__)
|
||||
|
||||
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 <config-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.
|
||||
|
||||
@ -392,7 +392,7 @@ Configuration variables:
|
||||
******************************
|
||||
|
||||
A simple `exponential moving average
|
||||
<https://en.wikipedia.org/wiki/Moving_average#Exponential_moving_average>`__ over the last few
|
||||
<https://www.itl.nist.gov/div898/software/dataplot/refman2/auxillar/quantile.htm>`__ 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).
|
||||
|
||||
|
||||
@ -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 <https://datasheets.maximintegrated.com/en/ds/MAX31856.pdf>`__) with ESPHome
|
||||
temperature sensor (`datasheet <https://datasheets.maximintegrated.com/en/ds/MAX31856.pdf>`__) 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 <spi>` 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
|
||||
|
||||
|
||||
@ -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:
|
||||
------------------------
|
||||
|
||||
@ -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:
|
||||
------------------------
|
||||
|
||||
|
||||
@ -248,10 +248,6 @@ variable ``output_component1``.
|
||||
3.4 CWWW Mirabella Genio Downlights
|
||||
***********************************
|
||||
|
||||
Kmart also sell a `downlight option <https://www.kmart.com.au/product/mirabella-genio-wi-fi-dimmable-9w-led-downlight/2754331>`__, 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 <https://github.com/ssieb/custom_components/tree/master/cwww2>`__ resolves this using a custom component.
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
esphome:
|
||||
|
||||
@ -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
|
||||
--------
|
||||
|
||||
|
||||
@ -385,7 +385,7 @@ And a docker compose file looks like this:
|
||||
|
||||
Notes on disabling mDNS
|
||||
------------------------------------------------------------------------------
|
||||
Some of ESPHome's functionalities rely on mDNS, so naturally :ref:`disabling <wifi-configuration_variables>` it will cause these features to stop working.
|
||||
Some of ESPHome's functionalities rely on mDNS, so naturally :doc:`disabling </components/mdns>` it will cause these features to stop working.
|
||||
Generally speaking, disabling mDNS without setting a :ref:`static IP address <wifi-manual_ip>` (or a static DHCP lease) is bound to cause problems. This is due to the fact that mDNS is used to find the IP address of each ESPHome nodes.
|
||||
|
||||
- You will not be able to use the node's hostname to ping, find it's IP address or connect to it.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user