Skip to content

Commit ac8480a

Browse files
DCSBLDCSBL
authored
Add documentation about updated kWh meter API (#41)
* Add documentation about updated kWh meter API * Update changelog
1 parent 5dd13c6 commit ac8480a

File tree

2 files changed

+135
-13
lines changed

2 files changed

+135
-13
lines changed

‎docs/changelog.mdx

+4
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ Get notified for changes in the API and its documentation when something has cha
88

99
## Changes
1010

11+
### 2024-01-19
12+
13+
Documentation for the updated kWh Meter firmware firmware has been added, which brings more data in the `api/v1/data` endpoint.
14+
1115
### 2023-11-15
1216

1317
Documentation has been re-written in Markdown and is now generated by [Docusaurus](https://docusaurus.io/). This helps us to further optimize the documentation and allows you easily suggest changes.

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

+131-13
Original file line numberDiff line numberDiff line change
@@ -199,20 +199,55 @@ Content-Length: <length>
199199

200200
## kWh Meters (SDM230-wifi and SDM630-wifi)
201201

202-
### Data points
202+
:::info New firmware version
203+
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.
204+
:::
203205

204-
| Data | Type | Available for | Description |
205-
| ------------------------- | ------ | ------------------------ | --------------------------------------------------- |
206-
| wifi_ssid | String | SDM230-wifi, SDM630-wifi | The Wi-Fi network that the meter is connected to |
207-
| wifi_strength | Number | SDM230-wifi, SDM630-wifi | The strength of the Wi-Fi signal in % |
208-
| total_power_import_t1_kwh | Number | SDM230-wifi, SDM630-wifi | The power usage meter reading for tariff 1 in kWh |
209-
| total_power_export_t1_kwh | Number | SDM230-wifi, SDM630-wifi | The power feed-in meter reading for tariff 1 in kWh |
210-
| active_power_w | Number | SDM230-wifi, SDM630-wifi | The total active usage in watt |
211-
| active_power_l1_w | Number | SDM230-wifi, SDM630-wifi | The active usage for phase 1 in watt |
212-
| active_power_l2_w | Number | SDM630-wifi | The active usage for phase 2 in watt |
213-
| active_power_l3_w | Number | SDM630-wifi | The active usage for phase 3 in watt |
206+
### Data points
214207

215-
### Example: SDM230-wifi
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)
216251

217252
```
218253
<Request>
@@ -233,7 +268,7 @@ Content-Length: <length>
233268
}
234269
```
235270

236-
### Example: SDM630-wifi
271+
### Example: SDM630-wifi (firmware version 3.06)
237272

238273
```
239274
<Request>
@@ -256,6 +291,89 @@ Content-Length: <length>
256291
}
257292
```
258293

294+
### Example: SDM230-wifi (firmware version 4.00)
295+
296+
```
297+
<Request>
298+
GET http://{IP address}/api/v1/data HTTP/1.1
299+
300+
<Response>
301+
HTTP/1.1 200 OK
302+
Content-Type: application/json
303+
Content-Length: <length>
304+
305+
{
306+
"wifi_ssid": "My Wi-Fi",
307+
"wifi_strength": 74,
308+
"total_power_import_kwh": 122.376,
309+
"total_power_import_t1_kwh": 122.376,
310+
"total_power_export_kwh": 579.813,
311+
"total_power_export_t1_kwh": 579.813,
312+
"active_power_w": -45.252,
313+
"active_power_l1_w": -45.252,
314+
"active_voltage_v": 228.472,
315+
"active_current_a": 0.273,
316+
"active_apparent_current_a": 0.447,
317+
"active_reactive_current_a": 0.354,
318+
"active_apparent_power_va": 74.052,
319+
"active_reactive_power_var": -58.612,
320+
"active_power_factor": 0.611,
321+
"active_frequency_hz": 50
322+
}
323+
```
324+
325+
### Example: SDM630-wifi (firmware version 4.00)
326+
327+
```
328+
<Request>
329+
GET http://{IP address}/api/v1/data HTTP/1.1
330+
331+
<Response>
332+
HTTP/1.1 200 OK
333+
Content-Type: application/json
334+
Content-Length: <length>
335+
336+
{
337+
"wifi_ssid": "HW WiFi",
338+
"wifi_strength": 84,
339+
"total_power_import_kwh": 2940.101,
340+
"total_power_import_t1_kwh": 2940.101,
341+
"total_power_export_kwh": 0,
342+
"total_power_export_t1_kwh": 0,
343+
"active_power_w": 7100.278,
344+
"active_power_l1_w": 0,
345+
"active_power_l2_w": 3547.015,
346+
"active_power_l3_w": 3553.263,
347+
"active_voltage_l1_v": 230.751,
348+
"active_voltage_l2_v": 228.391,
349+
"active_voltage_l3_v": 229.612,
350+
"active_current_a": 30.999,
351+
"active_current_l1_a": 0,
352+
"active_current_l2_a": 15.521,
353+
"active_current_l3_a": 15.477,
354+
"active_apparent_current_a": 31.058,
355+
"active_apparent_current_l1_a": 0,
356+
"active_apparent_current_l2_a": 15.539,
357+
"active_apparent_current_l3_a": 15.519,
358+
"active_reactive_current_a": 1.872,
359+
"active_reactive_current_l1_a": 0,
360+
"active_reactive_current_l2_a": 0.73,
361+
"active_reactive_current_l3_a": 1.143,
362+
"active_apparent_power_va": 7112.293,
363+
"active_apparent_power_l1_va": 0,
364+
"active_apparent_power_l2_va": 3548.879,
365+
"active_apparent_power_l3_va": 3563.414,
366+
"active_reactive_power_var": -429.025,
367+
"active_reactive_power_l1_var": 0,
368+
"active_reactive_power_l2_var": -166.675,
369+
"active_reactive_power_l3_var": -262.35,
370+
"active_power_factor_l1": 1,
371+
"active_power_factor_l2": 0.999,
372+
"active_power_factor_l3": 0.997,
373+
"active_frequency_hz": 49.926
374+
}
375+
```
376+
259377
## Watermeter (HWE-WTR)
260378

261379
:::warning API is not available when using batteries

0 commit comments

Comments
 (0)