Add connectivity_monitor documentation#44484
Add connectivity_monitor documentation#44484joshburkard wants to merge 13 commits intohome-assistant:nextfrom
Conversation
|
It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the |
home-assistant
bot
added
in-progress
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
This pull request adds comprehensive documentation for the new Connectivity Monitor integration, which helps users monitor the connectivity status of various device types including network hosts, Bluetooth devices, ESPHome devices, Matter devices, and Zigbee devices.
Changes:
- Added new integration documentation file with complete setup instructions, configuration options, and examples
- Added three Lovelace card screenshot images showing the card picker, configuration options, and rendered card display
- Provided a real-world automation example showing how to use the
connectivity_monitor_alertevent for notifications
Reviewed changes
Copilot reviewed 1 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
source/_integrations/connectivity_monitor.markdown |
Complete integration documentation following Home Assistant standards with configuration options, supported devices, examples, and known limitations |
source/images/integrations/connectivity_monitor/lovelace-001.png |
Screenshot of Connectivity Monitor card in the card picker |
source/images/integrations/connectivity_monitor/lovelace-002.png |
Screenshot showing device type and status configuration options |
source/images/integrations/connectivity_monitor/lovelace-003.png |
Screenshot of the rendered Connectivity Monitor dashboard card |
home-assistant
bot
removed
the
needs-rebase
I'm not pretty sure if this is correct. This documentation is for a new integration "connectivity_monitor" were i sent in the meantime the Pull Request home-assistant/core#167442 |
| #### Bluetooth, ESPHome, Matter, and Zigbee devices | ||
|
|
||
| - **[DeviceType] Status** | ||
| - **Active**: The device is currently online or reachable. | ||
| - **Inactive**: The device is currently offline or not reachable. | ||
| - **Unknown**: The device has not been detected yet. | ||
|
|
||
| #### Network device | ||
|
|
||
| - **Overall Status** | ||
| - **Connected**: The host and all configured protocol or port checks are reachable. | ||
| - **Partially Connected**: Some configured checks are reachable, but not all of them. | ||
| - **Disconnected**: None of the configured checks are reachable. | ||
| - **Unknown**: The host has not been detected yet. | ||
| - **[Protocol] [Port]** | ||
| - **Connected**: The configured protocol and port are reachable. | ||
| - **Disconnected**: The configured protocol and port are not reachable. |
There was a problem hiding this comment.
The entity name placeholders on lines 134 and 146 use square brackets (e.g., [DeviceType], [Protocol], [Port]) but are not explained. Following Home Assistant documentation conventions seen in other integrations (like Enphase Envoy), dynamic entity name parts should either be: (1) explained clearly with a note describing what the placeholder represents, (2) use angle bracket notation like <DeviceType>, or (3) provide concrete examples. Without clarification, users may be confused about whether these are literal entity names or placeholders.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
c0ffeeca7
added
the
new-integration
c0ffeeca7
left a comment
c0ffeeca7
left a comment
There was a problem hiding this comment.
Thank you for contributing, @joshburkard 👍
Please add a link to the related PR in the brands repository.
|
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>
Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
|
Once you are done implementing changes, select the Ready for review button to take the PR out of draft mode. |
Proposed change
I've created a new integration "Connectivity Monitor" and like to document it here
This documentation is for a new feature / integration connectivity_monitor which is requested with Pull Request home-assistant/core#167442
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.PR Brands: home-assistant/brands#10098