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

Tips

Browse Source
This commit is contained in:
Otto Winter 2018-06-02 21:54:39 +02:00
parent 823819ad8e
commit 3f0e58aa30
No known key found for this signature in database
GPG Key ID: DB66C0BE6013F97E
5 changed files with 46 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
esphomeyaml/components/fan/index.rst
View File

@ -74,11 +74,11 @@ Turns the fan with the given ID off when executed.
on_...:
then:
- fan.turn_on:
id: cover_1
id: fan_1
Configuration options:
- **id** (**Required**, :ref:`config-id`): The ID of the light.
- **id** (**Required**, :ref:`config-id`): The ID of the fan.
- **oscillating** (*Optional*, boolean, :ref:`templatable <config-templatable>`):
Set the oscillation state of the fan. Defaults to not affecting oscillation.
- **speed** (*Optional*, string, :ref:`templatable <config-templatable>`):

2
esphomeyaml/devices/sonoff_4ch.rst
View File

@ -302,6 +302,8 @@ to make all components in esphomeyaml as much "plug and play" as possible, you c
them in one area, and simply pass that ID later on. For example, above you can see an PWM (dimmer)
output being created with the ID ``blue_led`` for the blue LED. Later on it is then transformed
into a :doc:`monochromatic light </esphomeyaml/components/light/monochromatic>`.
If you additionally want the buttons to control the relays, look at `the complete Sonoff 4CH
with automation example <https://github.com/OttoWinter/esphomeyaml/blob/master/examples/sonoff_4ch.yaml>`__.
Upload the firmware again (through OTA or Serial) and you should immediately see
something like this in Home Assistant because of esphomeyaml's automatic MQTT discovery. (You'll

2
esphomeyaml/guides.csv
View File

@ -5,5 +5,5 @@ Migrating from Sonoff-Tasmota, guides/migrate_sonoff_tasmota, tasmota.svg
Migrating from ESPurna, guides/migrate_espurna, espurna.svg
Migrating from ESPEasy, guides/migrate_espeasy, espeasy.svg
Automations, guides/automations, auto-fix.svg
FAQ, guides/faq, question_answer.svg
FAQ and Tips, guides/faq, question_answer.svg
Contributing, guides/contributing, github-circle.svg

1 Getting Started through Command Line guides/getting_started_command_line console.svg
5 Migrating from ESPurna guides/migrate_espurna espurna.svg
6 Migrating from ESPEasy guides/migrate_espeasy espeasy.svg
7 Automations guides/automations auto-fix.svg
8 FAQ FAQ and Tips guides/faq question_answer.svg
9 Contributing guides/contributing github-circle.svg

34
esphomeyaml/guides/faq.rst
View File

@ -1,6 +1,40 @@
Frequently Asked Questions
==========================
Tips for using esphomeyaml
^^^^^^^^^^^^^^^^^^^^^^^^^^
1. esphomeyaml supports (most of) Home Assistant's YAML configuration directives like
``!include``, ``!secret``. So you can store all your secret WiFi passwords and so on
in a file called ``secrets.yaml`` within the directory where the configuration file is.
2. If you want to see how esphomeyaml interprets your configuration, run
.. code:: bash
esphomeyaml livingroom.yaml config
3. To view the logs from your node without uploading, run
.. code:: bash
esphomeyaml livingroom.yaml logs
4. If you have changed the name of the node and want to update over-the-air, just specify
``--upload-port`` when running esphomeyaml. For example:
.. code:: bash
esphomeyaml livingroom.yaml run --upload-port 192.168.178.52
.. |secret| replace:: ``!secret``
.. _secret: https://www.home-assistant.io/docs/configuration/secrets/
.. |include| replace:: ``!include``
.. _include: https://www.home-assistant.io/docs/configuration/splitting_configuration/
What's the difference between esphomelib and esphomeyaml?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

11
esphomeyaml/index.rst
View File

@ -40,9 +40,9 @@ Guides
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`Migrating from Sonoff-Tasmota`_ `Migrating from ESPurna`_ `Migrating from ESPEasy`_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
|Automations|_ |FAQ|_ |Contributing|_
|Automations|_ |FAQ and Tips|_ |Contributing|_
-------------------------------------------------- -------------------------------------------------- --------------------------------------------------
`Automations`_ `FAQ`_ `Contributing`_
`Automations`_ `FAQ and Tips`_ `Contributing`_
================================================== ================================================== ==================================================
.. |Getting Started through Command Line| image:: /esphomeyaml/images/console.svg
@ -66,9 +66,9 @@ Guides
.. |Automations| image:: /esphomeyaml/images/auto-fix.svg
:class: component-image
.. _Automations: /esphomeyaml/guides/automations.html
.. |FAQ| image:: /esphomeyaml/images/question_answer.svg
.. |FAQ and Tips| image:: /esphomeyaml/images/question_answer.svg
:class: component-image
.. _FAQ: /esphomeyaml/guides/faq.html
.. _FAQ and Tips: /esphomeyaml/guides/faq.html
.. |Contributing| image:: /esphomeyaml/images/github-circle.svg
:class: component-image
.. _Contributing: /esphomeyaml/guides/contributing.html
@ -518,6 +518,9 @@ This list contains items that are technically already supported by other compone
:class: component-image
.. _TEMT6000: /esphomeyaml/cookbook/temt6000.html
Do you have other awesome automations or 2nd order components? Please feel free to add them to the
documentation for others to copy. See :doc:`Contributing <guides/contributing>`.
.. toctree::
:hidden: