mirror of
https://github.com/esphome/esphome-docs.git
synced 2025-02-28 03:41:57 +01:00
Merge branch 'current' into beta
This commit is contained in:
commit
c8f3aa9a20
10
Dockerfile
10
Dockerfile
@ -1,22 +1,18 @@
|
|||||||
FROM ubuntu:xenial
|
FROM python:slim
|
||||||
|
|
||||||
RUN apt-get update && apt-get install -y --no-install-recommends \
|
RUN apt-get update && apt-get install -y --no-install-recommends \
|
||||||
curl \
|
curl \
|
||||||
python3 \
|
|
||||||
python3-pip \
|
|
||||||
python3-setuptools \
|
|
||||||
python3-pygments \
|
|
||||||
git \
|
git \
|
||||||
make \
|
make \
|
||||||
doxygen \
|
doxygen \
|
||||||
openssh-client \
|
openssh-client \
|
||||||
software-properties-common \
|
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: \
|
RUN pip3 install --no-cache-dir --no-binary :all: \
|
||||||
sphinx
|
sphinx
|
||||||
|
|
||||||
EXPOSE 8000
|
EXPOSE 8000
|
||||||
WORKDIR /data/esphome-docs
|
WORKDIR /data/esphomedocs
|
||||||
|
|
||||||
CMD ["make", "webserver"]
|
CMD ["make", "webserver"]
|
||||||
|
@ -55,6 +55,9 @@ Configuration variables:
|
|||||||
- **dns2** (*Optional*, IPv4 address): The backup DNS server to use.
|
- **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 <faq-notes_on_disabling_mdns>`. Defaults to ``true``.
|
- **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 <faq-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.
|
- **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 ``<HOSTNAME>.local``.
|
For example, if it's set to ``.local``, all uploads will be sent to ``<HOSTNAME>.local``.
|
||||||
Defaults to ``.local``.
|
Defaults to ``.local``.
|
||||||
|
@ -37,7 +37,7 @@ Configuration variables:
|
|||||||
|
|
||||||
- **frequency** (**Required**, float): The frequency to let the
|
- **frequency** (**Required**, float): The frequency to let the
|
||||||
component drive all PWM outputs at. Must be in range from 24Hz to
|
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.
|
- **address** (*Optional*, int): The I²C address of the driver.
|
||||||
Defaults to ``0x00``.
|
Defaults to ``0x00``.
|
||||||
- **id** (*Optional*, :ref:`config-id`): The id to use for
|
- **id** (*Optional*, :ref:`config-id`): The id to use for
|
||||||
|
@ -133,8 +133,8 @@ This :ref:`action <config-action>` sends an LG infrared remote code to a remote
|
|||||||
|
|
||||||
on_...:
|
on_...:
|
||||||
- remote_transmitter.transmit_lg:
|
- remote_transmitter.transmit_lg:
|
||||||
data: 0x1234567
|
data: 0x20DF10EF # power on/off
|
||||||
nbits: 28
|
nbits: 32
|
||||||
|
|
||||||
Configuration variables:
|
Configuration variables:
|
||||||
|
|
||||||
|
@ -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).
|
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 <i2c>` is
|
The :ref:`I²C Bus <i2c>` is
|
||||||
required to be set up in your configuration for this sensor to work.
|
required to be set up in your configuration for this sensor to work.
|
||||||
|
|
||||||
|
@ -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
|
ESPHome. This sensor is commonly found in Sonoff POW R2. CSE7759B is similar to CSE7766
|
||||||
and works with this integration.
|
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
|
As the communication with the CSE7766 done using UART, you need
|
||||||
to have an :ref:`UART bus <uart>` in your configuration with the ``rx_pin`` connected to the CSE7766.
|
to have an :ref:`UART bus <uart>` in your configuration with the ``rx_pin`` connected to the CSE7766.
|
||||||
Additionally, you need to set the baud rate to 4800.
|
Additionally, you need to set the baud rate to 4800.
|
||||||
|
@ -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
|
and work with this integration. Beware that CSE7759B is different and should be used
|
||||||
with the :doc:`CSE7766 <cse7766>` integration.
|
with the :doc:`CSE7766 <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.
|
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
|
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.
|
the SEL pin, one can choose between which mode to use.
|
||||||
|
@ -63,7 +63,7 @@ Momentary Switch
|
|||||||
----------------
|
----------------
|
||||||
|
|
||||||
To create momentary switches, for example switches that toggle a pin for a moment, you can use
|
To create momentary switches, for example switches that toggle a pin for a moment, you can use
|
||||||
:doc:`template switches <template>`.
|
`on_turn_on` trigger.
|
||||||
|
|
||||||
An example that uses a single relay to activate a remote control button. The button can only
|
An example that uses a single relay to activate a remote control button. The button can only
|
||||||
start or stop the motor of the gate. In itself, the button or remote can not know if it opens
|
start or stop the motor of the gate. In itself, the button or remote can not know if it opens
|
||||||
@ -76,11 +76,9 @@ or closes the gate. The relay simulates the button press for 500ms.
|
|||||||
- platform: gpio
|
- platform: gpio
|
||||||
pin: 25
|
pin: 25
|
||||||
id: relay
|
id: relay
|
||||||
- platform: template
|
|
||||||
name: "Gate Remote"
|
name: "Gate Remote"
|
||||||
icon: "mdi:gate"
|
icon: "mdi:gate"
|
||||||
turn_on_action:
|
on_turn_on:
|
||||||
- switch.turn_on: relay
|
|
||||||
- delay: 500ms
|
- delay: 500ms
|
||||||
- switch.turn_off: relay
|
- switch.turn_off: relay
|
||||||
|
|
||||||
|
@ -56,9 +56,10 @@ After validating the sensor is working, we can proceed and add some formulas.
|
|||||||
unit_of_measurement: 'g/m³'
|
unit_of_measurement: 'g/m³'
|
||||||
- platform: template
|
- platform: template
|
||||||
name: "Dew Point"
|
name: "Dew Point"
|
||||||
lambda: return (243.5*(log(id(bme280_humidity).state/100)+((17.67*id(bme280_temperature).state)/
|
lambda: |-
|
||||||
(243.5+id(bme280_temperature).state)))/(17.67-log(id(bme280_humidity).state/100)-
|
return (243.5*(log(id(bme280_humidity).state/100)+((17.67*id(bme280_temperature).state)/
|
||||||
((17.67*id(bme280_temperature).state)/(243.5+id(bme280_temperature).state))));
|
(243.5+id(bme280_temperature).state)))/(17.67-log(id(bme280_humidity).state/100)-
|
||||||
|
((17.67*id(bme280_temperature).state)/(243.5+id(bme280_temperature).state))));
|
||||||
unit_of_measurement: °C
|
unit_of_measurement: °C
|
||||||
icon: 'mdi:thermometer-alert'
|
icon: 'mdi:thermometer-alert'
|
||||||
|
|
||||||
|
Before Width: | Height: | Size: 5.4 KiB After Width: | Height: | Size: 5.5 KiB |
@ -158,7 +158,7 @@ Then you need to set it up with yaml.
|
|||||||
then:
|
then:
|
||||||
- fan.turn_on:
|
- fan.turn_on:
|
||||||
id: ifan02_fan
|
id: ifan02_fan
|
||||||
speed: LOW
|
speed: 1
|
||||||
- if:
|
- if:
|
||||||
condition:
|
condition:
|
||||||
and:
|
and:
|
||||||
@ -168,7 +168,7 @@ Then you need to set it up with yaml.
|
|||||||
then:
|
then:
|
||||||
- fan.turn_on:
|
- fan.turn_on:
|
||||||
id: ifan02_fan
|
id: ifan02_fan
|
||||||
speed: MEDIUM
|
speed: 2
|
||||||
- if:
|
- if:
|
||||||
condition:
|
condition:
|
||||||
and:
|
and:
|
||||||
@ -178,7 +178,7 @@ Then you need to set it up with yaml.
|
|||||||
then:
|
then:
|
||||||
- fan.turn_on:
|
- fan.turn_on:
|
||||||
id: ifan02_fan
|
id: ifan02_fan
|
||||||
speed: HIGH
|
speed: 3
|
||||||
- switch.turn_off: update_fan_speed
|
- switch.turn_off: update_fan_speed
|
||||||
|
|
||||||
- platform: gpio
|
- platform: gpio
|
||||||
@ -197,6 +197,7 @@ Then you need to set it up with yaml.
|
|||||||
- platform: speed
|
- platform: speed
|
||||||
output: fanoutput
|
output: fanoutput
|
||||||
id: ifan02_fan
|
id: ifan02_fan
|
||||||
|
speed_count: 3
|
||||||
name: "iFan02 Fan"
|
name: "iFan02 Fan"
|
||||||
|
|
||||||
See Also
|
See Also
|
||||||
|
@ -24,6 +24,10 @@ After that use the following list of pin to function mappings to set up your Son
|
|||||||
This list has been compiled from the Sonoff Tasmota pin source file which can be found here:
|
This list has been compiled from the Sonoff Tasmota pin source file which can be found here:
|
||||||
https://github.com/arendst/Tasmota/blob/development/tasmota/tasmota_template.h ❤️
|
https://github.com/arendst/Tasmota/blob/development/tasmota/tasmota_template.h ❤️
|
||||||
|
|
||||||
|
.. 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.
|
||||||
|
|
||||||
Sonoff RF
|
Sonoff RF
|
||||||
---------
|
---------
|
||||||
|
|
||||||
|
@ -63,7 +63,10 @@ There's also a simple REST API available which can be used to get and set the cu
|
|||||||
calls to this API follow the URL schema ``/<domain>/<id>[/<method>?<param>=<value>]``.
|
calls to this API follow the URL schema ``/<domain>/<id>[/<method>?<param>=<value>]``.
|
||||||
The ``domain`` is the type of the component, for example ``sensor`` or ``light``. ``id`` refers
|
The ``domain`` is the type of the component, for example ``sensor`` or ``light``. ``id`` refers
|
||||||
to the id of the component - this ID is created by taking the name of the component, stripping out
|
to the id of the component - this ID is created by taking the name of the component, stripping out
|
||||||
all non-alphanumeric characters, making everything lowercase and replacing all spaces by underscores.
|
all non-alphanumeric characters, making everything lowercase and replacing all spaces by underscores.
|
||||||
|
To confirm the ``<id>`` to use, you can set the :ref:`log level <logger-log_levels>`
|
||||||
|
to ``VERY_VERBOSE`` and check the ``object_id:`` in the logs.
|
||||||
|
|
||||||
|
|
||||||
By creating a simple GET request for a URL of the form ``/<domain>/<id>`` you will get a JSON payload
|
By creating a simple GET request for a URL of the form ``/<domain>/<id>`` you will get a JSON payload
|
||||||
describing the current state of the component. This payload is equivalent to the ones sent by the
|
describing the current state of the component. This payload is equivalent to the ones sent by the
|
||||||
|
Loading…
Reference in New Issue
Block a user