Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions docs/discovery.mdx
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
## `_homewizard._tcp`.

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

Expand Down
20 changes: 8 additions & 12 deletions docs/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,18 +39,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 colorName='hw-green' icon="mdi:check" detail='v1'>Supported</Badge> | <Badge colorName='hw-green' icon="mdi:check" detail='2.0.0'>Requires Firmware 6.00</Badge> <Badge colorName='hw-purple' icon="mdi:test-tube" detail='2.1.0'>In beta</Badge> |
| Energy Socket | `HWE-SKT` | <Badge colorName='hw-green' icon="mdi:check" detail='v1'>Supported</Badge> | <Badge colorName='hw-grey' icon="mdi:wrench">In development</Badge> |
| Watermeter (Only when powered over USB) | `HWE-WTR` | <Badge colorName='hw-green' icon="mdi:check" detail='v1'>Supported</Badge> | <Badge colorName='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 colorName='hw-green' icon="mdi:check" detail='v1'>Supported</Badge> | <Badge colorName='hw-green' icon="mdi:check" detail='2.1.0'>Supported</Badge> |
| Energy Display | `HWE-DSP` | <Badge colorName='hw-grey' icon="mdi:close">Not planned</Badge> | <Badge colorName='hw-grey' icon="mdi:wrench">In development</Badge> |
| Plug-In Battery | `HWE-BAT` | <Badge colorName='hw-grey' icon="mdi:close">Not planned</Badge> | <Badge colorName='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.
:::
| Device | Device type | API v1 | API v2 |
| --------------------------------------- | ----------------------------------------------------------------------- | -------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| P1 Meter | `HWE-P1` | <Badge colorName='hw-green' icon="mdi:check" detail='v1'>Supported</Badge> | <Badge colorName='hw-green' icon="mdi:check" detail='2.1.0'>Supported</Badge> |
| Energy Socket | `HWE-SKT` | <Badge colorName='hw-green' icon="mdi:check" detail='v1'>Supported</Badge> | <Badge colorName='hw-grey' icon="mdi:wrench">In development</Badge> |
| Watermeter (Only when powered over USB) | `HWE-WTR` | <Badge colorName='hw-green' icon="mdi:check" detail='v1'>Supported</Badge> | <Badge colorName='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 colorName='hw-green' icon="mdi:check" detail='v1'>Supported</Badge> | <Badge colorName='hw-green' icon="mdi:check" detail='2.1.0'>Supported</Badge> |
| Energy Display | `HWE-DSP` | <Badge colorName='hw-grey' icon="mdi:close">Not planned</Badge> | <Badge colorName='hw-grey' icon="mdi:wrench">In development</Badge> |
| Plug-In Battery | `HWE-BAT` | <Badge colorName='hw-grey' icon="mdi:close">Not planned</Badge> | <Badge colorName='hw-green' icon="mdi:check" detail='2.0.1'>Supported</Badge> |

## Beta Program.

Expand Down
2 changes: 1 addition & 1 deletion docs/v2/authorization.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import Badge from '@site/src/components/Badge.js'
# Authorization `/api/user`.

{/* prettier-ignore */}
<Badge colorName='hw-green' icon='mdi:check' subtext='Requires Firmware 6.0000 or later'>P1 Meter</Badge>
<Badge colorName='hw-green' icon='mdi:check' subtext='Supported'>P1 Meter</Badge>
<Badge colorName='hw-grey' icon='mdi:wrench' subtext='In development'>Energy Socket</Badge>
<Badge colorName='hw-grey' icon='mdi:wrench' subtext='In development'>Energy Display</Badge>
<Badge colorName='hw-green' icon='mdi:check' subtext='Supported'>kWh Meter</Badge>
Expand Down
2 changes: 1 addition & 1 deletion docs/v2/device_information.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import Badge from '@site/src/components/Badge.js'
# Device Information `/api`.

{/* prettier-ignore */}
<Badge colorName='hw-green' icon='mdi:check' subtext='Requires Firmware 6.0000 or later'>P1 Meter</Badge>
<Badge colorName='hw-green' icon='mdi:check' subtext='Supported'>P1 Meter</Badge>
<Badge colorName='hw-purple' icon='mdi:check' subtext='Supported in v1'>Energy Socket</Badge>
<Badge colorName='hw-grey' icon='mdi:wrench' subtext='In development'>Energy Display</Badge>
<Badge colorName='hw-green' icon='mdi:check' subtext='Supported'>kWh Meter</Badge>
Expand Down
2 changes: 1 addition & 1 deletion docs/v2/error-handling.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import Badge from '@site/src/components/Badge.js'
# Error Handling.

{/* prettier-ignore */}
<Badge colorName='hw-green' icon='mdi:check' subtext='Requires Firmware 6.0000 or later'>P1 Meter</Badge>
<Badge colorName='hw-green' icon='mdi:check' subtext='Supported'>P1 Meter</Badge>
<Badge colorName='hw-purple' icon='mdi:check' subtext='Supported in v1'>Energy Socket</Badge>
<Badge colorName='hw-grey' icon='mdi:wrench' subtext='In development'>Energy Display</Badge>
<Badge colorName='hw-green' icon='mdi:check' subtext='Supported'>kWh Meter</Badge>
Expand Down
2 changes: 1 addition & 1 deletion docs/v2/measurement.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import Badge from '@site/src/components/Badge.js'
# Recent Measurement `/api/measurement`.

{/* prettier-ignore */}
<Badge colorName='hw-green' icon='mdi:check' subtext='Requires Firmware 6.0000 or later'>P1 Meter</Badge>
<Badge colorName='hw-green' icon='mdi:check' subtext='Supported'>P1 Meter</Badge>
<Badge colorName='hw-purple' icon='mdi:check' subtext='Supported in v1'>Energy Socket</Badge>
<Badge colorName='hw-grey' icon='mdi:wrench' subtext='In development'>Energy Display</Badge>
<Badge colorName='hw-green' icon='mdi:check' subtext='Supported'>kWh Meter</Badge>
Expand Down
2 changes: 1 addition & 1 deletion docs/v2/system.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import Badge from '@site/src/components/Badge.js'
# System `/api/system`.

{/* prettier-ignore */}
<Badge colorName='hw-green' icon='mdi:check' subtext='Requires Firmware 6.0000 or later'>P1 Meter</Badge>
<Badge colorName='hw-green' icon='mdi:check' subtext='Supported'>P1 Meter</Badge>
<Badge colorName='hw-purple' icon='mdi:check' subtext='Supported in v1'>Energy Socket</Badge>
<Badge colorName='hw-grey' icon='mdi:wrench' subtext='In development'>Energy Display</Badge>
<Badge colorName='hw-green' icon='mdi:check' subtext='Supported'>kWh Meter</Badge>
Expand Down
2 changes: 1 addition & 1 deletion docs/v2/telegram.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import Badge from '@site/src/components/Badge.js'
# Telegram `/api/telegram`.

{/* prettier-ignore */}
<Badge colorName='hw-green' icon='mdi:check' subtext='Requires Firmware 6.0000 or later'>P1 Meter</Badge>
<Badge colorName='hw-green' icon='mdi:check' subtext='Supported'>P1 Meter</Badge>
<Badge colorName='hw-grey' icon='mdi:close' subtext='Not supported'>Energy Socket</Badge>
<Badge colorName='hw-grey' icon='mdi:close' subtext='Not supported'>Energy Display</Badge>
<Badge colorName='hw-grey' icon='mdi:close' subtext='Not supported'>kWh Meter</Badge>
Expand Down
2 changes: 1 addition & 1 deletion docs/v2/websocket.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import Badge from '@site/src/components/Badge.js'
# WebSocket `/api/ws`.

{/* prettier-ignore */}
<Badge colorName='hw-green' icon='mdi:check' subtext='Requires Firmware 6.0000 or later'>P1 Meter</Badge>
<Badge colorName='hw-green' icon='mdi:check' subtext='Supported'>P1 Meter</Badge>
<Badge colorName='hw-grey' icon='mdi:wrench' subtext='In development'>Energy Socket</Badge>
<Badge colorName='hw-grey' icon='mdi:wrench' subtext='In development'>Energy Display</Badge>
<Badge colorName='hw-green' icon='mdi:check' subtext='Supported'>kWh Meter</Badge>
Expand Down