Add Google Air Quality integration #39107
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 Walkthrough""" WalkthroughA new documentation file for the "Google Air Quality" integration has been added. This file details setup, configuration, features, limitations, and troubleshooting for integrating Google Air Quality data into Home Assistant, including credential requirements, API usage, and sensor information. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant HomeAssistant
participant GoogleAPI
User->>HomeAssistant: Configure Google Air Quality integration
HomeAssistant->>User: Request Google API credentials
User->>HomeAssistant: Provide credentials and location(s)
HomeAssistant->>GoogleAPI: Poll air quality data (every 60 min)
GoogleAPI-->>HomeAssistant: Return air quality data (UAQI, PM10, PM2.5, Category)
HomeAssistant-->>User: Update sensors with latest data
""" Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (6)
source/_integrations/google_air_quality.markdown (6)
25-25: Add missing commas to improve clarity
Introductory adverbs and clauses should be set off with commas for readability.- Additionally you have to create a *Billing Account*. At the time of writing this documentation Google allows 10,000 API calls per month for free. + Additionally, you have to create a *Billing Account*. At the time of writing this documentation, Google allows 10,000 API calls per month for free.
28-28: Rephrase warning overview for grammar and style
Replace awkward prepositions and phrasing to align with HA docs style.- This integration polls every 60 minutes. Here is an overview about how many API calls are performed per month in dependence of the amount of coordinates: + This integration polls every 60 minutes. Here is an overview of how many API calls are performed per month depending on the number of coordinates:🧰 Tools
🪛 LanguageTool
[uncategorized] ~28-~28: The preposition “of” seems more likely in this position.
Context: ...s every 60 minutes. Here is an overview about how many API calls are performed per mo...(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[uncategorized] ~28-~28: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...erformed per month in dependence of the amount of coordinates: Coordinates | API call...(AMOUNTOF_TO_NUMBEROF)
42-42: Remove unnecessary comma before “when”
The comma before “when reaching” is not needed.- ... but you can get an alert, when reaching the budget. + ... but you can get an alert when reaching the budget.🧰 Tools
🪛 LanguageTool
[typographical] ~42-~42: Usually, there’s no comma before “when”.
Context: ...mit your costs, but you can get an alert, when reaching the budget. You may want to se...(IF_NO_COMMA)
43-43: Correct “setup” verb usage and remove extra article
Use “set up” (verb) instead of “setup” (noun), and simplify phrasing.- You may want to setup [disable billing with notifications](...). This can still produce costs in the between incurring costs and receiving budget notifications. + You may want to set up [disable billing with notifications](...). This can still produce costs between incurring costs and receiving budget notifications.🧰 Tools
🪛 LanguageTool
[grammar] ~43-~43: The word “setup” is a noun. The verb is spelled with a space.
Context: ...en reaching the budget. You may want to setup [disable billing with notifications](ht...(NOUN_VERB_CONFUSION)
45-45: Hyphenate “self-aware”
Compound adjectives require a hyphen.- You are always self aware of the costs. + You are always self-aware of the costs.🧰 Tools
🪛 LanguageTool
[misspelling] ~45-~45: This word is normally spelled with a hyphen.
Context: ...g budget notifications. You are always self aware of the costs. {% endwarning %} {% incl...(EN_COMPOUNDS_SELF_AWARE)
56-56: Add comma and article in known limitations
Ensure grammatical accuracy in bullet points.- - Currently only the Universal Air Quality Index (UAQI) is supported as Air Quality Index. + - Currently, only the Universal Air Quality Index (UAQI) is supported as an air quality index.🧰 Tools
🪛 LanguageTool
[uncategorized] ~56-~56: A comma may be missing after the conjunctive/linking adverb ‘Currently’.
Context: ...le_oauth.md %} ## Known limitations - Currently only the Universal Air Quality Index (U...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[uncategorized] ~56-~56: You might be missing the article “an” here.
Context: ...ir Quality Index (UAQI) is supported as Air Quality Index. ## Troubleshooting If ...(AI_EN_LECTOR_MISSING_DETERMINER_AN)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_integrations/google_air_quality.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/google_air_quality.markdown
[uncategorized] ~24-~24: A comma may be missing after the conjunctive/linking adverb ‘Additionally’.
Context: ...Google Calendar](/integrations/google). Additionally you have to create a Billing Account....
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[uncategorized] ~28-~28: The preposition “of” seems more likely in this position.
Context: ...s every 60 minutes. Here is an overview about how many API calls are performed per mo...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[uncategorized] ~28-~28: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...erformed per month in dependence of the amount of coordinates: Coordinates | API call...
(AMOUNTOF_TO_NUMBEROF)
[typographical] ~42-~42: Usually, there’s no comma before “when”.
Context: ...mit your costs, but you can get an alert, when reaching the budget. You may want to se...
(IF_NO_COMMA)
[grammar] ~43-~43: The word “setup” is a noun. The verb is spelled with a space.
Context: ...en reaching the budget. You may want to setup [disable billing with notifications](ht...
(NOUN_VERB_CONFUSION)
[misspelling] ~45-~45: This word is normally spelled with a hyphen.
Context: ...g budget notifications. You are always self aware of the costs. {% endwarning %} {% incl...
(EN_COMPOUNDS_SELF_AWARE)
[uncategorized] ~56-~56: A comma may be missing after the conjunctive/linking adverb ‘Currently’.
Context: ...le_oauth.md %} ## Known limitations - Currently only the Universal Air Quality Index (U...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[uncategorized] ~56-~56: You might be missing the article “an” here.
Context: ...ir Quality Index (UAQI) is supported as Air Quality Index. ## Troubleshooting If ...
(AI_EN_LECTOR_MISSING_DETERMINER_AN)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (1)
source/_integrations/google_air_quality.markdown (1)
7-7: Verifyha_iot_classvalue formatting
Home Assistant frontmatter fields typically use lowercase snake_case for IoT class values (e.g.,cloud_poll). Please confirm thatCloud Pollmatches the expected format or update tocloud_poll.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
source/_integrations/google_air_quality.markdown (4)
25-25: Grammar: Add missing commas.Consider adding commas for clarity:
- Additionally you have to create a *Billing Account*. At the time of writing this documentation Google allows 10,000 API calls per month for free. + Additionally, you have to create a *Billing Account*. At the time of writing this documentation, Google allows 10,000 API calls per month for free.🧰 Tools
🪛 LanguageTool
[uncategorized] ~25-~25: Possible missing comma found.
Context: ...g Account*. At the time of writing this documentation Google allows 10,000 API calls per mont...(AI_HYDRA_LEO_MISSING_COMMA)
28-28: Clarity: Simplify phrasing for API call overview.Rephrase to improve readability and use correct term:
- This integration polls every 60 minutes. Here is an overview about how many API calls are performed per month in dependence of the amount of coordinates: + This integration polls every 60 minutes. Here is an overview of monthly API calls based on the number of coordinates:🧰 Tools
🪛 LanguageTool
[uncategorized] ~28-~28: The preposition “of” seems more likely in this position.
Context: ...s every 60 minutes. Here is an overview about how many API calls are performed per mo...(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[uncategorized] ~28-~28: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...erformed per month in dependence of the amount of coordinates: Coordinates | API call...(AMOUNTOF_TO_NUMBEROF)
43-43: Typo: Use correct verb form.Replace “setup” with the verb “set up”:
- You may want to setup [disable billing with notifications](...). + You may want to set up [disable billing with notifications](...).🧰 Tools
🪛 LanguageTool
[grammar] ~43-~43: The word “setup” is a noun. The verb is spelled with a space.
Context: ...en reaching the budget. You may want to setup [disable billing with notifications](ht...(NOUN_VERB_CONFUSION)
45-45: Typographical: Hyphenate compound adjective.Add a hyphen to “self-aware”:
- You are always self aware of the costs. + You are always self-aware of the costs.🧰 Tools
🪛 LanguageTool
[misspelling] ~45-~45: This word is normally spelled with a hyphen.
Context: ...g budget notifications. You are always self aware of the costs. {% endwarning %} {% incl...(EN_COMPOUNDS_SELF_AWARE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_integrations/google_air_quality.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/google_air_quality.markdown
[uncategorized] ~24-~24: A comma may be missing after the conjunctive/linking adverb ‘Additionally’.
Context: ...Google Calendar](/integrations/google). Additionally you have to create a Billing Account....
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[uncategorized] ~25-~25: Possible missing comma found.
Context: ...g Account*. At the time of writing this documentation Google allows 10,000 API calls per mont...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~28-~28: The preposition “of” seems more likely in this position.
Context: ...s every 60 minutes. Here is an overview about how many API calls are performed per mo...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[uncategorized] ~28-~28: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...erformed per month in dependence of the amount of coordinates: Coordinates | API call...
(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~39-~39: Possible missing comma found.
Context: ...0 | 8,000 12 | 9,600 Consider each restart of Home Assistant is an ad...
(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~42-~42: Usually, there’s no comma before “when”.
Context: ...mit your costs, but you can get an alert, when reaching the budget. You may want to se...
(IF_NO_COMMA)
[grammar] ~43-~43: The word “setup” is a noun. The verb is spelled with a space.
Context: ...en reaching the budget. You may want to setup [disable billing with notifications](ht...
(NOUN_VERB_CONFUSION)
[misspelling] ~45-~45: This word is normally spelled with a hyphen.
Context: ...g budget notifications. You are always self aware of the costs. {% endwarning %} {% incl...
(EN_COMPOUNDS_SELF_AWARE)
[uncategorized] ~56-~56: A comma may be missing after the conjunctive/linking adverb ‘Currently’.
Context: ...le_oauth.md %} ## Known limitations - Currently only the Universal Air Quality Index (U...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[uncategorized] ~56-~56: You might be missing the article “an” here.
Context: ...ir Quality Index (UAQI) is supported as Air Quality Index. ## Troubleshooting If ...
(AI_EN_LECTOR_MISSING_DETERMINER_AN)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (2)
source/_integrations/google_air_quality.markdown (2)
1-16: Frontmatter and Metadata: Looks good.The YAML frontmatter correctly specifies title, description, category, release, IoT class, config flow support, code owners, platforms, integration type, domain, and quality scale. Documentation standards met.
68-75: Entities Section: Definitions accurate.Sensor descriptions for Universal Air Quality Index, Category, PM10, and PM2.5 are correctly defined and formatted.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
source/_integrations/google_air_quality.markdown (4)
18-18: Consistent casing for 'air quality'
To align with common style guidelines, consider lowercasing “Air quality” in the sentence (the API name remains capitalized):- The **Google Air Quality** {% term integration %} provides Air quality data through the Google Air Quality API. + The **Google Air Quality** {% term integration %} provides air quality data through the Google Air Quality API.
22-26: Enhance billing guidance
Great to call out the free tier. Optionally, you could link to pricing details and clarify that charges apply beyond 10,000 calls:- Additionally, you have to create a *Billing Account*. At the time of writing this documentation, Google allows 10,000 API calls per month for free. + Additionally, you have to create a *Billing Account*. At the time of writing this documentation, Google allows 10,000 API calls per month for free. Beyond that, standard Google Cloud rates apply—see [Google Cloud pricing](https://cloud.google.com/pricing) for details.
27-46: Refine wording in usage table and notes
The section can be made clearer and more idiomatic by adjusting prepositions, hyphenating compounds, and rephrasing the restart note:- This integration polls every 60 minutes. Here is an overview about how many API calls are performed per month in dependence of the amount of coordinates: + This integration polls every 60 minutes. Below is an overview of API calls per month, depending on the number of coordinates: ... - Consider each restart of Home Assistant is an additional API call, per coordinate/entry. + Consider that each restart of Home Assistant results in an additional API call per coordinate. - You are always self aware of the costs. + You are always self-aware of the costs.🧰 Tools
🪛 LanguageTool
[uncategorized] ~28-~28: The preposition “of” seems more likely in this position.
Context: ...s every 60 minutes. Here is an overview about how many API calls are performed per mo...(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[uncategorized] ~28-~28: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...erformed per month in dependence of the amount of coordinates: Coordinates | API call...(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~39-~39: Possible missing comma found.
Context: ...0 | 8,000 12 | 9,600 Consider each restart of Home Assistant is an ad...(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~43-~43: The word “setup” is a noun. The verb is spelled with a space.
Context: ...n you reach the budget. You may want to setup [disable billing with notifications](ht...(NOUN_VERB_CONFUSION)
[misspelling] ~45-~45: This word is normally spelled with a hyphen.
Context: ...g budget notifications. You are always self aware of the costs. {% endimportant %} {% in...(EN_COMPOUNDS_SELF_AWARE)
54-57: Insert comma after 'Currently'
Improve readability by adding a comma after “Currently”:- - Currently only the Universal Air Quality Index (UAQI) is supported as Air Quality Index. + - Currently, only the Universal Air Quality Index (UAQI) is supported as Air Quality Index.🧰 Tools
🪛 LanguageTool
[uncategorized] ~56-~56: A comma may be missing after the conjunctive/linking adverb ‘Currently’.
Context: ...le_oauth.md %} ## Known limitations - Currently only the Universal Air Quality Index (U...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[uncategorized] ~56-~56: You might be missing the article “an” here.
Context: ...ir Quality Index (UAQI) is supported as Air Quality Index. ## Supported functional...(AI_EN_LECTOR_MISSING_DETERMINER_AN)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_integrations/google_air_quality.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/google_air_quality.markdown
[uncategorized] ~28-~28: The preposition “of” seems more likely in this position.
Context: ...s every 60 minutes. Here is an overview about how many API calls are performed per mo...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[uncategorized] ~28-~28: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...erformed per month in dependence of the amount of coordinates: Coordinates | API call...
(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~39-~39: Possible missing comma found.
Context: ...0 | 8,000 12 | 9,600 Consider each restart of Home Assistant is an ad...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~43-~43: The word “setup” is a noun. The verb is spelled with a space.
Context: ...n you reach the budget. You may want to setup [disable billing with notifications](ht...
(NOUN_VERB_CONFUSION)
[misspelling] ~45-~45: This word is normally spelled with a hyphen.
Context: ...g budget notifications. You are always self aware of the costs. {% endimportant %} {% in...
(EN_COMPOUNDS_SELF_AWARE)
[uncategorized] ~56-~56: A comma may be missing after the conjunctive/linking adverb ‘Currently’.
Context: ...le_oauth.md %} ## Known limitations - Currently only the Universal Air Quality Index (U...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[uncategorized] ~56-~56: You might be missing the article “an” here.
Context: ...ir Quality Index (UAQI) is supported as Air Quality Index. ## Supported functional...
(AI_EN_LECTOR_MISSING_DETERMINER_AN)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (5)
source/_integrations/google_air_quality.markdown (5)
1-16: Frontmatter follows Home Assistant standards
The YAML frontmatter includes all required keys (title,description,ha_category,ha_release,ha_iot_class,ha_config_flow,ha_codeowners,ha_platforms,ha_integration_type,ha_domain,ha_quality_scale) and correctly usesbronzefor a beta‐quality integration.
48-53: Verify snippet includes
Confirm that the following snippet files exist and are up to date insource/_integrations/integrations/(or the appropriate docs path):
google_client_secret.mdconfig_flow.mdgoogle_oauth.md
62-72: Sensor descriptions are accurate and well-formatted
The sensor list correctly includes:
- Proper apostrophe in “Google's AQI”
- Closed italic formatting for Category
- Accurate definitions for PM10 and PM2.5
73-76: Troubleshooting guidance is clear
The steps for deleting credentials via the Application Credentials UI are straightforward and actionable.
77-81: Removal instructions present
Including theremove_device_service.mdsnippet ensures users can cleanly uninstall the integration.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
81-81: Multiple consecutive blank lines
Expected: 1; Actual: 2(MD012, no-multiple-blanks)
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (7)
source/_integrations/google_air_quality.markdown (7)
18-18: Use consistent casing for 'air quality data'
Lowercase generic terms for clarity and consistency:-The **Google Air Quality** {% term integration %} provides Air quality data through the Google Air Quality API. +The **Google Air Quality** {% term integration %} provides air quality data through the Google Air Quality API.
25-26: Refine billing account instruction
Use lowercase for generic terms and improve phrasing:-Additionally, you have to create a *Billing Account*. At the time of writing this documentation, Google allows 10,000 API calls per month for free. +Additionally, you must create a billing account. At the time of writing, Google provides 10,000 free API calls per month.
28-29: Improve phrasing for API call overview
The sentence is awkward; consider rewording:-This integration polls every 60 minutes. Here is an overview about how many API calls are performed per month in dependence of the amount of coordinates: +This integration polls every 60 minutes. The table below shows the number of API calls per month based on the number of configured coordinates:🧰 Tools
🪛 LanguageTool
[uncategorized] ~28-~28: The preposition “of” seems more likely in this position.
Context: ...s every 60 minutes. Here is an overview about how many API calls are performed per mo...(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[uncategorized] ~28-~28: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...erformed per month in dependence of the amount of coordinates: Coordinates | API call...(AMOUNTOF_TO_NUMBEROF)
40-41: Clarify restart behavior wording
Refine the sentence for clarity:-Consider each restart of Home Assistant is an additional API call, per coordinate/entry. +Each restart of Home Assistant triggers an additional API call for every configured coordinate.
43-44: Correct verb form 'set up'
Use "set up" (verb) instead of "setup" (noun):-You may want to setup [disable billing with notifications](https://cloud.google.com/billing/docs/how-to/disable-billing-with-notifications). +You may want to set up [disable billing with notifications](https://cloud.google.com/billing/docs/how-to/disable-billing-with-notifications).🧰 Tools
🪛 LanguageTool
[grammar] ~43-~43: The word “setup” is a noun. The verb is spelled with a space.
Context: ...n you reach the budget. You may want to setup [disable billing with notifications](ht...(NOUN_VERB_CONFUSION)
45-45: Hyphenate 'self-aware'
Add a hyphen for correct spelling:-You are always self aware of the costs. +You are always self-aware of the costs.🧰 Tools
🪛 LanguageTool
[misspelling] ~45-~45: This word is normally spelled with a hyphen.
Context: ...g budget notifications. You are always self aware of the costs. {% endimportant %} {% in...(EN_COMPOUNDS_SELF_AWARE)
56-57: Add comma and article for clarity
Improve readability in the Known limitations:-Currently only the Universal Air Quality Index (UAQI) is supported as Air Quality Index. +Currently, only the Universal Air Quality Index (UAQI) is supported as the Air Quality Index.🧰 Tools
🪛 LanguageTool
[uncategorized] ~56-~56: A comma may be missing after the conjunctive/linking adverb ‘Currently’.
Context: ...le_oauth.md %} ## Known limitations - Currently only the Universal Air Quality Index (U...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[uncategorized] ~56-~56: You might be missing the article “an” here.
Context: ...ir Quality Index (UAQI) is supported as Air Quality Index. ## Supported functional...(AI_EN_LECTOR_MISSING_DETERMINER_AN)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_integrations/google_air_quality.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/google_air_quality.markdown
[uncategorized] ~28-~28: The preposition “of” seems more likely in this position.
Context: ...s every 60 minutes. Here is an overview about how many API calls are performed per mo...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[uncategorized] ~28-~28: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...erformed per month in dependence of the amount of coordinates: Coordinates | API call...
(AMOUNTOF_TO_NUMBEROF)
[grammar] ~43-~43: The word “setup” is a noun. The verb is spelled with a space.
Context: ...n you reach the budget. You may want to setup [disable billing with notifications](ht...
(NOUN_VERB_CONFUSION)
[misspelling] ~45-~45: This word is normally spelled with a hyphen.
Context: ...g budget notifications. You are always self aware of the costs. {% endimportant %} {% in...
(EN_COMPOUNDS_SELF_AWARE)
[uncategorized] ~56-~56: A comma may be missing after the conjunctive/linking adverb ‘Currently’.
Context: ...le_oauth.md %} ## Known limitations - Currently only the Universal Air Quality Index (U...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[uncategorized] ~56-~56: You might be missing the article “an” here.
Context: ...ir Quality Index (UAQI) is supported as Air Quality Index. ## Supported functional...
(AI_EN_LECTOR_MISSING_DETERMINER_AN)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (5)
source/_integrations/google_air_quality.markdown (5)
31-39: Verify accuracy of API call counts
The sample values (e.g., 800 calls for 1 coordinate) don’t align with a strict 60-minute polling schedule (24 × 30 = 720). Please confirm whether these figures are approximations or require correction.
48-53: Include statements look correct
The snippets forgoogle_client_secret,config_flow, andgoogle_oauthare properly included.
64-68: Sensor descriptions are accurate and formatted correctly
The descriptions for UAQI, Category, PM10, and PM2.5 accurately reflect their meanings and follow markdown conventions.
71-72: Troubleshooting instructions look good
The guidance for deleting credentials via the Application Credentials UI is clear and correctly linked.
73-76: Removal instructions are correctly included
The snippet for removing the integration is present and appropriate.
…ome-assistant.io into google_air_quality
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
source/_integrations/google_air_quality.markdown (1)
7-7: Fix IoT class metadata formatting
Theha_iot_classvalue should follow Home Assistant conventions and be in snake_case.-ha_iot_class: Cloud Poll +ha_iot_class: cloud_poll
🧹 Nitpick comments (3)
source/_integrations/google_air_quality.markdown (3)
43-43: Correct verb form: set up vs. setup
Use the verb phrase "set up" instead of the noun "setup" for clarity.-You may want to setup [disable billing with notifications] +You may want to set up [disable billing with notifications]
45-45: Hyphenate "self-aware"
The compound adjective should be hyphenated.-You are always self aware of the costs. +You are always self-aware of the costs.
28-28: Rephrase for grammatical accuracy
Consider using "overview of the number of API calls performed" instead of "overview about how many API calls are performed".-Here is an overview about how many API calls are performed per month +Here is an overview of the number of API calls performed per month
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
⛔ Files ignored due to path filters (1)
Gemfile.lockis excluded by!**/*.lock
📒 Files selected for processing (1)
source/_integrations/google_air_quality.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/google_air_quality.markdown
[uncategorized] ~28-~28: The preposition “of” seems more likely in this position.
Context: ...s every 60 minutes. Here is an overview about how many API calls are performed per mo...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[uncategorized] ~28-~28: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...erformed per month in dependence of the amount of coordinates: Coordinates | API call...
(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~39-~39: Possible missing comma found.
Context: ...0 | 8,000 12 | 9,600 Consider each restart of Home Assistant is an ad...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~43-~43: The word “setup” is a noun. The verb is spelled with a space.
Context: ...n you reach the budget. You may want to setup [disable billing with notifications](ht...
(NOUN_VERB_CONFUSION)
[misspelling] ~45-~45: This word is normally spelled with a hyphen.
Context: ...g budget notifications. You are always self aware of the costs. {% endimportant %} {% in...
(EN_COMPOUNDS_SELF_AWARE)
[uncategorized] ~56-~56: A comma may be missing after the conjunctive/linking adverb ‘Currently’.
Context: ...le_oauth.md %} ## Known limitations - Currently only the Universal Air Quality Index (U...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[uncategorized] ~63-~63: A comma might be missing here.
Context: ...e following sensors: For your local air quality you can find more details [here](https:...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/google_air_quality.markdown
66-66: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
source/_integrations/google_air_quality.markdown (1)
6-7: Metadata: Use snake_case forha_iot_class
Theha_iot_classfield should use snake_case to conform with Home Assistant documentation conventions.
Apply this diff:-ha_iot_class: Cloud Poll +ha_iot_class: cloud_poll
🧹 Nitpick comments (3)
source/_integrations/google_air_quality.markdown (3)
18-18: Fix capitalization in description sentence
"Provides Air quality data" should use lowercase "air" for consistency.-The **Google Air Quality** {% term integration %} provides Air quality data through the Google Air Quality API. +The **Google Air Quality** {% term integration %} provides air quality data through the Google Air Quality API.
45-45: Refine awkward phrasing
The sentence "You are always self aware of the costs." reads awkwardly.
Consider rephrasing:-You are always self aware of the costs. +You are always aware of any incurred costs.
72-72: Add missing comma in list of pollutants
In the UAQI Dominant Pollutant description, separate "Sulphur Dioxide (SO₂)" and "Carbon Monoxide (CO)" with a comma.-*The pollutant that most significantly influences the UAQI value. Possible values include: PM2.5, PM10, Ozone (O₃), Nitrogen Dioxide (NO₂), Sulphur Dioxide (SO₂) Carbon Monoxide (CO)* +*The pollutant that most significantly influences the UAQI value. Possible values include: PM2.5, PM10, Ozone (O₃), Nitrogen Dioxide (NO₂), Sulphur Dioxide (SO₂), Carbon Monoxide (CO)*
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
⛔ Files ignored due to path filters (1)
Gemfile.lockis excluded by!**/*.lock
📒 Files selected for processing (1)
source/_integrations/google_air_quality.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/google_air_quality.markdown
[uncategorized] ~24-~24: La lettre x peut être remplacée par un autre signe typographique.
Context: ...ns/google_mail). These are not the same as Device Auth credentials previously reco...
(ASTERISQUE)
[uncategorized] ~25-~25: La lettre x peut être remplacée par un autre signe typographique.
Context: ...ogle). Additionally, you have to create a Billing Account. At the time of writing...
(ASTERISQUE)
[uncategorized] ~28-~28: Les deux-points sont précédés d’une espace insécable.
Context: ...er month in dependence of the amount of coordinates: Coordinates | API calls per month ----...
(FRENCH_WHITESPACE)
[uncategorized] ~62-~62: Les deux-points sont précédés d’une espace insécable.
Context: ...e integration will create the following sensors: For your local air quality you can find...
(FRENCH_WHITESPACE)
[typographical] ~63-~63: Pas de correspondance fermante ou ouvrante pour le caractère « ] »
Context: ...l air quality you can find more details [here](https://developers.google.com/maps...
(UNPAIRED_BRACKETS)
[uncategorized] ~66-~66: S’il s’agit d’un impératif, pas de “s”.
Context: ...l air quality index provided by Google. Ranges from 0 (worst) to 100 (best).* - **UAQ...
(grammalecte_gv1__imp_verbe_groupe1__b2_a1_1)
[uncategorized] ~69-~69: Les deux-points sont précédés d’une espace insécable.
Context: ...tive category for UAQI. Possible values include: Excellent air quality, Good air quality...
(FRENCH_WHITESPACE)
[uncategorized] ~69-~69: Ce mot doit commencer par une minuscule.
Context: ...gory for UAQI. Possible values include: Excellent air quality, Good air quality, Moderate...
(DEUX_POINTS_MAJ)
[uncategorized] ~72-~72: Les deux-points sont précédés d’une espace insécable.
Context: ...luences the UAQI value. Possible values include: PM2.5, PM10, Ozone (O₃), Nitrogen Dioxi...
(FRENCH_WHITESPACE)
[uncategorized] ~72-~72: Une virgule semble être requise.
Context: ...itrogen Dioxide (NO₂), Sulphur Dioxide (SO₂) Carbon Monoxide (CO)* - **Local Air Qu...
(AI_FR_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~78-~78: Un verbe conjugué à la troisième personne semble plus approprié.
Context: ...The values can differ from the ones set as UAQI Category.* - **Local Dominant Pol...
(ACCORD_R_PERS_VERBE)
[uncategorized] ~81-~81: Un verbe conjugué à la troisième personne semble plus approprié.
Context: ...The values can differ from the ones set as UAQI Dominant Pollutant.* - PM2.5 ...
(ACCORD_R_PERS_VERBE)
[uncategorized] ~84-~84: Une virgule sépare le nombre entier et décimal.
Context: ...** Particulate matter smaller than 2.5 µm in diameter. - PM10 *Parti...
(VIRGULE_NOMBRE)
[uncategorized] ~103-~103: Une préposition ou un déterminant semble plus adéquat qu’un nom.
Context: ...tion.* ## Troubleshooting If you have an error with your credentials, you can de...
(AN_EN)
[uncategorized] ~103-~103: Le pluriel d’un nom ou d’un adjectif finissant par « -al » est « -aux ».
Context: ...ete them in the Application Credentials user interface. ## Removing the inte...
(PLURIEL_AL2)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
There was a problem hiding this comment.
Pull Request Overview
This PR introduces documentation for the new Google Air Quality integration, guiding users through setup, supported sensors, and troubleshooting.
- Adds a new integration page with prerequisites, setup flow, and billing considerations
- Details supported sensor entities and API usage limits
- Includes troubleshooting and removal instructions
Comments suppressed due to low confidence (3)
source/_integrations/google_air_quality.markdown:28
- [nitpick] Rephrase the sentence for clarity. For example: "Here is an overview of monthly API calls based on the number of configured coordinates:"
This integration polls every 60 minutes. Here is an overview about how many API calls are performed per month in dependence of the amount of coordinates:
source/_integrations/google_air_quality.markdown:45
- [nitpick] Consider rewording to emphasize user responsibility and clarity, e.g., "You are responsible for monitoring any costs incurred."
You are always self aware of the costs.
source/_integrations/google_air_quality.markdown:63
- [nitpick] Rephrase for readability, e.g., "For details on local air quality data, see the Google Maps documentation on LAQIs."
For your local air quality you can find more details [here](https://developers.google.com/maps/documentation/air-quality/laqis)
| *Descriptive category for UAQI. Possible values include: Excellent air quality, Good air quality, Moderate air quality, Low air quality, Poor air quality.* | ||
|
|
||
| - **UAQI Dominant Pollutant** | ||
| *The pollutant that most significantly influences the UAQI value. Possible values include: PM2.5, PM10, Ozone (O₃), Nitrogen Dioxide (NO₂), Sulphur Dioxide (SO₂) Carbon Monoxide (CO)* |
There was a problem hiding this comment.
Add a comma between the two pollutant names: "Sulphur Dioxide (SO₂), Carbon Monoxide (CO)".
| *The pollutant that most significantly influences the UAQI value. Possible values include: PM2.5, PM10, Ozone (O₃), Nitrogen Dioxide (NO₂), Sulphur Dioxide (SO₂) Carbon Monoxide (CO)* | |
| *The pollutant that most significantly influences the UAQI value. Possible values include: PM2.5, PM10, Ozone (O₃), Nitrogen Dioxide (NO₂), Sulphur Dioxide (SO₂), Carbon Monoxide (CO)* |
Copilot uses AI. Check for mistakes.
Proposed change
Add Google Air Quality integration
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit