Add IoTMeter documentation #33345
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,46 @@ | ||||||||||
| --- | ||||||||||
| title: IoTMeter | ||||||||||
| description: Instructions on how to integrate IoTMeter within Home Assistant. | ||||||||||
| ha_category: | ||||||||||
| - Energy | ||||||||||
| ha_release: 2024.6 | ||||||||||
| ha_iot_class: Cloud Polling | ||||||||||
| ha_domain: iotmeter | ||||||||||
| ha_platforms: | ||||||||||
| - sensor | ||||||||||
| ha_config_flow: true | ||||||||||
| ha_codeowners: | ||||||||||
| - '@lipic' | ||||||||||
| ha_integration_type: integration | ||||||||||
| --- | ||||||||||
|
|
||||||||||
| The **IoTMeter** {% term integration %} allows you to monitor and manage your [IoT meters](http://evracing.cz/iotmeter/iotmeter_EN.pdf) within Home Assistant. This integration provides real-time data and control over your connected devices. | ||||||||||
|
|
||||||||||
| {% include integrations/config_flow.md %} | ||||||||||
|
|
||||||||||
| ## Sensors | ||||||||||
|
|
||||||||||
| The {% term integration %} adds the following sensors: | ||||||||||
|
|
||||||||||
| - Total power (unit: kW) | ||||||||||
|
There was a problem hiding this comment.
Suggested change
We use bold to mark UI strings. I also added a colon. Otherwise, It would look like this: |
||||||||||
| 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.
Suggested change
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. |
||||||||||
| 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.
Suggested change
|
||||||||||
| 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.
Suggested change
There was a problem hiding this comment.
Suggested change
|
||||||||||
| This sensor provides the current status of the Electric Vehicle Supply Equipment (EVSE). The possible statuses are: | ||||||||||
| - EVSE not connected: Indicates that no electric vehicle is connected to the charger. | ||||||||||
| - EVSE ready: Indicates that the EVSE is ready and waiting for a vehicle to be connected. | ||||||||||
| - EV connected: Indicates that an electric vehicle is connected to the charger but not currently charging. | ||||||||||
| - EV charging: Indicates that an electric vehicle is connected and currently charging. | ||||||||||
|
|
||||||||||
|
|
||||||||||
| ## Number | ||||||||||
|
|
||||||||||
| The {% term integration %} adds the following number entities: | ||||||||||
|
|
||||||||||
| - Max charging current (Only for SmartModule) | ||||||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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?