diff --git a/README.md b/README.md index 3a8a00d4..e1b9ecf4 100644 --- a/README.md +++ b/README.md @@ -136,6 +136,20 @@ Simple & Free Wiki Software [:books: Bookstack add-on documentation][addon-doc-bookstack] +### ✓ [ESPHome][addon-esphome] + +![Latest Version][esphome-version-shield] +![Supports armhf Architecture][esphome-armhf-shield] +![Supports armv7 Architecture][esphome-armv7-shield] +![Supports aarch64 Architecture][esphome-aarch64-shield] +![Supports amd64 Architecture][esphome-amd64-shield] +![Supports i386 Architecture][esphome-i386-shield] +![Docker Pulls][esphome-pulls-shield] + +ESPHome Hass.io add-on for intelligently managing all your ESP8266/ESP32 devices. + +[:books: ESPHome add-on documentation][addon-doc-esphome] + ### ✓ [Example][addon-example] ![Latest Version][example-version-shield] @@ -686,6 +700,7 @@ on the correct GitHub repository matching the add-on. - [Open an issue for the add-on: AppDaemon 4][appdaemon-issue] - [Open an issue for the add-on: Bitwarden RS][bitwarden-issue] - [Open an issue for the add-on: Bookstack][bookstack-issue] +- [Open an issue for the add-on: ESPHome][esphome-issue] - [Open an issue for the add-on: Example][example-issue] - [Open an issue for the add-on: FTP][ftp-issue] - [Open an issue for the add-on: FlexTV][phlex-issue] @@ -840,6 +855,16 @@ SOFTWARE. [bookstack-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg [bookstack-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg [bookstack-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg +[addon-esphome]: https://github.com/esphome/hassio/tree/v1.14.4 +[addon-doc-esphome]: https://github.com/esphome/hassio/blob/v1.14.4/README.md +[esphome-issue]: https://github.com/esphome/hassio/issues +[esphome-version-shield]: https://img.shields.io/badge/version-v1.14.4-blue.svg +[esphome-pulls-shield]: https://img.shields.io/docker/pulls/esphome/esphome-hassio-amd64.svg +[esphome-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg +[esphome-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg +[esphome-armhf-shield]: https://img.shields.io/badge/armhf-no-red.svg +[esphome-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg +[esphome-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg [addon-example]: https://github.com/hassio-addons/addon-example/tree/v3.4.0 [addon-doc-example]: https://github.com/hassio-addons/addon-example/blob/v3.4.0/README.md [example-issue]: https://github.com/hassio-addons/addon-example/issues diff --git a/esphome/CHANGELOG.md b/esphome/CHANGELOG.md new file mode 100644 index 00000000..1618fc12 --- /dev/null +++ b/esphome/CHANGELOG.md @@ -0,0 +1,76 @@ +- docs: Added Android Beacon MQTT app [docs#417](https://github.com/esphome/esphome-docs/pull/417) by [@turbo-lab](https://github.com/turbo-lab) +- esphome: fix the problem of missing part of advertising packet when activ… [esphome#868](https://github.com/esphome/esphome/pull/868) by [@warpzone](https://github.com/warpzone) +- docs: dfplayer updates [docs#421](https://github.com/esphome/esphome-docs/pull/421) by [@glmnet](https://github.com/glmnet) +- docs: Fix time id conflict [docs#418](https://github.com/esphome/esphome-docs/pull/418) by [@guiguid](https://github.com/guiguid) +- docs: Cookbook for Sonoff Light Switches [docs#407](https://github.com/esphome/esphome-docs/pull/407) by [@bensuffolk](https://github.com/bensuffolk) +- esphome: fix climate_ir on receive optional [esphome#897](https://github.com/esphome/esphome/pull/897) by [@glmnet](https://github.com/glmnet) +- esphome: Fix MQTT logs Int or String expected Python 3 [esphome#898](https://github.com/esphome/esphome/pull/898) +- esphome: web_server call setup_controller [esphome#899](https://github.com/esphome/esphome/pull/899) +- esphome: Ignore ESP32 Camera unknown framesizes [esphome#901](https://github.com/esphome/esphome/pull/901) +- esphome: Update ESP32 BLE ADV parse to match BLE spec [esphome#904](https://github.com/esphome/esphome/pull/904) +- esphome: Add ESP8266 core v2.6.2 [esphome#905](https://github.com/esphome/esphome/pull/905) +- docs: Add doc for color correction of rgb* lights [docs#431](https://github.com/esphome/esphome-docs/pull/431) by [@nickw444](https://github.com/nickw444) +- docs: Use .timestamp instead of .time in time docs [docs#435](https://github.com/esphome/esphome-docs/pull/435) by [@davidjb](https://github.com/davidjb) +- docs: DIY Examples : Added SW420 Vibration Sensor with Remote Notifications [docs#436](https://github.com/esphome/esphome-docs/pull/436) by [@rmooreID](https://github.com/rmooreID) +- docs: Fix broken link [docs#437](https://github.com/esphome/esphome-docs/pull/437) by [@richrd](https://github.com/richrd) +- docs: Update getting_started_command_line.rst [docs#461](https://github.com/esphome/esphome-docs/pull/461) by [@CyanoFresh](https://github.com/CyanoFresh) +- docs: Added degree symbol output on ~ for MAX7219 [docs#376](https://github.com/esphome/esphome-docs/pull/376) by [@cyberplant](https://github.com/cyberplant) +- docs: change "tracker" to "presence" [docs#465](https://github.com/esphome/esphome-docs/pull/465) by [@spattinson](https://github.com/spattinson) +- docs: On_sunrise was listed twice in description. [docs#464](https://github.com/esphome/esphome-docs/pull/464) by [@Mechotronic](https://github.com/Mechotronic) +- docs: Patch 3 [docs#460](https://github.com/esphome/esphome-docs/pull/460) by [@Valcob](https://github.com/Valcob) +- docs: fixed non working example [docs#381](https://github.com/esphome/esphome-docs/pull/381) by [@danibjor](https://github.com/danibjor) +- docs: Added my custom component, now with correct syntax [docs#454](https://github.com/esphome/esphome-docs/pull/454) by [@nldroid](https://github.com/nldroid) +- docs: faq reboot_timeout [docs#472](https://github.com/esphome/esphome-docs/pull/472) by [@glmnet](https://github.com/glmnet) +- docs: my9231->bit_depth: parameter name and sonoff B1 [docs#489](https://github.com/esphome/esphome-docs/pull/489) by [@anduchs](https://github.com/anduchs) +- docs: New DIY project about Cat Feeder [docs#439](https://github.com/esphome/esphome-docs/pull/439) by [@rubengargar](https://github.com/rubengargar) +- docs: Update diy.rst [docs#493](https://github.com/esphome/esphome-docs/pull/493) by [@brianhanifin](https://github.com/brianhanifin) +- docs: Add my ESPHome configs [docs#492](https://github.com/esphome/esphome-docs/pull/492) by [@nuttytree](https://github.com/nuttytree) +- docs: Brightness feature not included in doc. [docs#445](https://github.com/esphome/esphome-docs/pull/445) by [@tubalainen](https://github.com/tubalainen) +- docs: remove apostrophe [docs#504](https://github.com/esphome/esphome-docs/pull/504) by [@perjury](https://github.com/perjury) +- docs: Add UART-based Mitsibishi HeatPump Component [docs#506](https://github.com/esphome/esphome-docs/pull/506) by [@geoffdavis](https://github.com/geoffdavis) +- docs: Update pzemac.rst [docs#495](https://github.com/esphome/esphome-docs/pull/495) by [@Francisk0](https://github.com/Francisk0) +- docs: Fix link syntax [docs#507](https://github.com/esphome/esphome-docs/pull/507) by [@geoffdavis](https://github.com/geoffdavis) +- docs: Typo fix [docs#498](https://github.com/esphome/esphome-docs/pull/498) by [@napieraj](https://github.com/napieraj) +- docs: Fix some typos in Sonoff basic light switch [docs#480](https://github.com/esphome/esphome-docs/pull/480) by [@kaykayehnn](https://github.com/kaykayehnn) +- docs: Wrong IC [docs#499](https://github.com/esphome/esphome-docs/pull/499) by [@Tuckie](https://github.com/Tuckie) +- docs: small mistype fix [docs#477](https://github.com/esphome/esphome-docs/pull/477) by [@trylika](https://github.com/trylika) +- docs: Update sonoff.rst [docs#470](https://github.com/esphome/esphome-docs/pull/470) by [@TBobsin](https://github.com/TBobsin) +- docs: Update sonoff-t1-3.rst [docs#497](https://github.com/esphome/esphome-docs/pull/497) by [@RockBomber](https://github.com/RockBomber) +- docs: remove uppercase allowed in names [docs#487](https://github.com/esphome/esphome-docs/pull/487) by [@truglodite](https://github.com/truglodite) +- docs: Update ssd1306.rst [docs#481](https://github.com/esphome/esphome-docs/pull/481) by [@Valcob](https://github.com/Valcob) +- docs: Update board for Sonoff and link to Tasmota [docs#484](https://github.com/esphome/esphome-docs/pull/484) by [@sillyfrog](https://github.com/sillyfrog) +- docs: Update migrate_sonoff_tasmota.rst [docs#483](https://github.com/esphome/esphome-docs/pull/483) by [@jasonehines](https://github.com/jasonehines) +- docs: added rgbww light using pwm driver [docs#482](https://github.com/esphome/esphome-docs/pull/482) by [@morph027](https://github.com/morph027) +- docs: add a note about the log level of dump: all [docs#475](https://github.com/esphome/esphome-docs/pull/475) by [@drewp](https://github.com/drewp) +- docs: ifan02 cookbook [docs#218](https://github.com/esphome/esphome-docs/pull/218) by [@quazzie](https://github.com/quazzie) +- docs: Add documentation for cwww and rgbww constant_brightness variables. [docs#530](https://github.com/esphome/esphome-docs/pull/530) by [@kroimon](https://github.com/kroimon) +- docs: remove link to Adafruit [docs#531](https://github.com/esphome/esphome-docs/pull/531) by [@ebaschiera](https://github.com/ebaschiera) +- docs: Revert "Add documentation for cwww and rgbww constant_brightness vari… [docs#539](https://github.com/esphome/esphome-docs/pull/539) by [@glmnet](https://github.com/glmnet) +- docs: Add Stepper Motor blinds to diy examples [docs#534](https://github.com/esphome/esphome-docs/pull/534) by [@icarome](https://github.com/icarome) +- docs: Update sonoff.rst [docs#549](https://github.com/esphome/esphome-docs/pull/549) by [@MrZetor](https://github.com/MrZetor) +- docs: Improve LEDC documentation [docs#557](https://github.com/esphome/esphome-docs/pull/557) by [@Skaronator](https://github.com/Skaronator) +- docs: Update wifi.rst [docs#562](https://github.com/esphome/esphome-docs/pull/562) by [@kbouchard111](https://github.com/kbouchard111) +- docs: Add unit_of_measurement to make graphing happens [docs#569](https://github.com/esphome/esphome-docs/pull/569) by [@deftdawg](https://github.com/deftdawg) +- docs: Simple grammar change. [docs#578](https://github.com/esphome/esphome-docs/pull/578) by [@mnaz](https://github.com/mnaz) +- docs: Fix typos [docs#561](https://github.com/esphome/esphome-docs/pull/561) by [@mje-nz](https://github.com/mje-nz) +- docs: Adding example of how to use a buzzer [docs#570](https://github.com/esphome/esphome-docs/pull/570) by [@declanshanaghy](https://github.com/declanshanaghy) +- docs: Deleted Warning because the component is already tested [docs#615](https://github.com/esphome/esphome-docs/pull/615) by [@deltazerorsan](https://github.com/deltazerorsan) +- docs: Update datasheet URL on SHTCX page [docs#598](https://github.com/esphome/esphome-docs/pull/598) by [@JeffResc](https://github.com/JeffResc) +- docs: Update datagram URL on TX20 page [docs#599](https://github.com/esphome/esphome-docs/pull/599) by [@JeffResc](https://github.com/JeffResc) +- docs: Update datasheet URL on SCD30 page [docs#600](https://github.com/esphome/esphome-docs/pull/600) by [@JeffResc](https://github.com/JeffResc) +- docs: Update datasheet URL on STS3X page [docs#602](https://github.com/esphome/esphome-docs/pull/602) by [@JeffResc](https://github.com/JeffResc) +- docs: Update datasheet URL on SGP30 page [docs#601](https://github.com/esphome/esphome-docs/pull/601) by [@JeffResc](https://github.com/JeffResc) +- docs: Update Home Assistant custom component URL on contributing guide page [docs#603](https://github.com/esphome/esphome-docs/pull/603) by [@JeffResc](https://github.com/JeffResc) +- docs: Update WaveShare E-Paper URL on WaveShare E-Paper page [docs#597](https://github.com/esphome/esphome-docs/pull/597) by [@JeffResc](https://github.com/JeffResc) +- docs: Fix copy/paste error [docs#574](https://github.com/esphome/esphome-docs/pull/574) by [@mniess](https://github.com/mniess) +- docs: Update pulse_counter.rst [docs#609](https://github.com/esphome/esphome-docs/pull/609) by [@m1ch](https://github.com/m1ch) +- docs: Add smart intercom blogpost [docs#621](https://github.com/esphome/esphome-docs/pull/621) by [@frog32](https://github.com/frog32) +- docs: Minor spelling [docs#622](https://github.com/esphome/esphome-docs/pull/622) by [@AalianKhan](https://github.com/AalianKhan) +- docs: Added NEO Coolcam [docs#496](https://github.com/esphome/esphome-docs/pull/496) by [@nldroid](https://github.com/nldroid) +- docs: pzemac energy support [docs#514](https://github.com/esphome/esphome-docs/pull/514) by [@rradar](https://github.com/rradar) +- docs: Revert "pzemac energy support" [docs#623](https://github.com/esphome/esphome-docs/pull/623) by [@glmnet](https://github.com/glmnet) +- docs: Changed miflora platforms [docs#586](https://github.com/esphome/esphome-docs/pull/586) by [@Guyohms](https://github.com/Guyohms) +- docs: Update docs to reflect ssd1327 support [docs#500](https://github.com/esphome/esphome-docs/pull/500) by [@igg](https://github.com/igg) +- docs: Typo: NEC -> Sony [docs#624](https://github.com/esphome/esphome-docs/pull/624) by [@gitolicious](https://github.com/gitolicious) +- docs: Not every nodeMCU board supports 12V [docs#626](https://github.com/esphome/esphome-docs/pull/626) by [@Laess3r](https://github.com/Laess3r) +- docs: Revert "Update docs to reflect ssd1327 support" [docs#634](https://github.com/esphome/esphome-docs/pull/634) by [@glmnet](https://github.com/glmnet) \ No newline at end of file diff --git a/esphome/README.md b/esphome/README.md new file mode 100644 index 00000000..b4704925 --- /dev/null +++ b/esphome/README.md @@ -0,0 +1,122 @@ +# ESPHome Hass.io Add-On + +[![ESPHome logo](https://raw.githubusercontent.com/esphome/hassio/master/esphome-dev/logo.png)](https://esphome.io/) + +[![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 +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 ESPHome. + +

+ +

+ +[_View the ESPHome documentation here_](https://esphome.io/) + +## 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: + + + +Then just click UPLOAD and the sensor will magically appear in Home Assistant: + + + +## Installation + +To install this Hass.io add-on you need to add the ESPHome add-on repository +first: + +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/esphome/hassio in the "Add new repository by URL" field. +2. Now scroll down and select the "ESPHome" 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 ESPHome dashboard. You will be asked for your Home Assistant credentials - ESPHome uses Hass.io's authentication system to log you in. + +You can view the ESPHome docs here: https://esphome.io/ + +## Configuration + +**Note**: _Remember to restart the add-on when the configuration is changed._ + +Example add-on configuration: + +```json +{ + "ssl": false, + "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 generate the key and certificate +files for encryption. For example using [Let's Encrypt](https://www.home-assistant.io/addons/lets_encrypt/) +or [Self-signed certificates](https://www.home-assistant.io/docs/ecosystem/certificates/tls_self_signed_certificate/). + +### Option: `certfile` + +The certificate file to use for SSL. If this file doesn't exist, the add-on start will fail. + +**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. If this file doesn't exist, the add-on start will fail. + +**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`. + +### Option: `esphome_version` + +Manually override which ESPHome version to use in the addon. +For example to install the latest development version, use `"esphome_version": "dev"`, +or for version 1.10.0: `"esphome_version": "v1.10.0""`. + +Please note that this does not always work and is only meant for testing, usually the +ESPHome add-on and dashboard version must match to guarantee a working system. + +### Option: `relative_url` + +Host the ESPHome dashboard under a relative URL, so that it can be integrated +into existing web proxys like nginx under a relative URl. Defaults to `/`. + +### Option: `status_use_ping` + +By default the dashboard uses mDNS to check if nodes are online. This does +not work across subnets unless your router supports mDNS forwarding or avahi. + +Setting this to `true` will make ESPHome use ICMP ping requests to get the node status. Use this if all nodes always have offline status even when they're connected. + +### Option: `streamer_mode` + +If set to `true`, this will enable streamer mode, which makes ESPHome hide all +potentially private information. So for example WiFi (B)SSIDs (which could be +used to find your location), usernames etc. Please note that you need to use +the `!secret` tag in your YAML file to also prevent these from showing up +while editing and validating. + +[discord-shield]: https://img.shields.io/discord/429907082951524364.svg +[dht22]: https://esphome.io/components/sensor/dht.html +[discord]: https://discord.gg/KhAMKrd +[releases-shield]: https://img.shields.io/github/release/esphome/esphome.svg +[releases]: https://esphome.io/changelog/index.html +[repository]: https://github.com/esphome/esphome diff --git a/esphome/config.json b/esphome/config.json new file mode 100644 index 00000000..1792badf --- /dev/null +++ b/esphome/config.json @@ -0,0 +1,47 @@ +{ + "arch": [ + "amd64", + "i386", + "armv7", + "aarch64" + ], + "auth_api": true, + "auto_uart": true, + "boot": "auto", + "description": "ESPHome Hass.io add-on for intelligently managing all your ESP8266/ESP32 devices.", + "hassio_api": true, + "hassio_role": "default", + "homeassistant_api": false, + "host_network": true, + "image": "esphome/esphome-hassio-{arch}", + "ingress": true, + "ingress_port": 0, + "map": [ + "ssl:ro", + "config:rw" + ], + "name": "ESPHome", + "options": {}, + "panel_icon": "mdi:chip", + "ports": { + "6052/tcp": null + }, + "ports_description": { + "6052/tcp": "Web interface (Not required for Hass.io Ingress)" + }, + "schema": { + "certfile": "str?", + "esphome_version": "str?", + "keyfile": "str?", + "leave_front_door_open": "bool?", + "relative_url": "str?", + "ssl": "bool?", + "status_use_ping": "bool?", + "streamer_mode": "bool?" + }, + "slug": "esphome", + "startup": "application", + "url": "https://esphome.io/", + "version": "1.14.4", + "webui": "http://[HOST]:[PORT:6052]" +} \ No newline at end of file diff --git a/esphome/icon.png b/esphome/icon.png new file mode 100644 index 00000000..8845ae85 Binary files /dev/null and b/esphome/icon.png differ diff --git a/esphome/logo.png b/esphome/logo.png new file mode 100644 index 00000000..91f65b1a Binary files /dev/null and b/esphome/logo.png differ