Update fyta documentation based on new quality scale (#35918)

Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
dontinelli 2024-11-24 11:13:31 +01:00 committed by GitHub
parent eb722e843f
commit 329438bf07
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -18,13 +18,31 @@ ha_quality_scale: platinum
The **FYTA** {% term integration %} uses the open API of [FYTA](https://www.fyta.de) to obtain the data from your plant sensors and integrate these into Home Assistant.
For the authentication on the FYTA server, you need your login-credentials (email and password).
## Supported devices
The integration provides a device for all plants with a [FYTA Beam](https://fyta.de/collections/all/products/single-beam) sensor. In order to be able to access your plant data over the API, you need a [FYTA hub](https://fyta.de/collections/all/products/single-hub) that uploads the data from the Beam sensor to the FYTA server. Alternatively, the mobile app can serve as gateaway to upload the data from the Beam to the server. No direct connection to the FYTA Beam is supported.
The integration should work with any [FYTA Beam](https://fyta.de/collections/all/products/single-beam).
## Prerequisites
For the integration to work you need a [FYTA Beam](https://fyta.de/collections/all/products/single-beam) and a FYTA account.
{% include integrations/config_flow.md %}
## Sensors
To setup the integration you need the following information:
{% configuration_basic %}
Email:
description: "The email address used to access the FYTA account."
Password:
description: "The password used to access the FYTA account."
{% endconfiguration_basic %}
## Configuration options
The integration has no additional configuration options.
## Supported functionality
### Sensors
The following sensors are currently available per plant:
@ -41,3 +59,23 @@ The following sensors are currently available per plant:
| moisture | % | Moisture measured by sensor |
| salinity | mS/cm | Salinity measured by sensor (measured as conductivity)|
| battery_level | % | Battery level of the sensor |
## Data updates
The integration fetches data from the device every 4 minutes.
## Actions
The integration provides no additional actions.
## Known limitations
The integration provides the data exposed by means of the plant API. The light measurement as current daily light integral (DLI) is not yet available (currently only the PAR value is provided).
Please note that in order to be able to access your plant data over the API, you need a [FYTA hub](https://fyta.de/collections/all/products/single-hub) that uploads the data from the Beam sensor to the FYTA server. Alternatively, the mobile app can serve as a gateway to upload the data from the Beam to the server. No direct connection to the FYTA Beam is supported (as the Beam only provides raw data, that needs to be processed on the FYTA server).
## Remove integration
For this integration the general process to remove integrations applies:
{% include integrations/remove_device_service.md %}