diff --git a/docs/endpoints/api-v1-data.mdx b/docs/endpoints/api-v1-data.mdx index e9160ae..5bf65f3 100644 --- a/docs/endpoints/api-v1-data.mdx +++ b/docs/endpoints/api-v1-data.mdx @@ -9,7 +9,9 @@ import Link from '@docusaurus/Link' The `/api/v1/data` endpoint allows you to get the most recent measurement from the device. All data points are "optional"; The API does not send data points that are `null` or not available at all. This mostly depends on the connected smart meter. Make sure your application can handle this. -## Data points for **HWE-P1** +## P1 Meter (HWE-P1) + +### Data points | Data | Type | Description | | --------------------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -55,7 +57,7 @@ The `/api/v1/data` endpoint allows you to get the most recent measurement from t | unique_gas_id | Number | The unique identifier for the gas meter, can be used to migrate to the 'external' data point | | external | Array | A list of externally connected utility meters, see [External data point](#external-data-point) for more information | -## `External` data point +### `External` data point Some smart meters have more than one external device connected to it. This can be, for example, a gas and a water meter. The `external` data point adds support for these devices. Each entry is supplied with a set of data. See [this example](#hwe-p1-3-phase-with-gas). @@ -70,11 +72,11 @@ Each entry is supplied with a set of data. See [this example](#hwe-p1-3-phase-wi The original data points `total_gas_m3`, `gas_timestamp` and `unique_gas_id` use the first detected gas meter. These data points will be removed in a future version. You can use `unique_id` to migrate any values if needed. -## Monthly power peak +### Monthly power peak Belgium users are started to get charged for the peak usage per month (see capaciteitstarief). The data points `active_power_average_w`, `montly_power_peak_w` and `montly_power_peak_timestamp` can be used to track the maximum demand. -## HWE-P1 (1-phase, no gas) +### Example: HWE-P1 (1-phase, no gas) ``` @@ -99,7 +101,7 @@ Content-Length: } ``` -### HWE-P1 (3-phase, with gas and water meter) +### Example: HWE-P1 (3-phase, with gas and water meter) ``` @@ -188,7 +190,7 @@ The firmware version 4.00 is currently in beta and is tested by a small group of | active_power_factor | Number | HWE-SKT-21 | The power factor | 4.07 or later | | active_frequency_hz | Number | All | The frequency in hertz | 4.07 or later | -### Example (HWE-SKT-11) +### Example: HWE-SKT-11 ``` @@ -214,7 +216,7 @@ Content-Length: } ``` -### Example (HWE-SKT-21) +### Example: HWE-SKT-21 ``` diff --git a/docs/endpoints/api-v1-identify.mdx b/docs/endpoints/api-v1-identify.mdx index a562a59..0cfca3c 100644 --- a/docs/endpoints/api-v1-identify.mdx +++ b/docs/endpoints/api-v1-identify.mdx @@ -9,9 +9,9 @@ The `/api/v1/identify` endpoint can be used to let the user identify the device. This feature is available for: -- HWE-P1 -- HWE-SKT -- HWE-WTR (firmware version 3.00 or later required) +- P1 Meter (HWE-P1) +- Energy Socket (HWE-SKT) +- Watermeter (HWE-WTR) (firmware version 3.00 or later required) :::info Watermeter support Support for this endpoint in the Watermeter will be added in version 3.00. This version is currently in beta and is tested by a small group of users. The firmware will be released to all users when the beta phase is completed. diff --git a/docs/endpoints/api-v1-state.mdx b/docs/endpoints/api-v1-state.mdx index 8240637..2fa44cf 100644 --- a/docs/endpoints/api-v1-state.mdx +++ b/docs/endpoints/api-v1-state.mdx @@ -5,7 +5,7 @@ description: Control the state of the Energy Socket. # Control socket state (`/api/v1/state`) -The `/api/v1/state` endpoint returns the actual state of the Energy Socket. This endpoint is only available for the Energy Socket as this is the only controllable device. +The `/api/v1/state` endpoint returns the actual state of the Energy Socket. This endpoint is **only available for the Energy Socket (HWE-SKT)** as this is the only controllable device. This endpoint accepts `GET` and `PUT` requests. diff --git a/docs/endpoints/api-v1-system.mdx b/docs/endpoints/api-v1-system.mdx index 6523f22..0e92796 100644 --- a/docs/endpoints/api-v1-system.mdx +++ b/docs/endpoints/api-v1-system.mdx @@ -9,11 +9,11 @@ The `/api/v1/system` endpoint can be used to configure system settings. Currentl This feature is currently only available for: -- HWE-P1 -- HWE-SKT -- HWE-KWH1 / SDM230-wifi -- HWE-KWH3 / SDM630-wifi -- HWE-WTR (firmware version 3.00 or later required) +- P1 Meter (HWE-P1) +- Energy Socket (HWE-SKT) +- kWh Meter 1-phase (HWE-KWH1 / SDM230-wifi) +- kWh Meter (HWE-KWH3 / SDM630-wifi) +- Watermeter (HWE-WTR) (firmware version 3.00 or later required) :::info Watermeter support Support for this endpoint in the Watermeter will be added in version 3.00. This version is currently in beta and is tested by a small group of users. The firmware will be released to all users when the beta phase is completed. diff --git a/docs/endpoints/api-v1-telegram.mdx b/docs/endpoints/api-v1-telegram.mdx index 3edf3fc..ea0f63e 100644 --- a/docs/endpoints/api-v1-telegram.mdx +++ b/docs/endpoints/api-v1-telegram.mdx @@ -5,7 +5,7 @@ description: Get the most recent, raw telegram from the P1 meter. # P1 telegram (`/api/v1/telegram`) -The `/api/v1/telegram` endpoint returns the most recent, valid telegram that was given by the P1 meter, therefore this endpoint is **only available for the HWE-P1**. +The `/api/v1/telegram` endpoint returns the most recent, valid telegram that was given by the P1 meter, therefore this endpoint is **only available for the P1 Meter (HWE-P1)**. - The telegram validated with its CRC, but not parsed in any form. - Note that this endpoint returns plain text instead of formatted JSON, even when an error occurs (see [Error handling](/docs/error-handling))