Document new Airzone MQTT integration #38203
Conversation
Signed-off-by: Álvaro Fernández Rojas <noltari@gmail.com>
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughA new markdown documentation file has been added for the Airzone MQTT integration in Home Assistant. The file provides integration instructions for connecting Home Assistant to Airzone HVAC zoning systems via MQTT. It includes key metadata such as the release version (2025.5), category (Sensor), IoT class (Local Push), and support for configuration flow. The document outlines the architecture with parent and child zones and details the configuration for the MQTT topic as well as the sensor entities for each Airzone thermostat zone. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant HA as "Home Assistant"
participant MQTT as "Airzone MQTT Integration"
participant Web as "Airzone WebServer"
participant HVAC as "Airzone HVAC System"
User->>HA: Configure integration via Airzone Cloud App (MQTT Topic)
HA->>MQTT: Initialize MQTT connection with topic
MQTT->>Web: Request sensor data for HVAC zones
Web->>HVAC: Query HVAC system status
HVAC-->>Web: Return sensor data (temperature, humidity, etc.)
Web-->>MQTT: Relay sensor data
MQTT-->>HA: Update sensor states
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🧰 Additional context used🪛 LanguageToolsource/_integrations/airzone_mqtt.markdown[uncategorized] ~21-~21: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA) 🔇 Additional comments (2)
🪧 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/airzone_mqtt.markdown (2)
17-22: Content Description: Enhance Clarity with PunctuationThe integration description is clear and informative. However, in line 21 consider revising the punctuation for improved readability. For example, adding a comma after "per HVAC system" may help clarify the sentence:
"Note that multiple HVAC systems can be connected to the same Airzone WebServer. In this case, there will be a parent zone per HVAC system, and there may also be child zones for each HVAC system."
🧰 Tools
🪛 LanguageTool
[uncategorized] ~21-~21: Possible missing comma found.
Context: ... there will be a parent zone per HVAC system and there may also be child zones for...(AI_HYDRA_LEO_MISSING_COMMA)
42-42: File Termination: Newline ConsistencyConsider ensuring that the file ends with a newline to maintain formatting consistency across the documentation files.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/airzone_mqtt.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/airzone_mqtt.markdown
[uncategorized] ~21-~21: Possible missing comma found.
Context: ... there will be a parent zone per HVAC system and there may also be child zones for...
(AI_HYDRA_LEO_MISSING_COMMA)
🔇 Additional comments (4)
source/_integrations/airzone_mqtt.markdown (4)
1-15: Metadata Section: Adherence to Integration StandardsThe YAML front matter is well-organized and includes all the required metadata fields: title, description, HA release, category, IoT class, config flow, domain, platforms, codeowners, and integration type. This adheres to Home Assistant's documentation standards.
23-23: Configuration Flow IncludeThe inclusion directive
{% include integrations/config_flow.md %}is correctly used. Please verify that the referenced file exists at the expected location to prevent any broken links in the documentation.
25-28: MQTT Topic Configuration BlockThe configuration block for the MQTT Topic is formatted correctly and provides a clear description. No issues are noted in this segment.
30-42: Sensors Table Formatting and ClarityThe markdown table listing the sensor conditions is clear, well-structured, and informative. It successfully communicates the available sensor information for each Airzone zone.
Signed-off-by: Álvaro Fernández Rojas <noltari@gmail.com>
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
source/_integrations/airzone_mqtt.markdown (1)
17-21: Integration Overview and ReadabilityThe integration description clearly explains the distinction between parent and child zones for HVAC systems. To improve readability, consider adding a comma after “per HVAC system” on line 21. For example:
-In this case, there will be a *parent zone* per HVAC system and there may also be *child zones* for each HVAC system. +In this case, there will be a *parent zone* per HVAC system, and there may also be *child zones* for each HVAC system.🧰 Tools
🪛 LanguageTool
[uncategorized] ~21-~21: Possible missing comma found.
Context: ... there will be a parent zone per HVAC system and there may also be child zones for...(AI_HYDRA_LEO_MISSING_COMMA)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/airzone_mqtt.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/airzone_mqtt.markdown
[uncategorized] ~21-~21: Possible missing comma found.
Context: ... there will be a parent zone per HVAC system and there may also be child zones for...
(AI_HYDRA_LEO_MISSING_COMMA)
🔇 Additional comments (4)
source/_integrations/airzone_mqtt.markdown (4)
1-15: Front Matter Metadata SetupThe front matter metadata is comprehensive and aligns with Home Assistant’s documentation standards. All necessary fields such as
title,description,ha_release,ha_category,ha_iot_class,ha_config_flow,ha_domain,ha_platforms,ha_codeowners, andha_integration_typeare correctly specified.
23-28: Configuration Block for MQTT TopicThe configuration block utilizing
{% configuration_basic %}is well formatted and provides clear instructions regarding the MQTT Topic as configured in the Airzone Cloud app. This is consistent with Home Assistant integration documentation practices.
30-42: Sensors Section Table FormattingThe Sensors section includes an organized table detailing each sensor created for an Airzone Zone. The table columns and descriptions are clear and adhere to the standards for documenting sensor entities.
43-47: Integration Removal InstructionsThe removal instructions are succinct and state that no extra steps are required beyond the standard removal process. The inclusion of the removal snippet using
{% include integrations/remove_device_service.md %}is in line with existing practices.
| A typical Airzone device has a *parent zone* (Master Thermostat) per <abbr title="heating, ventilation, and air conditioning">HVAC</abbr> system, which is the only zone where the HVAC mode can be changed. The rest are *child zones* which can only enable or disable the <abbr title="heating, ventilation, and air conditioning">HVAC</abbr> and adjust the desired temperature on that specific zone. | ||
|
|
||
| Note that multiple <abbr title="Heating, ventilation, and air conditioning">HVAC</abbr> systems can be connected to the same Airzone WebServer. In this case, there will be a *parent zone* per HVAC system and there may also be *child zones* for each HVAC system. | ||
|
|
There was a problem hiding this comment.
are there any prerequisites? Anything I need to have ready before installing the integration? set up an app, login credentials?
Proposed change
Document new Airzone MQTT integration.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit