Enhance gios integration documentation#42740
Conversation
Added use cases, supported functionality, examples, and troubleshooting section for the gios integration.
home-assistant
Bot
added
in-progress
|
It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the |
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
This PR enhances the GIOS integration documentation by adding use cases, supported functionality details, data update information, automation examples, and a troubleshooting section. The changes improve the documentation's usefulness for users setting up and using the GIOS air quality integration.
Key changes:
- Added use cases section describing practical applications for air quality monitoring
- Documented all available sensors provided by the integration
- Included an automation example for PM10 level notifications
- Added troubleshooting guidance with links to debug logging
| ## Use cases | ||
|
|
||
| - Monitor outdoor air quality. | ||
| - Warn to close windows when CO2 levels are too high. |
There was a problem hiding this comment.
The use case mentions "CO2 levels" but GIOS provides CO (carbon monoxide), not CO2 (carbon dioxide). These are different gases. Consider changing to "CO levels are too high" or "air quality is poor" to match the actual data provided by this integration.
| actions: | ||
| - action: notify.mobile_app_your_device | ||
| data: | ||
| title: "High CO2 Level Alert" |
There was a problem hiding this comment.
The title says "High CO2 Level Alert" but should say "High PM10 Level Alert" to match the automation purpose and the sensor being monitored (sensor.czerniawa_pm10).
|
|
||
| The integration provides the following sensors: | ||
|
|
||
| - Air quality index |
There was a problem hiding this comment.
According to the coding guidelines, lists should be surrounded by blank lines. Add a blank line before this list.
| data: | ||
| title: "High CO2 Level Alert" | ||
| message: > | ||
| The PM10 level is too high at {{ states('sensor.czerniawa_pm10') }} ppm. |
There was a problem hiding this comment.
PM10 is measured in µg/m³ (micrograms per cubic meter), not "ppm" (parts per million). The message should state the correct unit of measurement or omit the unit entirely.
|
|
||
| ### Notify when the PM10 level is too high | ||
|
|
||
| The following example sends a notification to your mobile device when the PM10 level exceeds 100 ppm. |
There was a problem hiding this comment.
PM10 is measured in µg/m³, not ppm. The message template should either use the correct unit or omit it entirely to avoid confusion.
| - PM2.5 | ||
| - PM2.5 index | ||
| - Sulphur dioxide | ||
| - Sulphur dioxide index |
There was a problem hiding this comment.
According to the coding guidelines, lists should be surrounded by blank lines. Add a blank line after the last list item.
|
Please fill out the form in open post. 
|
home-assistant
Bot
removed
needs-rebase
Added use cases, supported functionality, examples, and troubleshooting section for the gios integration.
Proposed change
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.