2018-11-14 22:12:27 +01:00
|
|
|
esphomelib
|
|
|
|
|
==========
|
2018-05-13 11:37:02 +02:00
|
|
|
|
2018-11-14 22:12:27 +01:00
|
|
|
.. seo::
|
|
|
|
|
:description: esphomeyaml Homepage - Reimagining DIY Home Automation
|
|
|
|
|
:image: /_static/logo-full.png
|
2018-05-13 11:37:02 +02:00
|
|
|
|
2018-11-14 22:12:27 +01:00
|
|
|
.. image:: /esphomeyaml/images/logo-full.svg
|
2018-05-13 11:37:02 +02:00
|
|
|
|
2018-11-14 22:12:27 +01:00
|
|
|
What is esphomelib?
|
|
|
|
|
-------------------
|
2018-05-13 11:37:02 +02:00
|
|
|
|
2018-11-14 22:12:27 +01:00
|
|
|
Esphomelib is a framework for creating custom firmwares for your WiFi-enabled
|
|
|
|
|
ESP microcontrollers. Its primary focus is making the process to get your ESP
|
|
|
|
|
running as simple as possible, with many helper tools to ensure you will have the
|
|
|
|
|
best user experience.
|
2018-05-13 11:37:02 +02:00
|
|
|
|
2018-11-14 22:12:27 +01:00
|
|
|
Esphomelib is split up into two main parts: esphomelib, the C++ framework backing the entire
|
|
|
|
|
framework, and esphomeyaml, a tool that automatically creates firmwares for you just
|
|
|
|
|
from simple configuration files - so **no programming experience required**!
|
2018-05-13 11:37:02 +02:00
|
|
|
|
2018-11-14 22:12:27 +01:00
|
|
|
.. imgtable::
|
2018-05-13 11:37:02 +02:00
|
|
|
|
2018-11-14 22:12:27 +01:00
|
|
|
Esphomeyaml Component Index, /esphomeyaml/index, logo.svg
|
|
|
|
|
Getting Started, /esphomeyaml/index.html#guides, download.svg
|
|
|
|
|
Esphomelib API Reference, /api/index, puzzle.svg
|
2018-05-13 11:37:02 +02:00
|
|
|
|
2018-11-14 22:12:27 +01:00
|
|
|
esphomeyaml will:
|
|
|
|
|
|
|
|
|
|
* Read your configuration file and warn you about potential errors (like using the invalid pins.)
|
|
|
|
|
* Create a custom C++ sketch file for you using esphomeyaml's powerful C++ generation engine.
|
|
|
|
|
* Compile the sketch file for you using `platformio <http://platformio.org/>`__.
|
|
|
|
|
* Upload the binary to your ESP via Over the Air updates.
|
|
|
|
|
* If you're using `Home Assistant <https://home-assistant.io/>`__, esphomelib
|
|
|
|
|
will automatically add all components to the home assistant UI.
|
|
|
|
|
|
|
|
|
|
Features
|
|
|
|
|
--------
|
|
|
|
|
|
|
|
|
|
* **No programming experience required:** just edit YAML configuration files like you're used to with Home Assistant.
|
|
|
|
|
* **Smart:**
|
|
|
|
|
* **Fast and efficient:** Written in C++ and keeps memory consumption to a minimum.
|
|
|
|
|
* **Small binaries:** Only the sensors/devices you actually use will appear in the binary.
|
|
|
|
|
* **Made for Home Assistant:** Almost all Home Assistant features are supported out of the box. Including RGB lights and many more.
|
|
|
|
|
* **Powerful logging engine:** View colorful logs and debug issues remotely.
|
|
|
|
|
* **Automations:** Using esphomeyaml's :ref:`automation engine <automation>`, you can have automations run on the ESP
|
|
|
|
|
with an intuitive script syntax.
|
|
|
|
|
* **Flexible:** Use `esphomelib <https://github.com/OttoWinter/esphomelib>`__'s powerful core to create custom sensors/outputs.
|
|
|
|
|
* **It's Open Source 😺**
|
2018-05-13 11:37:02 +02:00
|
|
|
|
|
|
|
|
|
2018-06-01 18:10:00 +02:00
|
|
|
.. toctree::
|
2018-11-14 22:12:27 +01:00
|
|
|
:hidden:
|
2018-06-01 18:10:00 +02:00
|
|
|
|
|
|
|
|
esphomeyaml/index
|
2018-06-03 14:00:32 +02:00
|
|
|
web-api/index
|
|
|
|
|
api/index
|
