-
-
Notifications
You must be signed in to change notification settings - Fork 7.7k
Add documentation for hanna
integration
#39617
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: next
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughA new documentation file for the Hanna integration has been added to Home Assistant. This file details the integration's configuration, supported sensors, update frequency, and removal process. It provides metadata, setup instructions, and descriptions for each sensor available via the HannaCloud account connection. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant HomeAssistant
participant HannaCloud
User->>HomeAssistant: Configure Hanna integration (email, password)
HomeAssistant->>HannaCloud: Authenticate and connect using credentials
loop Every 5 seconds
HomeAssistant->>HannaCloud: Poll for sensor data
HannaCloud-->>HomeAssistant: Return sensor readings
HomeAssistant-->>User: Update sensors in UI
end
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🧹 Nitpick comments (3)
source/_integrations/hanna.markdown (3)
30-31
: Correct spelling of “associated.”Typo in the password description:
- description: The password assiciated with your [HannaCloud](https://www.hannacloud.com) account + description: The password associated with your [HannaCloud](https://www.hannacloud.com) account
21-21
: Remove trailing whitespace.Lines 21 and 36 end with extra spaces, which violates Markdown lint rules:
- HannaCloud is· + HannaCloud is - The integration will update its sensors by polling the [HannaCloud](https://www.hannacloud.com) account every 5 seconds for new values.· + The integration will update its sensors by polling the [HannaCloud](https://www.hannacloud.com) account every 5 seconds for new values.Also applies to: 36-36
38-39
: Condense multiple blank lines.There are two consecutive blank lines here; please reduce to a single blank line to comply with style guidelines:
- - +
📜 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/hanna.markdown
(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/hanna.markdown
21-21: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
36-36: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
38-38: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
|
||
The **Hanna** {% term integration %} fetches data from your [Hanna Pool Controller](https://www.hannainstruments.be/en/Applicatons-measure-analyze/swimming-pool/ph-chlorine-control/systems/) device, by connecting to your [HannaCloud](https://www.hannacloud.com) account. | ||
|
||
HannaCloud is |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
HannaCloud is |
Did you want to add some more details here?
|
||
## Data updates | ||
|
||
The integration will update its sensors by polling the [HannaCloud](https://www.hannacloud.com) account every 5 seconds for new values. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The integration will update its sensors by polling the [HannaCloud](https://www.hannacloud.com) account every 5 seconds for new values. | |
The integration will update its sensors by {% term polling %} the [HannaCloud](https://www.hannacloud.com) account every 5 seconds for new values. |
- Air Temperature: Air Temperature reported by the device | ||
- Alarms: Binary sensor with alarm and warning details as attributes | ||
- Chlorine Flow Rate: Monitors chlorine dosing rate | ||
- Chlorine ORP value: Measures oxidation-reduction potential with calibration data as attributes | ||
- Chlorine Pump Status: Indicates if the pump is running or not | ||
- pH Acid/Base Flow Rate: Monitors acid/base (pH-) chemical dosing rate | ||
- pH Pump Status: Indicates if the pump is running or not | ||
- pH value: Measures pH level with calibration data as attributes | ||
- Service Status: Reports the condition of the device's service light | ||
- System Status: Reports the overall system status | ||
- Water Temperature: Water temperature reported by the device |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Air Temperature: Air Temperature reported by the device | |
- Alarms: Binary sensor with alarm and warning details as attributes | |
- Chlorine Flow Rate: Monitors chlorine dosing rate | |
- Chlorine ORP value: Measures oxidation-reduction potential with calibration data as attributes | |
- Chlorine Pump Status: Indicates if the pump is running or not | |
- pH Acid/Base Flow Rate: Monitors acid/base (pH-) chemical dosing rate | |
- pH Pump Status: Indicates if the pump is running or not | |
- pH value: Measures pH level with calibration data as attributes | |
- Service Status: Reports the condition of the device's service light | |
- System Status: Reports the overall system status | |
- Water Temperature: Water temperature reported by the device | |
- Air temperature: Air temperature reported by the device | |
- Alarms: Binary sensor with alarm and warning details as attributes | |
- Chlorine flow rate: Monitors chlorine dosing rate | |
- Chlorine ORP value: Measures oxidation-reduction potential with calibration data as attributes | |
- Chlorine pump status: Indicates if the pump is running or not | |
- pH Acid/base flow rate: Monitors acid/base (pH-) chemical dosing rate | |
- pH Pump status: Indicates if the pump is running or not | |
- pH value: Measures pH level with calibration data as attributes | |
- Service status: Reports the condition of the device's service light | |
- System status: Reports the overall system status | |
- Water temperature: Water temperature reported by the device |
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
The **Hanna** {% term integration %} fetches data from your [Hanna Pool Controller](https://www.hannainstruments.be/en/Applicatons-measure-analyze/swimming-pool/ph-chlorine-control/systems/) device, by connecting to your [HannaCloud](https://www.hannacloud.com) account. | ||
|
||
HannaCloud is | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
are there any prerequistes? Anything I need before I can add the integration? For example, a Hanna account, an app installed, or login credentials?
Proposed change
Added documentation for a new integration I'm adding to Home Assistant (domain=hanna).
The Integration will connect to Hanna Cloud from Hanna Instruments in order to integrate the Pool Controller.
Type of change
current
branch).current
branch).next
branch).next
branch).Additional information
Hanna
brands#7244Checklist
current
branch.next
branch.Summary by CodeRabbit