Home-IoT/esphome
1
0
Fork 0
mirror of https://github.com/esphome/esphome.git synced 2024-09-20 01:27:31 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

Fix

Browse source
This commit is contained in:
Otto Winter 2018-12-05 21:27:11 +01:00
parent 7c7032c59e
commit 71e221f6ec
No known key found for this signature in database
GPG key ID: DB66C0BE6013F97E
1 changed files with 11 additions and 43 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

54
esphomeyaml-edge/README.md
View file

@ -1,17 +1,10 @@
# Esphomeyaml Hass.io Add-On
[![esphomeyaml logo](https://raw.githubusercontent.com/OttoWinter/esphomeyaml/dev/esphomeyaml-edge/logo.png)](https://esphomelib.com/esphomeyaml/index.html)
[![GitHub stars](https://img.shields.io/github/stars/OttoWinter/esphomelib.svg?style=social&label=Star&maxAge=2592000)](https://github.com/OttoWinter/esphomelib)
[![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]
[![esphomeyaml logo](logo.png)](https://esphomelib.com/esphomeyaml/index.html)
## About
@ -21,7 +14,7 @@ is write YAML configuration files; the rest (over-the-air updates, compiling) is
handled by esphomeyaml.
<p align="center">
<img title="esphomeyaml dashboard screenshot" src="images/screenshot.png" width="700px"></img>
<img title="esphomeyaml dashboard screenshot" src="https://raw.githubusercontent.com/OttoWinter/esphomeyaml/dev/esphomeyaml-edge/images/screenshot.png" width="700px"></img>
</p>
[_View the esphomeyaml documentation here_](https://esphomelib.com/esphomeyaml/index.html)
@ -33,18 +26,18 @@ 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>
<img title="esphomeyaml DHT configuration example" src="https://raw.githubusercontent.com/OttoWinter/esphomeyaml/dev/esphomeyaml-edge/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>
<img title="esphomelib Home Assistant MQTT discovery" src="https://raw.githubusercontent.com/OttoWinter/esphomeyaml/dev/esphomeyaml-edge/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.
1. Add the epshomeyaml 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/OttoWinter/esphomeyaml 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.
@ -63,7 +56,7 @@ Example add-on configuration:
```json
{
"ssl": true,
"ssl": false,
"certfile": "fullchain.pem",
"keyfile": "privkey.pem"
}
@ -90,34 +83,9 @@ The private key file to use for SSL.
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
[releases-shield]: https://img.shields.io/github/release/OttoWinter/esphomeyaml.svg
[releases]: https://esphomelib.com/esphomeyaml/changelog/index.html
[repository]: https://github.com/OttoWinter/esphomeyaml