Add IoTMeter documentation #33345
Add IoTMeter documentation #33345
Conversation
WalkthroughThe 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
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? 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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
| To configure the IoTMeter integration, add the following to your `configuration.yaml` file: | ||
|
|
||
| ```yaml | ||
| iotmeter: | ||
| username: YOUR_USERNAME | ||
| password: YOUR_PASSWORD | ||
| meters: | ||
| - id: METER_ID_1 | ||
| name: "Living Room Meter" | ||
| - id: METER_ID_2 | ||
| name: "Kitchen Meter" |
There was a problem hiding this comment.
Configuration Instructions Review
The YAML configuration snippet provided is clear and well-formatted. It effectively instructs users on how to add IoTMeter to their configuration.yaml. However, consider adding a brief description for each field to enhance user understanding.
iotmeter:
username: YOUR_USERNAME # Replace YOUR_USERNAME with your IoTMeter account username.
password: YOUR_PASSWORD # Replace YOUR_PASSWORD with your IoTMeter account password.
meters:
- id: METER_ID_1 # Replace METER_ID_1 with the actual meter ID.
name: "Living Room Meter" # Optional: Name your meter for easier identification.
- id: METER_ID_2 # Replace METER_ID_2 with the actual meter ID.
name: "Kitchen Meter" # Optional: Name your meter for easier identification.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| To configure the IoTMeter integration, add the following to your `configuration.yaml` file: | |
| ```yaml | |
| iotmeter: | |
| username: YOUR_USERNAME | |
| password: YOUR_PASSWORD | |
| meters: | |
| - id: METER_ID_1 | |
| name: "Living Room Meter" | |
| - id: METER_ID_2 | |
| name: "Kitchen Meter" | |
| To configure the IoTMeter integration, add the following to your `configuration.yaml` file: | |
| ```yaml | |
| iotmeter: | |
| username: YOUR_USERNAME # Replace YOUR_USERNAME with your IoTMeter account username. | |
| password: YOUR_PASSWORD # Replace YOUR_PASSWORD with your IoTMeter account password. | |
| meters: | |
| - id: METER_ID_1 # Replace METER_ID_1 with the actual meter ID. | |
| name: "Living Room Meter" # Optional: Name your meter for easier identification. | |
| - id: METER_ID_2 # Replace METER_ID_2 with the actual meter ID. | |
| name: "Kitchen Meter" # Optional: Name your meter for easier identification. | |
| ``` |
Tools
LanguageTool
[misspelling] ~31-~31: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...tor ## Configuration To configure the IoTMeter integration, add the following to your ...
|
As this is related to a code change, please do the following:
|
c0ffeeca7
added
new-integration
home-assistant
bot
added
current
|
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 |
home-assistant
bot
removed
current
| --- | ||
|
|
||
| The **IoTMeter** {% term integration %} allows you to monitor and manage your IoT meters within Home Assistant. This integration provides real-time data and control over your connected devices. | ||
|
|
There was a problem hiding this comment.
Are there any prerequisites? Anything I should have before adding the integration? For example an account with IoTMeter? Do I need to have my login credentials ready?
| - Total power | ||
| - Total consumption energy | ||
| - Total generation energy | ||
| - EVSE status |
There was a problem hiding this comment.
| - EVSE status | |
| - <abbr title="electric vehicle supply equipment">EVSE</abbr> status |
|
|
||
| The {% term integration %} adds the following sensors: | ||
|
|
||
| - Total power |
There was a problem hiding this comment.
can you add more details? For example the unit. What is the total consumption? Per day, week, since start of measurement
There was a problem hiding this comment.
Nice! Thank you for the added descriptions!
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
| - Total Power (unit: kW) | ||
| This sensor measures the total power being consumed at any given time. It is useful for monitoring overall power usage and identifying peak consumption periods. | ||
|
|
||
| - Total Consumption Energy (unit: kWh) |
There was a problem hiding this comment.
Is there a reason you changed from sentence-style to heading-style capitalization? Is this how the UI strings are written? We usually use sentence-style capitalization, also in headings.
There was a problem hiding this comment.
I changed it unknowingly. Should I correct it to sentence-style capitalization and push it again?
| ha_integration_type: integration | ||
| --- | ||
|
|
||
| The **IoTMeter** {% term integration %} allows you to monitor and manage your IoT meters within Home Assistant. This integration provides real-time data and control over your connected devices. |
There was a problem hiding this comment.
When you say your IoT meters, is this the product you are referring to http://evracing.cz/iotmeter/iotmeter_EN.pdf?
|
|
||
| The {% term integration %} adds the following sensors: | ||
|
|
||
| - Total power (unit: kW) |
There was a problem hiding this comment.
| - Total power (unit: kW) | |
| - **Total power** (unit: kW): |
We use bold to mark UI strings. I also added a colon. Otherwise, It would look like this:
| - Total power (unit: kW) | ||
| This sensor measures the total power being consumed at any given time. It is useful for monitoring overall power usage and identifying peak consumption periods. | ||
|
|
||
| - Total consumption energy (unit: kWh) |
There was a problem hiding this comment.
| - Total consumption energy (unit: kWh) | |
| - **Total energy consumption** (unit: kWh): |
I took the liberty to rephrase this UI string, as it seems more logical. However, it is important that the UI string is the same as the one shown in the software. So please feel free to ignore the rephrase if this does not work with the software.
| - Total consumption energy (unit: kWh) | ||
| This sensor tracks the total amount of energy consumed since the start of the measurement period. It helps in understanding long-term energy usage patterns and can be used for energy management and optimization. | ||
|
|
||
| - Total generation energy (unit: kWh) |
There was a problem hiding this comment.
| - Total generation energy (unit: kWh) | |
| - **Total energy generated** (unit: kWh): |
| - Total generation energy (unit: kWh) | ||
| This sensor measures the total amount of energy generated since the start of the measurement period. It is particularly useful for systems that include renewable energy sources, such as solar panels, and helps in tracking the efficiency and output of these systems. | ||
|
|
||
| - EVSE status |
There was a problem hiding this comment.
| - EVSE status | |
| - **EVSE status**: |
Proposed change
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit