Adding documentation for ActronAir integration #38474
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 Walkthrough""" WalkthroughA new integration for ActronAir has been added to Home Assistant. This integration enables control of ActronAir Neo Air Conditioning systems via cloud polling. It supports multiple A/C systems per user, creating climate entities for the master controller and each zone, with controls for mode, fan speed, temperature set points, and zone on/off functionality. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant HomeAssistant
participant ActronAirCloud
participant AC_Controller
User->>HomeAssistant: Enter ActronAir credentials and select A/C system
HomeAssistant->>ActronAirCloud: Authenticate and fetch system details
ActronAirCloud-->>HomeAssistant: Return metadata and zone info
HomeAssistant->>AC_Controller: Send control commands (mode, fan speed, temperature)
AC_Controller-->>HomeAssistant: Respond with updated state
HomeAssistant-->>User: Display current A/C status and controls
""" 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (3)
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: 0
🧹 Nitpick comments (6)
source/_integrations/actronair.markdown (6)
1-17: Metadata and YAML Front-Matter Review
The YAML metadata is well-structured overall. However, note that line 15 contains trailing spaces which might trigger markdownlint warnings.
19-19: Wording Clarification in Introduction
Consider changing “controllers into Home Assistant” to “controllers in Home Assistant” to align with conventional phrasing.
23-23: Typo Correction in Prerequisites
There is a typo: “credentails” should be corrected to “credentials”.- The premium wall-mounted touchscreen control system [NEO](https://actronair.com.au/products/residential/residential-controls/neo/),must be configured with a user account and connected to the cloud. The user credentails should be entered on the integrations page in Home Assistant. + The premium wall-mounted touchscreen control system [NEO](https://actronair.com.au/products/residential/residential-controls/neo/), must be configured with a user account and connected to the cloud. The user credentials should be entered on the integrations page in Home Assistant.
31-31: Remove Trailing Whitespace in Markdown Content
Trailing whitespace detected on this line. Removing it will help satisfy markdownlint rules.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
31-31: Trailing spaces
Expected: 0 or 2; Actual: 1(MD009, no-trailing-spaces)
36-36: Typo Correction in Entity Description
Replace “creats” with “creates” for clarity in describing the climate entity.- The integration creats a climate entity for the master controller as well as each of the zones. + The integration creates a climate entity for the master controller as well as each of the zones.
39-40: Enhance Grammatical Clarity for Controller Descriptions
It is recommended to add missing articles and adjust phrasing for better clarity. For example, prepend “The” to both “Master controller” and “Zone controller”, and use “provides the ability” for smoother reading.- Master controller provides ability to change the AC Mode and Fan Speed besides master temperature set point. - Zone controller provides ability to turn ON/OFF a zone. Depending on the availability of zone sensor/controller, option to change the set point temperature is provided. + The master controller provides the ability to change the AC Mode, Fan Speed, and the master temperature set point. + The zone controller provides the ability to turn a zone ON/OFF. Depending on the availability of a zone sensor/controller, the option to change the set point temperature is provided.🧰 Tools
🪛 LanguageTool
[uncategorized] ~39-~39: You might be missing the article “the” here.
Context: ...bled zones. Master controller provides ability to change the AC Mode and Fan Speed bes...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~40-~40: Possible missing article found.
Context: ...ure set point. Zone controller provides ability to turn ON/OFF a zone. Depending on the...(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~40-~40: You might be missing the article “the” here.
Context: ...availability of zone sensor/controller, option to change the set point temperature is ...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/actronair.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/actronair.markdown
[uncategorized] ~38-~38: A determiner appears to be missing. Consider inserting it.
Context: ...enabled for each of the enabled zones. Master controller provides ability to change t...
(AI_EN_LECTOR_MISSING_DETERMINER)
[uncategorized] ~39-~39: You might be missing the article “the” here.
Context: ...bled zones. Master controller provides ability to change the AC Mode and Fan Speed bes...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~40-~40: Possible missing article found.
Context: ...ure set point. Zone controller provides ability to turn ON/OFF a zone. Depending on the...
(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~40-~40: You might be missing the article “the” here.
Context: ...availability of zone sensor/controller, option to change the set point temperature is ...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/actronair.markdown
31-31: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
⏰ 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: 1
🧹 Nitpick comments (3)
source/_integrations/actronair.markdown (3)
20-23: Grammar & punctuation fixes for prerequisites paragraph
Minor readability issues: missing space after the comma and an unnecessary comma before must.-The premium wall-mounted touchscreen control system [NEO](https://actronair.com.au/products/residential/residential-controls/neo/),must be configured with a user account and connected to the cloud. +The premium wall-mounted touchscreen control system [NEO](https://actronair.com.au/products/residential/residential-controls/neo/) must be configured with a user account and connected to the cloud.
28-28: Plural / article agreement-If a user has multiple A/C systems associated to their account, every zones and wall controller is treated as individual climate device. +If a user has multiple A/C systems associated with their account, each zone and wall controller is treated as an individual climate device.
32-36: Improve wording & comma placement for clarity-The integration creates a climate entity for the master controller as well as each of the zones. -Based on the zone capability such as temperature-controlled, controls are enabled for each of the enabled zones. - -The master controller provides the ability to change the AC Mode, Fan Speed, and the master temperature set point. -The zone controller provides the ability to turn a zone ON/OFF. Depending on the availability of a zone sensor/controller, the option to change the set point temperature is provided. +The integration creates one climate entity for the master controller and one for each zone. +Controls are enabled per zone based on its capabilities (e.g., temperature control). + +The master controller entity lets you change the AC mode, fan speed, and master set-point temperature. +Each zone entity lets you turn the zone on/off and, when a zone sensor/controller is present, adjust its set-point temperature.
📜 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/actronair.markdown(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`source/_integrations/*`: Integration documentation must use the provided template structure and section order.
source/_integrations/*: Integration documentation must use the provided template structure and section order.
source/_integrations/actronair.markdown
🪛 LanguageTool
source/_integrations/actronair.markdown
[grammar] ~28-~28: The noun should probably be in the singular form.
Context: ...tems associated to their account, every zones and wall controller is treated as indiv...
(EVERY_EACH_SINGULAR)
[uncategorized] ~28-~28: You might be missing the article “an” here.
Context: ...zones and wall controller is treated as individual climate device. ### Climate The integ...
(AI_EN_LECTOR_MISSING_DETERMINER_AN)
[uncategorized] ~33-~33: Possible missing comma found.
Context: ...as each of the zones. Based on the zone capability such as temperature-controlled, control...
(AI_HYDRA_LEO_MISSING_COMMA)
⏰ 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/actronair.markdown (1)
7-7:ha_releaselooks invalid – confirm correct Home-Assistant version tagIntegration docs usually pin the Home Assistant release in which the integration first ships (e.g.
2025.6.0).
0.0.1does not correspond to any Home Assistant version and will fail validation.Please verify the intended release and replace the value accordingly.
Proposed change
Documentation for a new integration named ActronAir (Neo)
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit