Document new configuration options for air-Q integration (#31193)

* Document new configuration options for air-Q integration

* Apply suggestions from code review

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>

---------

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
Renat Sibgatulin 2024-05-15 16:46:03 +02:00 committed by GitHub
parent 868ec50f07
commit 89f1c4764f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -21,7 +21,8 @@ The **air-Q** {% term integration %} allows integrating the sensors, provided by
{% include integrations/config_flow.md %}
During the configuration, the user is prompted for the IP address of the {% term device %} or the first 5 characters of the serial number, as well as the device password.
During the initial configuration, the user is prompted for the IP address of the {% term device %} or the first 5 characters of the serial number, as well as the device password.
For this integration to communicate with the device, both must be connected to the same Wi-Fi network.
@ -86,3 +87,11 @@ PM1, PM25, and PM10 correspond to concentrations of particulates with diameter l
Virus Index uses CO2 as a proxy for potential aerosol load and can be seen as an indicator of ventilation sufficiency (0%: insufficient ventilation, 100%: all fine).
Virtual sensors "Relative Pressure" and "Virus Index" are introduced in firmware v1.80.0 but deactivated by default. You can activate them in the air-Q mobile application under "Advanced settings".
## Additional configuration
After the integration has been initialized, the user can configure any of the following two parameters:
- **Show values averaged by the device**. Default: `on`. In its default configuration, air-Q averages the stream of sensor values. The strength of this averaging can be configured on the device side (not exposed through the HA). However, this integration allows to switch between polling the averaged and the raw data from the device. To poll noisy sensor readings from the device, set **Show values averaged by the device** to `off`.
- **Clip negative values**. Default: `on`. For baseline calibration purposes, certain sensor values may briefly become negative. The default behavior is to clip such values to 0.