Add Google Air Quality integration #145237
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
13 tasks
8 tasks
joostlek
requested changes
May 22, 2025
| return self.async_abort( | ||
| reason="access_not_configured", | ||
| description_placeholders={ | ||
| "message": f"Missing required scope: {OAUTH2_SCOPE}" |
There was a problem hiding this comment.
why is this in a placeholder? How does one add this?
Comment on lines
71
to
113
| async def async_step_coordinates( | ||
| self, user_input: dict[str, Any] | ||
| ) -> ConfigFlowResult: | ||
| """Handle coordinate input and create the config entry.""" | ||
| session = aiohttp_client.async_get_clientsession(self.hass) | ||
| auth = api.AsyncConfigFlowAuth( | ||
| session, self._oauth_data[CONF_TOKEN][CONF_ACCESS_TOKEN] | ||
| ) | ||
| client = GoogleAirQualityApi(auth) | ||
| location = user_input[CONF_LOCATION] | ||
| lat = location[CONF_LATITUDE] | ||
| lon = location[CONF_LONGITUDE] | ||
|
|
||
| try: | ||
| user_resource_info = await client.async_air_quality(lat, lon) | ||
| except NoDataForLocationError: | ||
| return self._show_form_user( | ||
| user_input, | ||
| errors={"base": "no_data_for_location"}, | ||
| ) | ||
| except GoogleAirQualityApiError as ex: | ||
| return self.async_abort( | ||
| reason="access_not_configured", | ||
| description_placeholders={"message": str(ex)}, | ||
| ) | ||
| except Exception: | ||
| self.logger.exception("Unknown error occurred") | ||
| return self.async_abort(reason="unknown") | ||
|
|
||
| unique_id = f"{lat}_{lon}" | ||
|
|
||
| await self.async_set_unique_id(unique_id) | ||
| self._oauth_data.update( | ||
| { | ||
| CONF_LATITUDE: lat, | ||
| CONF_LONGITUDE: lon, | ||
| "region_code": user_resource_info.region_code, | ||
| } | ||
| ) | ||
| self._abort_if_unique_id_configured() | ||
| return self.async_create_entry( | ||
| title=f"Coordinates {lat}, {lon}", data=self._oauth_data | ||
| ) |
There was a problem hiding this comment.
Would it make sense to use subentries here? This way we can use the same account for multiple locations
There was a problem hiding this comment.
Yes, I have implemented it here.
I haven't used subentries before and didn't find any examples in combination with a coordinator. So I'm happy about feedback.
Comment on lines
4
to
15
| "carbon_monoxide": { | ||
| "default": "mdi:molecule-co" | ||
| }, | ||
| "nitrogen_dioxide": { | ||
| "default": "mdi:molecule" | ||
| }, | ||
| "ozone": { | ||
| "default": "mdi:molecule" | ||
| }, | ||
| "sulphur_dioxide": { | ||
| "default": "mdi:molecule" | ||
| } |
There was a problem hiding this comment.
aren't these all device classes?
There was a problem hiding this comment.
Yes, they are, but the API delivers other units, than in the device classes allowed.
There was a problem hiding this comment.
CO is now a device class.
The API provides ppb for NO2, O3 and SO2. But home assistant requires µg/m³
Comment on lines
58
to
62
| "excellent_air_quality", | ||
| "good_air_quality", | ||
| "low_air_quality", | ||
| "moderate_air_quality", | ||
| "poor_air_quality", |
There was a problem hiding this comment.
strip _air_quality imo, easier to template with
There was a problem hiding this comment.
Some regions report for example moderate_air_quality and some moderate_air_pollution. So the stripped version can be confusing.
Comment on lines
179
to
181
| self._attr_translation_placeholders = { | ||
| "local_aqi": coordinator.data.indexes[1].display_name | ||
| } |
There was a problem hiding this comment.
This is the local AQI for the country, in which the selected coordinates are.
For Dutch it would for example be: LKI (NL)
https://developers.google.com/maps/documentation/air-quality/laqis?hl=de
Comment on lines
68
to
132
| "1_blue": "1 - Blue", | ||
| "1_green": "1 - Green", | ||
| "10_33_percent_of_guideline": "10-33% of guideline", | ||
| "1a_very_good_air_quality": "1A - Very good air quality", | ||
| "1b_good_air_quality": "1B - Good air quality", | ||
| "2_cyan": "2 - Cyan", | ||
| "2_light_green": "2 - Light green", | ||
| "2a_acceptable_air_quality": "2A - Acceptable air quality", | ||
| "2b_acceptable_air_quality": "2B - Acceptable air quality", | ||
| "3_green": "3 - Green", | ||
| "3_yellow": "3 - Yellow", | ||
| "33_66_percent_of_guideline": "33-66% of guideline", | ||
| "3a_aggravated_air_quality": "3A - Aggravated air quality", | ||
| "3b_bad_air_quality": "3B - Bad air quality", | ||
| "4_orange": "4 - Orange", | ||
| "4_yellow_watch": "4 - Yellow/Watch", | ||
| "5_orange_alert": "5 - Orange/Alert", | ||
| "5_red": "5 - Red", | ||
| "6_red_alert_plus": "6 - Red/Alert+", | ||
| "66_100_percent_of_guideline": "66-100% of guideline", | ||
| "above_average_air_pollution": "Above average air pollution", | ||
| "acceptable": "Acceptable", | ||
| "acceptable_air_quality": "Acceptable air quality", | ||
| "acutely_unhealthy_air_quality": "Acutely unhealthy air quality", | ||
| "alarm_level": "Alarm level", | ||
| "alert_level": "Alert level", | ||
| "alert_threshold": "Alert threshold", | ||
| "average_air_pollution": "Average air pollution", | ||
| "average_air_quality": "Average air quality", | ||
| "bad_air_quality": "Bad air quality", | ||
| "below_average_air_pollution": "Below average air pollution", | ||
| "caution": "Caution", | ||
| "clean": "Clean", | ||
| "considerable_air_pollution": "Considerable air pollution", | ||
| "degraded_air_quality": "Degraded air quality", | ||
| "desirable_air_quality": "Desirable air quality", | ||
| "emergency": "Emergency", | ||
| "emergency_level": "Emergency level", | ||
| "evident_air_pollution": "Evident air pollution", | ||
| "excellent": "Excellent", | ||
| "excellent_air_quality": "[%key:component::google_air_quality::entity::sensor::uaqi_category::state::excellent_air_quality%]", | ||
| "extremely_bad_air_quality": "Extremely bad air quality", | ||
| "extremely_poor_air_quality": "Extremely poor air quality", | ||
| "extremely_unfavorable_air_quality": "Extremely unfavorable air quality", | ||
| "extremely_unhealthy_air_quality": "Extremely unhealthy air quality", | ||
| "fair_air_quality": "Fair air quality", | ||
| "fairly_good_air_quality": "Fairly good air quality", | ||
| "good": "Good", | ||
| "good_air_quality": "[%key:component::google_air_quality::entity::sensor::uaqi_category::state::good_air_quality%]", | ||
| "greater_than_100_percent_of_guideline": "Greater than 100% of guideline", | ||
| "hazardous_air_quality": "Hazardous air quality", | ||
| "heavily_polluted": "Heavily Polluted", | ||
| "heavy_air_pollution": "Heavy air pollution", | ||
| "high_air_pollution": "High air pollution", | ||
| "high_health_risk": "High health risk", | ||
| "high_pollution": "High pollution", | ||
| "horrible_air_quality": "Horrible air quality", | ||
| "less_than_10_percent_of_guideline": "Less than 10% of guideline", | ||
| "light_air_pollution": "Light air pollution", | ||
| "low_air_pollution": "Low air pollution", | ||
| "low_air_quality": "[%key:component::google_air_quality::entity::sensor::uaqi_category::state::low_air_quality%]", | ||
| "low_health_risk": "Low health risk", | ||
| "low_pollution": "Low pollution", | ||
| "medium_air_pollution": "Medium air pollution", | ||
| "medium_air_quality": "Medium air quality", |
There was a problem hiding this comment.
What in the world does this mean
There was a problem hiding this comment.
These are the different possible values for the air quality in all the countries.
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>
|
Test errors are unrelated |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Breaking change
Proposed change
This PR introduces a new integration for the Google Air Quality API, allowing Home Assistant users to retrieve real-time air quality data based on geographic coordinates.
The integration uses this library: https://github.com/Thomas55555/python-google-air-quality-api
The documentation for the API can be found here: https://developers.google.com/maps/documentation/air-quality
Type of change
Additional information
Checklist
ruff format homeassistant tests)If user exposed functionality or configuration variables are added/changed:
If the code communicates with devices, web services, or third-party tools:
Updated and included derived files by running:
python3 -m script.hassfest.requirements_all.txt.Updated by running
python3 -m script.gen_requirements_all.To help with the load of incoming pull requests: