home-assistant.io
home-assistant.io copied to clipboard
Add iskra documentation
Proposed change
Adds documentation for iskra integration
Type of change
- [ ] Spelling, grammar or other readability improvements (
currentbranch). - [ ] Adjusted missing or incorrect information in the current documentation (
currentbranch). - [x] Added documentation for a new integration I'm adding to Home Assistant (
nextbranch).- [ ] I've opened up a PR to add logos and icons in Brands repository.
- [ ] Added documentation for a new feature I'm adding to Home Assistant (
nextbranch). - [ ] Removed stale or deprecated documentation.
Additional information
- Link to parent pull request in the codebase: https://github.com/home-assistant/core/pull/120658
- Link to parent pull request in the Brands repository: https://github.com/home-assistant/brands/pull/5620
Checklist
- [x] This PR uses the correct branch, based on one of the following:
- I made a change to the existing documentation and used the
currentbranch. - I made a change that is related to an upcoming version of Home Assistant and used the
nextbranch.
- I made a change to the existing documentation and used the
- [x] The documentation follows the Home Assistant documentation standards.
Summary by CodeRabbit
- New Features
- Introduced
Iskraintegration to connect and monitor Iskra energy meters and power quality analyzers. - Supported data collection via Modbus TCP or Iskra smartgateway's REST API.
- Added compatibility with specific Iskra device series, including Impact (IEXX), WM (WMXX), iMT/MT, and iMC/MC series.
- Provided detailed information on monitored metrics such as power, current, voltage, and energy counters.
- Included setup prerequisites, such as setting a static IP and selecting the appropriate connection type.
- Introduced
Deploy Preview for home-assistant-docs ready!
| Name | Link |
|---|---|
| Latest commit | a1d78f6b3720ed35a5273d889db20424199f741a |
| Latest deploy log | https://app.netlify.com/sites/home-assistant-docs/deploys/66de9ac027514d0008372d1e |
| Deploy Preview | https://deploy-preview-33422--home-assistant-docs.netlify.app |
| Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify site configuration.
Walkthrough
Walkthrough
The recent changes introduce a new Iskra integration guide for Home Assistant, detailing how to connect Iskra energy meters and power quality analyzers. This guide includes information on supported devices, configuration options using Modbus TCP or Iskraβs Smart Gateway with REST API, monitored data specifics, and important notes on usage.
Changes
| File Path | Change Summary |
|---|---|
source/_integrations/iskra.markdown |
Added a new integration guide for Iskra energy meters and power quality analyzers, covering setup, supported devices, configuration options, and monitored data details. |
Sequence Diagram(s)
sequenceDiagram
participant User
participant Home Assistant
participant Iskra Device
User->>Home Assistant: Configure Iskra Integration (Modbus TCP / REST API)
Home Assistant->>Iskra Device: Send Polling Request
Iskra Device-->>Home Assistant: Respond with Data (Power, Current, Voltage, Energy Counters)
Home Assistant-->>User: Display Collected Data
[!TIP]
New features
Walkthrough comment now includes:
- Possibly related PRs: A list of potentially related PRs to help you recall past context.
- Suggested labels: CodeRabbit can now suggest labels by learning from your past PRs. You can also provide custom labeling instructions in the UI or configuration file.
Notes:
- Please share any feedback in the discussion post on our Discord.
- Possibly related PRs, automatic label suggestions based on past PRs, learnings, and possibly related issues require data opt-in (enabled by default).
Recent review details
Configuration used: CodeRabbit UI Review profile: CHILL
Commits
Files that changed from the base of the PR and between 985f647465289bd41aefe8442056ab3c855d7eab and a1d78f6b3720ed35a5273d889db20424199f741a.
Files selected for processing (1)
- source/_integrations/iskra.markdown (1 hunks)
Additional context used
Markdownlint
source/_integrations/iskra.markdown
40-40: null Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
Tips
Chat
There are 3 ways to chat with CodeRabbit:
- Review comments: Directly reply to a review comment made by CodeRabbit. Example:
I pushed a fix in commit <commit_id>.Generate unit testing code for this file.Open a follow-up GitHub issue for this discussion.
- Files and specific lines of code (under the "Files changed" tab): Tag
@coderabbitaiin a new review comment at the desired location with your query. Examples:@coderabbitai generate unit testing code for this file.@coderabbitai modularize this function.
- PR comments: Tag
@coderabbitaiin a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:@coderabbitai generate interesting stats about this repository and render them as a table.@coderabbitai show all the console.log statements in this repository.@coderabbitai read src/utils.ts and generate unit testing code.@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.@coderabbitai help me debug CodeRabbit configuration file.
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)
@coderabbitai pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaior@coderabbitai titleanywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile to the root of your repository. - Please see the configuration documentation for more information.
- If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation:
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
Documentation and Community
- Visit our Documentation for detailed information on how to use CodeRabbit.
- Join our Discord Community to get help, request features, and share feedback.
- Follow us on X/Twitter for updates and announcements.