From cf5e8384b74e4ebadf103f786bd1a8d05e299ce4 Mon Sep 17 00:00:00 2001 From: xlenstra Date: Tue, 17 Nov 2026 11:21:51 +0100 Subject: [PATCH 1/8] Added API documentation for the V2 version of the socket API This commit adds documentation describing the functionality of the V2 version of the API for the Energy Socket. In many cases, this just amounts to setting the 'in development' badge to 'Supported'. In some cases more documentation is added. The measurement file is updated to document the values that are returned when querying a socket for its most recent measurements. The system file is updated to include the new socket-specific properties (switch lock & power state). --- docs/discovery.mdx | 10 ++++---- docs/introduction.mdx | 18 +++++++------- docs/v2/authorization.mdx | 2 +- docs/v2/device_information.mdx | 2 +- docs/v2/error-handling.mdx | 2 +- docs/v2/measurement.mdx | 43 +++++++++++++++++++++++++++++++++- docs/v2/system.mdx | 28 ++++++++++++---------- 7 files changed, 74 insertions(+), 31 deletions(-) diff --git a/docs/discovery.mdx b/docs/discovery.mdx index 8015848..46bab0a 100644 --- a/docs/discovery.mdx +++ b/docs/discovery.mdx @@ -46,12 +46,12 @@ A discovery response contains additional data to enhance the setup in your appli ## `_homewizard._tcp`. {/* prettier-ignore */} -P1 Meter -Energy Socket -Energy Display -kWh Meter +P1 Meter +Energy Socket +Energy Display +kWh Meter Watermeter -Plug-In Battery +Plug-In Battery --- diff --git a/docs/introduction.mdx b/docs/introduction.mdx index 03d646e..b50a05f 100644 --- a/docs/introduction.mdx +++ b/docs/introduction.mdx @@ -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` | Supported | Supported | -| Energy Socket | `HWE-SKT` | Supported | Planned | -| Watermeter (only when powered over USB) | `HWE-WTR` | Supported | Planned | -| kWh Meter (1-phase and 3-phase) | `HWE-KWH1`,
`HWE-KWH3`,
`SDM230-wifi` and
`SDM630-wifi` | Supported | Supported | -| Energy Display | `HWE-DSP` | Not planned | Planned | -| Plug-In Battery | `HWE-BAT` | Not planned | Supported | -| Temperature Humidity Meter (always battery powered) | `HWE-TMP` | Not planned | Exploring alternatives | +| Device | Device type | API v1 | API v2 | +| --------------------------------------------------- | ----------------------------------------------------------------------- | -------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| P1 Meter | `HWE-P1` | Supported | Supported | +| Energy Socket | `HWE-SKT` | Supported | API Support WebSocket Support Planned | +| Watermeter (only when powered over USB) | `HWE-WTR` | Supported | Planned | +| kWh Meter (1-phase and 3-phase) | `HWE-KWH1`,
`HWE-KWH3`,
`SDM230-wifi` and
`SDM630-wifi` | Supported | Supported | +| Energy Display | `HWE-DSP` | Not planned | Planned | +| Plug-In Battery | `HWE-BAT` | Not planned | Supported | +| Temperature Humidity Meter (always battery powered) | `HWE-TMP` | Not planned | Exploring alternatives | ## Beta Program. diff --git a/docs/v2/authorization.mdx b/docs/v2/authorization.mdx index 17165f8..ed49f18 100644 --- a/docs/v2/authorization.mdx +++ b/docs/v2/authorization.mdx @@ -10,7 +10,7 @@ import Badge from '@site/src/components/Badge.js' {/* prettier-ignore */} P1 Meter -Energy Socket +Energy Socket Energy Display kWh Meter Watermeter diff --git a/docs/v2/device_information.mdx b/docs/v2/device_information.mdx index 3c06c49..b6d5cd7 100644 --- a/docs/v2/device_information.mdx +++ b/docs/v2/device_information.mdx @@ -10,7 +10,7 @@ import Badge from '@site/src/components/Badge.js' {/* prettier-ignore */} P1 Meter -Energy Socket +Energy Socket Energy Display kWh Meter Watermeter diff --git a/docs/v2/error-handling.mdx b/docs/v2/error-handling.mdx index 48233de..4968e78 100644 --- a/docs/v2/error-handling.mdx +++ b/docs/v2/error-handling.mdx @@ -10,7 +10,7 @@ import Badge from '@site/src/components/Badge.js' {/* prettier-ignore */} P1 Meter -Energy Socket +Energy Socket Energy Display kWh Meter Watermeter diff --git a/docs/v2/measurement.mdx b/docs/v2/measurement.mdx index 509df31..899f67e 100644 --- a/docs/v2/measurement.mdx +++ b/docs/v2/measurement.mdx @@ -11,7 +11,7 @@ import Badge from '@site/src/components/Badge.js' {/* prettier-ignore */} P1 Meter -Energy Socket +Energy Socket Energy Display kWh Meter Watermeter @@ -166,6 +166,22 @@ Belgian users may be charged for the peak usage per month (see /api/measurement --insecure \ + -H "Authorization: Bearer " \ + -H "X-Api-Version: 2" +``` + +```http title="Response" +https/1.1 200 OK +Content-Type: application/json + +{ + "energy_import_kwh": 123.456, + "energy_export_kwh": 78.910, + "power_w": 123, + "voltage_v": 230, + "current_a": 1.5, + "frequency_hz": 50, + "reactive_power_var": 67, + "apparent_power_va": 345, + "power_factor": 0.95 + } +``` diff --git a/docs/v2/system.mdx b/docs/v2/system.mdx index 0147c90..73826aa 100644 --- a/docs/v2/system.mdx +++ b/docs/v2/system.mdx @@ -10,7 +10,7 @@ import Badge from '@site/src/components/Badge.js' {/* prettier-ignore */} P1 Meter -Energy Socket +Energy Socket Energy Display kWh Meter Watermeter @@ -24,21 +24,23 @@ The `/api/system` endpoint can be used to get and set some system information, l ## Parameters. -| Data | Type | Access | Description | Availability | -| --------------------------------------------------- | ---------------- | ---------- | ----------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| wifi_ssid | String | Read-only | The SSID of the Wi-Fi network. | P1 Meter kWh Meter Plug-In Battery | -| wifi_rssi_db | Number | Read-only | The signal strength of the Wi-Fi network. | P1 Meter kWh Meter Plug-In Battery | -| uptime_s | Number | Read-only | The uptime of the device in seconds. | P1 Meter kWh Meter Plug-In Battery | -| [cloud_enabled](#cloud-communication) | Boolean | Read/Write | The state of the cloud communication. | P1 Meter kWh Meter Plug-In Battery | -| [status_led_brightness_pct](#status-led-brightness) | Number | Read/Write | The brightness of the status LED in percent. | P1 Meter kWh Meter Plug-In Battery | -| [api_v1_enabled](#enable-or-disable-the-v1-api) | Optional Boolean | Read/Write | The state of the v1 API, will be removed when API v1 is removed, so this parameter is optional. | P1 Meter kWh Meter Plug-In Battery | +| Data | Type | Access | Description | Availability | +| --------------------------------------------------- | ---------------- | ---------- | ----------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| wifi_ssid | String | Read-only | The SSID of the Wi-Fi network. | P1 Meter kWh Meter Plug-In Battery Energy Socket | +| wifi_rssi_db | Number | Read-only | The signal strength of the Wi-Fi network. | P1 Meter kWh Meter Plug-In Battery Energy Socket | +| uptime_s | Number | Read-only | The uptime of the device in seconds. | P1 Meter kWh Meter Plug-In Battery Energy Socket | +| [cloud_enabled](#cloud-communication) | Boolean | Read/Write | The state of the cloud communication. | P1 Meter kWh Meter Plug-In Battery Energy Socket | +| [status_led_brightness_pct](#status-led-brightness) | Number | Read/Write | The brightness of the status LED in percent. | P1 Meter kWh Meter Plug-In Battery Energy Socket | +| [api_v1_enabled](#enable-or-disable-the-v1-api) | Optional Boolean | Read/Write | The state of the v1 API, will be removed when API v1 is removed, so this parameter is optional. | P1 Meter kWh Meter Plug-In Battery Energy Socket | +| switch_lock | Boolean | Read/Write | The state of the switch lock. When enabled, the socket power cannot be disabled. | P1 Meter kWh Meter Plug-In Battery Energy Socket | +| power_on | Boolean | Read/Write | The power state of the socket. | P1 Meter kWh Meter Plug-In Battery Energy Socket | ## Actions. -| Action | Description | Availability | -| --------------------- | --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| [Reboot](#reboot) | Reboot the device | P1 Meter kWh Meter Plug-In Battery | -| [Identify](#identify) | Let the device identify itself by blinking the status LED | P1 Meter kWh Meter Plug-In Battery | +| Action | Description | Availability | +| --------------------- | --------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [Reboot](#reboot) | Reboot the device | P1 Meter kWh Meter Plug-In Battery Energy Socket | +| [Identify](#identify) | Let the device identify itself by blinking the status LED | P1 Meter kWh Meter Plug-In Battery Energy Socket | ## Plug-In Battery exceptions. From 5e7e90b7d76daed24a68fa2e7f0d23673e1a34d9 Mon Sep 17 00:00:00 2001 From: xlenstra Date: Tue, 17 Nov 2026 15:27:38 +0100 Subject: [PATCH 2/8] Marked socket API v2 as beta & added new version number This commit marks the API v2 of the socket as being in beta in all relevant places. Additionally, the changelog was updated to reflect the changes made to the protocol to support the Energy Socket. --- docs/changelog.mdx | 5 +++++ docs/discovery.mdx | 2 +- docs/introduction.mdx | 18 +++++++++--------- docs/v2/authorization.mdx | 2 +- docs/v2/device_information.mdx | 2 +- docs/v2/error-handling.mdx | 2 +- docs/v2/measurement.mdx | 2 +- docs/v2/system.mdx | 2 +- 8 files changed, 20 insertions(+), 15 deletions(-) diff --git a/docs/changelog.mdx b/docs/changelog.mdx index 10de621..2155f44 100644 --- a/docs/changelog.mdx +++ b/docs/changelog.mdx @@ -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". diff --git a/docs/discovery.mdx b/docs/discovery.mdx index 46bab0a..115a5c4 100644 --- a/docs/discovery.mdx +++ b/docs/discovery.mdx @@ -47,7 +47,7 @@ A discovery response contains additional data to enhance the setup in your appli {/* prettier-ignore */} P1 Meter -Energy Socket +Energy Socket Energy Display kWh Meter Watermeter diff --git a/docs/introduction.mdx b/docs/introduction.mdx index b50a05f..b4cc532 100644 --- a/docs/introduction.mdx +++ b/docs/introduction.mdx @@ -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` | Supported | Supported | -| Energy Socket | `HWE-SKT` | Supported | API Support WebSocket Support Planned | -| Watermeter (only when powered over USB) | `HWE-WTR` | Supported | Planned | -| kWh Meter (1-phase and 3-phase) | `HWE-KWH1`,
`HWE-KWH3`,
`SDM230-wifi` and
`SDM630-wifi` | Supported | Supported | -| Energy Display | `HWE-DSP` | Not planned | Planned | -| Plug-In Battery | `HWE-BAT` | Not planned | Supported | -| Temperature Humidity Meter (always battery powered) | `HWE-TMP` | Not planned | Exploring alternatives | +| Device | Device type | API v1 | API v2 | +| --------------------------------------------------- | ----------------------------------------------------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| P1 Meter | `HWE-P1` | Supported | Supported | +| Energy Socket | `HWE-SKT` | Supported | API Support in beta WebSocket Support Planned | +| Watermeter (only when powered over USB) | `HWE-WTR` | Supported | Planned | +| kWh Meter (1-phase and 3-phase) | `HWE-KWH1`,
`HWE-KWH3`,
`SDM230-wifi` and
`SDM630-wifi` | Supported | Supported | +| Energy Display | `HWE-DSP` | Not planned | Planned | +| Plug-In Battery | `HWE-BAT` | Not planned | Supported | +| Temperature Humidity Meter (always battery powered) | `HWE-TMP` | Not planned | Exploring alternatives | ## Beta Program. diff --git a/docs/v2/authorization.mdx b/docs/v2/authorization.mdx index ed49f18..c836358 100644 --- a/docs/v2/authorization.mdx +++ b/docs/v2/authorization.mdx @@ -10,7 +10,7 @@ import Badge from '@site/src/components/Badge.js' {/* prettier-ignore */} P1 Meter -Energy Socket +Energy Socket Energy Display kWh Meter Watermeter diff --git a/docs/v2/device_information.mdx b/docs/v2/device_information.mdx index b6d5cd7..89b9ef8 100644 --- a/docs/v2/device_information.mdx +++ b/docs/v2/device_information.mdx @@ -10,7 +10,7 @@ import Badge from '@site/src/components/Badge.js' {/* prettier-ignore */} P1 Meter -Energy Socket +Energy Socket Energy Display kWh Meter Watermeter diff --git a/docs/v2/error-handling.mdx b/docs/v2/error-handling.mdx index 4968e78..06e101b 100644 --- a/docs/v2/error-handling.mdx +++ b/docs/v2/error-handling.mdx @@ -10,7 +10,7 @@ import Badge from '@site/src/components/Badge.js' {/* prettier-ignore */} P1 Meter -Energy Socket +Energy Socket Energy Display kWh Meter Watermeter diff --git a/docs/v2/measurement.mdx b/docs/v2/measurement.mdx index 899f67e..21ba0da 100644 --- a/docs/v2/measurement.mdx +++ b/docs/v2/measurement.mdx @@ -11,7 +11,7 @@ import Badge from '@site/src/components/Badge.js' {/* prettier-ignore */} P1 Meter -Energy Socket +Energy Socket Energy Display kWh Meter Watermeter diff --git a/docs/v2/system.mdx b/docs/v2/system.mdx index 73826aa..24b1794 100644 --- a/docs/v2/system.mdx +++ b/docs/v2/system.mdx @@ -10,7 +10,7 @@ import Badge from '@site/src/components/Badge.js' {/* prettier-ignore */} P1 Meter -Energy Socket +Energy Socket Energy Display kWh Meter Watermeter From c405eed303a67219d3bcdc4189cf7a427dadb70d Mon Sep 17 00:00:00 2001 From: xlenstra Date: Tue, 17 Nov 2026 16:45:06 +0100 Subject: [PATCH 3/8] Fixed wrong badge title Accidentally forgot to change this --- docs/discovery.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/discovery.mdx b/docs/discovery.mdx index 115a5c4..a8ab4bd 100644 --- a/docs/discovery.mdx +++ b/docs/discovery.mdx @@ -46,12 +46,12 @@ A discovery response contains additional data to enhance the setup in your appli ## `_homewizard._tcp`. {/* prettier-ignore */} -P1 Meter -Energy Socket +P1 Meter +Energy Socket Energy Display -kWh Meter +kWh Meter Watermeter -Plug-In Battery +Plug-In Battery --- From ab8a874af62e3029694d9ee618e23d20aaea1646 Mon Sep 17 00:00:00 2001 From: Lex Postma Date: Thu, 19 Nov 2026 11:53:58 +0100 Subject: [PATCH 4/8] Document Energy Socket power and switch lock in v2 system API This commit documents the socket-specific `power_on` and `switch_lock` parameters of the v2 system endpoint as thoroughly as the v1 state endpoint: the behavior of the switch lock, the rules for combined requests and request/response examples for turning the socket on and off and enabling the switch lock. The error returned for an invalid `power_on`/`switch_lock` combination still has to be confirmed with firmware; a TODO marks this in the page. Co-Authored-By: Claude Opus 5.5 --- docs/v2/system.mdx | 127 ++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 125 insertions(+), 2 deletions(-) diff --git a/docs/v2/system.mdx b/docs/v2/system.mdx index 24b1794..0d77ec3 100644 --- a/docs/v2/system.mdx +++ b/docs/v2/system.mdx @@ -32,8 +32,8 @@ The `/api/system` endpoint can be used to get and set some system information, l | [cloud_enabled](#cloud-communication) | Boolean | Read/Write | The state of the cloud communication. | P1 Meter kWh Meter Plug-In Battery Energy Socket | | [status_led_brightness_pct](#status-led-brightness) | Number | Read/Write | The brightness of the status LED in percent. | P1 Meter kWh Meter Plug-In Battery Energy Socket | | [api_v1_enabled](#enable-or-disable-the-v1-api) | Optional Boolean | Read/Write | The state of the v1 API, will be removed when API v1 is removed, so this parameter is optional. | P1 Meter kWh Meter Plug-In Battery Energy Socket | -| switch_lock | Boolean | Read/Write | The state of the switch lock. When enabled, the socket power cannot be disabled. | P1 Meter kWh Meter Plug-In Battery Energy Socket | -| power_on | Boolean | Read/Write | The power state of the socket. | P1 Meter kWh Meter Plug-In Battery Energy Socket | +| [switch_lock](#energy-socket-power-and-switch-lock) | Boolean | Read/Write | The state of the switch lock. When enabled, the socket power cannot be disabled. | P1 Meter kWh Meter Plug-In Battery Energy Socket | +| [power_on](#energy-socket-power-and-switch-lock) | Boolean | Read/Write | The power state of the socket. | P1 Meter kWh Meter Plug-In Battery Energy Socket | ## Actions. @@ -54,6 +54,129 @@ The Plug-In Battery has some exceptions compared to the P1 Meter: The battery is fully controlled locally by the P1 Meter, ensuring fast operation and continued functionality even if the internet connection is lost. ::: +## Energy Socket Power and Switch Lock. + +The Energy Socket can be controlled with the `power_on` and `switch_lock` parameters. In API v1 these parameters were part of the [state endpoint](/docs/v1/state); in API v2 they are part of the system endpoint. + +- `power_on` returns `true` when the relay is in the 'on' state. Set it to `true` or `false` to turn the socket on or off. +- `switch_lock` keeps the socket turned on. When `switch_lock` is enabled, the socket is turned on and cannot be turned off until `switch_lock` is disabled again. + +The complete state has to make sense; It is not possible to set `power_on` to `false` while `switch_lock` is `true`. Such a request is rejected, see [error handling](/docs/v2/error-handling) for more details. + +{/* TODO: Confirm with firmware which HTTP status and error code are returned when `power_on` is set to `false` while `switch_lock` is `true` (in a single request, or while the lock is already enabled), and add that error code to /docs/v2/error-handling. */} + +The order of a combined request does not matter. If `switch_lock` was enabled, sending `{"power_on": false, "switch_lock": false}` will still turn the socket off. + +### Examples + +#### Turn on Socket + +```http title="Request" +curl https:///api/system --insecure \ + -X PUT \ + -H "Authorization: Bearer " \ + -H "X-Api-Version: 2" \ + -d '{"power_on": true}' +``` + +```http title="Response" +https/1.1 200 OK +Content-Type: application/json + +{ + "wifi_ssid": "My Wi-Fi", + "wifi_rssi_db": -77, + "cloud_enabled": true, + "uptime_s": 356, + "status_led_brightness_pct": 100, + "api_v1_enabled": true, + "switch_lock": false, + "power_on": true +} +``` + +#### Turn off Socket + +```http title="Request" +curl https:///api/system --insecure \ + -X PUT \ + -H "Authorization: Bearer " \ + -H "X-Api-Version: 2" \ + -d '{"power_on": false}' +``` + +```http title="Response" +https/1.1 200 OK +Content-Type: application/json + +{ + "wifi_ssid": "My Wi-Fi", + "wifi_rssi_db": -77, + "cloud_enabled": true, + "uptime_s": 356, + "status_led_brightness_pct": 100, + "api_v1_enabled": true, + "switch_lock": false, + "power_on": false +} +``` + +#### Enable Switch Lock + +After enabling `switch_lock`, the socket is 'on' and cannot be turned off until `switch_lock` is disabled. + +```http title="Request" +curl https:///api/system --insecure \ + -X PUT \ + -H "Authorization: Bearer " \ + -H "X-Api-Version: 2" \ + -d '{"switch_lock": true}' +``` + +```http title="Response" +https/1.1 200 OK +Content-Type: application/json + +{ + "wifi_ssid": "My Wi-Fi", + "wifi_rssi_db": -77, + "cloud_enabled": true, + "uptime_s": 356, + "status_led_brightness_pct": 100, + "api_v1_enabled": true, + "switch_lock": true, + "power_on": true +} +``` + +#### Disable Switch Lock and Turn off Socket + +Both parameters can be set in a single request. The order does not matter: the socket turns off even though `switch_lock` was enabled. + +```http title="Request" +curl https:///api/system --insecure \ + -X PUT \ + -H "Authorization: Bearer " \ + -H "X-Api-Version: 2" \ + -d '{"power_on": false, "switch_lock": false}' +``` + +```http title="Response" +https/1.1 200 OK +Content-Type: application/json + +{ + "wifi_ssid": "My Wi-Fi", + "wifi_rssi_db": -77, + "cloud_enabled": true, + "uptime_s": 356, + "status_led_brightness_pct": 100, + "api_v1_enabled": true, + "switch_lock": false, + "power_on": false +} +``` + ## Cloud Communication. HomeWizard devices are designed to work with the HomeWizard app and rely on communication with the HomeWizard cloud for full functionality. From f36df53ebcce6c2c1658f03c352654136928bb2f Mon Sep 17 00:00:00 2001 From: Lex Postma Date: Thu, 19 Nov 2026 12:46:30 +0100 Subject: [PATCH 5/8] Document confirmed switch lock behavior of the Energy Socket This commit replaces the switch lock TODO with the behavior of the socket firmware (`components/app_api/app_api_v2.cpp` and `components/relay/relay.cpp`): - While the switch lock is enabled, a request that sets `power_on` without `switch_lock` is refused with `400 Bad Request` and `request:switch-lock-enabled`, for both `true` and `false`. - `switch_lock` is always applied before `power_on`, so the order of parameters does not matter. - `{"power_on": false, "switch_lock": true}` is accepted, and the switch lock takes precedence: the socket is turned on. It adds an example of the refused request and lists `request:switch-lock-enabled` in the v2 error codes. Co-Authored-By: Claude Opus 5.5 --- docs/v2/error-handling.mdx | 43 +++++++++++++++++++------------------- docs/v2/system.mdx | 26 ++++++++++++++++++++--- 2 files changed, 45 insertions(+), 24 deletions(-) diff --git a/docs/v2/error-handling.mdx b/docs/v2/error-handling.mdx index 06e101b..f875722 100644 --- a/docs/v2/error-handling.mdx +++ b/docs/v2/error-handling.mdx @@ -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:` | Invalid type for a parameter, e.g. a string where a number is expected. | -| `json:parameter-missing:` | 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:` | Invalid type for a parameter, e.g. a string where a number is expected. | +| `json:parameter-missing:` | 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` | The Energy Socket cannot be switched while the 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. diff --git a/docs/v2/system.mdx b/docs/v2/system.mdx index 0d77ec3..1fd89d2 100644 --- a/docs/v2/system.mdx +++ b/docs/v2/system.mdx @@ -61,11 +61,12 @@ The Energy Socket can be controlled with the `power_on` and `switch_lock` parame - `power_on` returns `true` when the relay is in the 'on' state. Set it to `true` or `false` to turn the socket on or off. - `switch_lock` keeps the socket turned on. When `switch_lock` is enabled, the socket is turned on and cannot be turned off until `switch_lock` is disabled again. -The complete state has to make sense; It is not possible to set `power_on` to `false` while `switch_lock` is `true`. Such a request is rejected, see [error handling](/docs/v2/error-handling) for more details. +While `switch_lock` is enabled, a request that sets `power_on` without also setting `switch_lock` is refused with `400 Bad Request` and the error `request:switch-lock-enabled`, see [error handling](/docs/v2/error-handling). This applies to both `true` and `false`. -{/* TODO: Confirm with firmware which HTTP status and error code are returned when `power_on` is set to `false` while `switch_lock` is `true` (in a single request, or while the lock is already enabled), and add that error code to /docs/v2/error-handling. */} +When a request contains both parameters, `switch_lock` is always applied before `power_on`, so the order of the parameters does not matter: -The order of a combined request does not matter. If `switch_lock` was enabled, sending `{"power_on": false, "switch_lock": false}` will still turn the socket off. +- If `switch_lock` was enabled, sending `{"power_on": false, "switch_lock": false}` disables the switch lock and turns the socket off. +- Sending `{"power_on": false, "switch_lock": true}` is accepted, but the switch lock takes precedence: the socket is turned on. ### Examples @@ -149,6 +150,25 @@ Content-Type: application/json } ``` +#### Turn off Socket when Switch Lock is Enabled + +```http title="Request" +curl https:///api/system --insecure \ + -X PUT \ + -H "Authorization: Bearer " \ + -H "X-Api-Version: 2" \ + -d '{"power_on": false}' +``` + +```http title="Response" +https/1.1 400 Bad Request +Content-Type: application/json + +{ + "error": "request:switch-lock-enabled" +} +``` + #### Disable Switch Lock and Turn off Socket Both parameters can be set in a single request. The order does not matter: the socket turns off even though `switch_lock` was enabled. From 8cfe2ce509a9ab12f7650033662c8d5a08552f98 Mon Sep 17 00:00:00 2001 From: xlenstra Date: Fri, 20 Nov 2026 14:23:39 +0100 Subject: [PATCH 6/8] Reworded & moved some text This commit moves around the documentation for features exclusive to the Energy Socket. Other features that are not exclusive to the Energy Socket should take precedence. Additionally, I reworded a statement to make it sound more in line with the 'dev-speak' of the other error descriptions. --- docs/v2/error-handling.mdx | 44 +++++------ docs/v2/system.mdx | 154 +++++++++++++++---------------------- 2 files changed, 86 insertions(+), 112 deletions(-) diff --git a/docs/v2/error-handling.mdx b/docs/v2/error-handling.mdx index f875722..7e63193 100644 --- a/docs/v2/error-handling.mdx +++ b/docs/v2/error-handling.mdx @@ -29,28 +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:` | Invalid type for a parameter, e.g. a string where a number is expected. | -| `json:parameter-missing:` | 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` | The Energy Socket cannot be switched while the 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). | +| 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:` | Invalid type for a parameter, e.g. a string where a number is expected. | +| `json:parameter-missing:` | 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. diff --git a/docs/v2/system.mdx b/docs/v2/system.mdx index 1fd89d2..af9232f 100644 --- a/docs/v2/system.mdx +++ b/docs/v2/system.mdx @@ -54,30 +54,30 @@ The Plug-In Battery has some exceptions compared to the P1 Meter: The battery is fully controlled locally by the P1 Meter, ensuring fast operation and continued functionality even if the internet connection is lost. ::: -## Energy Socket Power and Switch Lock. +## Cloud Communication. -The Energy Socket can be controlled with the `power_on` and `switch_lock` parameters. In API v1 these parameters were part of the [state endpoint](/docs/v1/state); in API v2 they are part of the system endpoint. +HomeWizard devices are designed to work with the HomeWizard app and rely on communication with the HomeWizard cloud for full functionality. -- `power_on` returns `true` when the relay is in the 'on' state. Set it to `true` or `false` to turn the socket on or off. -- `switch_lock` keeps the socket turned on. When `switch_lock` is enabled, the socket is turned on and cannot be turned off until `switch_lock` is disabled again. +Users can choose to disable cloud communication, making the device operate entirely locally. However, this will prevent the app from interacting with the device, and the device will no longer receive firmware updates. -While `switch_lock` is enabled, a request that sets `power_on` without also setting `switch_lock` is refused with `400 Bad Request` and the error `request:switch-lock-enabled`, see [error handling](/docs/v2/error-handling). This applies to both `true` and `false`. +Cloud communication can be re-enabled by setting `cloud_enabled` to `true`. It is also automatically restored after a factory reset or when the device is put into pairing mode. -When a request contains both parameters, `switch_lock` is always applied before `power_on`, so the order of the parameters does not matter: +:::tip +If you're implementing this feature, ensure that users clearly understand its implications. Users might disable cloud communication without fully realizing its effect or forget they did so, leading them to believe the app or device is malfunctioning. This can result in unnecessary support requests, which we want to avoid. -- If `switch_lock` was enabled, sending `{"power_on": false, "switch_lock": false}` disables the switch lock and turns the socket off. -- Sending `{"power_on": false, "switch_lock": true}` is accepted, but the switch lock takes precedence: the socket is turned on. +To prevent confusion, consider providing clear documentation or displaying a confirmation message before enabling or disabling this setting. +::: ### Examples -#### Turn on Socket +#### Disable Cloud Communication ```http title="Request" curl https:///api/system --insecure \ -X PUT \ -H "Authorization: Bearer " \ -H "X-Api-Version: 2" \ - -d '{"power_on": true}' + -d '{"cloud_enabled": false}' ``` ```http title="Response" @@ -87,23 +87,23 @@ Content-Type: application/json { "wifi_ssid": "My Wi-Fi", "wifi_rssi_db": -77, - "cloud_enabled": true, + "cloud_enabled": false, "uptime_s": 356, "status_led_brightness_pct": 100, - "api_v1_enabled": true, - "switch_lock": false, - "power_on": true + "api_v1_enabled": true } ``` -#### Turn off Socket +_After disabling the cloud communication, the device will only work locally._ + +#### Enable Cloud Communication ```http title="Request" curl https:///api/system --insecure \ -X PUT \ -H "Authorization: Bearer " \ -H "X-Api-Version: 2" \ - -d '{"power_on": false}' + -d '{"cloud_enabled": true}' ``` ```http title="Response" @@ -116,22 +116,26 @@ Content-Type: application/json "cloud_enabled": true, "uptime_s": 356, "status_led_brightness_pct": 100, - "api_v1_enabled": true, - "switch_lock": false, - "power_on": false + "api_v1_enabled": true } ``` -#### Enable Switch Lock +_Device will now reconnect to the cloud._ -After enabling `switch_lock`, the socket is 'on' and cannot be turned off until `switch_lock` is disabled. +## Status LED Brightness. + +Most devices have a status LED, and its brightness can be adjusted between 0% and 100%. This adjustment only affects the LED during normal operation. Error indications are always displayed at the default brightness, regardless of the setting. + +### Examples + +#### Set Status LED Brightness ```http title="Request" curl https:///api/system --insecure \ -X PUT \ -H "Authorization: Bearer " \ -H "X-Api-Version: 2" \ - -d '{"switch_lock": true}' + -d '{"status_led_brightness_pct": 50}' ``` ```http title="Response" @@ -143,42 +147,39 @@ Content-Type: application/json "wifi_rssi_db": -77, "cloud_enabled": true, "uptime_s": 356, - "status_led_brightness_pct": 100, - "api_v1_enabled": true, - "switch_lock": true, - "power_on": true + "status_led_brightness_pct": 50, + "api_v1_enabled": true } ``` -#### Turn off Socket when Switch Lock is Enabled +## Enable or Disable the v1 API. -```http title="Request" -curl https:///api/system --insecure \ - -X PUT \ - -H "Authorization: Bearer " \ - -H "X-Api-Version: 2" \ - -d '{"power_on": false}' -``` +To protect the device from unauthorized access, the v1 API can be disabled. When the v1 API is disabled, the device will only allow authorized request via the v2 API. -```http title="Response" -https/1.1 400 Bad Request -Content-Type: application/json +## Energy Socket Power and Switch Lock. -{ - "error": "request:switch-lock-enabled" -} -``` +The Energy Socket can be controlled with the `power_on` and `switch_lock` parameters. In API v1 these parameters were part of the [state endpoint](/docs/v1/state); in API v2 they are part of the system endpoint. -#### Disable Switch Lock and Turn off Socket +- `power_on` returns `true` when the relay is in the 'on' state. Set it to `true` or `false` to turn the socket on or off. +- `switch_lock` keeps the socket turned on. When `switch_lock` is enabled, the socket is turned on and cannot be turned off until `switch_lock` is disabled again. -Both parameters can be set in a single request. The order does not matter: the socket turns off even though `switch_lock` was enabled. +While `switch_lock` is enabled, a request that sets `power_on` without also setting `switch_lock` is refused with `400 Bad Request` and the error `request:switch-lock-enabled`, see [error handling](/docs/v2/error-handling). This applies to both `true` and `false`. + +When a request contains both parameters, `switch_lock` is always applied before `power_on`, so the order of the parameters does not matter: + +- If `switch_lock` was enabled, sending `{"power_on": false, "switch_lock": false}` disables the switch lock and turns the socket off. +- Sending `{"power_on": false, "switch_lock": true}` is accepted, but the switch lock takes precedence: the socket is turned on. + +### Examples + +#### Turn on Socket ```http title="Request" curl https:///api/system --insecure \ -X PUT \ -H "Authorization: Bearer " \ -H "X-Api-Version: 2" \ - -d '{"power_on": false, "switch_lock": false}' + -d '{"power_on": true}' ``` ```http title="Response" @@ -193,34 +194,20 @@ Content-Type: application/json "status_led_brightness_pct": 100, "api_v1_enabled": true, "switch_lock": false, - "power_on": false + "power_on": true } ``` -## Cloud Communication. - -HomeWizard devices are designed to work with the HomeWizard app and rely on communication with the HomeWizard cloud for full functionality. - -Users can choose to disable cloud communication, making the device operate entirely locally. However, this will prevent the app from interacting with the device, and the device will no longer receive firmware updates. - -Cloud communication can be re-enabled by setting `cloud_enabled` to `true`. It is also automatically restored after a factory reset or when the device is put into pairing mode. - -:::tip -If you're implementing this feature, ensure that users clearly understand its implications. Users might disable cloud communication without fully realizing its effect or forget they did so, leading them to believe the app or device is malfunctioning. This can result in unnecessary support requests, which we want to avoid. - -To prevent confusion, consider providing clear documentation or displaying a confirmation message before enabling or disabling this setting. -::: - -### Examples +#### Enable Switch Lock -#### Disable Cloud Communication +After enabling `switch_lock`, the socket is 'on' and cannot be turned off until `switch_lock` is disabled. ```http title="Request" curl https:///api/system --insecure \ -X PUT \ -H "Authorization: Bearer " \ -H "X-Api-Version: 2" \ - -d '{"cloud_enabled": false}' + -d '{"switch_lock": true}' ``` ```http title="Response" @@ -230,55 +217,44 @@ Content-Type: application/json { "wifi_ssid": "My Wi-Fi", "wifi_rssi_db": -77, - "cloud_enabled": false, + "cloud_enabled": true, "uptime_s": 356, "status_led_brightness_pct": 100, - "api_v1_enabled": true + "api_v1_enabled": true, + "switch_lock": true, + "power_on": true } ``` -_After disabling the cloud communication, the device will only work locally._ - -#### Enable Cloud Communication +#### Turn off Socket when Switch Lock is Enabled ```http title="Request" curl https:///api/system --insecure \ -X PUT \ -H "Authorization: Bearer " \ -H "X-Api-Version: 2" \ - -d '{"cloud_enabled": true}' + -d '{"power_on": false}' ``` ```http title="Response" -https/1.1 200 OK +https/1.1 400 Bad Request Content-Type: application/json { - "wifi_ssid": "My Wi-Fi", - "wifi_rssi_db": -77, - "cloud_enabled": true, - "uptime_s": 356, - "status_led_brightness_pct": 100, - "api_v1_enabled": true + "error": "request:switch-lock-enabled" } ``` -_Device will now reconnect to the cloud._ - -## Status LED Brightness. - -Most devices have a status LED, and its brightness can be adjusted between 0% and 100%. This adjustment only affects the LED during normal operation. Error indications are always displayed at the default brightness, regardless of the setting. - -### Examples +#### Disable Switch Lock and Turn off Socket -#### Set Status LED Brightness +Both parameters can be set in a single request. The order does not matter: the socket turns off even though `switch_lock` was enabled. ```http title="Request" curl https:///api/system --insecure \ -X PUT \ -H "Authorization: Bearer " \ -H "X-Api-Version: 2" \ - -d '{"status_led_brightness_pct": 50}' + -d '{"power_on": false, "switch_lock": false}' ``` ```http title="Response" @@ -290,15 +266,13 @@ Content-Type: application/json "wifi_rssi_db": -77, "cloud_enabled": true, "uptime_s": 356, - "status_led_brightness_pct": 50, - "api_v1_enabled": true + "status_led_brightness_pct": 100, + "api_v1_enabled": true, + "switch_lock": false, + "power_on": false } ``` -## Enable or Disable the v1 API. - -To protect the device from unauthorized access, the v1 API can be disabled. When the v1 API is disabled, the device will only allow authorized request via the v2 API. - ### Example #### Disable the v1 API From f68724d5e41b528cd1128d979f23c5aeacdf6221 Mon Sep 17 00:00:00 2001 From: Lex Postma Date: Fri, 20 Nov 2026 16:43:20 +0100 Subject: [PATCH 7/8] Minor letter tweaks for consistency --- docs/introduction.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/introduction.mdx b/docs/introduction.mdx index b4cc532..9391b56 100644 --- a/docs/introduction.mdx +++ b/docs/introduction.mdx @@ -41,12 +41,12 @@ The following table shows which devices are supported by the API and which API v | Device | Device type | API v1 | API v2 | | --------------------------------------------------- | ----------------------------------------------------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| P1 Meter | `HWE-P1` | Supported | Supported | -| Energy Socket | `HWE-SKT` | Supported | API Support in beta WebSocket Support Planned | +| P1 Meter | `HWE-P1` | Supported | Supported | +| Energy Socket | `HWE-SKT` | Supported | API support in beta WebSocket support planned | | Watermeter (only when powered over USB) | `HWE-WTR` | Supported | Planned | -| kWh Meter (1-phase and 3-phase) | `HWE-KWH1`,
`HWE-KWH3`,
`SDM230-wifi` and
`SDM630-wifi` | Supported | Supported | +| kWh Meter (1-phase and 3-phase) | `HWE-KWH1`,
`HWE-KWH3`,
`SDM230-wifi` and
`SDM630-wifi` | Supported | Supported | | Energy Display | `HWE-DSP` | Not planned | Planned | -| Plug-In Battery | `HWE-BAT` | Not planned | Supported | +| Plug-In Battery | `HWE-BAT` | Not planned | Supported | | Temperature Humidity Meter (always battery powered) | `HWE-TMP` | Not planned | Exploring alternatives | ## Beta Program. From 8125878a445a8774d22351704b60cce1b970e417 Mon Sep 17 00:00:00 2001 From: Lex Postma Date: Fri, 20 Nov 2026 16:46:57 +0100 Subject: [PATCH 8/8] Fix table formatting in introduction Co-Authored-By: Claude Opus 5.5 --- docs/introduction.mdx | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/introduction.mdx b/docs/introduction.mdx index 9391b56..265b316 100644 --- a/docs/introduction.mdx +++ b/docs/introduction.mdx @@ -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 | -| --------------------------------------------------- | ----------------------------------------------------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Device | Device type | API v1 | API v2 | +| --------------------------------------------------- | ----------------------------------------------------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | P1 Meter | `HWE-P1` | Supported | Supported | | Energy Socket | `HWE-SKT` | Supported | API support in beta WebSocket support planned | -| Watermeter (only when powered over USB) | `HWE-WTR` | Supported | Planned | +| Watermeter (only when powered over USB) | `HWE-WTR` | Supported | Planned | | kWh Meter (1-phase and 3-phase) | `HWE-KWH1`,
`HWE-KWH3`,
`SDM230-wifi` and
`SDM630-wifi` | Supported | Supported | -| Energy Display | `HWE-DSP` | Not planned | Planned | +| Energy Display | `HWE-DSP` | Not planned | Planned | | Plug-In Battery | `HWE-BAT` | Not planned | Supported | -| Temperature Humidity Meter (always battery powered) | `HWE-TMP` | Not planned | Exploring alternatives | +| Temperature Humidity Meter (always battery powered) | `HWE-TMP` | Not planned | Exploring alternatives | ## Beta Program.