You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/endpoints/api-v1-data.mdx
+9-7Lines changed: 9 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,9 @@ import Link from '@docusaurus/Link'
9
9
10
10
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.
@@ -55,7 +57,7 @@ The `/api/v1/data` endpoint allows you to get the most recent measurement from t
55
57
| unique_gas_id | Number | The unique identifier for the gas meter, can be used to migrate to the 'external' data point |
56
58
| external | Array | A list of externally connected utility meters, see [External data point](#external-data-point) for more information |
57
59
58
-
## `External` data point
60
+
###`External` data point
59
61
60
62
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.
61
63
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
70
72
71
73
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.
72
74
73
-
## Monthly power peak
75
+
###Monthly power peak
74
76
75
77
Belgium users are started to get charged for the peak usage per month (see <Linkto="https://www.fluvius.be/nl/thema/factuur-en-tarieven/capaciteitstarief">capaciteitstarief</Link>). The data points `active_power_average_w`, `montly_power_peak_w` and `montly_power_peak_timestamp` can be used to track the maximum demand.
76
78
77
-
## HWE-P1 (1-phase, no gas)
79
+
### Example: HWE-P1 (1-phase, no gas)
78
80
79
81
```
80
82
<Request>
@@ -99,7 +101,7 @@ Content-Length: <length>
99
101
}
100
102
```
101
103
102
-
### HWE-P1 (3-phase, with gas and water meter)
104
+
### Example: HWE-P1 (3-phase, with gas and water meter)
103
105
104
106
```
105
107
<Request>
@@ -188,7 +190,7 @@ The firmware version 4.00 is currently in beta and is tested by a small group of
188
190
| active_power_factor | Number | HWE-SKT-21 | The power factor | 4.07 or later |
189
191
| active_frequency_hz | Number | All | The frequency in hertz | 4.07 or later |
Copy file name to clipboardExpand all lines: docs/endpoints/api-v1-identify.mdx
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -9,9 +9,9 @@ The `/api/v1/identify` endpoint can be used to let the user identify the device.
9
9
10
10
This feature is available for:
11
11
12
-
- HWE-P1
13
-
- HWE-SKT
14
-
- HWE-WTR (firmware version 3.00 or later required)
12
+
-P1 Meter (HWE-P1)
13
+
-Energy Socket (HWE-SKT)
14
+
-Watermeter (HWE-WTR) (firmware version 3.00 or later required)
15
15
16
16
:::info Watermeter support
17
17
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.
Copy file name to clipboardExpand all lines: docs/endpoints/api-v1-state.mdx
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ description: Control the state of the Energy Socket.
5
5
6
6
# Control socket state (`/api/v1/state`)
7
7
8
-
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.
8
+
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.
Copy file name to clipboardExpand all lines: docs/endpoints/api-v1-system.mdx
+5-5Lines changed: 5 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -9,11 +9,11 @@ The `/api/v1/system` endpoint can be used to configure system settings. Currentl
9
9
10
10
This feature is currently only available for:
11
11
12
-
- HWE-P1
13
-
- HWE-SKT
14
-
- HWE-KWH1 / SDM230-wifi
15
-
- HWE-KWH3 / SDM630-wifi
16
-
- HWE-WTR (firmware version 3.00 or later required)
12
+
-P1 Meter (HWE-P1)
13
+
-Energy Socket (HWE-SKT)
14
+
-kWh Meter 1-phase (HWE-KWH1 / SDM230-wifi)
15
+
-kWh Meter (HWE-KWH3 / SDM630-wifi)
16
+
-Watermeter (HWE-WTR) (firmware version 3.00 or later required)
17
17
18
18
:::info Watermeter support
19
19
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.
Copy file name to clipboardExpand all lines: docs/endpoints/api-v1-telegram.mdx
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ description: Get the most recent, raw telegram from the P1 meter.
5
5
6
6
# P1 telegram (`/api/v1/telegram`)
7
7
8
-
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**.
8
+
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)**.
9
9
10
10
- The telegram validated with its CRC, but not parsed in any form.
11
11
- Note that this endpoint returns plain text instead of formatted JSON, even when an error occurs (see [Error handling](/docs/error-handling))
0 commit comments