Skip to content

Add documentation for kWh Meter v2 API #192

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jun 17, 2025
Merged

Add documentation for kWh Meter v2 API #192

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4d3faf4
Update badges to indicate support for super secret feature
DCSBL Jun 16, 2025
5c13ed1
Add documentation about measurement API for super secret feature
DCSBL Jun 16, 2025
ffee996
Update system documentation
DCSBL Jun 16, 2025
2ec8f43
Update docs/v2/websocket.mdx
DCSBL Jun 17, 2025
2ef15c9
Apply suggestions from code review
DCSBL Jun 17, 2025
9c09f48
Add comment about kwh meter 1-3 button restriction
DCSBL Jun 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/discovery.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,10 @@ A discovery response contains additional data to enhance the setup in your appli

{/* prettier-ignore */}
<Badge color='hw-green' icon="mdi:check" subtext="Requires Firmware 6.00">P1 Meter</Badge>
<Badge color='hw-purple' icon="mdi:wrench" subtext="In development">Energy Socket</Badge>
<Badge color='hw-purple' icon="mdi:wrench" subtext="In development">Energy Display</Badge>
<Badge color='hw-purple' icon="mdi:wrench" subtext="In development">kWh Meter</Badge>
<Badge color='hw-purple' icon="mdi:wrench" subtext="In development">Watermeter</Badge>
<Badge color='hw-grey' icon="mdi:wrench" subtext="In development">Energy Socket</Badge>
<Badge color='hw-grey' icon="mdi:wrench" subtext="In development">Energy Display</Badge>
<Badge color='hw-purple' icon="mdi:test-tube" subtext="Requires Firmware 5.0000 or later (in beta)">kWh Meter</Badge>
<Badge color='hw-grey' icon="mdi:wrench" subtext="In development">Watermeter</Badge>
<Badge color='hw-green' icon="mdi:check" subtext="Supported">Plug-In Battery</Badge>

---
Expand Down
17 changes: 8 additions & 9 deletions docs/introduction.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,14 @@ To understand the basics of the API, you can read the [getting-started](/docs/ge

The following table shows which devices are supported by the API and which API version they support.

| Device | Device type | API v1 | API v2 |
| --------------------------------------- | ---------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| P1 Meter | `HWE-P1` | <Badge color='hw-green' icon="mdi:check" detail='v1'>Supported</Badge> | <Badge color='hw-green' icon="mdi:check" detail='2.0.0'>Requires Firmware 6.00</Badge> <Badge color='hw-purple' icon="mdi:wrench" detail='2.1.0'>In beta</Badge> |
| Energy Socket | `HWE-SKT` | <Badge color='hw-green' icon="mdi:check" detail='v1'>Supported</Badge> | <Badge color='hw-purple' icon="mdi:wrench">In development</Badge> |
| Watermeter (Only when powered over USB) | `HWE-WTR` | <Badge color='hw-green' icon="mdi:check" detail='v1'>Supported</Badge> | <Badge color='hw-purple' icon="mdi:wrench">In development</Badge> |
| kWh Meter (1 phase) | `HWE-KWH1` and `SDM230-wifi` | <Badge color='hw-green' icon="mdi:check" detail='v1'>Supported</Badge> | <Badge color='hw-purple' icon="mdi:wrench">In development</Badge> |
| kWh Meter (3 phase) | `HWE-KWH3` and `SDM630-wifi` | <Badge color='hw-green' icon="mdi:check" detail='v1'>Supported</Badge> | <Badge color='hw-purple' icon="mdi:wrench">In development</Badge> |
| Energy Display | `HWE-DSP` | <Badge color='hw-grey' icon="mdi:close">Not planned</Badge> | <Badge color='hw-purple' icon="mdi:wrench">In development</Badge> |
| Plug-In Battery | `HWE-BAT` | <Badge color='hw-grey' icon="mdi:close">Not planned</Badge> | <Badge color='hw-green' icon="mdi:check" detail='2.0.1'>Supported</Badge> |
| Device | Device type | API v1 | API v2 |
| --------------------------------------- | ----------------------------------------------------------------------- | ---------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| P1 Meter | `HWE-P1` | <Badge color='hw-green' icon="mdi:check" detail='v1'>Supported</Badge> | <Badge color='hw-green' icon="mdi:check" detail='2.0.0'>Requires Firmware 6.00</Badge> <Badge color='hw-purple' icon="mdi:test-tube" detail='2.1.0'>In beta</Badge> |
| Energy Socket | `HWE-SKT` | <Badge color='hw-green' icon="mdi:check" detail='v1'>Supported</Badge> | <Badge color='hw-grey' icon="mdi:wrench">In development</Badge> |
| Watermeter (Only when powered over USB) | `HWE-WTR` | <Badge color='hw-green' icon="mdi:check" detail='v1'>Supported</Badge> | <Badge color='hw-grey' icon="mdi:wrench">In development</Badge> |
| kWh Meter (1 phase and 3-phase) | `HWE-KWH1`,<br /> `HWE-KWH3`,<br />`SDM230-wifi` and<br />`SDM630-wifi` | <Badge color='hw-green' icon="mdi:check" detail='v1'>Supported</Badge> | <Badge color='hw-purple' icon="mdi:test-tube" detail='2.1.0'>In beta</Badge> |
| Energy Display | `HWE-DSP` | <Badge color='hw-grey' icon="mdi:close">Not planned</Badge> | <Badge color='hw-grey' icon="mdi:wrench">In development</Badge> |
| Plug-In Battery | `HWE-BAT` | <Badge color='hw-grey' icon="mdi:close">Not planned</Badge> | <Badge color='hw-green' icon="mdi:check" detail='2.0.1'>Supported</Badge> |

:::tip P1 Meter
The v2 API is available for P1 Meter devices with firmware version 6.00 and higher. This version is currently only available for owners of the Plug-In Battery.
Expand Down
2 changes: 1 addition & 1 deletion docs/v1/api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import Badge from '@site/src/components/Badge.js'
<Badge color='hw-grey' icon='mdi:close' subtext='Not supported'>Energy Display</Badge>
<Badge color='hw-green' icon='mdi:check' subtext='Supported'>kWh Meter</Badge>
<Badge color='hw-green' icon='mdi:check' subtext='Supported'>Watermeter</Badge>
<Badge color='hw-orange' icon='mdi:check' subtext='Supported in v2'>Plug-In Battery</Badge>
<Badge color='hw-purple' icon='mdi:check' subtext='Supported in v2'>Plug-In Battery</Badge>
<br />
<sub>_See [Supported Devices](/docs/introduction#devices) for more information._</sub>

Expand Down
2 changes: 1 addition & 1 deletion docs/v1/error-handling.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import Badge from '@site/src/components/Badge.js'
<Badge color='hw-grey' icon='mdi:close' subtext='Not supported'>Energy Display</Badge>
<Badge color='hw-green' icon='mdi:check' subtext='Supported'>kWh Meter</Badge>
<Badge color='hw-green' icon='mdi:check' subtext='Supported'>Watermeter</Badge>
<Badge color='hw-orange' icon='mdi:check' subtext='Supported in v2'>Plug-In Battery</Badge>
<Badge color='hw-purple' icon='mdi:check' subtext='Supported in v2'>Plug-In Battery</Badge>
<br />
<sub>_See [Supported Devices](/docs/introduction#devices) for more information._</sub>

Expand Down
2 changes: 1 addition & 1 deletion docs/v1/identify.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import Badge from '@site/src/components/Badge.js'
<Badge color='hw-grey' icon='mdi:close' subtext='Not supported'>Energy Display</Badge>
<Badge color='hw-green' icon='mdi:check' subtext='Supported'>kWh Meter</Badge>
<Badge color='hw-green' icon='mdi:check' subtext='Supported'>Watermeter</Badge>
<Badge color='hw-orange' icon='mdi:check' subtext='Supported in v2'>Plug-In Battery</Badge>
<Badge color='hw-purple' icon='mdi:check' subtext='Supported in v2'>Plug-In Battery</Badge>
<br />
<sub>_See [Supported Devices](/docs/introduction#devices) for more information._</sub>

Expand Down
2 changes: 1 addition & 1 deletion docs/v1/measurement.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import Badge from '@site/src/components/Badge.js'
<Badge color='hw-grey' icon='mdi:close' subtext='Not supported'>Energy Display</Badge>
<Badge color='hw-green' icon='mdi:check' subtext='Supported'>kWh Meter</Badge>
<Badge color='hw-green' icon='mdi:check' subtext='Supported'>Watermeter</Badge>
<Badge color='hw-orange' icon='mdi:check' subtext='Supported in v2'>Plug-In Battery</Badge>
<Badge color='hw-purple' icon='mdi:check' subtext='Supported in v2'>Plug-In Battery</Badge>
<br />
<sub>_See [Supported Devices](/docs/introduction#devices) for more information._</sub>

Expand Down
2 changes: 1 addition & 1 deletion docs/v1/system.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import Badge from '@site/src/components/Badge.js'
<Badge color='hw-grey' icon='mdi:close' subtext='Not supported'>Energy Display</Badge>
<Badge color='hw-green' icon='mdi:check' subtext='Supported'>kWh Meter</Badge>
<Badge color='hw-green' icon='mdi:check' subtext='Supported'>Watermeter</Badge>
<Badge color='hw-orange' icon='mdi:check' subtext='Supported in v2'>Plug-In Battery</Badge>
<Badge color='hw-purple' icon='mdi:check' subtext='Supported in v2'>Plug-In Battery</Badge>
<br />
<sub>_See [Supported Devices](/docs/introduction#devices) for more information._</sub>

Expand Down
14 changes: 9 additions & 5 deletions docs/v2/authorization.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ import Badge from '@site/src/components/Badge.js'
# Authorization `/api/user`

{/* prettier-ignore */}
<Badge color='hw-green' icon='mdi:check' subtext='Requires Firmware 6.00'>P1 Meter</Badge>
<Badge color='hw-purple' icon='mdi:wrench' subtext='In development'>Energy Socket</Badge>
<Badge color='hw-purple' icon='mdi:wrench' subtext='In development'>Energy Display</Badge>
<Badge color='hw-purple' icon='mdi:wrench' subtext='In development'>kWh Meter</Badge>
<Badge color='hw-purple' icon='mdi:wrench' subtext='In development'>Watermeter</Badge>
<Badge color='hw-green' icon='mdi:check' subtext='Requires Firmware 6.0000 or later'>P1 Meter</Badge>
<Badge color='hw-grey' icon='mdi:wrench' subtext='In development'>Energy Socket</Badge>
<Badge color='hw-grey' icon='mdi:wrench' subtext='In development'>Energy Display</Badge>
<Badge color='hw-purple' icon='mdi:test-tube' subtext='Requires Firmware 5.0000 or later (in beta)'>kWh Meter</Badge>
<Badge color='hw-grey' icon='mdi:wrench' subtext='In development'>Watermeter</Badge>
<Badge color='hw-green' icon='mdi:check' subtext='Supported'>Plug-In Battery</Badge>
<br />
<sub>_See [Supported Devices](/docs/introduction#devices) for more information._</sub>
Expand Down Expand Up @@ -79,6 +79,10 @@ The response to a successful request will include the following fields:
Keep the token a secret, as it grants full access to the device's data.
:::

:::important
Due to hardware limitations, you need to press the wifi-pair button of the **kWh Meter** between **1 to 3 seconds** to authorize the request.
:::

### Examples

#### Step 1: Request a Token
Expand Down
4 changes: 2 additions & 2 deletions docs/v2/batteries.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ import Badge from '@site/src/components/Badge.js'
# Batteries `/api/batteries`

{/* prettier-ignore */}
<Badge color='hw-purple' icon='mdi:wrench' subtext='Requires firmware 6.0200 or later (in beta)'>P1 Meter</Badge>
<Badge color='hw-purple' icon='mdi:test-tube' subtext='Requires Firmware 6.0200 or later (in beta)'>P1 Meter</Badge>
<Badge color='hw-grey' icon='mdi:close' subtext='Not supported'>Energy Socket</Badge>
<Badge color='hw-grey' icon='mdi:close' subtext='Not supported'>Energy Display</Badge>
<Badge color='hw-purple' icon='mdi:wrench' subtext='In development'>kWh Meter</Badge>
<Badge color='hw-purple' icon='mdi:test-tube' subtext='Requires Firmware 5.0000 or later (in beta)'>kWh Meter</Badge>
<Badge color='hw-grey' icon='mdi:close' subtext='Not supported'>Water Meter</Badge>
<Badge color='hw-grey' icon='mdi:close' subtext='Not supported'>Plug-In Battery</Badge>
<br />
Expand Down
10 changes: 5 additions & 5 deletions docs/v2/device_information.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ import Badge from '@site/src/components/Badge.js'
# Device Information `/api`

{/* prettier-ignore */}
<Badge color='hw-green' icon='mdi:check' subtext='Requires Firmware 6.00'>P1 Meter</Badge>
<Badge color='hw-orange' icon='mdi:check' subtext='Supported in v1'>Energy Socket</Badge>
<Badge color='hw-purple' icon='mdi:wrench' subtext='In development'>Energy Display</Badge>
<Badge color='hw-orange' icon='mdi:check' subtext='Supported in v1'>kWh Meter</Badge>
<Badge color='hw-orange' icon='mdi:check' subtext='Supported in v1'>Watermeter</Badge>
<Badge color='hw-green' icon='mdi:check' subtext='Requires Firmware 6.0000 or later'>P1 Meter</Badge>
<Badge color='hw-purple' icon='mdi:check' subtext='Supported in v1'>Energy Socket</Badge>
<Badge color='hw-grey' icon='mdi:wrench' subtext='In development'>Energy Display</Badge>
<Badge color='hw-purple' icon='mdi:test-tube' subtext='Requires Firmware 5.0000 or later (in beta)'>kWh Meter</Badge>
<Badge color='hw-purple' icon='mdi:check' subtext='Supported in v1'>Watermeter</Badge>
<Badge color='hw-green' icon='mdi:check' subtext='Supported'>Plug-In Battery</Badge>
<br />
<sub>_See [Supported Devices](/docs/introduction#devices) for more information._</sub>
Expand Down
10 changes: 5 additions & 5 deletions docs/v2/error-handling.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ import Badge from '@site/src/components/Badge.js'
# Error Handling

{/* prettier-ignore */}
<Badge color='hw-green' icon='mdi:check' subtext='Requires Firmware 6.00'>P1 Meter</Badge>
<Badge color='hw-orange' icon='mdi:check' subtext='Supported in v1'>Energy Socket</Badge>
<Badge color='hw-purple' icon='mdi:wrench' subtext='In development'>Energy Display</Badge>
<Badge color='hw-orange' icon='mdi:check' subtext='Supported in v1'>kWh Meter</Badge>
<Badge color='hw-orange' icon='mdi:check' subtext='Supported in v1'>Watermeter</Badge>
<Badge color='hw-green' icon='mdi:check' subtext='Requires Firmware 6.0000 or later'>P1 Meter</Badge>
<Badge color='hw-purple' icon='mdi:check' subtext='Supported in v1'>Energy Socket</Badge>
<Badge color='hw-grey' icon='mdi:wrench' subtext='In development'>Energy Display</Badge>
<Badge color='hw-purple' icon='mdi:test-tube' subtext='Requires Firmware 5.0000 or later (in beta)'>kWh Meter</Badge>
<Badge color='hw-purple' icon='mdi:check' subtext='Supported in v1'>Watermeter</Badge>
<Badge color='hw-green' icon='mdi:check' subtext='Supported'>Plug-In Battery</Badge>
<br />
<sub>_See [Supported Devices](/docs/introduction#devices) for more information._</sub>
Expand Down
Loading