Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2025-02-28 03:41:57 +01:00
Code Issues Projects Releases Wiki Activity

Merge branch 'current' into next

Browse Source
This commit is contained in:
Otto Winter 2019-05-11 17:19:00 +02:00
commit b2fe7220f3
No known key found for this signature in database
GPG Key ID: DB66C0BE6013F97E
14 changed files with 116 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
.gitpod.yml Normal file
View File

@ -0,0 +1,7 @@
ports:
- port: 8000
onOpen: open-preview
tasks:
- before: pip3 install -r requirements.txt
command: make webserver

2
components/binary_sensor/index.rst
View File

@ -305,6 +305,8 @@ This :ref:`Condition <config-condition>` checks if the given binary sensor is ON
id: my_binary_sensor
for: 5s
.. _binary_sensor-lambda_calls:
lambda calls
************

1
components/cover/index.rst
View File

@ -72,6 +72,7 @@ This action stops the cover with the given ID when executed.
id(cover_1).stop();
.. _cover-lambda_calls:
lambda calls
------------

4
components/display/index.rst
View File

@ -374,13 +374,13 @@ different content, and switch between them on a timer.
You can then switch between these with three different actions:
**show_next** / **show_prev**: Shows the next or previous page, wraps around at the end.
**show_next** / **show_previous**: Shows the next or previous page, wraps around at the end.
.. code-block:: yaml
on_...:
- display.page.show_next: my_display
- display.page.show_prev: my_display
- display.page.show_previous: my_display
# For example cycle through pages on a timer
interval:

2
components/display/nextion.rst
View File

@ -15,7 +15,7 @@ with ESPHome.
Nextion LCD Display.
As the communication with the MH-Z19 is done using UART, you need to have an :ref:`UART bus <uart>`
As the communication with the Nextion LCD display is done using UART, you need to have an :ref:`UART bus <uart>`
in your configuration with ``rx_pin`` both the ``tx_pin`` set to the respective pins on the display.
Additionally, you need to set the baud rate to 9600.

26
components/esp32_camera.rst
View File

@ -122,7 +122,7 @@ Configuration for M5Stack Camera
This camera board has insufficient cooling and will overheat over time,
ESPHome does only activate the camera when Home Assistant requests an image, but
the camera until can still heat up considerably for some boards.
the camera unit can still heat up considerably for some boards.
If the camera is not recognized after a reboot and the unit feels warm, try waiting for
it to cool down and check again - if that still doesn't work try enabling the test pattern.
@ -170,6 +170,30 @@ Configuration for Wrover Kit Boards
name: My Camera
# ...
Configuration for TTGO T-Camera
-------------------------------
.. code-block:: yaml
# Example configuration entry
esp32_camera:
external_clock:
pin: GPIO32
frequency: 20MHz
i2c_pins:
sda: GPIO13
scl: GPIO12
data_pins: [GPIO5, GPIO14, GPIO4, GPIO15, GPIO18, GPIO23, GPIO36, GPIO39]
vsync_pin: GPIO27
href_pin: GPIO25
pixel_clock_pin: GPIO19
power_down_pin: GPIO26
# Image settings
name: My Camera
# ...
See Also
--------

2
components/sensor/index.rst
View File

@ -399,6 +399,8 @@ Configuration variables:
- **above** (*Optional*, float): The minimum for the condition.
- **below** (*Optional*, float): The maximum for the condition.
.. _sensor-lambda_calls:
lambda calls
************

7
components/sensor/xiaomi_miflora.rst
View File

@ -65,6 +65,13 @@ Configuration variables:
- **id** (*Optional*, :ref:`config-id`): Set the ID of this sensor for use in lambdas.
- All other options from :ref:`Sensor <config-sensor>`.
.. note::
This integration requires the MiFlora device to have a recent firmware version, see
https://github.com/esphome/issues/issues/260#issuecomment-487684720 for more info.
The ``battery_level`` does not appear to work with some firmware versions of the device (the other sensors
do work though). See https://github.com/esphome/issues/issues/107 for more information.
Setting Up Devices
------------------

6
components/switch/index.rst
View File

@ -93,6 +93,8 @@ This :ref:`Condition <config-condition>` checks if the given switch is ON (or OF
# Same syntax for is_off
switch.is_on: my_switch
.. _switch-lambda_calls:
lambda calls
************
@ -119,14 +121,14 @@ advanced stuff (see the full API Reference for more info).
// Switch is OFF, do something else here
}
- ``turn_off()``/``turn_on``: Manually turn the switch ON/OFF from code.
- ``turn_off()``/``turn_on()``: Manually turn the switch ON/OFF from code.
Similar to the ``switch.turn_on`` and ``switch.turn_off`` actions,
but can be used in complex lambda expressions.
.. code-block:: yaml
id(my_switch).turn_off();
id(my_switch).turn_on(true);
id(my_switch).turn_on();
// Toggle the switch
id(my_switch).toggle();

2
components/text_sensor/index.rst
View File

@ -62,6 +62,8 @@ In :ref:`Lambdas <config-lambda>` you can get the value from the trigger with ``
Configuration variables: See :ref:`Automation <automation>`.
.. _text_sensor-lambda_calls:
lambda calls
************

4
cookbook/h801.rst
View File

@ -40,11 +40,11 @@ and the :doc:`ESP8266 Software PWM output </components/output/esp8266_pwm>` comp
frequency: 1000 Hz
id: pwm_b
- platform: esp8266_pwm
pin: 15
pin: 13
frequency: 1000 Hz
id: pwm_g
- platform: esp8266_pwm
pin: 13
pin: 15
frequency: 1000 Hz
id: pwm_r
- platform: esp8266_pwm

2
guides/automations.rst
View File

@ -364,7 +364,7 @@ All Lambda Calls
- :ref:`Sensor <sensor-lambda_calls>`
- :ref:`Binary Sensor <binary_sensor-lambda_calls>`
- :ref:`Switch <switch-lambda_calls>`
- :ref:`Display <display-display_rendering_engine>`
- :ref:`Display <display-engine>`
- :ref:`Cover <cover-lambda_calls>`
- :ref:`Text Sensor <text_sensor-lambda_calls>`
- :ref:`Stepper <stepper-lambda_calls>`

26
guides/contributing.rst
View File

@ -531,6 +531,32 @@ it in the configuration. Specifically, it may contain these fields:
Run ``pip2 install -e .`` to install a development version of ESPHome.
ESPHome via Gitpod
******************
An alternative to a local checkout and build is doing so via `Gitpod <https://www.gitpod.io>`__.
ESPHome will be installed for you and the dashboard wizard will run on startup.
You can also run the steps manually.
.. code-block:: bash
python setup.py install
To start a command line wizard, run
.. code-block:: bash
python esphome my_configuration.yaml wizard
To get the web-based dashboard, use
.. code-block:: bash
python esphome my_configuration.yaml dashboard
and allow exposing the web app at port 6052.
See Also
--------

46
guides/supporters.rst
View File

@ -38,18 +38,26 @@ Patrons
People that support ESPHome's development over `Patreon <https://www.patreon.com/ottowinter>`__.
You guys are awesome!
- Nick Rout
- Kenvase
- Magnus Overli
- Dattas Moonchaser
- Intermittent Technology
- Anders
- Andrea Donno
- Ryan Bahm
- Jung Ervin
- Book of the Future
- Daan Damhuis
- Dattas Moonchaser
- Dennis Münchgesang
- DrZzs
- fabi
- Franck Nijhof
- Intermittent Technology
- Jung Ervin
- Kenvase
- Magnus Overli
- Nick Rout
- Paul Krischer
- Paul Morley
- Roman Priesol
- Ryan
- Ryan Bahm
- Wojciech Bederski
Contributors
@ -62,7 +70,7 @@ that have made it into the `ESPHome organization's <https://github.com/esphome>`
Author & Main Developer
***********************
- `Otto Winter (@OttoWinter) <https://github.com/OttoWinter>`__ - 1556 contributions
- `Otto Winter (@OttoWinter) <https://github.com/OttoWinter>`__ - 1610 contributions
Contributors
************
@ -70,15 +78,19 @@ Contributors
(in alphabetical order)
- `2016for (@2016for) <https://github.com/2016for>`__ - 1 contribution
- `Aalian Khan (@AalianKhan) <https://github.com/AalianKhan>`__ - 2 contributions
- `Alexandre Danault (@AlexDanault) <https://github.com/AlexDanault>`__ - 1 contribution
- `Rutger Nijhuis (@BananaPukeh) <https://github.com/BananaPukeh>`__ - 1 contribution
- `Bierchermuesli (@Bierchermuesli) <https://github.com/Bierchermuesli>`__ - 1 contribution
- `David De Sloovere (@DavidDeSloovere) <https://github.com/DavidDeSloovere>`__ - 3 contributions
- `Eenoo (@Eenoo) <https://github.com/Eenoo>`__ - 1 contribution
- `EmmanuelLM (@EmmanuelLM) <https://github.com/EmmanuelLM>`__ - 1 contribution
- `FrengerH (@FrengerH) <https://github.com/FrengerH>`__ - 2 contributions
- `Jimmy Hedman (@HeMan) <https://github.com/HeMan>`__ - 5 contributions
- `Fredrik Lindqvist (@Landrash) <https://github.com/Landrash>`__ - 1 contribution
- `Marco (@Melkor82) <https://github.com/Melkor82>`__ - 2 contributions
- `Mynasru (@Mynasru) <https://github.com/Mynasru>`__ - 2 contributions
- `Erik Näsström (@Naesstrom) <https://github.com/Naesstrom>`__ - 1 contribution
- `Jérôme W. (@RomRider) <https://github.com/RomRider>`__ - 1 contribution
- `Taigar2015 (@Taigar2015) <https://github.com/Taigar2015>`__ - 1 contribution
- `Spencer Hachmeister (@TheHackmeister) <https://github.com/TheHackmeister>`__ - 1 contribution
@ -91,6 +103,7 @@ Contributors
- `Florian Mösch (@badbadc0ffee) <https://github.com/badbadc0ffee>`__ - 4 contributions
- `balk77 (@balk77) <https://github.com/balk77>`__ - 1 contribution
- `Paulus Schoutsen (@balloob) <https://github.com/balloob>`__ - 1 contribution
- `Patrik Hermansson (@bphermansson) <https://github.com/bphermansson>`__ - 1 contribution
- `Brandon Davidson (@brandond) <https://github.com/brandond>`__ - 11 contributions
- `brianrjones69 (@brianrjones69) <https://github.com/brianrjones69>`__ - 1 contribution
- `chris-jennings (@chris-jennings) <https://github.com/chris-jennings>`__ - 1 contribution
@ -102,11 +115,13 @@ Contributors
- `Jiang Sheng (@doskoi) <https://github.com/doskoi>`__ - 1 contribution
- `Robert Schütz (@dotlambda) <https://github.com/dotlambda>`__ - 3 contributions
- `Drew Perttula (@drewp) <https://github.com/drewp>`__ - 1 contribution
- `Anders Persson (@emwap) <https://github.com/emwap>`__ - 1 contribution
- `Anders Persson (@emwap) <https://github.com/emwap>`__ - 4 contributions
- `Nico Weichbrodt (@envy) <https://github.com/envy>`__ - 1 contribution
- `erazor666 (@erazor666) <https://github.com/erazor666>`__ - 1 contribution
- `escoand (@escoand) <https://github.com/escoand>`__ - 5 contributions
- `Malte Franken (@exxamalte) <https://github.com/exxamalte>`__ - 2 contributions
- `Fabian Affolter (@fabaff) <https://github.com/fabaff>`__ - 10 contributions
- `gitolicious (@gitolicious) <https://github.com/gitolicious>`__ - 7 contributions
- `The Gitter Badger (@gitter-badger) <https://github.com/gitter-badger>`__ - 1 contribution
- `Guillermo Ruffino (@glmnet) <https://github.com/glmnet>`__ - 1 contribution
- `Antoine GRÉA (@grea09) <https://github.com/grea09>`__ - 3 contributions
@ -114,22 +129,27 @@ Contributors
- `Ivan Kravets (@ivankravets) <https://github.com/ivankravets>`__ - 1 contribution
- `Jan Pieper (@janpieper) <https://github.com/janpieper>`__ - 2 contributions
- `JbLb (@jblb) <https://github.com/jblb>`__ - 1 contribution
- `jcullen86 (@jcullen86) <https://github.com/jcullen86>`__ - 1 contribution
- `Joshua Dadswell (@jdads1) <https://github.com/jdads1>`__ - 1 contribution
- `Jesse Hills (@jesserockz) <https://github.com/jesserockz>`__ - 3 contributions
- `John Erik Halse (@johnerikhalse) <https://github.com/johnerikhalse>`__ - 1 contribution
- `JonnyaiR (@jonnyair) <https://github.com/jonnyair>`__ - 2 contributions
- `Kevin O'Rourke (@kevinior) <https://github.com/kevinior>`__ - 1 contribution
- `kimonm (@kimonm) <https://github.com/kimonm>`__ - 1 contribution
- `Ken Davidson (@kwdavidson) <https://github.com/kwdavidson>`__ - 1 contribution
- `Jeppe Ladefoged (@ladefoged81) <https://github.com/ladefoged81>`__ - 2 contributions
- `Lazar Obradovic (@lobradov) <https://github.com/lobradov>`__ - 3 contributions
- `Lewis Juggins (@lwis) <https://github.com/lwis>`__ - 1 contribution
- `Magnus Øverli (@magnusoverli) <https://github.com/magnusoverli>`__ - 1 contribution
- `MeIchthys (@meichthys) <https://github.com/meichthys>`__ - 1 contribution
- `meijerwynand (@meijerwynand) <https://github.com/meijerwynand>`__ - 2 contributions
- `mjoshd (@mjoshd) <https://github.com/mjoshd>`__ - 2 contributions
- `Matt N. (@mnoorenberghe) <https://github.com/mnoorenberghe>`__ - 1 contribution
- `mtl010957 (@mtl010957) <https://github.com/mtl010957>`__ - 3 contributions
- `mtl010957 (@mtl010957) <https://github.com/mtl010957>`__ - 4 contributions
- `Michiel van Turnhout (@mvturnho) <https://github.com/mvturnho>`__ - 5 contributions
- `Kevin Uhlir (@n0bel) <https://github.com/n0bel>`__ - 1 contribution
- `Alex (@nnmalex) <https://github.com/nnmalex>`__ - 1 contribution
- `ffabi (@norges) <https://github.com/norges>`__ - 2 contributions
- `Greg Johnson (@notgwj) <https://github.com/notgwj>`__ - 1 contribution
- `Nuno Sousa (@nunofgs) <https://github.com/nunofgs>`__ - 1 contribution
- `Oscar Bolmsten (@oscar-b) <https://github.com/oscar-b>`__ - 3 contributions
@ -139,11 +159,13 @@ Contributors
- `Plácido Revilla (@placidorevilla) <https://github.com/placidorevilla>`__ - 2 contributions
- `DK (@poldim) <https://github.com/poldim>`__ - 1 contribution
- `Leandro Puerari (@puerari) <https://github.com/puerari>`__ - 1 contribution
- `puuu (@puuu) <https://github.com/puuu>`__ - 10 contributions
- `puuu (@puuu) <https://github.com/puuu>`__ - 12 contributions
- `Tommy Jonsson (@quazzie) <https://github.com/quazzie>`__ - 1 contribution
- `r-jordan (@r-jordan) <https://github.com/r-jordan>`__ - 1 contribution
- `Pär Stålberg (@rabbadab) <https://github.com/rabbadab>`__ - 1 contribution
- `Richard Lewis (@richrd) <https://github.com/richrd>`__ - 1 contribution
- `Robbie Page (@rorpage) <https://github.com/rorpage>`__ - 1 contribution
- `sethcohn (@sethcohn) <https://github.com/sethcohn>`__ - 1 contribution
- `Emanuele Tessore (@setola) <https://github.com/setola>`__ - 1 contribution
- `sherbang (@sherbang) <https://github.com/sherbang>`__ - 4 contributions
- `thubot (@thubot) <https://github.com/thubot>`__ - 1 contribution
@ -155,4 +177,4 @@ Contributors
- `Vladimir Eremin (@yottatsa) <https://github.com/yottatsa>`__ - 1 contribution
- `YuanL.Lee (@yuanl) <https://github.com/yuanl>`__ - 1 contribution
*This page was last updated Sun Apr 7 12:19:13 2019 UTC.*
*This page was last updated Sat May 11 09:54:48 2019 UTC.*