home-assistant-addon/template/README.md

42 lines
1.8 KiB
Markdown
Raw Normal View History

2023-04-30 05:37:21 +02:00
# ESPHome Add-On
2019-04-24 17:09:50 +02:00
2023-06-21 13:03:42 +02:00
[![ESPHome logo][logo]][website]
2019-04-24 17:09:50 +02:00
2023-06-21 13:03:42 +02:00
[![GitHub stars][github-stars-shield]][repository]
2019-04-24 17:09:50 +02:00
[![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-04-24 17:09:50 +02:00
is write YAML configuration files; the rest (over-the-air updates, compiling) is all
handled by ESPHome.
<p align="center">
2023-06-21 13:03:42 +02:00
<img title="ESPHome dashboard screenshot" src="https://github.com/esphome/home-assistant-addon/raw/main/esphome/images/screenshot.png" width="700px"></img>
2019-04-24 17:09:50 +02:00
</p>
2023-06-21 13:03:42 +02:00
[View the ESPHome documentation][website]
2019-04-24 17:09:50 +02: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:
2023-06-21 13:03:42 +02:00
<img title="ESPHome DHT configuration example" src="https://github.com/esphome/home-assistant-addon/raw/main/esphome/images/dht-example.png" width="500px"></img>
2019-04-24 17:09:50 +02:00
Then just click UPLOAD and the sensor will magically appear in Home Assistant:
2023-06-21 13:03:42 +02:00
<img title="ESPHome Home Assistant discovery" src="https://github.com/esphome/home-assistant-addon/raw/main/esphome/images/temperature-humidity.png" width="600px"></img>
2019-04-24 17:09:50 +02:00
2023-06-21 13:03:42 +02:00
[discord]: https://discord.gg/KhAMKrd
[repository]: https://github.com/esphome/esphome
2019-04-24 17:09:50 +02:00
[discord-shield]: https://img.shields.io/discord/429907082951524364.svg
2023-06-21 13:03:42 +02:00
[github-stars-shield]: https://img.shields.io/github/stars/esphome/esphome.svg?style=social&label=Star&maxAge=2592000
2019-04-24 17:09:50 +02:00
[dht22]: https://esphome.io/components/sensor/dht.html
[releases]: https://esphome.io/changelog/index.html
2023-06-21 13:03:42 +02:00
[logo]: https://github.com/esphome/home-assistant-addon/raw/main/esphome/logo.png
[website]: https://esphome.io/