Skip to content

Commit acb2c41

Browse files
DCSBLDCSBL
authored
Add documentation about new kWh Meter model (#43)
* Add documentation about new kWh Meter model * Update changelog
1 parent a9da021 commit acb2c41

File tree

4 files changed

+67
-55
lines changed

4 files changed

+67
-55
lines changed

‎docs/changelog.mdx‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ Get notified for changes in the API and its documentation when something has cha
88

99
## Changes
1010

11+
### 2024-01-30
12+
13+
Documentation for the HWE-KWH1 and HWE-KWH3 is added. These devices are a direct replacement for the SDM230-wifi and SDM630-wifi, with the only difference that the model name is changed.
14+
15+
## Changes
16+
1117
### 2024-01-19
1218

1319
Documentation for the updated kWh Meter firmware firmware has been added, which brings more data in the `api/v1/data` endpoint.

‎docs/endpoints/api-v1-data.mdx‎

Lines changed: 52 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -197,57 +197,62 @@ Content-Length: <length>
197197
}
198198
```
199199

200-
## kWh Meters (SDM230-wifi and SDM630-wifi)
200+
## kWh Meters (1 and 3 phase)
201201

202202
:::info New firmware version
203203
Firmware version 4.00 is currently in beta and will be available soon for everyone. You meter will automatically update to this version when it is available.
204204
:::
205205

206+
Each type of meter is available in two versions. The API and functionality is the same for both types.
207+
208+
- **1-phase**: HWE-KWH1 and SDM230-wifi
209+
- **3-phase**: HWE-KWH3 and SDM630-wifi
210+
206211
### Data points
207212

208-
| Data | Type | Available for | Description | Required firmware version |
209-
| ---------------------------- | ------ | ------------------------ | ---------------------------------------------------------------------------------- | ------------------------- |
210-
| wifi_ssid | String | SDM230-wifi, SDM630-wifi | The Wi-Fi network that the meter is connected to | 3.06 or later |
211-
| wifi_strength | Number | SDM230-wifi, SDM630-wifi | The strength of the Wi-Fi signal in % | 3.06 or later |
212-
| total_power_import_kwh | Number | SDM230-wifi, SDM630-wifi | The power usage meter reading in kWh | 4.00 or later |
213-
| total_power_import_t1_kwh | Number | SDM230-wifi, SDM630-wifi | Same value as `total_power_import_t1_kwh`, kept for backwards compatibility | 3.06 or later |
214-
| total_power_export_kwh | Number | SDM230-wifi, SDM630-wifi | The power feed-in meter reading in kWh | 4.00 or later |
215-
| total_power_export_t1_kwh | Number | SDM230-wifi, SDM630-wifi | Same value as `total_power_export_kwh`, kept for backwards compatibility | 3.06 or later |
216-
| active_power_w | Number | SDM230-wifi, SDM630-wifi | The total active usage in watt | 3.06 or later |
217-
| active_power_l1_w | Number | SDM230-wifi, SDM630-wifi | The active usage for phase 1 in watt, same as `active_power_w` for SDM230-wifi | 3.06 or later |
218-
| active_power_l2_w | Number | SDM630-wifi | The active usage for phase 2 in watt | 3.06 or later |
219-
| active_power_l3_w | Number | SDM630-wifi | The active usage for phase 3 in watt | 3.06 or later |
220-
| active_voltage_v | Number | SDM230-wifi | The active voltage in volts | 4.00 or later |
221-
| active_voltage_l1_v | Number | SDM630-wifi | The active voltage for phase 1 in volts | 4.00 or later |
222-
| active_voltage_l2_v | Number | SDM630-wifi | The active voltage for phase 2 in volts | 4.00 or later |
223-
| active_voltage_l3_v | Number | SDM630-wifi | The active voltage for phase 3 in volts | 4.00 or later |
224-
| active_current_a | Number | SDM230-wifi, SDM630-wifi | The active current in amperes, the sum of all phases for SDM630-wifi | 4.00 or later |
225-
| active_current_l1_a | Number | SDM630-wifi | The active current for phase 1 in amperes | 4.00 or later |
226-
| active_current_l2_a | Number | SDM630-wifi | The active current for phase 2 in amperes | 4.00 or later |
227-
| active_current_l3_a | Number | SDM630-wifi | The active current for phase 3 in amperes | 4.00 or later |
228-
| active_apparent_current_a | Number | SDM230-wifi, SDM630-wifi | The apparent current in amperes, the sum of all phases for SDM630-wifi | 4.00 or later |
229-
| active_apparent_current_l1_a | Number | SDM630-wifi | The apparent current for phase 1 in amperes | 4.00 or later |
230-
| active_apparent_current_l2_a | Number | SDM630-wifi | The apparent current for phase 2 in amperes | 4.00 or later |
231-
| active_apparent_current_l3_a | Number | SDM630-wifi | The apparent current for phase 3 in amperes | 4.00 or later |
232-
| active_reactive_current_a | Number | SDM230-wifi, SDM630-wifi | The reactive current in amperes, the sum of all phases for SDM630-wifi | 4.00 or later |
233-
| active_reactive_current_l1_a | Number | SDM630-wifi | The reactive current for phase 1 in amperes | 4.00 or later |
234-
| active_reactive_current_l2_a | Number | SDM630-wifi | The reactive current for phase 2 in amperes | 4.00 or later |
235-
| active_reactive_current_l3_a | Number | SDM630-wifi | The reactive current for phase 3 in amperes | 4.00 or later |
236-
| active_apparent_power_va | Number | SDM230-wifi, SDM630-wifi | The apparent power in volt-amperes, the sum of all phases for SDM630-wifi | 4.00 or later |
237-
| active_apparent_power_l1_va | Number | SDM630-wifi | The apparent power for phase 1 in volt-amperes | 4.00 or later |
238-
| active_apparent_power_l2_va | Number | SDM630-wifi | The apparent power for phase 2 in volt-amperes | 4.00 or later |
239-
| active_apparent_power_l3_va | Number | SDM630-wifi | The apparent power for phase 3 in volt-amperes | 4.00 or later |
240-
| active_reactive_power_var | Number | SDM230-wifi, SDM630-wifi | The reactive power in volt-amperes reactive, the sum of all phases for SDM630-wifi | 4.00 or later |
241-
| active_reactive_power_l1_var | Number | SDM630-wifi | The reactive power for phase 1 in volt-amperes reactive | 4.00 or later |
242-
| active_reactive_power_l2_var | Number | SDM630-wifi | The reactive power for phase 2 in volt-amperes reactive | 4.00 or later |
243-
| active_reactive_power_l3_var | Number | SDM630-wifi | The reactive power for phase 3 in volt-amperes reactive | 4.00 or later |
244-
| active_power_factor | Number | SDM230-wifi | The power factor | 4.00 or later |
245-
| active_power_factor_l1 | Number | SDM630-wifi | The power factor for phase 1 | 4.00 or later |
246-
| active_power_factor_l2 | Number | SDM630-wifi | The power factor for phase 2 | 4.00 or later |
247-
| active_power_factor_l3 | Number | SDM630-wifi | The power factor for phase 3 | 4.00 or later |
248-
| active_frequency_hz | Number | SDM230-wifi, SDM630-wifi | The frequency in hertz | 4.00 or later |
249-
250-
### Example: SDM230-wifi (firmware version 3.06)
213+
| Data | Type | Available for | Description | Required firmware version |
214+
| ---------------------------- | ------ | ---------------- | ------------------------------------------------------------------------------ | ------------------------- |
215+
| wifi_ssid | String | 1-phase, 3-phase | The Wi-Fi network that the meter is connected to | 3.06 or later |
216+
| wifi_strength | Number | 1-phase, 3-phase | The strength of the Wi-Fi signal in % | 3.06 or later |
217+
| total_power_import_kwh | Number | 1-phase, 3-phase | The power usage meter reading in kWh | 4.00 or later |
218+
| total_power_import_t1_kwh | Number | 1-phase, 3-phase | Same value as `total_power_import_t1_kwh`, kept for backwards compatibility | 3.06 or later |
219+
| total_power_export_kwh | Number | 1-phase, 3-phase | The power feed-in meter reading in kWh | 4.00 or later |
220+
| total_power_export_t1_kwh | Number | 1-phase, 3-phase | Same value as `total_power_export_kwh`, kept for backwards compatibility | 3.06 or later |
221+
| active_power_w | Number | 1-phase, 3-phase | The total active usage in watt | 3.06 or later |
222+
| active_power_l1_w | Number | 1-phase, 3-phase | The active usage for phase 1 in watt, same as `active_power_w` for 1-phase | 3.06 or later |
223+
| active_power_l2_w | Number | 3-phase | The active usage for phase 2 in watt | 3.06 or later |
224+
| active_power_l3_w | Number | 3-phase | The active usage for phase 3 in watt | 3.06 or later |
225+
| active_voltage_v | Number | 1-phase | The active voltage in volts | 4.00 or later |
226+
| active_voltage_l1_v | Number | 3-phase | The active voltage for phase 1 in volts | 4.00 or later |
227+
| active_voltage_l2_v | Number | 3-phase | The active voltage for phase 2 in volts | 4.00 or later |
228+
| active_voltage_l3_v | Number | 3-phase | The active voltage for phase 3 in volts | 4.00 or later |
229+
| active_current_a | Number | 1-phase, 3-phase | The active current in amperes, the sum of all phases for 3-phase | 4.00 or later |
230+
| active_current_l1_a | Number | 3-phase | The active current for phase 1 in amperes | 4.00 or later |
231+
| active_current_l2_a | Number | 3-phase | The active current for phase 2 in amperes | 4.00 or later |
232+
| active_current_l3_a | Number | 3-phase | The active current for phase 3 in amperes | 4.00 or later |
233+
| active_apparent_current_a | Number | 1-phase, 3-phase | The apparent current in amperes, the sum of all phases for 3-phase | 4.00 or later |
234+
| active_apparent_current_l1_a | Number | 3-phase | The apparent current for phase 1 in amperes | 4.00 or later |
235+
| active_apparent_current_l2_a | Number | 3-phase | The apparent current for phase 2 in amperes | 4.00 or later |
236+
| active_apparent_current_l3_a | Number | 3-phase | The apparent current for phase 3 in amperes | 4.00 or later |
237+
| active_reactive_current_a | Number | 1-phase, 3-phase | The reactive current in amperes, the sum of all phases for 3-phase | 4.00 or later |
238+
| active_reactive_current_l1_a | Number | 3-phase | The reactive current for phase 1 in amperes | 4.00 or later |
239+
| active_reactive_current_l2_a | Number | 3-phase | The reactive current for phase 2 in amperes | 4.00 or later |
240+
| active_reactive_current_l3_a | Number | 3-phase | The reactive current for phase 3 in amperes | 4.00 or later |
241+
| active_apparent_power_va | Number | 1-phase, 3-phase | The apparent power in volt-amperes, the sum of all phases for 3-phase | 4.00 or later |
242+
| active_apparent_power_l1_va | Number | 3-phase | The apparent power for phase 1 in volt-amperes | 4.00 or later |
243+
| active_apparent_power_l2_va | Number | 3-phase | The apparent power for phase 2 in volt-amperes | 4.00 or later |
244+
| active_apparent_power_l3_va | Number | 3-phase | The apparent power for phase 3 in volt-amperes | 4.00 or later |
245+
| active_reactive_power_var | Number | 1-phase, 3-phase | The reactive power in volt-amperes reactive, the sum of all phases for 3-phase | 4.00 or later |
246+
| active_reactive_power_l1_var | Number | 3-phase | The reactive power for phase 1 in volt-amperes reactive | 4.00 or later |
247+
| active_reactive_power_l2_var | Number | 3-phase | The reactive power for phase 2 in volt-amperes reactive | 4.00 or later |
248+
| active_reactive_power_l3_var | Number | 3-phase | The reactive power for phase 3 in volt-amperes reactive | 4.00 or later |
249+
| active_power_factor | Number | 1-phase | The power factor | 4.00 or later |
250+
| active_power_factor_l1 | Number | 3-phase | The power factor for phase 1 | 4.00 or later |
251+
| active_power_factor_l2 | Number | 3-phase | The power factor for phase 2 | 4.00 or later |
252+
| active_power_factor_l3 | Number | 3-phase | The power factor for phase 3 | 4.00 or later |
253+
| active_frequency_hz | Number | 1-phase, 3-phase | The frequency in hertz | 4.00 or later |
254+
255+
### Example: 1-phase (firmware version 3.06)
251256

252257
```
253258
<Request>
@@ -268,7 +273,7 @@ Content-Length: <length>
268273
}
269274
```
270275

271-
### Example: SDM630-wifi (firmware version 3.06)
276+
### Example: 3-phase (firmware version 3.06)
272277

273278
```
274279
<Request>
@@ -291,7 +296,7 @@ Content-Length: <length>
291296
}
292297
```
293298

294-
### Example: SDM230-wifi (firmware version 4.00)
299+
### Example: 1-phase (firmware version 4.00)
295300

296301
```
297302
<Request>
@@ -322,7 +327,7 @@ Content-Length: <length>
322327
}
323328
```
324329

325-
### Example: SDM630-wifi (firmware version 4.00)
330+
### Example: 3-phase (firmware version 4.00)
326331

327332
```
328333
<Request>

‎docs/endpoints/api-v1-system.mdx‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ This feature is currently only available for:
1111

1212
- HWE-P1
1313
- HWE-SKT
14-
- SDM230-wifi / SDM630-wifi
14+
- HWE-KWH1 / SDM230-wifi
15+
- HWE-KWH3 / SDM630-wifi
1516

1617
See [Firmware updates](/docs/versioning#firmware-updates) for more information.
1718

‎docs/getting-started.mdx‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@ To understand each value, please read [endpoints](/docs/category/endpoints/).
2828

2929
The supported devices are listed below. The device type is used as identifier within the API.
3030

31-
| Device | Device type |
32-
| --------------------------------------------- | ----------- |
33-
| Wi-Fi P1 meter | HWE-P1 |
34-
| Wi-Fi Energy Socket | HWE-SKT |
35-
| Wi-Fi Watermeter (Only when powered over USB) | HWE-WTR |
36-
| Wi-Fi kWh Meter (1 phase) | SDM230-wifi |
37-
| Wi-Fi kWh Meter (3 phase) | SDM630-wifi |
31+
| Device | Device type |
32+
| --------------------------------------------- | ------------------------ |
33+
| Wi-Fi P1 meter | HWE-P1 |
34+
| Wi-Fi Energy Socket | HWE-SKT |
35+
| Wi-Fi Watermeter (Only when powered over USB) | HWE-WTR |
36+
| Wi-Fi kWh Meter (1 phase) | HWE-KWH1 and SDM230-wifi |
37+
| Wi-Fi kWh Meter (3 phase) | HWE-KWH3 and SDM630-wifi |
3838

3939
## Data update frequency
4040

0 commit comments

Comments
 (0)