Stromzähler

WARP Charger und Energy Manager unterstützen mehrere Stromzähler. Die Stromzähler-API ist aufgeteilt in einem allgemeinen Teil unter meters/... und einen Stromzähler-spezifischen Teil unter meters/X/... wobei X einer Stromzähler-Nummer entspricht. Der Stromzähler-spezifische Teil beinhaltet immer

Beispielsweise können die Messwerte des ersten Stromzählers (der die Stromzählernummer 0 besitzt) unter meters/0/values gelesen werden. Außerdem hat jeder Zähler die APIs

deren Inhalt von der Klasse des Stromzählers abhängt. Die Stromzählerklasse wird als das Union-Tag von meters/X/config angegeben.

Jeder Stromzähler meldet seine Messwerte unter meters/X/values als ein Array von Floats. Welcher Messwert wie zu interpretieren ist, kann unter meters/X/value_ids (einem Array von Ints, den sogenannten MeterValueIDs) ausgelesen werden: Wenn beispielsweise an Index 3 in meters/X/value_ids die MeterValueID 13 gelesen wird, dann ist der meters/X/values-Wert an Index 3 als der Phasenstrom auf L1 zu interpretieren.

Alle MeterValueIDs sind auf Github dokumentiert: Liste aller MeterValueIDs

warp1
warp2
warp3
wem
any

`meters/X/values`

Die Messwerte des X. Stromzählers. Die Bedeutung der Messwerte kann aus meters/X/value_ids ermittelt werden.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp-AbCd

Lesen

curl http://$HOST/meters/1/values

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/meters/1/values

[
  // Index 0
  217.6941223, 0, 0,
  30.72553635, 0, 0,
  6680.515625, 0, 0,
  6681.138672, 0, 0,
  // Index 12
  -90.09844208, 0, 0,
  1, 0, 0,
  72.56191254, 10.24184513, 30.72553635,
  6683.693359, 6680.666016, -90.09844208,
  // Index 24
  1, 50, 4644.044922,
  3.992000103, 0, 0,
  0, 0, 30.70857239,
  4648.038086, 197.5639954, 4648.038086,
  // Index 36
  4644.044922, 3.992000103
]

`meters/X/update`

Aktualisiert die Messwerte des X. Stromzählers. Kann nur bei einem API-Stromzähler (Union-Tag 4 in der entsprechenden meters/X/config) verwendet werden.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp-AbCd

Schreiben

curl http://$HOST/meters/1/update -d '[
    15.9, 16, 16.1,
    3657, 3680, 3703
]'

Beispiel für einen Zähler, der pro Phase Strom (Bezug + Einspeisung) und Wirkleistung (Bezug - Einspeisung) misst. Die korrekte Konfiguration (meters/X/config) für diesen Zähler wäre

[4, { "display_name": "API-Zähler", "value_ids": [13, 17, 21, 39, 48, 57] }]

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp/AbCd

Schreiben

mosquitto_pub -h $BROKER -t $PREFIX/meters/1/update -m '[
    15.9, 16, 16.1,
    3657, 3680, 3703
]'

Beispiel für einen Zähler, der pro Phase Strom (Bezug + Einspeisung) und Wirkleistung (Bezug - Einspeisung) misst. Die korrekte Konfiguration (meters/X/config) für diesen Zähler wäre

[4, { "display_name": "API-Zähler", "value_ids": [13, 17, 21, 39, 48, 57] }]

`meters/X/value_ids`

Die MeterValueIDs des X. Stromzählers. Der n-te Eintrag in diesem Array gibt die Bedeutung des n-ten Messwerts aus meters/X/values an. Liste aller MeterValueIDs

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp-AbCd

Lesen

curl http://$HOST/meters/1/value_ids

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/meters/1/value_ids

[
  // Index 0
  1, 2, 3,       // Spannung L1-N, L2-N, L3-N
  13, 17, 21,    // Strom (Bezug + Einspeisung) L1-N, L2-N, L3-N
  39, 48, 57,    // Wirkleistung (Bezug - Einspeisung) L1-N, L2-N, L3-N
  122, 130, 138, // Scheinleistung (Bezug + Einspeisung) L1-N, L2-N, L3-N
  // Index 12
  83, 91, 99,    // Blindleistung (induktiv - kapazitiv)  L1-N, L2-N, L3-N
  353, 354, 355, // Leistungsfaktor (gerichtet; Vorzeichen gibt Richtung des Stromflusses an) L1, L2, L3
  7,             // Durchschnittliche Phasenspannung
  29,            // Durchschnitt der (Bezug + Einspeisung)-Phasenströme
  33,            // Summe der (Bezug + Einspeisung)-Phasenstöme
  74,            // Summe der (Bezug - Einspeisung)-Phasenwirkleistungen
  154,           // Summe der (Bezug + Einspeisung)-Phasenscheinleistungen
  115,           // Summe der (induktiv - kapazitiv)-Phasenblindleistungen
  // Index 24
  356,           // Summe der gerichteten Leistungsfaktoren
  364,           // Netzfrequenz
  209, 211,      // Wirkenergie (Σ L1, L2, L3, seit Herstellung) Bezug, Einspeisung
  4, 5, 6, 8,    // Spannung L1-L2; L2-L3; L3-L1; ⌀ L1-L2, L2-L3, L3-L1
  25,            // Neutralleiterstrom
  213,           // Wirkenergie (Σ L1, L2, L3, seit Herstellung) Bezug + Einspeisung
  277,           // Blindenergie (Σ L1, L2, L3, seit Herstellung) induktiv + kapazitiv
  214,           // Wirkenergie (Σ L1, L2, L3, seit letztem Zurücksetzen) Bezug + Einspeisung
  // Index 36
  210,           // Wirkenergie (Σ L1, L2, L3, seit letztem Zurücksetzen) Bezug
  212            // Wirkenergie (Σ L1, L2, L3, seit letztem Zurücksetzen) Einspeisung
]

`meters/X/history`

HTTP (curl)
MQTT (mosquitto)

Eine 48-Stunden-Historie der Ladeleistung des X. Stromzählers in Watt. Bisher fehlende Werte werden durch null angezeigt. Die Historie wird von hinten nach vorne gefüllt, sodass null-Werte nur geschlossen am Anfang des Arrays auftreten, falls der ESP innerhalb der letzten 48 Stunden neugestartet wurde. Es werden bis zu 720 Werte ausgegeben, das entspricht einem Messwert alle 4 Minuten. Diese Messwerte sind der jeweilige Durchschnitt dieser 4 Minuten.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp-AbCd

curl http://$HOST/meters/1/history

{
  "offset": 60927,
  "samples": [
      null, null, null, null, null, null, null, null,
      // 600 weitere null-Werte entfernt
         0,    0,    0,    0,    0,    0,    0,    0,
         0,    0,    0,    0,    0,    0,    0,    0,
         0,    0,    0,    0,    0,    0,    0,    0,
         0,    0,    0,    0, 1736, 6656, 6655, 6666,
      6680, 6716, 6714, 6625, 6640, 6641, 6595, 6612,
      6592, 6593, 6589, 6592, 6600, 6625, 6626, 6637,
      6665, 6636, 6632, 6656, 6616, 6611, 6646, 6670,
      6691, 6715, 6787, 6754, 6761, 6797, 6771, 6685,
      6705, 6778, 6703, 6675, 6681, 6721, 6739, 6816,
      6872, 6858, 6821, 6836, 6784, 6871, 6943, 6930,
      6968, 6955, 6837, 6800, 6846, 6919, 6881, 6736,
      6671, 6655, 6674, 6743, 6878, 5733, 4462, 3712,
      3098, 2693, 2337, 2098, 1683, 1575, 1575,   84,
         0,    0,    0,    0,    0,    0,    0,    0
  ]
}

Name	Bedeutung
`offset` int (ms)	Das Alter des zuletzt gemessenen Wertes.
`samples` int[..]	Die gemessenen Werte.

`meters/X/live`

HTTP (curl)
MQTT (mosquitto)

Die letzten Ladeleistungs-Messwerte des X. Stromzählers. Auf Basis dieser Werte werden die Durchschnittswerte für meters/X/history generiert.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp-AbCd

curl http://$HOST/meters/1/live

{
  "offset": 370,
  "samples_per_second": 1.99565,
  "samples": [
    2626, 2626, 2626, 2626, 2626, 2626, 2626, 2673,
    2673, 2673, 2673, 2673, 2673, 2673, 2673, 2677,
    2677, 2677, 2677, 2677, 2677, 2677, 2677, 2677,
    2677, 2677, 2677, 2677, 2677, 2677, 2677,  988,
     988,  988,  988,  988,  988,  988,  988,    3,
       3,    3,    3,    3,    3,    3,    3,    1,
       1,    1,    1,    1,    1,    1,    1,    3,
       3,    3,    3,    3,    3,    3,    3,    3,
       3,    3,    3,    3,    3,    3,    3,    3,
       3,    3,    3,    3,    3,    3,    3,    4
   ]
}

Es liegen 80 Werte vor, ~ 2 Werte pro Sekunde wurden erhoben, das Offset des letzten Werts sind 370 ms -> Die Messwerte reichen im Moment 40,370 Sekunden in die Vergangenheit.

Name	Bedeutung
`offset` int (ms)	Das Alter des zuletzt gemessenen Wertes.
`samples_per_second` float (Hz)	Die Anzahl der gemessenen Werte pro Sekunde.
`samples` int[..]	Die gemessenen Werte. Abhängig von der Länge des Arrays und dem samples_per_second-Wert kann ermittelt werden, wie weit in die Vergangenheit die Messwerte reichen.

`meters/X/config`

Die Konfiguration des X. Stromzählers. Das Union-Tag gibt die Zählerklasse an.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp-AbCd

Lesen

curl http://$HOST/meters/1/config

[4, { "display_name": "API-Zähler", "value_ids": [13, 17, 21, 39, 48, 57] }]

Konfiguriert für den Stromzähler-Slot 1 einen über meters/1/update mit Werten befüllbaren Stromzähler, der pro Phase Strom (Bezug + Einspeisung) und Wirkleistung (Bezug - Einspeisung) misst. 4 ist das Union-Tag des API-Stromzählers.

Schreiben

curl http://$HOST/meters/1/config -d '[4, { "display_name": "API-Zähler", "value_ids": [13, 17, 21, 39, 48, 57] }]'

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/meters/1/config

[4, { "display_name": "API-Zähler", "value_ids": [13, 17, 21, 39, 48, 57] }]

Schreiben

Mit MQTT auf $PREFIX/meters/1/config_update

mosquitto_pub -h $BROKER -t $PREFIX/meters/1/config_update -m '[4, { "display_name": "API-Zähler", "value_ids": [13, 17, 21, 39, 48, 57] }]'

0 - Kein Stromzähler konfiguriert.
1 - Interner Stromzähler (an RS485-Bricklet)
4 - API-Stromzähler
5 - SunSpec-Gerät über Modbus-TCP
6 - Modbus-TCP-Stromzähler.
7 - SMA Speedwire-Stromzähler.

null: Kein Stromzähler konfiguriert.

Name Bedeutung

display_name
string

Anzeigename des Stromzählers

type_override
int

Erlaubt es den verbauten Zählertyp zu überschreiben, falls die Auto-Detektion nicht funktioniert.

0 - Kein Stromzähler verfügbar
1 - SDM72
2 - SDM630
3 - SDM72V2
255 - Typ-Override nicht aktiv. Stromzählertyp wird automatisch detektiert.

Name	Bedeutung
`display_name` string	Anzeigename des Stromzählers
`value_ids` int[..]	MeterValueIDs, die über die API meters/X/update gesetzt werden können sollen. Liste aller MeterValueIDs

Name	Bedeutung
`display_name` string	Anzeigename des Geräts
`host` string	Hostname oder IP-Adresse des SunSpec-Geräts
`port` int	Port des SunSpec-Geräts. Typischerweise 502
`device_address` int	Modbus-Device-Adresse des Sunspec-Geräts
`manufacturer_name` string	Name des Herstellers des SunSpec-Geräts. Die Kombination aus `manufacturer_name`, `model_name` und `serial_number` sollte ein Gerät weltweit eindeutig identifizieren.
`model_name` string	Name des Modells des SunSpec-Geräts.
`serial_number` string	Seriennummer des SunSpec-Geräts.
`model_id` int	SunSpec-Model-ID
`model_instance` int	Gibt an wie viele SunSpec-Modelle mit gleicher `model_id` übersprungen werden, bis das gewünsche Modell gleicher ID erreicht ist.

Name Bedeutung

display_name
string

Anzeigename des Stromzählers

host
string

Hostname oder IP-Adresse des SunSpec-Geräts

port
int

Port des SunSpec-Geräts. Typischerweise 502

table
Union

Registertabelle, die gelesen werden soll.

0 - Keine Registertabelle konfiguriert.
1 - Benutzerdefinierte Registertabelle
2 - Sungrow Hybrid-Wechselrichter (SH...)
3 - Sungrow String-Wechselrichter (SG...)
4 - Solarmax Max.Storage
5 - Victron Energy GX
6 - Deye Hybrid-Wechselrichter
7 - AlphaESS Hybrid-Wechselrichter
8 - Shelly Pro EM
9 - Shelly Pro 3EM
10 - GoodWe Hybrid-Wechselrichter

null: Keine Registertabelle konfiguriert.

Name Bedeutung

device_address
int

Geräteadresse.

register_address_mode
int

Gibt an, ob die konfigurierten Registerstartadressen im Webinterface als Adressen oder Registernummern angezeigt werden.

0 - Startadressen werden als Registeraddressen angezeigt. Die erste Adresse ist 0.
1 - Startadressen werden als Registernummern angezeigt. Die erste Registernummer ist 1.

registers
object[36]

Registertabelle

[0..35] - Ein Register, dass gelesen werden soll

Name	Bedeutung
`rtype` int	Registertyp 0 - Holding Register 1 - Input Register
`addr` int	Startadresse des Registers.
`vtype` int	Wert-Typ 1 - Ein Register, 16-Bit, Ganzzahl, vorzeichenlos 9 - Ein Register, 16-Bit, Ganzzahl, vorzeichenbehaftet 2 - Zwei Register, 32-Bit, Ganzzahl, vorzeichenlos, Big-Endian 34 - Zwei Register, 32-Bit, Ganzzahl, vorzeichenlos, Little-Endian 10 - Zwei Register, 32-Bit, Ganzzahl, vorzeichenbehaftet, Big-Endian 42 - Zwei Register, 32-Bit, Ganzzahl, vorzeichenbehaftet, Little-Endian 26 - Zwei Register, 32-Bit, Gleitkommazahl, Big-Endian 58 - Zwei Register, 32-Bit, Gleitkommazahl, Little-Endian 4 - Vier Register, 64-Bit, Ganzzahl, vorzeichenlos, Big-Endian 36 - Vier Register, 64-Bit, Ganzzahl, vorzeichenlos, Little-Endian 12 - Vier Register, 64-Bit, Ganzzahl, vorzeichenbehaftet, Big-Endian 44 - Vier Register, 64-Bit, Ganzzahl, vorzeichenbehaftet, Little-Endian 28 - Vier Register, 64-Bit, Gleitkommazahl, Big-Endian 60 - Vier Register, 64-Bit, Gleitkommazahl, Little-Endian
`off` float	Offset, dass auf den gelesenen Wert addiert werden soll. Der Offset-Wert wird addiert, bevor der Skalierungsfaktor angewandt wird.
`scale` float	Skalierungsfaktor, mit dem der gelesene Wert multipliziert werden soll. Der Skalierungsfaktor wirkt auf den Wert, der durch die Addition des gelesenen Wertes mit dem Offset entstanden ist.
`id` int	MeterValueID, die die Interpretation des gelesenen Werts angibt. Liste aller MeterValueIDs

Name Bedeutung

virtual_meter
int

Virtueller Zähler. Gibt an welcher Teil der Registertabelle gelesen wird.

0 - Kein virtueller Zähler ausgewählt
1 - Wechselrichter
2 - Netzanschluss
3 - Speicher
4 - Last

device_address
int

Geräteadresse. Typischerweise 1.

Name Bedeutung

virtual_meter
int

Virtueller Zähler. Gibt an welcher Teil der Registertabelle gelesen wird.

0 - Kein virtueller Zähler ausgewählt
1 - Wechselrichter
2 - Netzanschluss
3 - Last

device_address
int

Geräteadresse. Typischerweise 1.

Name Bedeutung

virtual_meter
int

Virtueller Zähler. Gibt an welcher Teil der Registertabelle gelesen wird.

0 - Kein virtueller Zähler ausgewählt
1 - Wechselrichter
2 - Netzanschluss
3 - Speicher

device_address
int

Geräteadresse. Typischerweise 1.

Name Bedeutung

virtual_meter
int

Virtueller Zähler. Gibt an welcher Teil der Registertabelle gelesen wird.

0 - Kein virtueller Zähler ausgewählt
1 - Wechselrichter
2 - Netzanschluss
3 - Speicher
4 - Last

device_address
int

Geräteadresse. Typischerweise 100.

Name Bedeutung

virtual_meter
int

Virtueller Zähler. Gibt an welcher Teil der Registertabelle gelesen wird.

0 - Kein virtueller Zähler ausgewählt
1 - Wechselrichter
2 - Netzanschluss
3 - Speicher
4 - Last

device_address
int

Geräteadresse. Typischerweise 1.

Name Bedeutung

virtual_meter
int

Virtueller Zähler. Gibt an welcher Teil der Registertabelle gelesen wird.

0 - Kein virtueller Zähler ausgewählt
1 - Wechselrichter
2 - Netzanschluss
3 - Speicher

device_address
int

Geräteadresse. Typischerweise 1.

Name Bedeutung

device_address
int

Geräteadresse. Typischerweise 1.

monophase_channel
int

Kanal, der gelesen werden soll.

0 - Kein Kanal ausgewählt
1 - Kanal 1
2 - Kanal 2

monophase_mapping
int

Phase der die Messwerte zugeordnet werden.

0 - Keine Phase ausgewählt
1 - L1
2 - L2
3 - L3

Name	Bedeutung
`device_address` int	Geräteadresse. Typischerweise 1.
`device_profile` int	Gibt an, ob eine oder alle drei Phasen gelesen werden sollen. 0 - Dreiphasig. `monophase_channel` und `monophase_mapping` werden ignoriert. 1 - Einphasig
`monophase_channel` int	Kanal, der gelesen werden soll. 0 - Kein Kanal ausgewählt 1 - Kanal 1 2 - Kanal 2 3 - Kanal 3
`monophase_mapping` int	Phase der die Messwerte zugeordnet werden. 0 - Keine Phase ausgewählt 1 - L1 2 - L2 3 - L3

Name Bedeutung

virtual_meter
int

Virtueller Zähler. Gibt an welcher Teil der Registertabelle gelesen wird.

0 - Kein virtueller Zähler ausgewählt
1 - Wechselrichter
2 - Netzanschluss
3 - Speicher
4 - Last
5 - Backup-Last
6 - Zähler

device_address
int

Geräteadresse. Typischerweise 247.

Name	Bedeutung
`display_name` string	Anzeigename des Stromzählers

`meters/X/state`

Der Zustand des X. Stromzählers. Der Inhalt dieser API hängt vom Typ des Stromzählers ab, der in meters/X/config konfiguriert wurde.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp-AbCd

Lesen

curl http://$HOST/meters/1/state

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/meters/1/state

null

0 - Kein Stromzähler konfiguriert.
1 - Zustand des internen Stromzählers
2 - Zustand des internen Stromzählers
3 - Zustand des internen Stromzählers
4 - Zustand des API-Stromzählers. Im Moment leer.
5 - Zustand des SunSpec-Stromzählers. Im Moment leer.

null: Kein Stromzähler konfiguriert.

Name Bedeutung

Name	Bedeutung
`type` int	Typ des verbauten Stromzählers. Nicht jeder Stromzähler wird von jedem Gerät unterstützt! 0 - Kein Stromzähler verfügbar 1 - SDM72 2 - SDM630 3 - SDM72V2

type
int

Typ des verbauten Stromzählers. Nicht jeder Stromzähler wird von jedem Gerät unterstützt!

0 - Kein Stromzähler verfügbar
1 - SDM72
2 - SDM630
3 - SDM72V2

Name Bedeutung

Name	Bedeutung
`type` int	Typ des verbauten Stromzählers. Nicht jeder Stromzähler wird von jedem Gerät unterstützt! 0 - Kein Stromzähler verfügbar 2 - SDM630 3 - SDM72V2 4 - SDM72CTM 5 - SDM630MCT 6 - DSZ15DZMOD 7 - DEM4A

type
int

Typ des verbauten Stromzählers. Nicht jeder Stromzähler wird von jedem Gerät unterstützt!

0 - Kein Stromzähler verfügbar
2 - SDM630
3 - SDM72V2
4 - SDM72CTM
5 - SDM630MCT
6 - DSZ15DZMOD
7 - DEM4A

Name Bedeutung

Name	Bedeutung
`type` int	Typ des verbauten Stromzählers. Nicht jeder Stromzähler wird von jedem Gerät unterstützt! 0 - Kein Stromzähler verfügbar 2 - SDM630 3 - SDM72V2 4 - SDM72CTM 5 - SDM630MCT 6 - DSZ15DZMOD 7 - DEM4A

type
int

Typ des verbauten Stromzählers. Nicht jeder Stromzähler wird von jedem Gerät unterstützt!

0 - Kein Stromzähler verfügbar
2 - SDM630
3 - SDM72V2
4 - SDM72CTM
5 - SDM630MCT
6 - DSZ15DZMOD
7 - DEM4A

`meters/X/errors`

Fehlerzähler der Kommunikation mit dem Stromzähler. Der Inhalt dieser API hängt vom Typ des Stromzählers ab, der in meters/X/config konfiguriert wurde.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp-AbCd

Lesen

curl http://$HOST/meters/1/errors

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/meters/1/errors

null

0 - Kein Stromzähler konfiguriert.
1 - Fehlerzähler des internen Stromzählers
2 - Fehlerzähler des internen Stromzählers
3 - Fehlerzähler des internen Stromzählers
4 - Fehlerzähler des API-Stromzählers. Im Moment leer.
5 - Fehlerzähler des SunSpec-Stromzählers. Im Moment leer.

null: Kein Stromzähler konfiguriert.

Name	Bedeutung
`meter` int	Kommunikationsfehler zwischen RS485 Bricklet und Stromzähler.
`bricklet` int	Kommunikationsfehler zwischen ESP Brick und RS485 Bricklet.
`bricklet_reset` int	Unerwartete Resets des RS485 Bricklets.

Name	Bedeutung
`local_timeout` int	Local Timeout
`global_timeout` int	Global Timeout
`illegal_function` int	Illegal Function
`illegal_data_access` int	Illegal Data Access
`illegal_data_value` int	Illegal Data Value
`slave_device_failure` int	Slave Device Failure

Name	Bedeutung
`local_timeout` int	Local Timeout
`global_timeout` int	Global Timeout
`illegal_function` int	Illegal Function
`illegal_data_access` int	Illegal Data Access
`illegal_data_value` int	Illegal Data Value
`slave_device_failure` int	Slave Device Failure

`meters/X/reset`

Setzt alle zurücksetzbaren (Alle Werte deren kind-Eintrag resettable ist: Liste aller MeterValueIDs) Zählerwerte des X. Stromzählers zurück. Leerer Payload. Es muss einer der folgenden Werte übergeben werden: null, "", false, 0, [] oder {}

http
mqtt

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp-AbCd

Schreiben

curl http://$HOST/meters/1/reset -d 'null'

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp/AbCd

Schreiben

mosquitto_pub -h $BROKER -t $PREFIX/meters/1/reset -m 'null'

`meters/X/last_reset`

Der Zeitpunkt des letzten Zähler-Resets (siehe meters/X/reset) als Unix-Timestamp. 0 falls kein Reset durchgeführt wurde. Falls zum Zeitpunkt des letzten Resets keine Zeitsynchronisierung vorlag, ist dieser Wert stattdessen ein Zähler, der angibt, wie oft ein Reset durchgeführt wurde.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp-AbCd

Lesen

curl http://$HOST/meters/1/last_reset

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/meters/1/last_reset

{ "last_reset": 1714728252 }

Zuletzt zurückgesetzt 2024-05-03T11:24:12+02:00

Name	Bedeutung
`last_reset` int (s)	Unix-Timestamp des Zeitpunkts des letzten Zähler-Resets.

`meters/history`

HTTP (curl)
MQTT (mosquitto)

Eine 48-Stunden-Historie der Ladeleistung in Watt. Bisher fehlende Werte werden durch null angezeigt. Die Historie wird von hinten nach vorne gefüllt, sodass null-Werte nur geschlossen am Anfang des Arrays auftreten, falls der ESP innerhalb der letzten 48 Stunden neugestartet wurde. Es werden bis zu 720 Werte ausgegeben, das entspricht einem Messwert alle 4 Minuten. Diese Messwerte sind der jeweilige Durchschnitt dieser 4 Minuten.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp-AbCd

curl http://$HOST/meters/history

{
  "offset": 9378,
  "samples": [
    [
      null, null, null, null, null, null, null, null,
      // 600 weitere null-Werte entfernt
         0,    0,    0,    0,    0,    0,    0,    0,
         0,    0,    0,    0,    0,    0,    0,    0,
         0,    0,    0,    0,    0,    0,    0,    0,
         0,    0,    0,    0, 1736, 6656, 6655, 6666,
      6680, 6716, 6714, 6625, 6640, 6641, 6595, 6612,
      6592, 6593, 6589, 6592, 6600, 6625, 6626, 6637,
      6665, 6636, 6632, 6656, 6616, 6611, 6646, 6670,
      6691, 6715, 6787, 6754, 6761, 6797, 6771, 6685,
      6705, 6778, 6703, 6675, 6681, 6721, 6739, 6816,
      6872, 6858, 6821, 6836, 6784, 6871, 6943, 6930,
      6968, 6955, 6837, 6800, 6846, 6919, 6881, 6736,
      6671, 6655, 6674, 6743, 6878, 5733, 4462, 3712,
      3098, 2693, 2337, 2098, 1683, 1575, 1575,   84,
         0,    0,    0,    0,    0,    0,    0,    0
    ],
    null,
    null,
    null,
    null,
    null,
    null
  ]
}

Name Bedeutung

offset
int (ms)

Das Alter des zuletzt gemessenen Wertes.

samples
int[..][2]

Die gemessenen Werte aller Stromzähler.

[0..1] - Die gemessenen Werte des jeweiligen Stromzählers. Null falls ein Zähler nicht konfiguriert ist.

`meters/live`

HTTP (curl)
MQTT (mosquitto)

Die letzten Ladeleistungs-Messwerte. Auf Basis dieser Werte werden die Durchschnittswerte für meters/history generiert. Es werden bis zu 720 Werte ausgegeben, das entspricht 6 Minuten bei einem Messwert alle 500 Millisekunden.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp-AbCd

curl http://$HOST/meters/live

{
  "offset": 370,
  "samples_per_second": 1.99565,
  "samples": [
    [
        2626, 2626, 2626, 2626, 2626, 2626, 2626, 2673,
        2673, 2673, 2673, 2673, 2673, 2673, 2673, 2677,
        2677, 2677, 2677, 2677, 2677, 2677, 2677, 2677,
        2677, 2677, 2677, 2677, 2677, 2677, 2677,  988,
         988,  988,  988,  988,  988,  988,  988,    3,
           3,    3,    3,    3,    3,    3,    3,    1,
           1,    1,    1,    1,    1,    1,    1,    3,
           3,    3,    3,    3,    3,    3,    3,    3,
           3,    3,    3,    3,    3,    3,    3,    3,
           3,    3,    3,    3,    3,    3,    3,    4
    ],
    null
  ]
}

Name Bedeutung

offset
int (ms)

Das Alter des zuletzt gemessenen Wertes.

samples_per_second
float (Hz)

Die Anzahl der gemessenen Werte pro Sekunde.

samples
int[..][2]

Die gemessenen Werte aller Stromzähler.

[0..1] - Die gemessenen Werte. Abhängig von der Länge des Arrays und dem samples_per_second-Wert kann ermittelt werden, wie weit in die Vergangenheit die Messwerte reichen.

`meters/X/values`

Die Messwerte des X. Stromzählers. Die Bedeutung der Messwerte kann aus meters/X/value_ids ermittelt werden.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp2-AbCd

Lesen

curl http://$HOST/meters/1/values

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp2/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/meters/1/values

[
  // Index 0
  217.6941223, 0, 0,
  30.72553635, 0, 0,
  6680.515625, 0, 0,
  6681.138672, 0, 0,
  // Index 12
  -90.09844208, 0, 0,
  1, 0, 0,
  72.56191254, 10.24184513, 30.72553635,
  6683.693359, 6680.666016, -90.09844208,
  // Index 24
  1, 50, 4644.044922,
  3.992000103, 0, 0,
  0, 0, 30.70857239,
  4648.038086, 197.5639954, 4648.038086,
  // Index 36
  4644.044922, 3.992000103
]

`meters/X/update`

Aktualisiert die Messwerte des X. Stromzählers. Kann nur bei einem API-Stromzähler (Union-Tag 4 in der entsprechenden meters/X/config) verwendet werden.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp2-AbCd

Schreiben

curl http://$HOST/meters/1/update -d '[
    15.9, 16, 16.1,
    3657, 3680, 3703
]'

Beispiel für einen Zähler, der pro Phase Strom (Bezug + Einspeisung) und Wirkleistung (Bezug - Einspeisung) misst. Die korrekte Konfiguration (meters/X/config) für diesen Zähler wäre

[4, { "display_name": "API-Zähler", "value_ids": [13, 17, 21, 39, 48, 57] }]

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp2/AbCd

Schreiben

mosquitto_pub -h $BROKER -t $PREFIX/meters/1/update -m '[
    15.9, 16, 16.1,
    3657, 3680, 3703
]'

Beispiel für einen Zähler, der pro Phase Strom (Bezug + Einspeisung) und Wirkleistung (Bezug - Einspeisung) misst. Die korrekte Konfiguration (meters/X/config) für diesen Zähler wäre

[4, { "display_name": "API-Zähler", "value_ids": [13, 17, 21, 39, 48, 57] }]

`meters/X/value_ids`

Die MeterValueIDs des X. Stromzählers. Der n-te Eintrag in diesem Array gibt die Bedeutung des n-ten Messwerts aus meters/X/values an. Liste aller MeterValueIDs

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp2-AbCd

Lesen

curl http://$HOST/meters/1/value_ids

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp2/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/meters/1/value_ids

[
  // Index 0
  1, 2, 3,       // Spannung L1-N, L2-N, L3-N
  13, 17, 21,    // Strom (Bezug + Einspeisung) L1-N, L2-N, L3-N
  39, 48, 57,    // Wirkleistung (Bezug - Einspeisung) L1-N, L2-N, L3-N
  122, 130, 138, // Scheinleistung (Bezug + Einspeisung) L1-N, L2-N, L3-N
  // Index 12
  83, 91, 99,    // Blindleistung (induktiv - kapazitiv)  L1-N, L2-N, L3-N
  353, 354, 355, // Leistungsfaktor (gerichtet; Vorzeichen gibt Richtung des Stromflusses an) L1, L2, L3
  7,             // Durchschnittliche Phasenspannung
  29,            // Durchschnitt der (Bezug + Einspeisung)-Phasenströme
  33,            // Summe der (Bezug + Einspeisung)-Phasenstöme
  74,            // Summe der (Bezug - Einspeisung)-Phasenwirkleistungen
  154,           // Summe der (Bezug + Einspeisung)-Phasenscheinleistungen
  115,           // Summe der (induktiv - kapazitiv)-Phasenblindleistungen
  // Index 24
  356,           // Summe der gerichteten Leistungsfaktoren
  364,           // Netzfrequenz
  209, 211,      // Wirkenergie (Σ L1, L2, L3, seit Herstellung) Bezug, Einspeisung
  4, 5, 6, 8,    // Spannung L1-L2; L2-L3; L3-L1; ⌀ L1-L2, L2-L3, L3-L1
  25,            // Neutralleiterstrom
  213,           // Wirkenergie (Σ L1, L2, L3, seit Herstellung) Bezug + Einspeisung
  277,           // Blindenergie (Σ L1, L2, L3, seit Herstellung) induktiv + kapazitiv
  214,           // Wirkenergie (Σ L1, L2, L3, seit letztem Zurücksetzen) Bezug + Einspeisung
  // Index 36
  210,           // Wirkenergie (Σ L1, L2, L3, seit letztem Zurücksetzen) Bezug
  212            // Wirkenergie (Σ L1, L2, L3, seit letztem Zurücksetzen) Einspeisung
]

`meters/X/history`

HTTP (curl)
MQTT (mosquitto)

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp2-AbCd

curl http://$HOST/meters/1/history

{
  "offset": 60927,
  "samples": [
      null, null, null, null, null, null, null, null,
      // 600 weitere null-Werte entfernt
         0,    0,    0,    0,    0,    0,    0,    0,
         0,    0,    0,    0,    0,    0,    0,    0,
         0,    0,    0,    0,    0,    0,    0,    0,
         0,    0,    0,    0, 1736, 6656, 6655, 6666,
      6680, 6716, 6714, 6625, 6640, 6641, 6595, 6612,
      6592, 6593, 6589, 6592, 6600, 6625, 6626, 6637,
      6665, 6636, 6632, 6656, 6616, 6611, 6646, 6670,
      6691, 6715, 6787, 6754, 6761, 6797, 6771, 6685,
      6705, 6778, 6703, 6675, 6681, 6721, 6739, 6816,
      6872, 6858, 6821, 6836, 6784, 6871, 6943, 6930,
      6968, 6955, 6837, 6800, 6846, 6919, 6881, 6736,
      6671, 6655, 6674, 6743, 6878, 5733, 4462, 3712,
      3098, 2693, 2337, 2098, 1683, 1575, 1575,   84,
         0,    0,    0,    0,    0,    0,    0,    0
  ]
}

Name	Bedeutung
`offset` int (ms)	Das Alter des zuletzt gemessenen Wertes.
`samples` int[..]	Die gemessenen Werte.

`meters/X/live`

HTTP (curl)
MQTT (mosquitto)

Die letzten Ladeleistungs-Messwerte des X. Stromzählers. Auf Basis dieser Werte werden die Durchschnittswerte für meters/X/history generiert.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp2-AbCd

curl http://$HOST/meters/1/live

{
  "offset": 370,
  "samples_per_second": 1.99565,
  "samples": [
    2626, 2626, 2626, 2626, 2626, 2626, 2626, 2673,
    2673, 2673, 2673, 2673, 2673, 2673, 2673, 2677,
    2677, 2677, 2677, 2677, 2677, 2677, 2677, 2677,
    2677, 2677, 2677, 2677, 2677, 2677, 2677,  988,
     988,  988,  988,  988,  988,  988,  988,    3,
       3,    3,    3,    3,    3,    3,    3,    1,
       1,    1,    1,    1,    1,    1,    1,    3,
       3,    3,    3,    3,    3,    3,    3,    3,
       3,    3,    3,    3,    3,    3,    3,    3,
       3,    3,    3,    3,    3,    3,    3,    4
   ]
}

Es liegen 80 Werte vor, ~ 2 Werte pro Sekunde wurden erhoben, das Offset des letzten Werts sind 370 ms -> Die Messwerte reichen im Moment 40,370 Sekunden in die Vergangenheit.

Name	Bedeutung
`offset` int (ms)	Das Alter des zuletzt gemessenen Wertes.
`samples_per_second` float (Hz)	Die Anzahl der gemessenen Werte pro Sekunde.
`samples` int[..]	Die gemessenen Werte. Abhängig von der Länge des Arrays und dem samples_per_second-Wert kann ermittelt werden, wie weit in die Vergangenheit die Messwerte reichen.

`meters/X/config`

Die Konfiguration des X. Stromzählers. Das Union-Tag gibt die Zählerklasse an.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp2-AbCd

Lesen

curl http://$HOST/meters/1/config

[4, { "display_name": "API-Zähler", "value_ids": [13, 17, 21, 39, 48, 57] }]

Schreiben

curl http://$HOST/meters/1/config -d '[4, { "display_name": "API-Zähler", "value_ids": [13, 17, 21, 39, 48, 57] }]'

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp2/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/meters/1/config

[4, { "display_name": "API-Zähler", "value_ids": [13, 17, 21, 39, 48, 57] }]

Schreiben

Mit MQTT auf $PREFIX/meters/1/config_update

mosquitto_pub -h $BROKER -t $PREFIX/meters/1/config_update -m '[4, { "display_name": "API-Zähler", "value_ids": [13, 17, 21, 39, 48, 57] }]'

0 - Kein Stromzähler konfiguriert.
2 - Interner Stromzähler (an EVSE-2.0-Bricklet)
4 - API-Stromzähler
5 - SunSpec-Gerät über Modbus-TCP
6 - Modbus-TCP-Stromzähler.
7 - SMA Speedwire-Stromzähler.

null: Kein Stromzähler konfiguriert.

Name	Bedeutung
`display_name` string	Anzeigename des Stromzählers

Name	Bedeutung
`display_name` string	Anzeigename des Stromzählers
`value_ids` int[..]	MeterValueIDs, die über die API meters/X/update gesetzt werden können sollen. Liste aller MeterValueIDs

Name	Bedeutung
`display_name` string	Anzeigename des Geräts
`host` string	Hostname oder IP-Adresse des SunSpec-Geräts
`port` int	Port des SunSpec-Geräts. Typischerweise 502
`device_address` int	Modbus-Device-Adresse des Sunspec-Geräts
`manufacturer_name` string	Name des Herstellers des SunSpec-Geräts. Die Kombination aus `manufacturer_name`, `model_name` und `serial_number` sollte ein Gerät weltweit eindeutig identifizieren.
`model_name` string	Name des Modells des SunSpec-Geräts.
`serial_number` string	Seriennummer des SunSpec-Geräts.
`model_id` int	SunSpec-Model-ID
`model_instance` int	Gibt an wie viele SunSpec-Modelle mit gleicher `model_id` übersprungen werden, bis das gewünsche Modell gleicher ID erreicht ist.

Name Bedeutung

display_name
string

Anzeigename des Stromzählers

host
string

Hostname oder IP-Adresse des SunSpec-Geräts

port
int

Port des SunSpec-Geräts. Typischerweise 502

table
Union

Registertabelle, die gelesen werden soll.

0 - Keine Registertabelle konfiguriert.
1 - Benutzerdefinierte Registertabelle
2 - Sungrow Hybrid-Wechselrichter (SH...)
3 - Sungrow String-Wechselrichter (SG...)
4 - Solarmax Max.Storage
5 - Victron Energy GX
6 - Deye Hybrid-Wechselrichter
7 - AlphaESS Hybrid-Wechselrichter
8 - Shelly Pro EM
9 - Shelly Pro 3EM
10 - GoodWe Hybrid-Wechselrichter

null: Keine Registertabelle konfiguriert.

Name Bedeutung

device_address
int

Geräteadresse.

register_address_mode
int

Gibt an, ob die konfigurierten Registerstartadressen im Webinterface als Adressen oder Registernummern angezeigt werden.

0 - Startadressen werden als Registeraddressen angezeigt. Die erste Adresse ist 0.
1 - Startadressen werden als Registernummern angezeigt. Die erste Registernummer ist 1.

registers
object[36]

Registertabelle

[0..35] - Ein Register, dass gelesen werden soll

Name	Bedeutung
`rtype` int	Registertyp 0 - Holding Register 1 - Input Register
`addr` int	Startadresse des Registers.
`vtype` int	Wert-Typ 1 - Ein Register, 16-Bit, Ganzzahl, vorzeichenlos 9 - Ein Register, 16-Bit, Ganzzahl, vorzeichenbehaftet 2 - Zwei Register, 32-Bit, Ganzzahl, vorzeichenlos, Big-Endian 34 - Zwei Register, 32-Bit, Ganzzahl, vorzeichenlos, Little-Endian 10 - Zwei Register, 32-Bit, Ganzzahl, vorzeichenbehaftet, Big-Endian 42 - Zwei Register, 32-Bit, Ganzzahl, vorzeichenbehaftet, Little-Endian 26 - Zwei Register, 32-Bit, Gleitkommazahl, Big-Endian 58 - Zwei Register, 32-Bit, Gleitkommazahl, Little-Endian 4 - Vier Register, 64-Bit, Ganzzahl, vorzeichenlos, Big-Endian 36 - Vier Register, 64-Bit, Ganzzahl, vorzeichenlos, Little-Endian 12 - Vier Register, 64-Bit, Ganzzahl, vorzeichenbehaftet, Big-Endian 44 - Vier Register, 64-Bit, Ganzzahl, vorzeichenbehaftet, Little-Endian 28 - Vier Register, 64-Bit, Gleitkommazahl, Big-Endian 60 - Vier Register, 64-Bit, Gleitkommazahl, Little-Endian
`off` float	Offset, dass auf den gelesenen Wert addiert werden soll. Der Offset-Wert wird addiert, bevor der Skalierungsfaktor angewandt wird.
`scale` float	Skalierungsfaktor, mit dem der gelesene Wert multipliziert werden soll. Der Skalierungsfaktor wirkt auf den Wert, der durch die Addition des gelesenen Wertes mit dem Offset entstanden ist.
`id` int	MeterValueID, die die Interpretation des gelesenen Werts angibt. Liste aller MeterValueIDs

Name Bedeutung

virtual_meter
int

Virtueller Zähler. Gibt an welcher Teil der Registertabelle gelesen wird.

0 - Kein virtueller Zähler ausgewählt
1 - Wechselrichter
2 - Netzanschluss
3 - Speicher
4 - Last

device_address
int

Geräteadresse. Typischerweise 1.

Name Bedeutung

virtual_meter
int

Virtueller Zähler. Gibt an welcher Teil der Registertabelle gelesen wird.

0 - Kein virtueller Zähler ausgewählt
1 - Wechselrichter
2 - Netzanschluss
3 - Last

device_address
int

Geräteadresse. Typischerweise 1.

Name Bedeutung

virtual_meter
int

Virtueller Zähler. Gibt an welcher Teil der Registertabelle gelesen wird.

0 - Kein virtueller Zähler ausgewählt
1 - Wechselrichter
2 - Netzanschluss
3 - Speicher

device_address
int

Geräteadresse. Typischerweise 1.

Name Bedeutung

virtual_meter
int

Virtueller Zähler. Gibt an welcher Teil der Registertabelle gelesen wird.

0 - Kein virtueller Zähler ausgewählt
1 - Wechselrichter
2 - Netzanschluss
3 - Speicher
4 - Last

device_address
int

Geräteadresse. Typischerweise 100.

Name Bedeutung

virtual_meter
int

Virtueller Zähler. Gibt an welcher Teil der Registertabelle gelesen wird.

0 - Kein virtueller Zähler ausgewählt
1 - Wechselrichter
2 - Netzanschluss
3 - Speicher
4 - Last

device_address
int

Geräteadresse. Typischerweise 1.

Name Bedeutung

virtual_meter
int

Virtueller Zähler. Gibt an welcher Teil der Registertabelle gelesen wird.

0 - Kein virtueller Zähler ausgewählt
1 - Wechselrichter
2 - Netzanschluss
3 - Speicher

device_address
int

Geräteadresse. Typischerweise 1.

Name Bedeutung

device_address
int

Geräteadresse. Typischerweise 1.

monophase_channel
int

Kanal, der gelesen werden soll.

0 - Kein Kanal ausgewählt
1 - Kanal 1
2 - Kanal 2

monophase_mapping
int

Phase der die Messwerte zugeordnet werden.

0 - Keine Phase ausgewählt
1 - L1
2 - L2
3 - L3

Name	Bedeutung
`device_address` int	Geräteadresse. Typischerweise 1.
`device_profile` int	Gibt an, ob eine oder alle drei Phasen gelesen werden sollen. 0 - Dreiphasig. `monophase_channel` und `monophase_mapping` werden ignoriert. 1 - Einphasig
`monophase_channel` int	Kanal, der gelesen werden soll. 0 - Kein Kanal ausgewählt 1 - Kanal 1 2 - Kanal 2 3 - Kanal 3
`monophase_mapping` int	Phase der die Messwerte zugeordnet werden. 0 - Keine Phase ausgewählt 1 - L1 2 - L2 3 - L3

Name Bedeutung

virtual_meter
int

Virtueller Zähler. Gibt an welcher Teil der Registertabelle gelesen wird.

0 - Kein virtueller Zähler ausgewählt
1 - Wechselrichter
2 - Netzanschluss
3 - Speicher
4 - Last
5 - Backup-Last
6 - Zähler

device_address
int

Geräteadresse. Typischerweise 247.

Name	Bedeutung
`display_name` string	Anzeigename des Stromzählers

`meters/X/state`

Der Zustand des X. Stromzählers. Der Inhalt dieser API hängt vom Typ des Stromzählers ab, der in meters/X/config konfiguriert wurde.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp2-AbCd

Lesen

curl http://$HOST/meters/1/state

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp2/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/meters/1/state

null

0 - Kein Stromzähler konfiguriert.
1 - Zustand des internen Stromzählers
2 - Zustand des internen Stromzählers
3 - Zustand des internen Stromzählers
4 - Zustand des API-Stromzählers. Im Moment leer.
5 - Zustand des SunSpec-Stromzählers. Im Moment leer.

null: Kein Stromzähler konfiguriert.

Name Bedeutung

Name	Bedeutung
`type` int	Typ des verbauten Stromzählers. Nicht jeder Stromzähler wird von jedem Gerät unterstützt! 0 - Kein Stromzähler verfügbar 1 - SDM72 2 - SDM630 3 - SDM72V2

type
int

Typ des verbauten Stromzählers. Nicht jeder Stromzähler wird von jedem Gerät unterstützt!

0 - Kein Stromzähler verfügbar
1 - SDM72
2 - SDM630
3 - SDM72V2

Name Bedeutung

Name	Bedeutung
`type` int	Typ des verbauten Stromzählers. Nicht jeder Stromzähler wird von jedem Gerät unterstützt! 0 - Kein Stromzähler verfügbar 2 - SDM630 3 - SDM72V2 4 - SDM72CTM 5 - SDM630MCT 6 - DSZ15DZMOD 7 - DEM4A

type
int

Typ des verbauten Stromzählers. Nicht jeder Stromzähler wird von jedem Gerät unterstützt!

0 - Kein Stromzähler verfügbar
2 - SDM630
3 - SDM72V2
4 - SDM72CTM
5 - SDM630MCT
6 - DSZ15DZMOD
7 - DEM4A

Name Bedeutung

Name	Bedeutung
`type` int	Typ des verbauten Stromzählers. Nicht jeder Stromzähler wird von jedem Gerät unterstützt! 0 - Kein Stromzähler verfügbar 2 - SDM630 3 - SDM72V2 4 - SDM72CTM 5 - SDM630MCT 6 - DSZ15DZMOD 7 - DEM4A

type
int

Typ des verbauten Stromzählers. Nicht jeder Stromzähler wird von jedem Gerät unterstützt!

0 - Kein Stromzähler verfügbar
2 - SDM630
3 - SDM72V2
4 - SDM72CTM
5 - SDM630MCT
6 - DSZ15DZMOD
7 - DEM4A

`meters/X/errors`

Fehlerzähler der Kommunikation mit dem Stromzähler. Der Inhalt dieser API hängt vom Typ des Stromzählers ab, der in meters/X/config konfiguriert wurde.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp2-AbCd

Lesen

curl http://$HOST/meters/1/errors

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp2/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/meters/1/errors

null

0 - Kein Stromzähler konfiguriert.
1 - Fehlerzähler des internen Stromzählers
2 - Fehlerzähler des internen Stromzählers
3 - Fehlerzähler des internen Stromzählers
4 - Fehlerzähler des API-Stromzählers. Im Moment leer.
5 - Fehlerzähler des SunSpec-Stromzählers. Im Moment leer.

null: Kein Stromzähler konfiguriert.

Name	Bedeutung
`meter` int	Kommunikationsfehler zwischen RS485 Bricklet und Stromzähler.
`bricklet` int	Kommunikationsfehler zwischen ESP Brick und RS485 Bricklet.
`bricklet_reset` int	Unerwartete Resets des RS485 Bricklets.

Name	Bedeutung
`local_timeout` int	Local Timeout
`global_timeout` int	Global Timeout
`illegal_function` int	Illegal Function
`illegal_data_access` int	Illegal Data Access
`illegal_data_value` int	Illegal Data Value
`slave_device_failure` int	Slave Device Failure

Name	Bedeutung
`local_timeout` int	Local Timeout
`global_timeout` int	Global Timeout
`illegal_function` int	Illegal Function
`illegal_data_access` int	Illegal Data Access
`illegal_data_value` int	Illegal Data Value
`slave_device_failure` int	Slave Device Failure

`meters/X/reset`

http
mqtt

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp2-AbCd

Schreiben

curl http://$HOST/meters/1/reset -d 'null'

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp2/AbCd

Schreiben

mosquitto_pub -h $BROKER -t $PREFIX/meters/1/reset -m 'null'

`meters/X/last_reset`

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp2-AbCd

Lesen

curl http://$HOST/meters/1/last_reset

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp2/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/meters/1/last_reset

{ "last_reset": 1714728252 }

Zuletzt zurückgesetzt 2024-05-03T11:24:12+02:00

Name	Bedeutung
`last_reset` int (s)	Unix-Timestamp des Zeitpunkts des letzten Zähler-Resets.

`meters/history`

HTTP (curl)
MQTT (mosquitto)

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp2-AbCd

curl http://$HOST/meters/history

{
  "offset": 9378,
  "samples": [
    [
      null, null, null, null, null, null, null, null,
      // 600 weitere null-Werte entfernt
         0,    0,    0,    0,    0,    0,    0,    0,
         0,    0,    0,    0,    0,    0,    0,    0,
         0,    0,    0,    0,    0,    0,    0,    0,
         0,    0,    0,    0, 1736, 6656, 6655, 6666,
      6680, 6716, 6714, 6625, 6640, 6641, 6595, 6612,
      6592, 6593, 6589, 6592, 6600, 6625, 6626, 6637,
      6665, 6636, 6632, 6656, 6616, 6611, 6646, 6670,
      6691, 6715, 6787, 6754, 6761, 6797, 6771, 6685,
      6705, 6778, 6703, 6675, 6681, 6721, 6739, 6816,
      6872, 6858, 6821, 6836, 6784, 6871, 6943, 6930,
      6968, 6955, 6837, 6800, 6846, 6919, 6881, 6736,
      6671, 6655, 6674, 6743, 6878, 5733, 4462, 3712,
      3098, 2693, 2337, 2098, 1683, 1575, 1575,   84,
         0,    0,    0,    0,    0,    0,    0,    0
    ],
    null,
    null,
    null,
    null,
    null,
    null
  ]
}

Name Bedeutung

offset
int (ms)

Das Alter des zuletzt gemessenen Wertes.

samples
int[..][2]

Die gemessenen Werte aller Stromzähler.

[0..1] - Die gemessenen Werte des jeweiligen Stromzählers. Null falls ein Zähler nicht konfiguriert ist.

`meters/live`

HTTP (curl)
MQTT (mosquitto)

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp2-AbCd

curl http://$HOST/meters/live

{
  "offset": 370,
  "samples_per_second": 1.99565,
  "samples": [
    [
        2626, 2626, 2626, 2626, 2626, 2626, 2626, 2673,
        2673, 2673, 2673, 2673, 2673, 2673, 2673, 2677,
        2677, 2677, 2677, 2677, 2677, 2677, 2677, 2677,
        2677, 2677, 2677, 2677, 2677, 2677, 2677,  988,
         988,  988,  988,  988,  988,  988,  988,    3,
           3,    3,    3,    3,    3,    3,    3,    1,
           1,    1,    1,    1,    1,    1,    1,    3,
           3,    3,    3,    3,    3,    3,    3,    3,
           3,    3,    3,    3,    3,    3,    3,    3,
           3,    3,    3,    3,    3,    3,    3,    4
    ],
    null
  ]
}

Name Bedeutung

offset
int (ms)

Das Alter des zuletzt gemessenen Wertes.

samples_per_second
float (Hz)

Die Anzahl der gemessenen Werte pro Sekunde.

samples
int[..][2]

Die gemessenen Werte aller Stromzähler.

[0..1] - Die gemessenen Werte. Abhängig von der Länge des Arrays und dem samples_per_second-Wert kann ermittelt werden, wie weit in die Vergangenheit die Messwerte reichen.

`meters/X/values`

Die Messwerte des X. Stromzählers. Die Bedeutung der Messwerte kann aus meters/X/value_ids ermittelt werden.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp3-AbCd

Lesen

curl http://$HOST/meters/1/values

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp3/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/meters/1/values

[
  // Index 0
  217.6941223, 0, 0,
  30.72553635, 0, 0,
  6680.515625, 0, 0,
  6681.138672, 0, 0,
  // Index 12
  -90.09844208, 0, 0,
  1, 0, 0,
  72.56191254, 10.24184513, 30.72553635,
  6683.693359, 6680.666016, -90.09844208,
  // Index 24
  1, 50, 4644.044922,
  3.992000103, 0, 0,
  0, 0, 30.70857239,
  4648.038086, 197.5639954, 4648.038086,
  // Index 36
  4644.044922, 3.992000103
]

`meters/X/update`

Aktualisiert die Messwerte des X. Stromzählers. Kann nur bei einem API-Stromzähler (Union-Tag 4 in der entsprechenden meters/X/config) verwendet werden.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp3-AbCd

Schreiben

curl http://$HOST/meters/1/update -d '[
    15.9, 16, 16.1,
    3657, 3680, 3703
]'

Beispiel für einen Zähler, der pro Phase Strom (Bezug + Einspeisung) und Wirkleistung (Bezug - Einspeisung) misst. Die korrekte Konfiguration (meters/X/config) für diesen Zähler wäre

[4, { "display_name": "API-Zähler", "value_ids": [13, 17, 21, 39, 48, 57] }]

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp3/AbCd

Schreiben

mosquitto_pub -h $BROKER -t $PREFIX/meters/1/update -m '[
    15.9, 16, 16.1,
    3657, 3680, 3703
]'

Beispiel für einen Zähler, der pro Phase Strom (Bezug + Einspeisung) und Wirkleistung (Bezug - Einspeisung) misst. Die korrekte Konfiguration (meters/X/config) für diesen Zähler wäre

[4, { "display_name": "API-Zähler", "value_ids": [13, 17, 21, 39, 48, 57] }]

`meters/X/value_ids`

Die MeterValueIDs des X. Stromzählers. Der n-te Eintrag in diesem Array gibt die Bedeutung des n-ten Messwerts aus meters/X/values an. Liste aller MeterValueIDs

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp3-AbCd

Lesen

curl http://$HOST/meters/1/value_ids

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp3/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/meters/1/value_ids

[
  // Index 0
  1, 2, 3,       // Spannung L1-N, L2-N, L3-N
  13, 17, 21,    // Strom (Bezug + Einspeisung) L1-N, L2-N, L3-N
  39, 48, 57,    // Wirkleistung (Bezug - Einspeisung) L1-N, L2-N, L3-N
  122, 130, 138, // Scheinleistung (Bezug + Einspeisung) L1-N, L2-N, L3-N
  // Index 12
  83, 91, 99,    // Blindleistung (induktiv - kapazitiv)  L1-N, L2-N, L3-N
  353, 354, 355, // Leistungsfaktor (gerichtet; Vorzeichen gibt Richtung des Stromflusses an) L1, L2, L3
  7,             // Durchschnittliche Phasenspannung
  29,            // Durchschnitt der (Bezug + Einspeisung)-Phasenströme
  33,            // Summe der (Bezug + Einspeisung)-Phasenstöme
  74,            // Summe der (Bezug - Einspeisung)-Phasenwirkleistungen
  154,           // Summe der (Bezug + Einspeisung)-Phasenscheinleistungen
  115,           // Summe der (induktiv - kapazitiv)-Phasenblindleistungen
  // Index 24
  356,           // Summe der gerichteten Leistungsfaktoren
  364,           // Netzfrequenz
  209, 211,      // Wirkenergie (Σ L1, L2, L3, seit Herstellung) Bezug, Einspeisung
  4, 5, 6, 8,    // Spannung L1-L2; L2-L3; L3-L1; ⌀ L1-L2, L2-L3, L3-L1
  25,            // Neutralleiterstrom
  213,           // Wirkenergie (Σ L1, L2, L3, seit Herstellung) Bezug + Einspeisung
  277,           // Blindenergie (Σ L1, L2, L3, seit Herstellung) induktiv + kapazitiv
  214,           // Wirkenergie (Σ L1, L2, L3, seit letztem Zurücksetzen) Bezug + Einspeisung
  // Index 36
  210,           // Wirkenergie (Σ L1, L2, L3, seit letztem Zurücksetzen) Bezug
  212            // Wirkenergie (Σ L1, L2, L3, seit letztem Zurücksetzen) Einspeisung
]

`meters/X/history`

HTTP (curl)
MQTT (mosquitto)

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp3-AbCd

curl http://$HOST/meters/1/history

{
  "offset": 60927,
  "samples": [
      null, null, null, null, null, null, null, null,
      // 600 weitere null-Werte entfernt
         0,    0,    0,    0,    0,    0,    0,    0,
         0,    0,    0,    0,    0,    0,    0,    0,
         0,    0,    0,    0,    0,    0,    0,    0,
         0,    0,    0,    0, 1736, 6656, 6655, 6666,
      6680, 6716, 6714, 6625, 6640, 6641, 6595, 6612,
      6592, 6593, 6589, 6592, 6600, 6625, 6626, 6637,
      6665, 6636, 6632, 6656, 6616, 6611, 6646, 6670,
      6691, 6715, 6787, 6754, 6761, 6797, 6771, 6685,
      6705, 6778, 6703, 6675, 6681, 6721, 6739, 6816,
      6872, 6858, 6821, 6836, 6784, 6871, 6943, 6930,
      6968, 6955, 6837, 6800, 6846, 6919, 6881, 6736,
      6671, 6655, 6674, 6743, 6878, 5733, 4462, 3712,
      3098, 2693, 2337, 2098, 1683, 1575, 1575,   84,
         0,    0,    0,    0,    0,    0,    0,    0
  ]
}

Name	Bedeutung
`offset` int (ms)	Das Alter des zuletzt gemessenen Wertes.
`samples` int[..]	Die gemessenen Werte.

`meters/X/live`

HTTP (curl)
MQTT (mosquitto)

Die letzten Ladeleistungs-Messwerte des X. Stromzählers. Auf Basis dieser Werte werden die Durchschnittswerte für meters/X/history generiert.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp3-AbCd

curl http://$HOST/meters/1/live

{
  "offset": 370,
  "samples_per_second": 1.99565,
  "samples": [
    2626, 2626, 2626, 2626, 2626, 2626, 2626, 2673,
    2673, 2673, 2673, 2673, 2673, 2673, 2673, 2677,
    2677, 2677, 2677, 2677, 2677, 2677, 2677, 2677,
    2677, 2677, 2677, 2677, 2677, 2677, 2677,  988,
     988,  988,  988,  988,  988,  988,  988,    3,
       3,    3,    3,    3,    3,    3,    3,    1,
       1,    1,    1,    1,    1,    1,    1,    3,
       3,    3,    3,    3,    3,    3,    3,    3,
       3,    3,    3,    3,    3,    3,    3,    3,
       3,    3,    3,    3,    3,    3,    3,    4
   ]
}

Es liegen 80 Werte vor, ~ 2 Werte pro Sekunde wurden erhoben, das Offset des letzten Werts sind 370 ms -> Die Messwerte reichen im Moment 40,370 Sekunden in die Vergangenheit.

Name	Bedeutung
`offset` int (ms)	Das Alter des zuletzt gemessenen Wertes.
`samples_per_second` float (Hz)	Die Anzahl der gemessenen Werte pro Sekunde.
`samples` int[..]	Die gemessenen Werte. Abhängig von der Länge des Arrays und dem samples_per_second-Wert kann ermittelt werden, wie weit in die Vergangenheit die Messwerte reichen.

`meters/X/config`

Die Konfiguration des X. Stromzählers. Das Union-Tag gibt die Zählerklasse an.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp3-AbCd

Lesen

curl http://$HOST/meters/1/config

[4, { "display_name": "API-Zähler", "value_ids": [13, 17, 21, 39, 48, 57] }]

Schreiben

curl http://$HOST/meters/1/config -d '[4, { "display_name": "API-Zähler", "value_ids": [13, 17, 21, 39, 48, 57] }]'

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp3/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/meters/1/config

[4, { "display_name": "API-Zähler", "value_ids": [13, 17, 21, 39, 48, 57] }]

Schreiben

Mit MQTT auf $PREFIX/meters/1/config_update

mosquitto_pub -h $BROKER -t $PREFIX/meters/1/config_update -m '[4, { "display_name": "API-Zähler", "value_ids": [13, 17, 21, 39, 48, 57] }]'

0 - Kein Stromzähler konfiguriert.
2 - Interner Stromzähler (an EVSE-2.0-Bricklet)
4 - API-Stromzähler
5 - SunSpec-Gerät über Modbus-TCP
6 - Modbus-TCP-Stromzähler.
7 - SMA Speedwire-Stromzähler.

null: Kein Stromzähler konfiguriert.

Name	Bedeutung
`display_name` string	Anzeigename des Stromzählers

Name	Bedeutung
`display_name` string	Anzeigename des Stromzählers
`value_ids` int[..]	MeterValueIDs, die über die API meters/X/update gesetzt werden können sollen. Liste aller MeterValueIDs

Name	Bedeutung
`display_name` string	Anzeigename des Geräts
`host` string	Hostname oder IP-Adresse des SunSpec-Geräts
`port` int	Port des SunSpec-Geräts. Typischerweise 502
`device_address` int	Modbus-Device-Adresse des Sunspec-Geräts
`manufacturer_name` string	Name des Herstellers des SunSpec-Geräts. Die Kombination aus `manufacturer_name`, `model_name` und `serial_number` sollte ein Gerät weltweit eindeutig identifizieren.
`model_name` string	Name des Modells des SunSpec-Geräts.
`serial_number` string	Seriennummer des SunSpec-Geräts.
`model_id` int	SunSpec-Model-ID
`model_instance` int	Gibt an wie viele SunSpec-Modelle mit gleicher `model_id` übersprungen werden, bis das gewünsche Modell gleicher ID erreicht ist.

Name Bedeutung

display_name
string

Anzeigename des Stromzählers

host
string

Hostname oder IP-Adresse des SunSpec-Geräts

port
int

Port des SunSpec-Geräts. Typischerweise 502

table
Union

Registertabelle, die gelesen werden soll.

0 - Keine Registertabelle konfiguriert.
1 - Benutzerdefinierte Registertabelle
2 - Sungrow Hybrid-Wechselrichter (SH...)
3 - Sungrow String-Wechselrichter (SG...)
4 - Solarmax Max.Storage
5 - Victron Energy GX
6 - Deye Hybrid-Wechselrichter
7 - AlphaESS Hybrid-Wechselrichter
8 - Shelly Pro EM
9 - Shelly Pro 3EM
10 - GoodWe Hybrid-Wechselrichter

null: Keine Registertabelle konfiguriert.

Name Bedeutung

device_address
int

Geräteadresse.

register_address_mode
int

Gibt an, ob die konfigurierten Registerstartadressen im Webinterface als Adressen oder Registernummern angezeigt werden.

0 - Startadressen werden als Registeraddressen angezeigt. Die erste Adresse ist 0.
1 - Startadressen werden als Registernummern angezeigt. Die erste Registernummer ist 1.

registers
object[36]

Registertabelle

[0..35] - Ein Register, dass gelesen werden soll

Name	Bedeutung
`rtype` int	Registertyp 0 - Holding Register 1 - Input Register
`addr` int	Startadresse des Registers.
`vtype` int	Wert-Typ 1 - Ein Register, 16-Bit, Ganzzahl, vorzeichenlos 9 - Ein Register, 16-Bit, Ganzzahl, vorzeichenbehaftet 2 - Zwei Register, 32-Bit, Ganzzahl, vorzeichenlos, Big-Endian 34 - Zwei Register, 32-Bit, Ganzzahl, vorzeichenlos, Little-Endian 10 - Zwei Register, 32-Bit, Ganzzahl, vorzeichenbehaftet, Big-Endian 42 - Zwei Register, 32-Bit, Ganzzahl, vorzeichenbehaftet, Little-Endian 26 - Zwei Register, 32-Bit, Gleitkommazahl, Big-Endian 58 - Zwei Register, 32-Bit, Gleitkommazahl, Little-Endian 4 - Vier Register, 64-Bit, Ganzzahl, vorzeichenlos, Big-Endian 36 - Vier Register, 64-Bit, Ganzzahl, vorzeichenlos, Little-Endian 12 - Vier Register, 64-Bit, Ganzzahl, vorzeichenbehaftet, Big-Endian 44 - Vier Register, 64-Bit, Ganzzahl, vorzeichenbehaftet, Little-Endian 28 - Vier Register, 64-Bit, Gleitkommazahl, Big-Endian 60 - Vier Register, 64-Bit, Gleitkommazahl, Little-Endian
`off` float	Offset, dass auf den gelesenen Wert addiert werden soll. Der Offset-Wert wird addiert, bevor der Skalierungsfaktor angewandt wird.
`scale` float	Skalierungsfaktor, mit dem der gelesene Wert multipliziert werden soll. Der Skalierungsfaktor wirkt auf den Wert, der durch die Addition des gelesenen Wertes mit dem Offset entstanden ist.
`id` int	MeterValueID, die die Interpretation des gelesenen Werts angibt. Liste aller MeterValueIDs

Name Bedeutung

virtual_meter
int

Virtueller Zähler. Gibt an welcher Teil der Registertabelle gelesen wird.

0 - Kein virtueller Zähler ausgewählt
1 - Wechselrichter
2 - Netzanschluss
3 - Speicher
4 - Last

device_address
int

Geräteadresse. Typischerweise 1.

Name Bedeutung

virtual_meter
int

Virtueller Zähler. Gibt an welcher Teil der Registertabelle gelesen wird.

0 - Kein virtueller Zähler ausgewählt
1 - Wechselrichter
2 - Netzanschluss
3 - Last

device_address
int

Geräteadresse. Typischerweise 1.

Name Bedeutung

virtual_meter
int

Virtueller Zähler. Gibt an welcher Teil der Registertabelle gelesen wird.

0 - Kein virtueller Zähler ausgewählt
1 - Wechselrichter
2 - Netzanschluss
3 - Speicher

device_address
int

Geräteadresse. Typischerweise 1.

Name Bedeutung

virtual_meter
int

Virtueller Zähler. Gibt an welcher Teil der Registertabelle gelesen wird.

0 - Kein virtueller Zähler ausgewählt
1 - Wechselrichter
2 - Netzanschluss
3 - Speicher
4 - Last

device_address
int

Geräteadresse. Typischerweise 100.

Name Bedeutung

virtual_meter
int

Virtueller Zähler. Gibt an welcher Teil der Registertabelle gelesen wird.

0 - Kein virtueller Zähler ausgewählt
1 - Wechselrichter
2 - Netzanschluss
3 - Speicher
4 - Last

device_address
int

Geräteadresse. Typischerweise 1.

Name Bedeutung

virtual_meter
int

Virtueller Zähler. Gibt an welcher Teil der Registertabelle gelesen wird.

0 - Kein virtueller Zähler ausgewählt
1 - Wechselrichter
2 - Netzanschluss
3 - Speicher

device_address
int

Geräteadresse. Typischerweise 1.

Name Bedeutung

device_address
int

Geräteadresse. Typischerweise 1.

monophase_channel
int

Kanal, der gelesen werden soll.

0 - Kein Kanal ausgewählt
1 - Kanal 1
2 - Kanal 2

monophase_mapping
int

Phase der die Messwerte zugeordnet werden.

0 - Keine Phase ausgewählt
1 - L1
2 - L2
3 - L3

Name	Bedeutung
`device_address` int	Geräteadresse. Typischerweise 1.
`device_profile` int	Gibt an, ob eine oder alle drei Phasen gelesen werden sollen. 0 - Dreiphasig. `monophase_channel` und `monophase_mapping` werden ignoriert. 1 - Einphasig
`monophase_channel` int	Kanal, der gelesen werden soll. 0 - Kein Kanal ausgewählt 1 - Kanal 1 2 - Kanal 2 3 - Kanal 3
`monophase_mapping` int	Phase der die Messwerte zugeordnet werden. 0 - Keine Phase ausgewählt 1 - L1 2 - L2 3 - L3

Name Bedeutung

virtual_meter
int

Virtueller Zähler. Gibt an welcher Teil der Registertabelle gelesen wird.

0 - Kein virtueller Zähler ausgewählt
1 - Wechselrichter
2 - Netzanschluss
3 - Speicher
4 - Last
5 - Backup-Last
6 - Zähler

device_address
int

Geräteadresse. Typischerweise 247.

Name	Bedeutung
`display_name` string	Anzeigename des Stromzählers

`meters/X/state`

Der Zustand des X. Stromzählers. Der Inhalt dieser API hängt vom Typ des Stromzählers ab, der in meters/X/config konfiguriert wurde.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp3-AbCd

Lesen

curl http://$HOST/meters/1/state

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp3/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/meters/1/state

null

0 - Kein Stromzähler konfiguriert.
1 - Zustand des internen Stromzählers
2 - Zustand des internen Stromzählers
3 - Zustand des internen Stromzählers
4 - Zustand des API-Stromzählers. Im Moment leer.
5 - Zustand des SunSpec-Stromzählers. Im Moment leer.

null: Kein Stromzähler konfiguriert.

Name Bedeutung

type
int

Typ des verbauten Stromzählers. Nicht jeder Stromzähler wird von jedem Gerät unterstützt!

0 - Kein Stromzähler verfügbar
1 - SDM72
2 - SDM630
3 - SDM72V2

Name Bedeutung

type
int

Typ des verbauten Stromzählers. Nicht jeder Stromzähler wird von jedem Gerät unterstützt!

0 - Kein Stromzähler verfügbar
2 - SDM630
3 - SDM72V2
4 - SDM72CTM
5 - SDM630MCT
6 - DSZ15DZMOD
7 - DEM4A

Name Bedeutung

type
int

Typ des verbauten Stromzählers. Nicht jeder Stromzähler wird von jedem Gerät unterstützt!

0 - Kein Stromzähler verfügbar
2 - SDM630
3 - SDM72V2
4 - SDM72CTM
5 - SDM630MCT
6 - DSZ15DZMOD
7 - DEM4A

`meters/X/errors`

Fehlerzähler der Kommunikation mit dem Stromzähler. Der Inhalt dieser API hängt vom Typ des Stromzählers ab, der in meters/X/config konfiguriert wurde.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp3-AbCd

Lesen

curl http://$HOST/meters/1/errors

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp3/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/meters/1/errors

null

0 - Kein Stromzähler konfiguriert.
1 - Fehlerzähler des internen Stromzählers
2 - Fehlerzähler des internen Stromzählers
3 - Fehlerzähler des internen Stromzählers
4 - Fehlerzähler des API-Stromzählers. Im Moment leer.
5 - Fehlerzähler des SunSpec-Stromzählers. Im Moment leer.

null: Kein Stromzähler konfiguriert.

Name	Bedeutung
`meter` int	Kommunikationsfehler zwischen RS485 Bricklet und Stromzähler.
`bricklet` int	Kommunikationsfehler zwischen ESP Brick und RS485 Bricklet.
`bricklet_reset` int	Unerwartete Resets des RS485 Bricklets.

Name	Bedeutung
`local_timeout` int	Local Timeout
`global_timeout` int	Global Timeout
`illegal_function` int	Illegal Function
`illegal_data_access` int	Illegal Data Access
`illegal_data_value` int	Illegal Data Value
`slave_device_failure` int	Slave Device Failure

Name	Bedeutung
`local_timeout` int	Local Timeout
`global_timeout` int	Global Timeout
`illegal_function` int	Illegal Function
`illegal_data_access` int	Illegal Data Access
`illegal_data_value` int	Illegal Data Value
`slave_device_failure` int	Slave Device Failure

`meters/X/reset`

http
mqtt

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp3-AbCd

Schreiben

curl http://$HOST/meters/1/reset -d 'null'

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp3/AbCd

Schreiben

mosquitto_pub -h $BROKER -t $PREFIX/meters/1/reset -m 'null'

`meters/X/last_reset`

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp3-AbCd

Lesen

curl http://$HOST/meters/1/last_reset

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp3/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/meters/1/last_reset

{ "last_reset": 1714728252 }

Zuletzt zurückgesetzt 2024-05-03T11:24:12+02:00

Name	Bedeutung
`last_reset` int (s)	Unix-Timestamp des Zeitpunkts des letzten Zähler-Resets.

`meters/history`

HTTP (curl)
MQTT (mosquitto)

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp3-AbCd

curl http://$HOST/meters/history

{
  "offset": 9378,
  "samples": [
    [
      null, null, null, null, null, null, null, null,
      // 600 weitere null-Werte entfernt
         0,    0,    0,    0,    0,    0,    0,    0,
         0,    0,    0,    0,    0,    0,    0,    0,
         0,    0,    0,    0,    0,    0,    0,    0,
         0,    0,    0,    0, 1736, 6656, 6655, 6666,
      6680, 6716, 6714, 6625, 6640, 6641, 6595, 6612,
      6592, 6593, 6589, 6592, 6600, 6625, 6626, 6637,
      6665, 6636, 6632, 6656, 6616, 6611, 6646, 6670,
      6691, 6715, 6787, 6754, 6761, 6797, 6771, 6685,
      6705, 6778, 6703, 6675, 6681, 6721, 6739, 6816,
      6872, 6858, 6821, 6836, 6784, 6871, 6943, 6930,
      6968, 6955, 6837, 6800, 6846, 6919, 6881, 6736,
      6671, 6655, 6674, 6743, 6878, 5733, 4462, 3712,
      3098, 2693, 2337, 2098, 1683, 1575, 1575,   84,
         0,    0,    0,    0,    0,    0,    0,    0
    ],
    null,
    null,
    null,
    null,
    null,
    null
  ]
}

Name Bedeutung

offset
int (ms)

Das Alter des zuletzt gemessenen Wertes.

samples
int[..][2]

Die gemessenen Werte aller Stromzähler.

[0..1] - Die gemessenen Werte des jeweiligen Stromzählers. Null falls ein Zähler nicht konfiguriert ist.

`meters/live`

HTTP (curl)
MQTT (mosquitto)

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp3-AbCd

curl http://$HOST/meters/live

{
  "offset": 370,
  "samples_per_second": 1.99565,
  "samples": [
    [
        2626, 2626, 2626, 2626, 2626, 2626, 2626, 2673,
        2673, 2673, 2673, 2673, 2673, 2673, 2673, 2677,
        2677, 2677, 2677, 2677, 2677, 2677, 2677, 2677,
        2677, 2677, 2677, 2677, 2677, 2677, 2677,  988,
         988,  988,  988,  988,  988,  988,  988,    3,
           3,    3,    3,    3,    3,    3,    3,    1,
           1,    1,    1,    1,    1,    1,    1,    3,
           3,    3,    3,    3,    3,    3,    3,    3,
           3,    3,    3,    3,    3,    3,    3,    3,
           3,    3,    3,    3,    3,    3,    3,    4
    ],
    null
  ]
}

Name Bedeutung

offset
int (ms)

Das Alter des zuletzt gemessenen Wertes.

samples_per_second
float (Hz)

Die Anzahl der gemessenen Werte pro Sekunde.

samples
int[..][2]

Die gemessenen Werte aller Stromzähler.

[0..1] - Die gemessenen Werte. Abhängig von der Länge des Arrays und dem samples_per_second-Wert kann ermittelt werden, wie weit in die Vergangenheit die Messwerte reichen.

`meters/X/values`

Die Messwerte des X. Stromzählers. Die Bedeutung der Messwerte kann aus meters/X/value_ids ermittelt werden.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. wem-AbCd

Lesen

curl http://$HOST/meters/1/values

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. wem/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/meters/1/values

[
  // Index 0
  217.6941223, 0, 0,
  30.72553635, 0, 0,
  6680.515625, 0, 0,
  6681.138672, 0, 0,
  // Index 12
  -90.09844208, 0, 0,
  1, 0, 0,
  72.56191254, 10.24184513, 30.72553635,
  6683.693359, 6680.666016, -90.09844208,
  // Index 24
  1, 50, 4644.044922,
  3.992000103, 0, 0,
  0, 0, 30.70857239,
  4648.038086, 197.5639954, 4648.038086,
  // Index 36
  4644.044922, 3.992000103
]

`meters/X/update`

Aktualisiert die Messwerte des X. Stromzählers. Kann nur bei einem API-Stromzähler (Union-Tag 4 in der entsprechenden meters/X/config) verwendet werden.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. wem-AbCd

Schreiben

curl http://$HOST/meters/1/update -d '[
    15.9, 16, 16.1,
    3657, 3680, 3703
]'

Beispiel für einen Zähler, der pro Phase Strom (Bezug + Einspeisung) und Wirkleistung (Bezug - Einspeisung) misst. Die korrekte Konfiguration (meters/X/config) für diesen Zähler wäre

[4, { "display_name": "API-Zähler", "value_ids": [13, 17, 21, 39, 48, 57] }]

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. wem/AbCd

Schreiben

mosquitto_pub -h $BROKER -t $PREFIX/meters/1/update -m '[
    15.9, 16, 16.1,
    3657, 3680, 3703
]'

Beispiel für einen Zähler, der pro Phase Strom (Bezug + Einspeisung) und Wirkleistung (Bezug - Einspeisung) misst. Die korrekte Konfiguration (meters/X/config) für diesen Zähler wäre

[4, { "display_name": "API-Zähler", "value_ids": [13, 17, 21, 39, 48, 57] }]

`meters/X/value_ids`

Die MeterValueIDs des X. Stromzählers. Der n-te Eintrag in diesem Array gibt die Bedeutung des n-ten Messwerts aus meters/X/values an. Liste aller MeterValueIDs

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. wem-AbCd

Lesen

curl http://$HOST/meters/1/value_ids

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. wem/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/meters/1/value_ids

[
  // Index 0
  1, 2, 3,       // Spannung L1-N, L2-N, L3-N
  13, 17, 21,    // Strom (Bezug + Einspeisung) L1-N, L2-N, L3-N
  39, 48, 57,    // Wirkleistung (Bezug - Einspeisung) L1-N, L2-N, L3-N
  122, 130, 138, // Scheinleistung (Bezug + Einspeisung) L1-N, L2-N, L3-N
  // Index 12
  83, 91, 99,    // Blindleistung (induktiv - kapazitiv)  L1-N, L2-N, L3-N
  353, 354, 355, // Leistungsfaktor (gerichtet; Vorzeichen gibt Richtung des Stromflusses an) L1, L2, L3
  7,             // Durchschnittliche Phasenspannung
  29,            // Durchschnitt der (Bezug + Einspeisung)-Phasenströme
  33,            // Summe der (Bezug + Einspeisung)-Phasenstöme
  74,            // Summe der (Bezug - Einspeisung)-Phasenwirkleistungen
  154,           // Summe der (Bezug + Einspeisung)-Phasenscheinleistungen
  115,           // Summe der (induktiv - kapazitiv)-Phasenblindleistungen
  // Index 24
  356,           // Summe der gerichteten Leistungsfaktoren
  364,           // Netzfrequenz
  209, 211,      // Wirkenergie (Σ L1, L2, L3, seit Herstellung) Bezug, Einspeisung
  4, 5, 6, 8,    // Spannung L1-L2; L2-L3; L3-L1; ⌀ L1-L2, L2-L3, L3-L1
  25,            // Neutralleiterstrom
  213,           // Wirkenergie (Σ L1, L2, L3, seit Herstellung) Bezug + Einspeisung
  277,           // Blindenergie (Σ L1, L2, L3, seit Herstellung) induktiv + kapazitiv
  214,           // Wirkenergie (Σ L1, L2, L3, seit letztem Zurücksetzen) Bezug + Einspeisung
  // Index 36
  210,           // Wirkenergie (Σ L1, L2, L3, seit letztem Zurücksetzen) Bezug
  212            // Wirkenergie (Σ L1, L2, L3, seit letztem Zurücksetzen) Einspeisung
]

`meters/X/history`

HTTP (curl)
MQTT (mosquitto)

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. wem-AbCd

curl http://$HOST/meters/1/history

{
  "offset": 60927,
  "samples": [
      null, null, null, null, null, null, null, null,
      // 600 weitere null-Werte entfernt
         0,    0,    0,    0,    0,    0,    0,    0,
         0,    0,    0,    0,    0,    0,    0,    0,
         0,    0,    0,    0,    0,    0,    0,    0,
         0,    0,    0,    0, 1736, 6656, 6655, 6666,
      6680, 6716, 6714, 6625, 6640, 6641, 6595, 6612,
      6592, 6593, 6589, 6592, 6600, 6625, 6626, 6637,
      6665, 6636, 6632, 6656, 6616, 6611, 6646, 6670,
      6691, 6715, 6787, 6754, 6761, 6797, 6771, 6685,
      6705, 6778, 6703, 6675, 6681, 6721, 6739, 6816,
      6872, 6858, 6821, 6836, 6784, 6871, 6943, 6930,
      6968, 6955, 6837, 6800, 6846, 6919, 6881, 6736,
      6671, 6655, 6674, 6743, 6878, 5733, 4462, 3712,
      3098, 2693, 2337, 2098, 1683, 1575, 1575,   84,
         0,    0,    0,    0,    0,    0,    0,    0
  ]
}

Name	Bedeutung
`offset` int (ms)	Das Alter des zuletzt gemessenen Wertes.
`samples` int[..]	Die gemessenen Werte.

`meters/X/live`

HTTP (curl)
MQTT (mosquitto)

Die letzten Ladeleistungs-Messwerte des X. Stromzählers. Auf Basis dieser Werte werden die Durchschnittswerte für meters/X/history generiert.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. wem-AbCd

curl http://$HOST/meters/1/live

{
  "offset": 370,
  "samples_per_second": 1.99565,
  "samples": [
    2626, 2626, 2626, 2626, 2626, 2626, 2626, 2673,
    2673, 2673, 2673, 2673, 2673, 2673, 2673, 2677,
    2677, 2677, 2677, 2677, 2677, 2677, 2677, 2677,
    2677, 2677, 2677, 2677, 2677, 2677, 2677,  988,
     988,  988,  988,  988,  988,  988,  988,    3,
       3,    3,    3,    3,    3,    3,    3,    1,
       1,    1,    1,    1,    1,    1,    1,    3,
       3,    3,    3,    3,    3,    3,    3,    3,
       3,    3,    3,    3,    3,    3,    3,    3,
       3,    3,    3,    3,    3,    3,    3,    4
   ]
}

Es liegen 80 Werte vor, ~ 2 Werte pro Sekunde wurden erhoben, das Offset des letzten Werts sind 370 ms -> Die Messwerte reichen im Moment 40,370 Sekunden in die Vergangenheit.

Name	Bedeutung
`offset` int (ms)	Das Alter des zuletzt gemessenen Wertes.
`samples_per_second` float (Hz)	Die Anzahl der gemessenen Werte pro Sekunde.
`samples` int[..]	Die gemessenen Werte. Abhängig von der Länge des Arrays und dem samples_per_second-Wert kann ermittelt werden, wie weit in die Vergangenheit die Messwerte reichen.

`meters/X/config`

Die Konfiguration des X. Stromzählers. Das Union-Tag gibt die Zählerklasse an.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. wem-AbCd

Lesen

curl http://$HOST/meters/1/config

[4, { "display_name": "API-Zähler", "value_ids": [13, 17, 21, 39, 48, 57] }]

Schreiben

curl http://$HOST/meters/1/config -d '[4, { "display_name": "API-Zähler", "value_ids": [13, 17, 21, 39, 48, 57] }]'

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. wem/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/meters/1/config

[4, { "display_name": "API-Zähler", "value_ids": [13, 17, 21, 39, 48, 57] }]

Schreiben

Mit MQTT auf $PREFIX/meters/1/config_update

mosquitto_pub -h $BROKER -t $PREFIX/meters/1/config_update -m '[4, { "display_name": "API-Zähler", "value_ids": [13, 17, 21, 39, 48, 57] }]'

0 - Kein Stromzähler konfiguriert.
3 - Stromzähler angeschlossen am WARP Energy Manager
4 - API-Stromzähler
5 - SunSpec-Gerät über Modbus-TCP
6 - Modbus-TCP-Stromzähler.
7 - SMA Speedwire-Stromzähler.

null: Kein Stromzähler konfiguriert.

Name	Bedeutung
`display_name` string	Anzeigename des Stromzählers

Name	Bedeutung
`display_name` string	Anzeigename des Stromzählers
`value_ids` int[..]	MeterValueIDs, die über die API meters/X/update gesetzt werden können sollen. Liste aller MeterValueIDs

Name	Bedeutung
`display_name` string	Anzeigename des Geräts
`host` string	Hostname oder IP-Adresse des SunSpec-Geräts
`port` int	Port des SunSpec-Geräts. Typischerweise 502
`device_address` int	Modbus-Device-Adresse des Sunspec-Geräts
`manufacturer_name` string	Name des Herstellers des SunSpec-Geräts. Die Kombination aus `manufacturer_name`, `model_name` und `serial_number` sollte ein Gerät weltweit eindeutig identifizieren.
`model_name` string	Name des Modells des SunSpec-Geräts.
`serial_number` string	Seriennummer des SunSpec-Geräts.
`model_id` int	SunSpec-Model-ID
`model_instance` int	Gibt an wie viele SunSpec-Modelle mit gleicher `model_id` übersprungen werden, bis das gewünsche Modell gleicher ID erreicht ist.

Name Bedeutung

display_name
string

Anzeigename des Stromzählers

host
string

Hostname oder IP-Adresse des SunSpec-Geräts

port
int

Port des SunSpec-Geräts. Typischerweise 502

table
Union

Registertabelle, die gelesen werden soll.

0 - Keine Registertabelle konfiguriert.
1 - Benutzerdefinierte Registertabelle
2 - Sungrow Hybrid-Wechselrichter (SH...)
3 - Sungrow String-Wechselrichter (SG...)
4 - Solarmax Max.Storage
5 - Victron Energy GX
6 - Deye Hybrid-Wechselrichter
7 - AlphaESS Hybrid-Wechselrichter
8 - Shelly Pro EM
9 - Shelly Pro 3EM
10 - GoodWe Hybrid-Wechselrichter

null: Keine Registertabelle konfiguriert.

Name Bedeutung

device_address
int

Geräteadresse.

register_address_mode
int

Gibt an, ob die konfigurierten Registerstartadressen im Webinterface als Adressen oder Registernummern angezeigt werden.

0 - Startadressen werden als Registeraddressen angezeigt. Die erste Adresse ist 0.
1 - Startadressen werden als Registernummern angezeigt. Die erste Registernummer ist 1.

registers
object[36]

Registertabelle

[0..35] - Ein Register, dass gelesen werden soll

Name	Bedeutung
`rtype` int	Registertyp 0 - Holding Register 1 - Input Register
`addr` int	Startadresse des Registers.
`vtype` int	Wert-Typ 1 - Ein Register, 16-Bit, Ganzzahl, vorzeichenlos 9 - Ein Register, 16-Bit, Ganzzahl, vorzeichenbehaftet 2 - Zwei Register, 32-Bit, Ganzzahl, vorzeichenlos, Big-Endian 34 - Zwei Register, 32-Bit, Ganzzahl, vorzeichenlos, Little-Endian 10 - Zwei Register, 32-Bit, Ganzzahl, vorzeichenbehaftet, Big-Endian 42 - Zwei Register, 32-Bit, Ganzzahl, vorzeichenbehaftet, Little-Endian 26 - Zwei Register, 32-Bit, Gleitkommazahl, Big-Endian 58 - Zwei Register, 32-Bit, Gleitkommazahl, Little-Endian 4 - Vier Register, 64-Bit, Ganzzahl, vorzeichenlos, Big-Endian 36 - Vier Register, 64-Bit, Ganzzahl, vorzeichenlos, Little-Endian 12 - Vier Register, 64-Bit, Ganzzahl, vorzeichenbehaftet, Big-Endian 44 - Vier Register, 64-Bit, Ganzzahl, vorzeichenbehaftet, Little-Endian 28 - Vier Register, 64-Bit, Gleitkommazahl, Big-Endian 60 - Vier Register, 64-Bit, Gleitkommazahl, Little-Endian
`off` float	Offset, dass auf den gelesenen Wert addiert werden soll. Der Offset-Wert wird addiert, bevor der Skalierungsfaktor angewandt wird.
`scale` float	Skalierungsfaktor, mit dem der gelesene Wert multipliziert werden soll. Der Skalierungsfaktor wirkt auf den Wert, der durch die Addition des gelesenen Wertes mit dem Offset entstanden ist.
`id` int	MeterValueID, die die Interpretation des gelesenen Werts angibt. Liste aller MeterValueIDs

Name Bedeutung

virtual_meter
int

Virtueller Zähler. Gibt an welcher Teil der Registertabelle gelesen wird.

0 - Kein virtueller Zähler ausgewählt
1 - Wechselrichter
2 - Netzanschluss
3 - Speicher
4 - Last

device_address
int

Geräteadresse. Typischerweise 1.

Name Bedeutung

virtual_meter
int

Virtueller Zähler. Gibt an welcher Teil der Registertabelle gelesen wird.

0 - Kein virtueller Zähler ausgewählt
1 - Wechselrichter
2 - Netzanschluss
3 - Last

device_address
int

Geräteadresse. Typischerweise 1.

Name Bedeutung

virtual_meter
int

Virtueller Zähler. Gibt an welcher Teil der Registertabelle gelesen wird.

0 - Kein virtueller Zähler ausgewählt
1 - Wechselrichter
2 - Netzanschluss
3 - Speicher

device_address
int

Geräteadresse. Typischerweise 1.

Name Bedeutung

virtual_meter
int

Virtueller Zähler. Gibt an welcher Teil der Registertabelle gelesen wird.

0 - Kein virtueller Zähler ausgewählt
1 - Wechselrichter
2 - Netzanschluss
3 - Speicher
4 - Last

device_address
int

Geräteadresse. Typischerweise 100.

Name Bedeutung

virtual_meter
int

Virtueller Zähler. Gibt an welcher Teil der Registertabelle gelesen wird.

0 - Kein virtueller Zähler ausgewählt
1 - Wechselrichter
2 - Netzanschluss
3 - Speicher
4 - Last

device_address
int

Geräteadresse. Typischerweise 1.

Name Bedeutung

virtual_meter
int

Virtueller Zähler. Gibt an welcher Teil der Registertabelle gelesen wird.

0 - Kein virtueller Zähler ausgewählt
1 - Wechselrichter
2 - Netzanschluss
3 - Speicher

device_address
int

Geräteadresse. Typischerweise 1.

Name Bedeutung

device_address
int

Geräteadresse. Typischerweise 1.

monophase_channel
int

Kanal, der gelesen werden soll.

0 - Kein Kanal ausgewählt
1 - Kanal 1
2 - Kanal 2

monophase_mapping
int

Phase der die Messwerte zugeordnet werden.

0 - Keine Phase ausgewählt
1 - L1
2 - L2
3 - L3

Name	Bedeutung
`device_address` int	Geräteadresse. Typischerweise 1.
`device_profile` int	Gibt an, ob eine oder alle drei Phasen gelesen werden sollen. 0 - Dreiphasig. `monophase_channel` und `monophase_mapping` werden ignoriert. 1 - Einphasig
`monophase_channel` int	Kanal, der gelesen werden soll. 0 - Kein Kanal ausgewählt 1 - Kanal 1 2 - Kanal 2 3 - Kanal 3
`monophase_mapping` int	Phase der die Messwerte zugeordnet werden. 0 - Keine Phase ausgewählt 1 - L1 2 - L2 3 - L3

Name Bedeutung

virtual_meter
int

Virtueller Zähler. Gibt an welcher Teil der Registertabelle gelesen wird.

0 - Kein virtueller Zähler ausgewählt
1 - Wechselrichter
2 - Netzanschluss
3 - Speicher
4 - Last
5 - Backup-Last
6 - Zähler

device_address
int

Geräteadresse. Typischerweise 247.

Name	Bedeutung
`display_name` string	Anzeigename des Stromzählers

`meters/X/state`

Der Zustand des X. Stromzählers. Der Inhalt dieser API hängt vom Typ des Stromzählers ab, der in meters/X/config konfiguriert wurde.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. wem-AbCd

Lesen

curl http://$HOST/meters/1/state

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. wem/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/meters/1/state

null

0 - Kein Stromzähler konfiguriert.
1 - Zustand des internen Stromzählers
2 - Zustand des internen Stromzählers
3 - Zustand des internen Stromzählers
4 - Zustand des API-Stromzählers. Im Moment leer.
5 - Zustand des SunSpec-Stromzählers. Im Moment leer.

null: Kein Stromzähler konfiguriert.

Name Bedeutung

type
int

Typ des verbauten Stromzählers. Nicht jeder Stromzähler wird von jedem Gerät unterstützt!

0 - Kein Stromzähler verfügbar
1 - SDM72
2 - SDM630
3 - SDM72V2

Name Bedeutung

type
int

Typ des verbauten Stromzählers. Nicht jeder Stromzähler wird von jedem Gerät unterstützt!

0 - Kein Stromzähler verfügbar
2 - SDM630
3 - SDM72V2
4 - SDM72CTM
5 - SDM630MCT
6 - DSZ15DZMOD
7 - DEM4A

Name Bedeutung

type
int

Typ des verbauten Stromzählers. Nicht jeder Stromzähler wird von jedem Gerät unterstützt!

0 - Kein Stromzähler verfügbar
2 - SDM630
3 - SDM72V2
4 - SDM72CTM
5 - SDM630MCT
6 - DSZ15DZMOD
7 - DEM4A

`meters/X/errors`

Fehlerzähler der Kommunikation mit dem Stromzähler. Der Inhalt dieser API hängt vom Typ des Stromzählers ab, der in meters/X/config konfiguriert wurde.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. wem-AbCd

Lesen

curl http://$HOST/meters/1/errors

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. wem/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/meters/1/errors

null

0 - Kein Stromzähler konfiguriert.
1 - Fehlerzähler des internen Stromzählers
2 - Fehlerzähler des internen Stromzählers
3 - Fehlerzähler des internen Stromzählers
4 - Fehlerzähler des API-Stromzählers. Im Moment leer.
5 - Fehlerzähler des SunSpec-Stromzählers. Im Moment leer.

null: Kein Stromzähler konfiguriert.

Name	Bedeutung
`meter` int	Kommunikationsfehler zwischen RS485 Bricklet und Stromzähler.
`bricklet` int	Kommunikationsfehler zwischen ESP Brick und RS485 Bricklet.
`bricklet_reset` int	Unerwartete Resets des RS485 Bricklets.

Name	Bedeutung
`local_timeout` int	Local Timeout
`global_timeout` int	Global Timeout
`illegal_function` int	Illegal Function
`illegal_data_access` int	Illegal Data Access
`illegal_data_value` int	Illegal Data Value
`slave_device_failure` int	Slave Device Failure

Name	Bedeutung
`local_timeout` int	Local Timeout
`global_timeout` int	Global Timeout
`illegal_function` int	Illegal Function
`illegal_data_access` int	Illegal Data Access
`illegal_data_value` int	Illegal Data Value
`slave_device_failure` int	Slave Device Failure

`meters/X/reset`

http
mqtt

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. wem-AbCd

Schreiben

curl http://$HOST/meters/1/reset -d 'null'

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. wem/AbCd

Schreiben

mosquitto_pub -h $BROKER -t $PREFIX/meters/1/reset -m 'null'

`meters/X/last_reset`

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. wem-AbCd

Lesen

curl http://$HOST/meters/1/last_reset

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. wem/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/meters/1/last_reset

{ "last_reset": 1714728252 }

Zuletzt zurückgesetzt 2024-05-03T11:24:12+02:00

Name	Bedeutung
`last_reset` int (s)	Unix-Timestamp des Zeitpunkts des letzten Zähler-Resets.

`meters/history`

HTTP (curl)
MQTT (mosquitto)

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. wem-AbCd

curl http://$HOST/meters/history

{
  "offset": 9378,
  "samples": [
    [
      null, null, null, null, null, null, null, null,
      // 600 weitere null-Werte entfernt
         0,    0,    0,    0,    0,    0,    0,    0,
         0,    0,    0,    0,    0,    0,    0,    0,
         0,    0,    0,    0,    0,    0,    0,    0,
         0,    0,    0,    0, 1736, 6656, 6655, 6666,
      6680, 6716, 6714, 6625, 6640, 6641, 6595, 6612,
      6592, 6593, 6589, 6592, 6600, 6625, 6626, 6637,
      6665, 6636, 6632, 6656, 6616, 6611, 6646, 6670,
      6691, 6715, 6787, 6754, 6761, 6797, 6771, 6685,
      6705, 6778, 6703, 6675, 6681, 6721, 6739, 6816,
      6872, 6858, 6821, 6836, 6784, 6871, 6943, 6930,
      6968, 6955, 6837, 6800, 6846, 6919, 6881, 6736,
      6671, 6655, 6674, 6743, 6878, 5733, 4462, 3712,
      3098, 2693, 2337, 2098, 1683, 1575, 1575,   84,
         0,    0,    0,    0,    0,    0,    0,    0
    ],
    null
  ]
}

Name Bedeutung

offset
int (ms)

Das Alter des zuletzt gemessenen Wertes.

samples
int[..][7]

Die gemessenen Werte aller Stromzähler.

[0..6] - Die gemessenen Werte des jeweiligen Stromzählers. Null falls ein Zähler nicht konfiguriert ist.

`meters/live`

HTTP (curl)
MQTT (mosquitto)

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. wem-AbCd

curl http://$HOST/meters/live

{
  "offset": 370,
  "samples_per_second": 1.99565,
  "samples": [
    [
        2626, 2626, 2626, 2626, 2626, 2626, 2626, 2673,
        2673, 2673, 2673, 2673, 2673, 2673, 2673, 2677,
        2677, 2677, 2677, 2677, 2677, 2677, 2677, 2677,
        2677, 2677, 2677, 2677, 2677, 2677, 2677,  988,
         988,  988,  988,  988,  988,  988,  988,    3,
           3,    3,    3,    3,    3,    3,    3,    1,
           1,    1,    1,    1,    1,    1,    1,    3,
           3,    3,    3,    3,    3,    3,    3,    3,
           3,    3,    3,    3,    3,    3,    3,    3,
           3,    3,    3,    3,    3,    3,    3,    4
    ],
    null,
    null,
    null,
    null,
    null,
    null
  ]
}

Name Bedeutung

offset
int (ms)

Das Alter des zuletzt gemessenen Wertes.

samples_per_second
float (Hz)

Die Anzahl der gemessenen Werte pro Sekunde.

samples
int[..][7]

Die gemessenen Werte aller Stromzähler.

[0..6] - Die gemessenen Werte. Abhängig von der Länge des Arrays und dem samples_per_second-Wert kann ermittelt werden, wie weit in die Vergangenheit die Messwerte reichen.

`meters/X/values`

Die Messwerte des X. Stromzählers. Die Bedeutung der Messwerte kann aus meters/X/value_ids ermittelt werden.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp-AbCd

Lesen

curl http://$HOST/meters/1/values

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/meters/1/values

[
  // Index 0
  217.6941223, 0, 0,
  30.72553635, 0, 0,
  6680.515625, 0, 0,
  6681.138672, 0, 0,
  // Index 12
  -90.09844208, 0, 0,
  1, 0, 0,
  72.56191254, 10.24184513, 30.72553635,
  6683.693359, 6680.666016, -90.09844208,
  // Index 24
  1, 50, 4644.044922,
  3.992000103, 0, 0,
  0, 0, 30.70857239,
  4648.038086, 197.5639954, 4648.038086,
  // Index 36
  4644.044922, 3.992000103
]

`meters/X/update`

Aktualisiert die Messwerte des X. Stromzählers. Kann nur bei einem API-Stromzähler (Union-Tag 4 in der entsprechenden meters/X/config) verwendet werden.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp-AbCd

Schreiben

curl http://$HOST/meters/1/update -d '[
    15.9, 16, 16.1,
    3657, 3680, 3703
]'

Beispiel für einen Zähler, der pro Phase Strom (Bezug + Einspeisung) und Wirkleistung (Bezug - Einspeisung) misst. Die korrekte Konfiguration (meters/X/config) für diesen Zähler wäre

[4, { "display_name": "API-Zähler", "value_ids": [13, 17, 21, 39, 48, 57] }]

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp/AbCd

Schreiben

mosquitto_pub -h $BROKER -t $PREFIX/meters/1/update -m '[
    15.9, 16, 16.1,
    3657, 3680, 3703
]'

Beispiel für einen Zähler, der pro Phase Strom (Bezug + Einspeisung) und Wirkleistung (Bezug - Einspeisung) misst. Die korrekte Konfiguration (meters/X/config) für diesen Zähler wäre

[4, { "display_name": "API-Zähler", "value_ids": [13, 17, 21, 39, 48, 57] }]

`meters/X/value_ids`

Die MeterValueIDs des X. Stromzählers. Der n-te Eintrag in diesem Array gibt die Bedeutung des n-ten Messwerts aus meters/X/values an. Liste aller MeterValueIDs

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp-AbCd

Lesen

curl http://$HOST/meters/1/value_ids

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/meters/1/value_ids

[
  // Index 0
  1, 2, 3,       // Spannung L1-N, L2-N, L3-N
  13, 17, 21,    // Strom (Bezug + Einspeisung) L1-N, L2-N, L3-N
  39, 48, 57,    // Wirkleistung (Bezug - Einspeisung) L1-N, L2-N, L3-N
  122, 130, 138, // Scheinleistung (Bezug + Einspeisung) L1-N, L2-N, L3-N
  // Index 12
  83, 91, 99,    // Blindleistung (induktiv - kapazitiv)  L1-N, L2-N, L3-N
  353, 354, 355, // Leistungsfaktor (gerichtet; Vorzeichen gibt Richtung des Stromflusses an) L1, L2, L3
  7,             // Durchschnittliche Phasenspannung
  29,            // Durchschnitt der (Bezug + Einspeisung)-Phasenströme
  33,            // Summe der (Bezug + Einspeisung)-Phasenstöme
  74,            // Summe der (Bezug - Einspeisung)-Phasenwirkleistungen
  154,           // Summe der (Bezug + Einspeisung)-Phasenscheinleistungen
  115,           // Summe der (induktiv - kapazitiv)-Phasenblindleistungen
  // Index 24
  356,           // Summe der gerichteten Leistungsfaktoren
  364,           // Netzfrequenz
  209, 211,      // Wirkenergie (Σ L1, L2, L3, seit Herstellung) Bezug, Einspeisung
  4, 5, 6, 8,    // Spannung L1-L2; L2-L3; L3-L1; ⌀ L1-L2, L2-L3, L3-L1
  25,            // Neutralleiterstrom
  213,           // Wirkenergie (Σ L1, L2, L3, seit Herstellung) Bezug + Einspeisung
  277,           // Blindenergie (Σ L1, L2, L3, seit Herstellung) induktiv + kapazitiv
  214,           // Wirkenergie (Σ L1, L2, L3, seit letztem Zurücksetzen) Bezug + Einspeisung
  // Index 36
  210,           // Wirkenergie (Σ L1, L2, L3, seit letztem Zurücksetzen) Bezug
  212            // Wirkenergie (Σ L1, L2, L3, seit letztem Zurücksetzen) Einspeisung
]

`meters/X/history`

HTTP (curl)
MQTT (mosquitto)

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp-AbCd

curl http://$HOST/meters/1/history

{
  "offset": 60927,
  "samples": [
      null, null, null, null, null, null, null, null,
      // 600 weitere null-Werte entfernt
         0,    0,    0,    0,    0,    0,    0,    0,
         0,    0,    0,    0,    0,    0,    0,    0,
         0,    0,    0,    0,    0,    0,    0,    0,
         0,    0,    0,    0, 1736, 6656, 6655, 6666,
      6680, 6716, 6714, 6625, 6640, 6641, 6595, 6612,
      6592, 6593, 6589, 6592, 6600, 6625, 6626, 6637,
      6665, 6636, 6632, 6656, 6616, 6611, 6646, 6670,
      6691, 6715, 6787, 6754, 6761, 6797, 6771, 6685,
      6705, 6778, 6703, 6675, 6681, 6721, 6739, 6816,
      6872, 6858, 6821, 6836, 6784, 6871, 6943, 6930,
      6968, 6955, 6837, 6800, 6846, 6919, 6881, 6736,
      6671, 6655, 6674, 6743, 6878, 5733, 4462, 3712,
      3098, 2693, 2337, 2098, 1683, 1575, 1575,   84,
         0,    0,    0,    0,    0,    0,    0,    0
  ]
}

Name	Bedeutung
`offset` int (ms)	Das Alter des zuletzt gemessenen Wertes.
`samples` int[..]	Die gemessenen Werte.

`meters/X/live`

HTTP (curl)
MQTT (mosquitto)

Die letzten Ladeleistungs-Messwerte des X. Stromzählers. Auf Basis dieser Werte werden die Durchschnittswerte für meters/X/history generiert.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp-AbCd

curl http://$HOST/meters/1/live

{
  "offset": 370,
  "samples_per_second": 1.99565,
  "samples": [
    2626, 2626, 2626, 2626, 2626, 2626, 2626, 2673,
    2673, 2673, 2673, 2673, 2673, 2673, 2673, 2677,
    2677, 2677, 2677, 2677, 2677, 2677, 2677, 2677,
    2677, 2677, 2677, 2677, 2677, 2677, 2677,  988,
     988,  988,  988,  988,  988,  988,  988,    3,
       3,    3,    3,    3,    3,    3,    3,    1,
       1,    1,    1,    1,    1,    1,    1,    3,
       3,    3,    3,    3,    3,    3,    3,    3,
       3,    3,    3,    3,    3,    3,    3,    3,
       3,    3,    3,    3,    3,    3,    3,    4
   ]
}

Es liegen 80 Werte vor, ~ 2 Werte pro Sekunde wurden erhoben, das Offset des letzten Werts sind 370 ms -> Die Messwerte reichen im Moment 40,370 Sekunden in die Vergangenheit.

Name	Bedeutung
`offset` int (ms)	Das Alter des zuletzt gemessenen Wertes.
`samples_per_second` float (Hz)	Die Anzahl der gemessenen Werte pro Sekunde.
`samples` int[..]	Die gemessenen Werte. Abhängig von der Länge des Arrays und dem samples_per_second-Wert kann ermittelt werden, wie weit in die Vergangenheit die Messwerte reichen.

`meters/X/config`

Die Konfiguration des X. Stromzählers. Das Union-Tag gibt die Zählerklasse an.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp-AbCd

Lesen

curl http://$HOST/meters/1/config

[4, { "display_name": "API-Zähler", "value_ids": [13, 17, 21, 39, 48, 57] }]

Schreiben

curl http://$HOST/meters/1/config -d '[4, { "display_name": "API-Zähler", "value_ids": [13, 17, 21, 39, 48, 57] }]'

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/meters/1/config

[4, { "display_name": "API-Zähler", "value_ids": [13, 17, 21, 39, 48, 57] }]

Schreiben

Mit MQTT auf $PREFIX/meters/1/config_update

mosquitto_pub -h $BROKER -t $PREFIX/meters/1/config_update -m '[4, { "display_name": "API-Zähler", "value_ids": [13, 17, 21, 39, 48, 57] }]'

0 - Kein Stromzähler konfiguriert.
1 - Interner Stromzähler (an RS485-Bricklet)
2 - Interner Stromzähler (an EVSE-2.0-Bricklet)
3 - Stromzähler angeschlossen am WARP Energy Manager
4 - API-Stromzähler
5 - SunSpec-Gerät über Modbus-TCP
6 - Modbus-TCP-Stromzähler.
7 - SMA Speedwire-Stromzähler.

null: Kein Stromzähler konfiguriert.

Name Bedeutung

display_name
string

Anzeigename des Stromzählers

type_override
int

Erlaubt es den verbauten Zählertyp zu überschreiben, falls die Auto-Detektion nicht funktioniert.

0 - Kein Stromzähler verfügbar
1 - SDM72
2 - SDM630
3 - SDM72V2
255 - Typ-Override nicht aktiv. Stromzählertyp wird automatisch detektiert.

Name	Bedeutung
`display_name` string	Anzeigename des Stromzählers

Name	Bedeutung
`display_name` string	Anzeigename des Stromzählers

Name	Bedeutung
`display_name` string	Anzeigename des Stromzählers
`value_ids` int[..]	MeterValueIDs, die über die API meters/X/update gesetzt werden können sollen. Liste aller MeterValueIDs

Name	Bedeutung
`display_name` string	Anzeigename des Geräts
`host` string	Hostname oder IP-Adresse des SunSpec-Geräts
`port` int	Port des SunSpec-Geräts. Typischerweise 502
`device_address` int	Modbus-Device-Adresse des Sunspec-Geräts
`manufacturer_name` string	Name des Herstellers des SunSpec-Geräts. Die Kombination aus `manufacturer_name`, `model_name` und `serial_number` sollte ein Gerät weltweit eindeutig identifizieren.
`model_name` string	Name des Modells des SunSpec-Geräts.
`serial_number` string	Seriennummer des SunSpec-Geräts.
`model_id` int	SunSpec-Model-ID
`model_instance` int	Gibt an wie viele SunSpec-Modelle mit gleicher `model_id` übersprungen werden, bis das gewünsche Modell gleicher ID erreicht ist.

Name Bedeutung

display_name
string

Anzeigename des Stromzählers

host
string

Hostname oder IP-Adresse des SunSpec-Geräts

port
int

Port des SunSpec-Geräts. Typischerweise 502

table
Union

Registertabelle, die gelesen werden soll.

0 - Keine Registertabelle konfiguriert.
1 - Benutzerdefinierte Registertabelle
2 - Sungrow Hybrid-Wechselrichter (SH...)
3 - Sungrow String-Wechselrichter (SG...)
4 - Solarmax Max.Storage
5 - Victron Energy GX
6 - Deye Hybrid-Wechselrichter
7 - AlphaESS Hybrid-Wechselrichter
8 - Shelly Pro EM
9 - Shelly Pro 3EM
10 - GoodWe Hybrid-Wechselrichter

null: Keine Registertabelle konfiguriert.

Name Bedeutung

device_address
int

Geräteadresse.

register_address_mode
int

Gibt an, ob die konfigurierten Registerstartadressen im Webinterface als Adressen oder Registernummern angezeigt werden.

0 - Startadressen werden als Registeraddressen angezeigt. Die erste Adresse ist 0.
1 - Startadressen werden als Registernummern angezeigt. Die erste Registernummer ist 1.

registers
object[36]

Registertabelle

[0..35] - Ein Register, dass gelesen werden soll

Name	Bedeutung
`rtype` int	Registertyp 0 - Holding Register 1 - Input Register
`addr` int	Startadresse des Registers.
`vtype` int	Wert-Typ 1 - Ein Register, 16-Bit, Ganzzahl, vorzeichenlos 9 - Ein Register, 16-Bit, Ganzzahl, vorzeichenbehaftet 2 - Zwei Register, 32-Bit, Ganzzahl, vorzeichenlos, Big-Endian 34 - Zwei Register, 32-Bit, Ganzzahl, vorzeichenlos, Little-Endian 10 - Zwei Register, 32-Bit, Ganzzahl, vorzeichenbehaftet, Big-Endian 42 - Zwei Register, 32-Bit, Ganzzahl, vorzeichenbehaftet, Little-Endian 26 - Zwei Register, 32-Bit, Gleitkommazahl, Big-Endian 58 - Zwei Register, 32-Bit, Gleitkommazahl, Little-Endian 4 - Vier Register, 64-Bit, Ganzzahl, vorzeichenlos, Big-Endian 36 - Vier Register, 64-Bit, Ganzzahl, vorzeichenlos, Little-Endian 12 - Vier Register, 64-Bit, Ganzzahl, vorzeichenbehaftet, Big-Endian 44 - Vier Register, 64-Bit, Ganzzahl, vorzeichenbehaftet, Little-Endian 28 - Vier Register, 64-Bit, Gleitkommazahl, Big-Endian 60 - Vier Register, 64-Bit, Gleitkommazahl, Little-Endian
`off` float	Offset, dass auf den gelesenen Wert addiert werden soll. Der Offset-Wert wird addiert, bevor der Skalierungsfaktor angewandt wird.
`scale` float	Skalierungsfaktor, mit dem der gelesene Wert multipliziert werden soll. Der Skalierungsfaktor wirkt auf den Wert, der durch die Addition des gelesenen Wertes mit dem Offset entstanden ist.
`id` int	MeterValueID, die die Interpretation des gelesenen Werts angibt. Liste aller MeterValueIDs

Name Bedeutung

virtual_meter
int

Virtueller Zähler. Gibt an welcher Teil der Registertabelle gelesen wird.

0 - Kein virtueller Zähler ausgewählt
1 - Wechselrichter
2 - Netzanschluss
3 - Speicher
4 - Last

device_address
int

Geräteadresse. Typischerweise 1.

Name Bedeutung

virtual_meter
int

Virtueller Zähler. Gibt an welcher Teil der Registertabelle gelesen wird.

0 - Kein virtueller Zähler ausgewählt
1 - Wechselrichter
2 - Netzanschluss
3 - Last

device_address
int

Geräteadresse. Typischerweise 1.

Name Bedeutung

virtual_meter
int

Virtueller Zähler. Gibt an welcher Teil der Registertabelle gelesen wird.

0 - Kein virtueller Zähler ausgewählt
1 - Wechselrichter
2 - Netzanschluss
3 - Speicher

device_address
int

Geräteadresse. Typischerweise 1.

Name Bedeutung

virtual_meter
int

Virtueller Zähler. Gibt an welcher Teil der Registertabelle gelesen wird.

0 - Kein virtueller Zähler ausgewählt
1 - Wechselrichter
2 - Netzanschluss
3 - Speicher
4 - Last

device_address
int

Geräteadresse. Typischerweise 100.

Name Bedeutung

virtual_meter
int

Virtueller Zähler. Gibt an welcher Teil der Registertabelle gelesen wird.

0 - Kein virtueller Zähler ausgewählt
1 - Wechselrichter
2 - Netzanschluss
3 - Speicher
4 - Last

device_address
int

Geräteadresse. Typischerweise 1.

Name Bedeutung

virtual_meter
int

Virtueller Zähler. Gibt an welcher Teil der Registertabelle gelesen wird.

0 - Kein virtueller Zähler ausgewählt
1 - Wechselrichter
2 - Netzanschluss
3 - Speicher

device_address
int

Geräteadresse. Typischerweise 1.

Name Bedeutung

device_address
int

Geräteadresse. Typischerweise 1.

monophase_channel
int

Kanal, der gelesen werden soll.

0 - Kein Kanal ausgewählt
1 - Kanal 1
2 - Kanal 2

monophase_mapping
int

Phase der die Messwerte zugeordnet werden.

0 - Keine Phase ausgewählt
1 - L1
2 - L2
3 - L3

Name	Bedeutung
`device_address` int	Geräteadresse. Typischerweise 1.
`device_profile` int	Gibt an, ob eine oder alle drei Phasen gelesen werden sollen. 0 - Dreiphasig. `monophase_channel` und `monophase_mapping` werden ignoriert. 1 - Einphasig
`monophase_channel` int	Kanal, der gelesen werden soll. 0 - Kein Kanal ausgewählt 1 - Kanal 1 2 - Kanal 2 3 - Kanal 3
`monophase_mapping` int	Phase der die Messwerte zugeordnet werden. 0 - Keine Phase ausgewählt 1 - L1 2 - L2 3 - L3

Name Bedeutung

virtual_meter
int

Virtueller Zähler. Gibt an welcher Teil der Registertabelle gelesen wird.

0 - Kein virtueller Zähler ausgewählt
1 - Wechselrichter
2 - Netzanschluss
3 - Speicher
4 - Last
5 - Backup-Last
6 - Zähler

device_address
int

Geräteadresse. Typischerweise 247.

Name	Bedeutung
`display_name` string	Anzeigename des Stromzählers

`meters/X/state`

Der Zustand des X. Stromzählers. Der Inhalt dieser API hängt vom Typ des Stromzählers ab, der in meters/X/config konfiguriert wurde.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp-AbCd

Lesen

curl http://$HOST/meters/1/state

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/meters/1/state

null

0 - Kein Stromzähler konfiguriert.
1 - Zustand des internen Stromzählers
2 - Zustand des internen Stromzählers
3 - Zustand des internen Stromzählers
4 - Zustand des API-Stromzählers. Im Moment leer.
5 - Zustand des SunSpec-Stromzählers. Im Moment leer.

null: Kein Stromzähler konfiguriert.

Name Bedeutung

type
int

Typ des verbauten Stromzählers. Nicht jeder Stromzähler wird von jedem Gerät unterstützt!

0 - Kein Stromzähler verfügbar
1 - SDM72
2 - SDM630
3 - SDM72V2

Name Bedeutung

type
int

Typ des verbauten Stromzählers. Nicht jeder Stromzähler wird von jedem Gerät unterstützt!

0 - Kein Stromzähler verfügbar
2 - SDM630
3 - SDM72V2
4 - SDM72CTM
5 - SDM630MCT
6 - DSZ15DZMOD
7 - DEM4A

Name Bedeutung

type
int

Typ des verbauten Stromzählers. Nicht jeder Stromzähler wird von jedem Gerät unterstützt!

0 - Kein Stromzähler verfügbar
2 - SDM630
3 - SDM72V2
4 - SDM72CTM
5 - SDM630MCT
6 - DSZ15DZMOD
7 - DEM4A

`meters/X/errors`

Fehlerzähler der Kommunikation mit dem Stromzähler. Der Inhalt dieser API hängt vom Typ des Stromzählers ab, der in meters/X/config konfiguriert wurde.

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp-AbCd

Lesen

curl http://$HOST/meters/1/errors

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/meters/1/errors

null

0 - Kein Stromzähler konfiguriert.
1 - Fehlerzähler des internen Stromzählers
2 - Fehlerzähler des internen Stromzählers
3 - Fehlerzähler des internen Stromzählers
4 - Fehlerzähler des API-Stromzählers. Im Moment leer.
5 - Fehlerzähler des SunSpec-Stromzählers. Im Moment leer.

null: Kein Stromzähler konfiguriert.

Name	Bedeutung
`meter` int	Kommunikationsfehler zwischen RS485 Bricklet und Stromzähler.
`bricklet` int	Kommunikationsfehler zwischen ESP Brick und RS485 Bricklet.
`bricklet_reset` int	Unerwartete Resets des RS485 Bricklets.

Name	Bedeutung
`local_timeout` int	Local Timeout
`global_timeout` int	Global Timeout
`illegal_function` int	Illegal Function
`illegal_data_access` int	Illegal Data Access
`illegal_data_value` int	Illegal Data Value
`slave_device_failure` int	Slave Device Failure

Name	Bedeutung
`local_timeout` int	Local Timeout
`global_timeout` int	Global Timeout
`illegal_function` int	Illegal Function
`illegal_data_access` int	Illegal Data Access
`illegal_data_value` int	Illegal Data Value
`slave_device_failure` int	Slave Device Failure

`meters/X/reset`

http
mqtt

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp-AbCd

Schreiben

curl http://$HOST/meters/1/reset -d 'null'

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp/AbCd

Schreiben

mosquitto_pub -h $BROKER -t $PREFIX/meters/1/reset -m 'null'

`meters/X/last_reset`

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp-AbCd

Lesen

curl http://$HOST/meters/1/last_reset

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/meters/1/last_reset

{ "last_reset": 1714728252 }

Zuletzt zurückgesetzt 2024-05-03T11:24:12+02:00

Name	Bedeutung
`last_reset` int (s)	Unix-Timestamp des Zeitpunkts des letzten Zähler-Resets.

`meters/history`

HTTP (curl)
MQTT (mosquitto)

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp-AbCd

curl http://$HOST/meters/history

{
  "offset": 9378,
  "samples": [
    [
      null, null, null, null, null, null, null, null,
      // 600 weitere null-Werte entfernt
         0,    0,    0,    0,    0,    0,    0,    0,
         0,    0,    0,    0,    0,    0,    0,    0,
         0,    0,    0,    0,    0,    0,    0,    0,
         0,    0,    0,    0, 1736, 6656, 6655, 6666,
      6680, 6716, 6714, 6625, 6640, 6641, 6595, 6612,
      6592, 6593, 6589, 6592, 6600, 6625, 6626, 6637,
      6665, 6636, 6632, 6656, 6616, 6611, 6646, 6670,
      6691, 6715, 6787, 6754, 6761, 6797, 6771, 6685,
      6705, 6778, 6703, 6675, 6681, 6721, 6739, 6816,
      6872, 6858, 6821, 6836, 6784, 6871, 6943, 6930,
      6968, 6955, 6837, 6800, 6846, 6919, 6881, 6736,
      6671, 6655, 6674, 6743, 6878, 5733, 4462, 3712,
      3098, 2693, 2337, 2098, 1683, 1575, 1575,   84,
         0,    0,    0,    0,    0,    0,    0,    0
    ],
    null,
    null,
    null,
    null,
    null,
    null
  ]
}

Name Bedeutung

offset
int (ms)

Das Alter des zuletzt gemessenen Wertes.

samples
int[..][..]

Die gemessenen Werte aller Stromzähler.

WARP 1 und WARP 2 und WARP 3:

[0..1] - Die gemessenen Werte des jeweiligen Stromzählers. Null falls ein Zähler nicht konfiguriert ist.

Energy Manager:

[0..6] - Die gemessenen Werte des jeweiligen Stromzählers. Null falls ein Zähler nicht konfiguriert ist.

`meters/live`

HTTP (curl)
MQTT (mosquitto)

Beispiel

HTTP (curl)
MQTT (mosquitto)

# $HOST z.B. warp-AbCd

curl http://$HOST/meters/live

{
  "offset": 370,
  "samples_per_second": 1.99565,
  "samples": [
    [
        2626, 2626, 2626, 2626, 2626, 2626, 2626, 2673,
        2673, 2673, 2673, 2673, 2673, 2673, 2673, 2677,
        2677, 2677, 2677, 2677, 2677, 2677, 2677, 2677,
        2677, 2677, 2677, 2677, 2677, 2677, 2677,  988,
         988,  988,  988,  988,  988,  988,  988,    3,
           3,    3,    3,    3,    3,    3,    3,    1,
           1,    1,    1,    1,    1,    1,    1,    3,
           3,    3,    3,    3,    3,    3,    3,    3,
           3,    3,    3,    3,    3,    3,    3,    3,
           3,    3,    3,    3,    3,    3,    3,    4
    ],
    null
  ]
}

Name Bedeutung

offset
int (ms)

Das Alter des zuletzt gemessenen Wertes.

samples_per_second
float (Hz)

Die Anzahl der gemessenen Werte pro Sekunde.

samples
int[..][..]

Die gemessenen Werte aller Stromzähler.

WARP 1 und WARP 2 und WARP 3:

[0..1] - Die gemessenen Werte. Abhängig von der Länge des Arrays und dem samples_per_second-Wert kann ermittelt werden, wie weit in die Vergangenheit die Messwerte reichen.

Energy Manager:

[0..6] - Die gemessenen Werte. Abhängig von der Länge des Arrays und dem samples_per_second-Wert kann ermittelt werden, wie weit in die Vergangenheit die Messwerte reichen.

meters/X/values​

Lesen​

Lesen​

meters/X/update​

Schreiben​

Schreiben​

meters/X/value_ids​

Lesen​

Lesen​

meters/X/history​

meters/X/live​

meters/X/config​

Lesen​

Schreiben​

Lesen​

Schreiben​

meters/X/state​

Lesen​

Lesen​

meters/X/errors​

Lesen​

Lesen​

meters/X/reset​

Schreiben​

Schreiben​

meters/X/last_reset​

Lesen​

Lesen​

meters/history​

meters/live​

meters/X/values​

Lesen​

Lesen​

meters/X/update​

Schreiben​

Schreiben​

meters/X/value_ids​

Lesen​

Lesen​

meters/X/history​

meters/X/live​

meters/X/config​

Lesen​

Schreiben​

Lesen​

Schreiben​

meters/X/state​

Lesen​

Lesen​

meters/X/errors​

Lesen​

Lesen​

meters/X/reset​

Schreiben​

Schreiben​

meters/X/last_reset​

Lesen​

Lesen​

meters/history​

meters/live​

meters/X/values​

Lesen​

Lesen​

meters/X/update​

Schreiben​

Schreiben​

meters/X/value_ids​

Lesen​

Lesen​

meters/X/history​

meters/X/live​

meters/X/config​

Lesen​

Schreiben​

Lesen​

Schreiben​

meters/X/state​

Lesen​

Lesen​

meters/X/errors​

`meters/X/values`

Lesen

Lesen

`meters/X/update`

Schreiben

Schreiben

`meters/X/value_ids`

Lesen

Lesen

`meters/X/history`

`meters/X/live`

`meters/X/config`

Lesen

Schreiben

Lesen

Schreiben

`meters/X/state`

Lesen

Lesen

`meters/X/errors`

Lesen

Lesen

`meters/X/reset`

Schreiben

Schreiben

`meters/X/last_reset`

Lesen

Lesen

`meters/history`

`meters/live`

`meters/X/values`

Lesen

Lesen

`meters/X/update`

Schreiben

Schreiben

`meters/X/value_ids`

Lesen

Lesen

`meters/X/history`

`meters/X/live`

`meters/X/config`

Lesen

Schreiben

Lesen

Schreiben

`meters/X/state`

Lesen

Lesen

`meters/X/errors`

Lesen

Lesen

`meters/X/reset`

Schreiben

Schreiben

`meters/X/last_reset`

Lesen

Lesen

`meters/history`

`meters/live`

`meters/X/values`

Lesen

Lesen

`meters/X/update`

Schreiben

Schreiben

`meters/X/value_ids`

Lesen

Lesen

`meters/X/history`

`meters/X/live`

`meters/X/config`

Lesen

Schreiben

Lesen

Schreiben

`meters/X/state`

Lesen

Lesen

`meters/X/errors`