Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rsciriano committed Oct 29, 2022
1 parent 6e868f1 commit 9185062
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@
**/src/
**/platformio.ini
/secrets.yaml
.vscode
6 changes: 6 additions & 0 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,9 @@ This is an example of a integration with a OpenTherm boiler using [ESPHome](http
- Make sure the board and device settings are correct for your device
- Set the sensor entity_id with the external temperature sensor's name from Home Assistant. (The ESPHome sensor name is temperature_sensor).
- Flash the ESP and configure in Home Assistant. It should be auto-discovered by the ESPHome Integration.

## Additional info

> I am working in a new version of this integration, completely rewriting it as an [external component](https://esphome.io/components/external_components.html). You can see the progress in [this branch](https://github.com/rsciriano/ESPHome-OpenTherm/tree/external-component)
> I have pending to write a detailed documentation, I promise to do it for the new version. Until then you have lot of info in [this issue](https://github.com/rsciriano/ESPHome-OpenTherm/issues/37#issuecomment-1288779030), thanks to [@foltymat](https://github.com/foltymat)

0 comments on commit 9185062

Please sign in to comment.