Add documentation to ecoforest integration (#28953)

* Add documentation for ecoforest integration

* Update sensor info

Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>

* rephrase

Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>

* update ha release

Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>

* update documentation

* remove the list

Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>

* fix typo

Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>

* Test

---------

Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>
This commit is contained in:
Pedro Januário 2023-09-21 14:19:30 +01:00 committed by GitHub
parent 7f2c0e03eb
commit b52dde1d1e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 47 additions and 0 deletions

View File

@ -0,0 +1,47 @@
---
title: Ecoforest
description: Instructions on how to integrate Ecoforest fireplaces with Home Assistant.
ha_category:
- Climate
ha_release: 2023.10
ha_iot_class: Local Polling
ha_config_flow: true
ha_codeowners:
- '@pjanuario'
ha_domain: ecoforest
ha_platforms:
- sensor
ha_integration_type: integration
---
The Ecoforest integration allows monitoring and control of local [Ecoforest](https://ecoforest.com) fireplaces in Home Assistant. These fireplaces are manufactured in Spain.
There is currently support for the following device platforms within Home Assistant:
- [Sensor](#sensor)
{% include integrations/config_flow.md %}
<div class='note'>
Devices must first be connected to Wi-Fi or LAN using the app or website provided by the device manufacturer. It is not possible to connect devices to Wi-Fi using this integration.
</div>
### Credentials
To configure the Ecoforest integration you will need to enter your Ecoforest credentials which are the same ones you would use with the manufacturer app. The image below shows how to obtain the credentials:
- Username: use the serial number of the device as identified by 1.
- Password: use the first 8 characters of the wifi password as identified by 4.
![Ecoforest Credentials](/images/integrations/ecoforest/credentials.png)
## Supported models
Any Ecoforest device working with [Ecoforest Home](https://ecoforesthome.com/) should be supported, this integration is confirmed to support:
- Ecoforest Cordoba Glass (using firmware version `30Abr19_v2z`)
## Sensor
The Ecoforest integration exposes a sensor for the current ambient temperature

Binary file not shown.

After

Width:  |  Height:  |  Size: 31 KiB