diff --git a/Dockerfile b/Dockerfile index 0cc95621a..df93220a7 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,22 +1,18 @@ -FROM ubuntu:xenial +FROM python:slim RUN apt-get update && apt-get install -y --no-install-recommends \ curl \ - python3 \ - python3-pip \ - python3-setuptools \ - python3-pygments \ git \ make \ doxygen \ openssh-client \ software-properties-common \ - && apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/* + && apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/* RUN pip3 install --no-cache-dir --no-binary :all: \ sphinx EXPOSE 8000 -WORKDIR /data/esphome-docs +WORKDIR /data/esphomedocs CMD ["make", "webserver"] diff --git a/components/ethernet.rst b/components/ethernet.rst index 791b763fb..f02fb9bec 100644 --- a/components/ethernet.rst +++ b/components/ethernet.rst @@ -55,6 +55,9 @@ Configuration variables: - **dns2** (*Optional*, IPv4 address): The backup DNS server to use. - **enable_mdns** (*Optional*, boolean): Controls if your node should advertise its presense and services using mDNS. When set to ``false`` you won't be able to access your node using its hostname which can break certain functionalities. Please see :ref:`notes on disabling mDNS `. Defaults to ``true``. +- **use_address** (*Optional*, string): Manually override what address to use to connect + to the ESP. Defaults to auto-generated value. For example, if you have changed your + static IP and want to flash OTA to the previously configured IP address. - **domain** (*Optional*, string): Set the domain of the node hostname used for uploading. For example, if it's set to ``.local``, all uploads will be sent to ``.local``. Defaults to ``.local``. diff --git a/components/output/pca9685.rst b/components/output/pca9685.rst index 123f48b95..2bd61347b 100644 --- a/components/output/pca9685.rst +++ b/components/output/pca9685.rst @@ -37,7 +37,7 @@ Configuration variables: - **frequency** (**Required**, float): The frequency to let the component drive all PWM outputs at. Must be in range from 24Hz to - 1526Hz. + 1525.88Hz. - **address** (*Optional*, int): The I²C address of the driver. Defaults to ``0x00``. - **id** (*Optional*, :ref:`config-id`): The id to use for diff --git a/components/remote_transmitter.rst b/components/remote_transmitter.rst index 73d18d840..8f2529a4e 100644 --- a/components/remote_transmitter.rst +++ b/components/remote_transmitter.rst @@ -133,8 +133,8 @@ This :ref:`action ` sends an LG infrared remote code to a remote on_...: - remote_transmitter.transmit_lg: - data: 0x1234567 - nbits: 28 + data: 0x20DF10EF # power on/off + nbits: 32 Configuration variables: diff --git a/components/sensor/ade7953.rst b/components/sensor/ade7953.rst index eec03f22e..ed0263862 100644 --- a/components/sensor/ade7953.rst +++ b/components/sensor/ade7953.rst @@ -19,6 +19,10 @@ with ESPHome. These are commonly found in **Shelly 2.5** devices. This sensor can measure voltage and has two channels for reading current and active power (A & B). +.. note:: + + SAFETY HAZARD: Some devices such as Sonoff POWs/Shelly/etc, have the digital GND connected directly to mains voltage so **the GPIOs become LIVE during normal operation**. Our advice is to mark these boards to prevent any use of the dangerous digital pins. + The :ref:`I²C Bus ` is required to be set up in your configuration for this sensor to work. diff --git a/components/sensor/cse7766.rst b/components/sensor/cse7766.rst index 287db2c8a..642ea7ca6 100644 --- a/components/sensor/cse7766.rst +++ b/components/sensor/cse7766.rst @@ -11,6 +11,10 @@ The ``cse7766`` sensor platform allows you to use your CSE7766 voltage/current a ESPHome. This sensor is commonly found in Sonoff POW R2. CSE7759B is similar to CSE7766 and works with this integration. +.. note:: + + SAFETY HAZARD: Some devices such as Sonoff POWs/Shelly/etc, have the digital GND connected directly to mains voltage so **the GPIOs become LIVE during normal operation**. Our advice is to mark these boards to prevent any use of the dangerous digital pins. + As the communication with the CSE7766 done using UART, you need to have an :ref:`UART bus ` in your configuration with the ``rx_pin`` connected to the CSE7766. Additionally, you need to set the baud rate to 4800. diff --git a/components/sensor/hlw8012.rst b/components/sensor/hlw8012.rst index f02f5c852..5773159cc 100644 --- a/components/sensor/hlw8012.rst +++ b/components/sensor/hlw8012.rst @@ -12,6 +12,10 @@ ESPHome. This sensor is commonly found in Sonoff POWs. CSE7759 and BL0937 are si and work with this integration. Beware that CSE7759B is different and should be used with the :doc:`CSE7766 ` integration. +.. note:: + + SAFETY HAZARD: Some devices such as Sonoff POWs/Shelly/etc, have the digital GND connected directly to mains voltage so **the GPIOs become LIVE during normal operation**. Our advice is to mark these boards to prevent any use of the dangerous digital pins. + This sensor has two data outputs which both encode values using the frequency of a modulated signal: CF and CF1. CF's frequency is proportional to the (active) power measured and CF1 is proportional to the current/voltage. Using the SEL pin, one can choose between which mode to use. diff --git a/components/switch/gpio.rst b/components/switch/gpio.rst index 359e228d3..40dcab8f9 100644 --- a/components/switch/gpio.rst +++ b/components/switch/gpio.rst @@ -63,7 +63,7 @@ Momentary Switch ---------------- To create momentary switches, for example switches that toggle a pin for a moment, you can use -:doc:`template switches