Skip to content

Commit c077e0c

Browse files
DCSBLDCSBL
authored
Mark optional parameters actually as optional (#142)
1 parent 1829ad5 commit c077e0c

File tree

1 file changed

+44
-42
lines changed

1 file changed

+44
-42
lines changed

‎docs/v2/measurement.mdx

Lines changed: 44 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -24,53 +24,55 @@ import PreliminaryWarning from '@site/src/components/PreliminaryWarning.js'
2424

2525
<PreliminaryWarning />
2626

27-
The `/api/measurement` 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.
27+
The `/api/measurement` endpoint allows you to get the most recent measurement from the device.
2828

2929
## P1 Meter (HWE-P1)
3030

31+
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.
32+
3133
### Parameters
3234

33-
| Data | Type | Description |
34-
| ---------------------------- | ------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |
35-
| unique_id | String | The unique identifier from the smart meter. |
36-
| protocol_version | Number | The DSMR version of the smart meter. |
37-
| meter_model | String | The brand identification the smart meter. |
38-
| timestamp | [Timestamp](#timestamps) | Timestamp provided by smart meter, indicated at what moment the measurement was send to the P1 Meter. |
39-
| tariff | Number | The active tariff, matches one of the totals. |
40-
| energy_import_kwh | Number | The energy usage meter reading for all tariffs in kWh. |
41-
| energy_import_t1_kwh | Number | The energy usage meter reading for tariff 1 in kWh. |
42-
| energy_import_t2_kwh | Number | The energy usage meter reading for tariff 2 in kWh. |
43-
| energy_import_t3_kwh | Number | The energy usage meter reading for tariff 3 in kWh. |
44-
| energy_import_t4_kwh | Number | The energy usage meter reading for tariff 4 in kWh. |
45-
| energy_export_kwh | Number | The energy feed-in meter reading for all tariffs in kWh. |
46-
| energy_export_t1_kwh | Number | The energy feed-in meter reading for tariff 1 in kWh. |
47-
| energy_export_t2_kwh | Number | The energy feed-in meter reading for tariff 2 in kWh. |
48-
| energy_export_t3_kwh | Number | The energy feed-in meter reading for tariff 3 in kWh. |
49-
| energy_export_t4_kwh | Number | The energy feed-in meter reading for tariff 4 in kWh. |
50-
| power_w | Number | The total active usage in watt, this value is the sum of all phases, so if l1=200, l2=300, l3=-100 then this value is 400. |
51-
| power_l1_w | Number | The active usage for phase 1 in watt, will be negative when exporting. |
52-
| power_l2_w | Number | The active usage for phase 2 in watt, will be negative when exporting. |
53-
| power_l3_w | Number | The active usage for phase 3 in watt, will be negative when exporting. |
54-
| voltage_l1_v | Number | The active voltage for phase 1 in volt. |
55-
| voltage_l2_v | Number | The active voltage for phase 2 in volt. |
56-
| voltage_l3_v | Number | The active voltage for phase 3 in volt. |
57-
| current_a | Number | The active current for phase 1 in ampere, this value is the sum of absolute values, so if l1=2, l2=3, l3=-1 then this value is 6. |
58-
| current_l1_a | Number | The active current for phase 1 in ampere, will be negative when exporting. |
59-
| current_l2_a | Number | The active current for phase 2 in ampere, will be negative when exporting. |
60-
| current_l3_a | Number | The active current for phase 3 in ampere, will be negative when exporting. |
61-
| frequency_hz | Number | Line frequency in hertz. |
62-
| voltage_sag_l1_count | Number | Number of voltage sags detected by meter for phase 1. |
63-
| voltage_sag_l2_count | Number | Number of voltage sags detected by meter for phase 2. |
64-
| voltage_sag_l3_count | Number | Number of voltage sags detected by meter for phase 3. |
65-
| voltage_swell_l1_count | Number | Number of voltage swells detected by meter for phase 1. |
66-
| voltage_swell_l2_count | Number | Number of voltage swells detected by meter for phase 2. |
67-
| voltage_swell_l3_count | Number | Number of voltage swells detected by meter for phase 3. |
68-
| any_power_fail_count | Number | Number of power failures detected by meter. |
69-
| long_power_fail_count | Number | Number of 'long' power fails detected by meter. |
70-
| average_power_15m_w | Number | The active average demand, available for smart meters with [capacity rate](#capacity-rate). |
71-
| monthly_power_peak_w | Number | The peak average demand of this month, available for smart meters with [capacity rate](#capacity-rate). |
72-
| monthly_power_peak_timestamp | [Timestamp](#timestamps) | Timestamp when peak demand was registered, available for smart meters with [capacity rate](#capacity-rate). |
73-
| external | Array with [`external`](#external-devices) | A list of externally connected utility meters, see [external data point](#external-devices) for more information. |
35+
| Data | Type | Description |
36+
| ---------------------------- | --------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
37+
| unique_id | Optional String | The unique identifier from the smart meter. |
38+
| protocol_version | Optional Number | The DSMR version of the smart meter. |
39+
| meter_model | Optional String | The brand identification the smart meter. |
40+
| timestamp | Optional [Timestamp](#timestamps) | Timestamp provided by smart meter, indicated at what moment the measurement was send to the P1 Meter. |
41+
| tariff | Optional Number | The active tariff, matches one of the totals. |
42+
| energy_import_kwh | Optional Number | The energy usage meter reading for all tariffs in kWh. |
43+
| energy_import_t1_kwh | Optional Number | The energy usage meter reading for tariff 1 in kWh. |
44+
| energy_import_t2_kwh | Optional Number | The energy usage meter reading for tariff 2 in kWh. |
45+
| energy_import_t3_kwh | Optional Number | The energy usage meter reading for tariff 3 in kWh. |
46+
| energy_import_t4_kwh | Optional Number | The energy usage meter reading for tariff 4 in kWh. |
47+
| energy_export_kwh | Optional Number | The energy feed-in meter reading for all tariffs in kWh. |
48+
| energy_export_t1_kwh | Optional Number | The energy feed-in meter reading for tariff 1 in kWh. |
49+
| energy_export_t2_kwh | Optional Number | The energy feed-in meter reading for tariff 2 in kWh. |
50+
| energy_export_t3_kwh | Optional Number | The energy feed-in meter reading for tariff 3 in kWh. |
51+
| energy_export_t4_kwh | Optional Number | The energy feed-in meter reading for tariff 4 in kWh. |
52+
| power_w | Optional Number | The total active usage in watt, this value is the sum of all phases, so if l1=200, l2=300, l3=-100 then this value is 400. |
53+
| power_l1_w | Optional Number | The active usage for phase 1 in watt, will be negative when exporting. |
54+
| power_l2_w | Optional Number | The active usage for phase 2 in watt, will be negative when exporting. |
55+
| power_l3_w | Optional Number | The active usage for phase 3 in watt, will be negative when exporting. |
56+
| voltage_l1_v | Optional Number | The active voltage for phase 1 in volt. |
57+
| voltage_l2_v | Optional Number | The active voltage for phase 2 in volt. |
58+
| voltage_l3_v | Optional Number | The active voltage for phase 3 in volt. |
59+
| current_a | Optional Number | The active current for phase 1 in ampere, this value is the sum of absolute values, so if l1=2, l2=3, l3=-1 then this value is 6. |
60+
| current_l1_a | Optional Number | The active current for phase 1 in ampere, will be negative when exporting. |
61+
| current_l2_a | Optional Number | The active current for phase 2 in ampere, will be negative when exporting. |
62+
| current_l3_a | Optional Number | The active current for phase 3 in ampere, will be negative when exporting. |
63+
| frequency_hz | Optional Number | Line frequency in hertz. |
64+
| voltage_sag_l1_count | Optional Number | Number of voltage sags detected by meter for phase 1. |
65+
| voltage_sag_l2_count | Optional Number | Number of voltage sags detected by meter for phase 2. |
66+
| voltage_sag_l3_count | Optional Number | Number of voltage sags detected by meter for phase 3. |
67+
| voltage_swell_l1_count | Optional Number | Number of voltage swells detected by meter for phase 1. |
68+
| voltage_swell_l2_count | Optional Number | Number of voltage swells detected by meter for phase 2. |
69+
| voltage_swell_l3_count | Optional Number | Number of voltage swells detected by meter for phase 3. |
70+
| any_power_fail_count | Optional Number | Number of power failures detected by meter. |
71+
| long_power_fail_count | Optional Number | Number of 'long' power fails detected by meter. |
72+
| average_power_15m_w | Optional Number | The active average demand, available for smart meters with [capacity rate](#capacity-rate). |
73+
| monthly_power_peak_w | Optional Number | The peak average demand of this month, available for smart meters with [capacity rate](#capacity-rate). |
74+
| monthly_power_peak_timestamp | Optional [Timestamp](#timestamps) | Timestamp when peak demand was registered, available for smart meters with [capacity rate](#capacity-rate). |
75+
| external | Optional Array with [`external`](#external-devices) | A list of externally connected utility meters, see [external data point](#external-devices) for more information. |
7476

7577
### External Devices
7678

0 commit comments

Comments
 (0)