Add Rexense integration doc #38636
Add Rexense integration doc #38636
Conversation
home-assistant
bot
added
has-parent
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughA new documentation file for the Rexense integration with Home Assistant has been introduced. This file explains the integration's capabilities, such as device discovery, real-time sensor data acquisition, and switch control. It provides step-by-step installation and configuration instructions, details on supported device models and sensor entities, and guidance on removing the integration. The documentation outlines the communication flow between Home Assistant and Rexense devices, including initial HTTP requests and subsequent WebSocket connections for live updates. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant HomeAssistant
participant RexenseDevice
User->>HomeAssistant: Add Rexense Integration via UI
HomeAssistant->>RexenseDevice: HTTP GET /rex/GetBasicInfo
RexenseDevice-->>HomeAssistant: Device Info Response
HomeAssistant->>RexenseDevice: Establish WebSocket /rpc
RexenseDevice-->>HomeAssistant: Push real-time sensor updates
HomeAssistant-->>User: Display sensor data 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:
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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
source/_integrations/rexense.markdown (5)
23-23: Surround heading with blank lines for markdown linting
MarkdownLint (MD022) requires blank lines before and after headings. Please add blank lines around the## High‑Level Descriptionheading.Apply:
+ ## High‑Level Description +🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
23-23: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below(MD022, blanks-around-headings)
26-32: Add blank lines around Installation section elements
Several lint issues (MD022, MD032, MD031) indicate that headings, lists, and fenced code blocks need blank lines around them. Please apply the following adjustments:--- a/source/_integrations/rexense.markdown +++ b/source/_integrations/rexense.markdown @@ -26,7 +26,9 @@ -## Installation Instructions + +## Installation Instructions + 1. **Enable default integrations** + In your `configuration.yaml`, add: ```yaml @@ -31,7 +33,9 @@ zeroconf:
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
26-26: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below(MD022, blanks-around-headings)
27-27: Lists should be surrounded by blank lines
null(MD032, blanks-around-lists)
29-29: Fenced code blocks should be surrounded by blank lines
null(MD031, blanks-around-fences)
32-32: Fenced code blocks should be surrounded by blank lines
null(MD031, blanks-around-fences)
53-55: Surround WebSocket Push Updates heading with blank lines
MarkdownLint (MD022) flags the## WebSocket Push Updatesheading for missing surrounding blank lines. Please add blank lines before and after.+ ## WebSocket Push Updates +🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
53-53: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below(MD022, blanks-around-headings)
56-68: Entities section formatting
The content under Entities accurately lists supported sensor entities for REX-3PHASEMETER-01. For improved lint compliance (MD022, MD032), insert blank lines:
- Before the
### Sensorssubheading.- Around the lists of sensor types.
+ ### Sensors + - **Phase A/B/C:** Current, Voltage, Active Power, Apparent Power, Power Factor + - **Totals:** Total Active Power, Total Apparent Power, Cumulative Energy Imported/Exported + - **Temperature**🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
58-58: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below(MD022, blanks-around-headings)
60-60: Lists should be surrounded by blank lines
null(MD032, blanks-around-lists)
65-65: Lists should be surrounded by blank lines
null(MD032, blanks-around-lists)
69-77: Removal instructions formatting
The removal steps are clear. MarkdownLint (MD022, MD032) suggests blank lines around the## Removal Instructionsheading and list items. Please add blank lines accordingly.+ ## Removal Instructions + 1. Go to **Settings → Devices & Services** + 2. Locate **Rexense** and click the trash icon to **Delete** + 3. (If you previously ran as a custom component) Delete any `custom_components/rexense` folder + 4. Restart Home Assistant🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
69-69: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below(MD022, blanks-around-headings)
71-71: Lists should be surrounded by blank lines
null(MD032, blanks-around-lists)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/rexense.markdown(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/rexense.markdown
23-23: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
26-26: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
27-27: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
29-29: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
32-32: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
53-53: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
58-58: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
60-60: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
65-65: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
69-69: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
71-71: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
🔇 Additional comments (5)
source/_integrations/rexense.markdown (5)
1-19: Front matter metadata is well-structured
The YAML front matter includes the required keys (title,description,ha_*) and a proper closing delimiter at line 19. Codeowners, IoT class, integration type, and platforms appear correct for the new Rexense integration.
21-24: Introductory content is clear
The introduction and high‑level description effectively convey the purpose and capabilities of the Rexense integration.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
23-23: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below(MD022, blanks-around-headings)
40-41: HTTP & WebSocket upgrade description is concise
The sentence describing the initial HTTP fetch and subsequent WebSocket upgrade clearly communicates the communication flow. No changes needed here.
42-51: Configuration options look correct
Theconfig_flowinclude andHost/Portfields are properly documented using the standard Jinja templates. This aligns with other Home Assistant integration docs.
78-79: Include template for removal service
The{% include integrations/remove_device_service.md %}template is correctly added here to document the removal API. No further changes needed.
c0ffeeca7
added
the
new-integration
|
Hi @GorgeOu 👋 Thank you for contributing.
|
| ## High‑Level Description | ||
| The Rexense integration enables Home Assistant to automatically discover and manage Rexense IoT Mesh devices, providing automated device discovery, real‑time sensor data, and switch control. | ||
|
|
||
| ## Installation Instructions |
There was a problem hiding this comment.
is this section needed? or are the installation instructions covered in the {% include integrations/config_flow.md %}?
| - **Automatic name** generated from device model and sensor type | ||
|
|
||
| ## Removal Instructions | ||
| To remove the Rexense integration: |
There was a problem hiding this comment.
I think these steps are a duplicate of the {% include integrations/remove_device_service.md %}
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
home-assistant
bot
added
in-progress
|
It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the |
…teps, correct include syntax
GorgeOu
force-pushed
the
add-rexense-doc
branch
from
6dfacc1 to
264ac36
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
source/_integrations/rexense.markdown (1)
26-39: Avoid duplicating installation steps & fix list/code-block spacing
Your manual installation instructions overlap with{% include integrations/config_flow.md %}under Configuration options. To reduce maintenance overhead:
- Consider removing the manual steps and relying on the standard include.
- Ensure there’s a blank line before/after the numbered list (MD032) and before/after the fenced code block (MD031).
Example diff to wrap the list and fence:
## Installation instructions -1. **Enable default integrations** +1. **Enable default integrations** In your `configuration.yaml`, add: ```yaml default_config: zeroconf:🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
26-26: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below(MD022, blanks-around-headings)
27-27: Lists should be surrounded by blank lines
null(MD032, blanks-around-lists)
29-29: Fenced code blocks should be surrounded by blank lines
null(MD031, blanks-around-fences)
32-32: Fenced code blocks should be surrounded by blank lines
null(MD031, blanks-around-fences)
🧹 Nitpick comments (7)
source/_integrations/rexense.markdown (7)
8-9: Remove quotes aroundha_codeownersentries
Code owners should be listed without quotation marks to match the style of other integrations (e.g.,- @rexenseinstead of- '@rexense').
23-25: Surround “## High-level description” with blank lines
Add an empty line before and after this heading to comply with markdownlint MD022 and improve readability.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
23-23: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below(MD022, blanks-around-headings)
42-45: Surround “## Configuration options” with blank lines
Insert an empty line above line 42 and below line 45 so the heading and include are separated from surrounding text (MD022).
46-48: Surround “## WebSocket push updates” with blank lines
Add a blank line before and after this heading to satisfy MD022.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
46-46: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below(MD022, blanks-around-headings)
49-53: Add blank lines for “## Entities” and “### Sensors”
Place an empty line above## Entities(line 49) and above### Sensors(line 51) to meet MD022.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
51-51: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below(MD022, blanks-around-headings)
53-53: Lists should be surrounded by blank lines
null(MD032, blanks-around-lists)
53-61: Ensure blank lines around sensor bullet lists
Add an empty line before the list at line 53 and after the list ending at line 58 to adhere to MD032.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
53-53: Lists should be surrounded by blank lines
null(MD032, blanks-around-lists)
58-58: Lists should be surrounded by blank lines
null(MD032, blanks-around-lists)
62-65: Surround “## Removal instructions” and include with blank lines
Insert an empty line before the heading on line 62 and after the include on line 64 to comply with MD022/MD031.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/rexense.markdown(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/rexense.markdown
23-23: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
26-26: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
27-27: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
29-29: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
32-32: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
46-46: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
51-51: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
53-53: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
58-58: 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
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
source/_integrations/rexense.markdown (3)
23-24: Align heading with documentation standards
Home Assistant docs generally use "Overview" for this section.-## High-level description +## Overview
32-32: Remove trailing spaces
There are trailing spaces on this blank line. Removing them will satisfy markdownlint.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
32-32: Trailing spaces
Expected: 0 or 2; Actual: 3(MD009, no-trailing-spaces)
48-49: Condense multiple blank lines
There are two consecutive blank lines here; collapse to a single blank line to adhere to markdown style.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
49-49: Multiple consecutive blank lines
Expected: 1; Actual: 2(MD012, no-multiple-blanks)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/rexense.markdown(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/rexense.markdown
32-32: Trailing spaces
Expected: 0 or 2; Actual: 3
(MD009, no-trailing-spaces)
49-49: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
⏰ 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 (6)
source/_integrations/rexense.markdown (6)
1-19: Frontmatter metadata looks correct
The integration metadata (title, description, category, platforms, codeowners, etc.) adheres to the standard format and covers all necessary fields.
21-26: Introduction is clear and concise
The overview sentence succinctly introduces the Rexense IoT Mesh integration.
27-47: Installation prerequisites are helpful
Includingdefault_configandzeroconfsetup guides users on required dependencies before configuring the integration.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
32-32: Trailing spaces
Expected: 0 or 2; Actual: 3(MD009, no-trailing-spaces)
50-53: Configuration options via config_flow include
Using{% include integrations/config_flow.md %}aligns with standards and avoids duplication of UI configuration steps.
54-57: WebSocket push update instructions are clear
The description of the HTTP-to-WebSocket flow is precise and in line with other integration docs.
74-77: Removal instructions via include are appropriate
Using{% include integrations/remove_device_service.md %}follows the pattern used by other integrations and prevents duplication.
Proposed change
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit