home-assistant.io
home-assistant.io copied to clipboard
Add IoTMeter documentation
Proposed change
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/120087
- Link to parent pull request in the Brands repository: https://github.com/home-assistant/brands/pull/5599
- This PR fixes or closes issue: fixes #
Checklist
- [ ] 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 IoTMeter integration for Home Assistant.
- Enabled real-time monitoring and management of IoT meters.
- Added sensors for total power, consumption energy, generation energy, and EVSE status.
- Added controls for max charging current (SmartModule only).
Walkthrough
The recent updates introduce the IoTMeter integration for Home Assistant, allowing users to monitor and manage IoT meters in real time. This integration supports sensors for tracking power, energy consumption, generation, and EVSE status, as well as configurable entities for setting the maximum charging current for SmartModule devices.
Changes
| File | Summary |
|---|---|
| source/_integrations/iotmeter.markdown | Introduced the IoTMeter integration with sensors for power metrics and EVSE status. Added entities for configuring max charging current. |
Sequence Diagram(s)
sequenceDiagram
participant User
participant HomeAssistant
participant IoTMeterAPI
User->>HomeAssistant: Add IoTMeter integration
HomeAssistant->>IoTMeterAPI: Get initial meter data
IoTMeterAPI-->>HomeAssistant: Return meter data
HomeAssistant-->>User: Display real-time meter data
User->>HomeAssistant: Adjust max charging current
HomeAssistant->>IoTMeterAPI: Send newcharging current setting
IoTMeterAPI-->>HomeAssistant: Confirm setting change
HomeAssistant-->>User: Update UI with confirmation
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 as 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.
Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
CodeRabbit Configration 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.
Deploy Preview for home-assistant-docs ready!
| Name | Link |
|---|---|
| Latest commit | 1d91604bdca758b99fcf65346762737dc13c605f |
| Latest deploy log | https://app.netlify.com/sites/home-assistant-docs/deploys/667ae581f4479900080f1efc |
| Deploy Preview | https://deploy-preview-33345--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.
As this is related to a code change, please do the following:
- add the link to the related core PR in the PR template under Link to parent pull request
- Rebase and point the PR against the next branch
It seems that this PR is targeted against an incorrect branch since it has a parent PR on one of our codebases. Documentation that needs to be updated for an upcoming release should target the next branch. Please change the target branch of this PR to next and rebase if needed.
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks :+1: