Skip to content
Open
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
5 changes: 5 additions & 0 deletions docs/changelog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,11 @@ Feature development of the v1 API has been stopped. No new features will be adde
- The `mode` field in the [Plug-In Battery API](/docs/v2/batteries) now supports a new mode: `predictive`. In this mode, the control system will automatically select between `charge_allowed`, `discharge_allowed`, both or neither based on the current and predicted power consumption/production of your home and the current energy prices.
- A new field is added to the [Plug-In Battery API](/docs/v2/batteries): `charge_to_full`. This field can be set to `true` to charge all connected Plug-In Batteries to 100% and can be set to `false` to disable this behavior.

#### 2.3.1 - 17-11-2026

- Support has been added for the v2 of the API to the Energy Socket
- New fields are added to the [System API](/docs/v2/system): 'switch_lock' and 'power_on'. These properties are only relevant for the Energy Socket.

## Subscribe to Updates.

Get notified for changes in the API and its documentation when something has changed. Subscribe to changes at GitHub. Click the "Watch" button in the top-right to select your notifications type. We recommend you to select "Watch → "Custom" → "Releases".
Expand Down
10 changes: 5 additions & 5 deletions docs/discovery.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,12 @@ 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="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>
<Badge colorName='hw-green' icon="mdi:check" subtext="Supported">P1 Meter</Badge>
<Badge colorName='hw-green' icon="mdi:check" subtext="Supported" detail="In beta">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>
<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>
<Badge colorName='hw-green' icon="mdi:check" subtext="Supported">Plug-In Battery</Badge>

---

Expand Down
18 changes: 9 additions & 9 deletions docs/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,15 +39,15 @@ 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.3.0'>Supported</Badge> |
| Energy Socket | `HWE-SKT` | <Badge colorName='hw-green' icon="mdi:check" detail='v1'>Supported</Badge> | <Badge colorName='hw-grey' icon="mdi:calendar-blank">Planned</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:calendar-blank">Planned</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.3.0'>Supported</Badge> |
| Energy Display | `HWE-DSP` | <Badge colorName='hw-grey' icon="mdi:close">Not planned</Badge> | <Badge colorName='hw-grey' icon="mdi:calendar-blank">Planned</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> |
| Temperature Humidity Meter (always battery powered) | `HWE-TMP` | <Badge colorName='hw-grey' icon="mdi:close">Not planned</Badge> | <Badge colorName='hw-grey' icon="mdi:compass">Exploring alternatives</Badge> |
| 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='v2.3.0'>Supported</Badge> |
| Energy Socket | `HWE-SKT` | <Badge colorName='hw-green' icon="mdi:check" detail='v1'>Supported</Badge> | <Badge colorName='hw-green' icon="mdi:check" detail='v2.3.1'>API support in beta</Badge> <Badge colorName='hw-grey' icon="mdi:calendar-blank">WebSocket support planned</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:calendar-blank">Planned</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='v2.3.0'>Supported</Badge> |
| Energy Display | `HWE-DSP` | <Badge colorName='hw-grey' icon="mdi:close">Not planned</Badge> | <Badge colorName='hw-grey' icon="mdi:calendar-blank">Planned</Badge> |
| Plug-In Battery | `HWE-BAT` | <Badge colorName='hw-grey' icon="mdi:close">Not planned</Badge> | <Badge colorName='hw-green' icon="mdi:check" detail='v2.0.1'>Supported</Badge> |
| Temperature Humidity Meter (always battery powered) | `HWE-TMP` | <Badge colorName='hw-grey' icon="mdi:close">Not planned</Badge> | <Badge colorName='hw-grey' icon="mdi:compass">Exploring alternatives</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 @@ -10,7 +10,7 @@ import Badge from '@site/src/components/Badge.js'

{/* prettier-ignore */}
<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-green' icon='mdi:check' subtext='Supported' detail="In beta">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>
<Badge colorName='hw-grey' icon='mdi:wrench' subtext='In development'>Watermeter</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 @@ -10,7 +10,7 @@ import Badge from '@site/src/components/Badge.js'

{/* prettier-ignore */}
<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-green' icon='mdi:check' subtext='Supported' detail="In beta">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>
<Badge colorName='hw-purple' icon='mdi:check' subtext='Supported in v1'>Watermeter</Badge>
Expand Down
45 changes: 23 additions & 22 deletions docs/v2/error-handling.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'

{/* prettier-ignore */}
<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-green' icon='mdi:check' subtext='Supported' detail="In beta">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>
<Badge colorName='hw-purple' icon='mdi:check' subtext='Supported in v1'>Watermeter</Badge>
Expand All @@ -29,27 +29,28 @@ Each error is represented as a set of 'scope' and 'error' fields. The 'scope' fi

### List of Errors

| Code | Description |
| ----------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `request:invalid-json` | Server was unable to parse the JSON data. |
| `json:no-parameters-recognized` | JSON was correct, but no required parameters were found. |
| `json:parameter-invalid-type:<parameter>` | Invalid type for a parameter, e.g. a string where a number is expected. |
| `json:parameter-missing:<parameter>` | Required parameter is missing. |
| `json:parameter-not-exclusive` | Two or more parameters are mutually exclusive. |
| `request:api-version-not-supported` | Requested API version not supported, see [versioning](/docs/versioning). |
| `request:internal-server-error` | Something went wrong on the server side. |
| `request:too-large` | Request too large. |
| `request:unknown-subscription` | WebSocket subscription topic not recognized, see [WebSocket subscriptions](/docs/v2/websocket#subscribe). |
| `request:unknown-type` | WebSocket `type` parameter not recognized, see [WebSocket structure](/docs/v2/websocket#structure). |
| `telegram:no-telegram-received` | No telegram received, see [telegram](/docs/v2/telegram#error-handling). |
| `user:creation-not-enabled` | User creation is not enabled, button press required. |
| `user:invalid-prefix` | Invalid name prefix provided, see [create user](/docs/v2/authorization#create-user-and-get-token). |
| `user:name-empty` | Upon creating a user, the name was empty. |
| `user:name-invalid` | Upon creating a user, the name contained invalid tokens, see [create user](/docs/v2/authorization#create-user-and-get-token). |
| `user:name-too-long` | Upon creating a user, the name was too long. |
| `user:no-storage` | No storage available to store a new user, delete existing users. |
| `user:not-found` | Tried to delete a user which does not exist. |
| `user:unauthorized` | User token is invalid or not authorized, see [authorization](/docs/v2/authorization). |
| Code | Description |
| ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `request:invalid-json` | Server was unable to parse the JSON data. |
| `json:no-parameters-recognized` | JSON was correct, but no required parameters were found. |
| `json:parameter-invalid-type:<parameter>` | Invalid type for a parameter, e.g. a string where a number is expected. |
| `json:parameter-missing:<parameter>` | Required parameter is missing. |
| `json:parameter-not-exclusive` | Two or more parameters are mutually exclusive. |
| `request:api-version-not-supported` | Requested API version not supported, see [versioning](/docs/versioning). |
| `request:internal-server-error` | Something went wrong on the server side. |
| `request:switch-lock-enabled` | Disabling the power flow is impossible when switch lock is enabled, see [switch lock](/docs/v2/system#energy-socket-power-and-switch-lock). |
| `request:too-large` | Request too large. |
| `request:unknown-subscription` | WebSocket subscription topic not recognized, see [WebSocket subscriptions](/docs/v2/websocket#subscribe). |
| `request:unknown-type` | WebSocket `type` parameter not recognized, see [WebSocket structure](/docs/v2/websocket#structure). |
| `telegram:no-telegram-received` | No telegram received, see [telegram](/docs/v2/telegram#error-handling). |
| `user:creation-not-enabled` | User creation is not enabled, button press required. |
| `user:invalid-prefix` | Invalid name prefix provided, see [create user](/docs/v2/authorization#create-user-and-get-token). |
| `user:name-empty` | Upon creating a user, the name was empty. |
| `user:name-invalid` | Upon creating a user, the name contained invalid tokens, see [create user](/docs/v2/authorization#create-user-and-get-token). |
| `user:name-too-long` | Upon creating a user, the name was too long. |
| `user:no-storage` | No storage available to store a new user, delete existing users. |
| `user:not-found` | Tried to delete a user which does not exist. |
| `user:unauthorized` | User token is invalid or not authorized, see [authorization](/docs/v2/authorization). |

:::tip
The list of error codes may be extended in the future. We recommend that you prepare for new error codes by having a generic error handling mechanism in place.
Expand Down
Loading