Skip to content

Commit 2fe06cc

Browse files
authored
Adjust headers and model numbers to make style more consistent (#73)
1 parent 489953c commit 2fe06cc

File tree

5 files changed

+19
-17
lines changed

5 files changed

+19
-17
lines changed

docs/endpoints/api-v1-data.mdx

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ import Link from '@docusaurus/Link'
99

1010
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.
1111

12-
## Data points for **HWE-P1**
12+
## P1 Meter (HWE-P1)
13+
14+
### Data points
1315

1416
| Data | Type | Description |
1517
| --------------------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -55,7 +57,7 @@ The `/api/v1/data` endpoint allows you to get the most recent measurement from t
5557
| unique_gas_id | Number | The unique identifier for the gas meter, can be used to migrate to the 'external' data point |
5658
| external | Array | A list of externally connected utility meters, see [External data point](#external-data-point) for more information |
5759

58-
## `External` data point
60+
### `External` data point
5961

6062
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.
6163
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
7072

7173
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.
7274

73-
## Monthly power peak
75+
### Monthly power peak
7476

7577
Belgium users are started to get charged for the peak usage per month (see <Link to="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.
7678

77-
## HWE-P1 (1-phase, no gas)
79+
### Example: HWE-P1 (1-phase, no gas)
7880

7981
```
8082
<Request>
@@ -99,7 +101,7 @@ Content-Length: <length>
99101
}
100102
```
101103

102-
### HWE-P1 (3-phase, with gas and water meter)
104+
### Example: HWE-P1 (3-phase, with gas and water meter)
103105

104106
```
105107
<Request>
@@ -188,7 +190,7 @@ The firmware version 4.00 is currently in beta and is tested by a small group of
188190
| active_power_factor | Number | HWE-SKT-21 | The power factor | 4.07 or later |
189191
| active_frequency_hz | Number | All | The frequency in hertz | 4.07 or later |
190192

191-
### Example (HWE-SKT-11)
193+
### Example: HWE-SKT-11
192194

193195
```
194196
<Request>
@@ -214,7 +216,7 @@ Content-Length: <length>
214216
}
215217
```
216218

217-
### Example (HWE-SKT-21)
219+
### Example: HWE-SKT-21
218220

219221
```
220222
<Request>

docs/endpoints/api-v1-identify.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ The `/api/v1/identify` endpoint can be used to let the user identify the device.
99

1010
This feature is available for:
1111

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)
1515

1616
:::info Watermeter support
1717
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.

docs/endpoints/api-v1-state.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Control the state of the Energy Socket.
55

66
# Control socket state (`/api/v1/state`)
77

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.
99

1010
This endpoint accepts `GET` and `PUT` requests.
1111

docs/endpoints/api-v1-system.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ The `/api/v1/system` endpoint can be used to configure system settings. Currentl
99

1010
This feature is currently only available for:
1111

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)
1717

1818
:::info Watermeter support
1919
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.

docs/endpoints/api-v1-telegram.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Get the most recent, raw telegram from the P1 meter.
55

66
# P1 telegram (`/api/v1/telegram`)
77

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)**.
99

1010
- The telegram validated with its CRC, but not parsed in any form.
1111
- 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

Comments
 (0)