home-assistant-addon/esphome-beta/README.md

41 lines
1.9 KiB
Markdown
Raw Normal View History

2020-06-09 07:55:20 +02:00
# ESPHome Home Assistant Add-On
2019-02-13 22:05:11 +01:00
2021-07-02 15:42:46 +02:00
[![ESPHome logo](https://raw.githubusercontent.com/esphome/hassio/main/esphome-dev/logo.png)](https://esphome.io/)
2019-02-13 22:05:11 +01:00
[![GitHub stars](https://img.shields.io/github/stars/esphome/esphome.svg?style=social&label=Star&maxAge=2592000)](https://github.com/esphome/esphome)
[![GitHub Release][releases-shield]][releases]
[![Discord][discord-shield]][discord]
## About
This add-on allows you to manage and program your ESP8266 and ESP32 based microcontrollers
2020-06-09 07:55:20 +02:00
directly through Home Assistant **with no programming experience required**. All you need to do
2019-02-13 22:05:11 +01:00
is write YAML configuration files; the rest (over-the-air updates, compiling) is all
handled by ESPHome.
<p align="center">
2021-07-02 15:42:46 +02:00
<img title="ESPHome dashboard screenshot" src="https://raw.githubusercontent.com/esphome/hassio/main/esphome-dev/images/screenshot.png" width="700px"></img>
2019-02-13 22:05:11 +01:00
</p>
2020-06-09 07:55:20 +02:00
[View the ESPHome documentation](https://esphome.io/)
2019-02-13 22:05:11 +01:00
## Example
With ESPHome, 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:
2021-07-02 15:42:46 +02:00
<img title="ESPHome DHT configuration example" src="https://raw.githubusercontent.com/esphome/hassio/main/esphome-dev/images/dht-example.png" width="500px"></img>
2019-02-13 22:05:11 +01:00
Then just click UPLOAD and the sensor will magically appear in Home Assistant:
2021-07-02 15:42:46 +02:00
<img title="ESPHome Home Assistant MQTT discovery" src="https://raw.githubusercontent.com/esphome/hassio/main/esphome-dev/images/temperature-humidity.png" width="600px"></img>
2019-02-13 22:05:11 +01:00
[discord-shield]: https://img.shields.io/discord/429907082951524364.svg
[dht22]: https://esphome.io/components/sensor/dht.html
[discord]: https://discord.gg/KhAMKrd
2019-02-13 22:05:11 +01:00
[releases-shield]: https://img.shields.io/github/release/esphome/esphome.svg
[releases]: https://esphome.io/changelog/index.html
[repository]: https://github.com/esphome/esphome