Sync AirGradient entities with the codebase #37936
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe pull request updates the AirGradient integration documentation by adding a new sensor and several configuration entities. The documentation now includes the "Raw PM2.5" sensor to enhance data collection. In addition, multiple new configuration entities are detailed for automation and device setup. These include options for calibration, offset values, LED bar settings, brightness controls, and display standards. The updates expand the documentation with more detailed configuration options for the AirGradient devices. Changes
Tip ⚡💬 Agentic Chat (Pro Plan, General Availability)
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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: 0
🧹 Nitpick comments (2)
source/_integrations/airgradient.markdown (2)
53-60: Configuration Entities as Sensors: Clarity & Markdown Formatting
The block introducing configuration entities available as sensors is a useful addition. To improve readability and align with markdownlint (MD032) guidelines, consider adding a blank line before the bullet list. Additionally, note that the phrases “Data used for the LED bar” and “LED bar brightness” appear consecutively—verify that this duplication is intentional and that the distinction between these two configuration entities is clear to your users.🧰 Tools
🪛 LanguageTool
[grammar] ~57-~57: This phrase is duplicated. You should probably use “LED bar” only once.
Context: ...nds learning offset - Data used for the LED bar - LED bar brightness - Display temperature unit -...(PHRASE_REPETITION)
🪛 markdownlint-cli2 (0.17.2)
54-54: Lists should be surrounded by blank lines
null(MD032, blanks-around-lists)
74-79: Configuration Entities Update: Consistency and Duplication Check
The newly added configuration entities ("Configuration source", "Data used for the LED bar", "Display PM standard", "CO2 automatic baseline calibration days", "NOx learning offset", and "Total volatile organic compounds learning offset") enhance the customization options. Please double-check that these entities are presented consistently with the sensor-based configuration section and that any duplicate phrasing (particularly regarding “LED bar”) is deliberate, avoiding potential confusion in the user documentation.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/airgradient.markdown(2 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/airgradient.markdown
[grammar] ~57-~57: This phrase is duplicated. You should probably use “LED bar” only once.
Context: ...nds learning offset - Data used for the LED bar - LED bar brightness - Display temperature unit -...
(PHRASE_REPETITION)
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/airgradient.markdown
54-54: 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
🔇 Additional comments (1)
source/_integrations/airgradient.markdown (1)
48-48: New Sensor Addition: "Raw PM2.5"
The addition of the "Raw PM2.5" sensor to the supported sensors list is appropriate and clearly reflects the expanded data collection capabilities. Please ensure that the integration logic elsewhere (if applicable) recognizes this new sensor.
| - Signal strength | ||
| - Temperature | ||
| - Total volatile organic compounds index | ||
|
|
||
| A number of configuration entities are available as sensors to automate with if you set up the device via AirGradient instead. |
There was a problem hiding this comment.
what do you mean by "if you set up the device via AirGradient instead"?
There was a problem hiding this comment.
You can set up the device both via the cloud and locally. So if you set airgradient up via the cloud, you can still see the settings of the device, but not as an entity that can be updated using HA
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
# Conflicts: # source/_integrations/airgradient.markdown
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
source/_integrations/airgradient.markdown (2)
59-67: Clarify and Rephrase the Configuration Entities Introduction
The sentence on line 59—"A number of configuration entities are available as sensors to automate with if you control the device via the AirGradient dashboard instead of set it to control locally."
—can be made clearer and more parallel. Consider rephrasing it to something like:
"A number of configuration entities are available for automation when you control the device via the AirGradient dashboard rather than locally."
Additionally, note that markdownlint (MD032) suggests that list items (lines 60–67) should be surrounded by blank lines. A simple adjustment in the markdown formatting would improve readability.🧰 Tools
🪛 LanguageTool
[grammar] ~63-~63: This phrase is duplicated. You should probably use “LED bar” only once.
Context: ...nds learning offset - Data used for the LED bar - LED bar brightness - Display temperature unit -...(PHRASE_REPETITION)
🪛 markdownlint-cli2 (0.17.2)
60-60: Lists should be surrounded by blank lines
null(MD032, blanks-around-lists)
63-64: Re-evaluate Repetition of the 'LED bar' Phrase
Static analysis flagged a potential repeated use of "LED bar" in the items "Data used for the LED bar" (line 63) and "LED bar brightness" (line 64). While these likely refer to distinct configuration parameters, consider revising one of the labels for extra clarity (or adding additional context in the documentation) if the duplicated phrase could cause confusion.🧰 Tools
🪛 LanguageTool
[grammar] ~63-~63: This phrase is duplicated. You should probably use “LED bar” only once.
Context: ...nds learning offset - Data used for the LED bar - LED bar brightness - Display temperature unit -...(PHRASE_REPETITION)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/airgradient.markdown(2 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/airgradient.markdown
[grammar] ~63-~63: This phrase is duplicated. You should probably use “LED bar” only once.
Context: ...nds learning offset - Data used for the LED bar - LED bar brightness - Display temperature unit -...
(PHRASE_REPETITION)
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/airgradient.markdown
60-60: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
🔇 Additional comments (2)
source/_integrations/airgradient.markdown (2)
54-54: New Sensor Addition: "Raw PM2.5"
The addition of the "Raw PM2.5" sensor aligns well with the intent to expand data collection capabilities.
80-85: Review the Newly Added Configuration Entities
The new configuration entities—"Configuration source", "Data used for the LED bar", "Display PM standard", "CO2 automatic baseline calibration days", "NOx learning offset", and "Total volatile organic compounds learning offset"—are well aligned with the PR objectives. Please verify that their naming and any accompanying explanations elsewhere in the documentation are consistent.
Proposed change
Sync AirGradient entities with the codebase
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit