mirror of
https://github.com/esphome/esphome.git
synced 2024-09-20 01:27:31 +02:00
7c7032c59e
* Implement custom sensor platform
* Update
* Ethernet
* Lint
* Fix
* Login page
* Rename cookie secret
* Update manifest
* Update cookie check logic
* Favicon
* Fix
* Favicon manifest
* Fix
* Fix
* Fix
* Use hostname
* Message
* Temporary commit for screenshot
* Automatic board selection
* Undo temporary commit
* Update esphomeyaml-edge
* In-dashboard editing and hosting files locally
* Update esphomeyaml-edge
* Better ANSI color escaping
* Message
* Lint
* Download Efficiency
* Fix gitlab
* Fix
* Rename extra_libraries to libraries
* Add example
* Update README.md
* Update README.md
* Update README.md
* HassIO -> Hass.io
* Updates
* Add update available notice
* Update
* Fix substitutions
* Better error message
* Re-do dashboard ANSI colors
* Only include FastLED if user says so
* Autoscroll logs
* Remove old checks
* Use safer RedirectText
* Improvements
* Fix
* Use enviornment variable
* Use http://hassio/host/info
* Fix conditions
* Update platformio versions
* Revert "Use enviornment variable"
This reverts commit 7f038eb5d2.
* Fix
* README update
* Temp
* Better invalid config messages
* Platformio debug
* Improve error messages
* Debug
* Remove debug
* Multi Conf
* Update
* Better paths
* Remove unused
* Fixes
* Lint
* lib_ignore
* Try fix platformio colors
* Fix dashboard scrolling
* Revert
* Lint
* Revert
123 lines
5 KiB
Markdown
123 lines
5 KiB
Markdown
# Esphomeyaml Hass.io Add-On
|
|
|
|
[![GitHub Release][releases-shield]][releases]
|
|
![Project Stage][project-stage-shield]
|
|
[![License][license-shield]](LICENSE.md)
|
|
|
|
[![GitLab CI][gitlabci-shield]][gitlabci]
|
|
![Project Maintenance][maintenance-shield]
|
|
[![GitHub Activity][commits-shield]][commits]
|
|
|
|
[![Discord][discord-shield]][discord]
|
|
[![Community Forum][forum-shield]][forum]
|
|
|
|
[](https://esphomelib.com/esphomeyaml/index.html)
|
|
|
|
## About
|
|
|
|
This add-on allows you to manage and program your ESP8266 and ESP32 based microcontrollers
|
|
directly through Hass.io **with no programming experience required**. All you need to do
|
|
is write YAML configuration files; the rest (over-the-air updates, compiling) is all
|
|
handled by esphomeyaml.
|
|
|
|
<p align="center">
|
|
<img title="esphomeyaml dashboard screenshot" src="images/screenshot.png" width="700px"></img>
|
|
</p>
|
|
|
|
[_View the esphomeyaml documentation here_](https://esphomelib.com/esphomeyaml/index.html)
|
|
|
|
## Example
|
|
|
|
With esphomeyaml, you can go from a few lines of YAML straight to a custom-made
|
|
firmware. For example, to include a [DHT22][dht22].
|
|
temperature and humidity sensor, you just need to include 8 lines of YAML
|
|
in your configuration file:
|
|
|
|
<img title="esphomeyaml DHT configuration example" src="images/dht-example.png" width="500px"></img>
|
|
|
|
Then just click UPLOAD and the sensor will magically appear in Home Assistant:
|
|
|
|
<img title="esphomelib Home Assistant MQTT discovery" src="images/temperature-humidity.png" width="600px"></img>
|
|
|
|
## Installation
|
|
|
|
To install this Hass.io add-on you need to add the esphomeyaml add-on repository
|
|
first:
|
|
|
|
1. Add our Hass.io add-ons repository to your Hass.io instance. You can do this by navigating to the "Add-on Store" tab in the Hass.io panel and then entering https://github.com/hassio-addons/repository in the "Add new repository by URL" field.
|
|
2. Now scroll down and select the "esphomeyaml" add-on.
|
|
3. Press install to download the add-on and unpack it on your machine. This can take some time.
|
|
4. Optional: If you're using SSL certificates and want to encrypt your communication to this add-on, please enter `true` into the `ssl` field and set the `fullchain` and `certfile` options accordingly.
|
|
5. Start the add-on, check the logs of the add-on to see if everything went well.
|
|
6. Click "OPEN WEB UI" to open the esphomeyaml dashboard. You will be asked for your Home Assistant credentials - esphomeyaml uses Hass.io's authentication system to log you in.
|
|
|
|
**NOTE**: Installation on RPis running in 64-bit mode is currently not possible. Please use the 32-bit variant of HassOS instead.
|
|
|
|
You can view the esphomeyaml docs here: https://esphomelib.com/esphomeyaml/index.html
|
|
|
|
## Configuration
|
|
|
|
**Note**: _Remember to restart the add-on when the configuration is changed._
|
|
|
|
Example add-on configuration:
|
|
|
|
```json
|
|
{
|
|
"ssl": true,
|
|
"certfile": "fullchain.pem",
|
|
"keyfile": "privkey.pem"
|
|
}
|
|
```
|
|
|
|
### Option: `ssl`
|
|
|
|
Enables/Disables encrypted SSL (HTTPS) connections to the web server of this add-on. Set it to `true` to encrypt communications, `false` otherwise. Please note that if you set this to `true` you must also specify a `certfile` and `keyfile`.
|
|
|
|
### Option: `certfile`
|
|
|
|
The certificate file to use for SSL.
|
|
|
|
**Note**: _The file MUST be stored in `/ssl/`, which is the default for Hass.io_
|
|
|
|
### Option: `keyfile`
|
|
|
|
The private key file to use for SSL.
|
|
|
|
**Note**: _The file MUST be stored in `/ssl/`, which is the default for Hass.io_
|
|
|
|
### Option: `leave_front_door_open`
|
|
|
|
Adding this option to the add-on configuration allows you to disable
|
|
authentication by setting it to `true`.
|
|
|
|
## Embedding into Home Assistant
|
|
|
|
It is possible to embed the esphomeyaml dashboard directly into
|
|
Home Assistant, allowing you to access your ESP nodes through
|
|
the Home Assistant frontend using the `panel_iframe` component.
|
|
|
|
Example configuration:
|
|
|
|
```yaml
|
|
panel_iframe:
|
|
esphomeyaml:
|
|
title: esphomeyaml Dashboard
|
|
icon: mdi:code-brackets
|
|
url: https://addres.to.your.hass.io:6052
|
|
```
|
|
|
|
[commits-shield]: https://img.shields.io/github/commit-activity/y/hassio-addons/addon-esphomeyaml.svg
|
|
[commits]: https://github.com/hassio-addons/addon-esphomeyaml/commits/master
|
|
[discord-shield]: https://img.shields.io/discord/429907082951524364.svg
|
|
[dht22]: https://esphomelib.com/esphomeyaml/components/sensor/dht.html
|
|
[discord]: https://discord.me/KhAMKrd
|
|
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
|
|
[forum]: https://community.home-assistant.io/c/third-party/esphomelib
|
|
[gitlabci-shield]: https://gitlab.com/hassio-addons/addon-esphomeyaml/badges/master/pipeline.svg
|
|
[gitlabci]: https://gitlab.com/hassio-addons/addon-esphomeyaml/pipelines
|
|
[license-shield]: https://img.shields.io/github/license/hassio-addons/addon-esphomeyaml.svg
|
|
[maintenance-shield]: https://img.shields.io/maintenance/yes/2018.svg
|
|
[project-stage-shield]: https://img.shields.io/badge/project%20stage-stable-green.svg
|
|
[releases-shield]: https://img.shields.io/github/release/hassio-addons/addon-esphomeyaml.svg
|
|
[releases]: https://github.com/hassio-addons/addon-esphomeyaml/releases
|
|
[repository]: https://github.com/hassio-addons/repository
|