MQTT - Energy Monitor Bricklet

Dies ist die Beschreibung der MQTT API Bindings für das Energy Monitor Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Energy Monitor Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die MQTT API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (example-simple.txt)

1
2
3
4
5
6
# Change XYZ to the UID of your Energy Monitor Bricklet

setup:
    # Get current energy data
    subscribe to tinkerforge/response/energy_monitor_bricklet/XYZ/get_energy_data
    publish '' to tinkerforge/request/energy_monitor_bricklet/XYZ/get_energy_data

Callback

Download (example-callback.txt)

1
2
3
4
5
6
7
8
9
# Change XYZ to the UID of your Energy Monitor Bricklet

setup:
    # Handle incoming energy data callbacks
    subscribe to tinkerforge/callback/energy_monitor_bricklet/XYZ/energy_data
    publish '{"register": true}' to tinkerforge/register/energy_monitor_bricklet/XYZ/energy_data # Register energy_data callback

    # Set period for energy data callback to 1s (1000ms)
    publish '{"period": 1000, "value_has_to_change": false}' to tinkerforge/request/energy_monitor_bricklet/XYZ/set_energy_data_callback_configuration

API

Alle veröffentlichten Payloads an die und von den MQTT-Bindings sind im JSON Format.

Falls ein Fehler auftritt, veröffentlichen die Bindings ein JSON-Objekt, das die Fehlermeldung als _ERROR-Member enthält. Das Objekt wird auf dem zugehörigen Antwort-Topic veröffentlicht: .../response/... für .../request/... und .../callback/... für .../register/....

Grundfunktionen

request/energy_monitor_bricklet/<UID>/get_energy_data
Anfrage:
  • keine Nutzdaten
Antwort:
  • voltage – Typ: int, Einheit: 1/100 V, Wertebereich: [-231 bis 231 - 1]
  • current – Typ: int, Einheit: 1/100 A, Wertebereich: [-231 bis 231 - 1]
  • energy – Typ: int, Einheit: 1/100 Wh, Wertebereich: [-231 bis 231 - 1]
  • real_power – Typ: int, Einheit: 1/100 W, Wertebereich: [-231 bis 231 - 1]
  • apparent_power – Typ: int, Einheit: 1/100 VA, Wertebereich: [-231 bis 231 - 1]
  • reactive_power – Typ: int, Einheit: 1/100 var, Wertebereich: [-231 bis 231 - 1]
  • power_factor – Typ: int, Einheit: 1/1000, Wertebereich: [0 bis 216 - 1]
  • frequency – Typ: int, Einheit: 1/100 Hz, Wertebereich: [0 bis 216 - 1]

Gibt alle Messdaten des Energy Monitor Bricklets zurück.

  • Voltage: RMS-Spannung (Effektivwert)
  • Current: RMS-Strom (Effektivwert)
  • Energy: Energie (integriert über Zeit)
  • Real Power: Wirkleistung
  • Apparent Power: Scheinleistung
  • Reactive Power: Blindleistung
  • Power Factor: Leistungsfaktor
  • Frequency: AC-Frequenz der Netzspannung

Die Frequenz wird alle 6 Sekunden neu berechnet.

Alle anderen Werte werden über 10 Nulldurchgänge der Spannungs-Sinuskurve integriert. Mit einer Standard Netzspannungsfrequenz von 50Hz entspricht das 5 Messungen pro Sekunde (oder einer Integrationszeit von 200ms pro Messung).

Wenn kein Spannungstransformator angeschlossen ist, nutzt das Bricklet den Kurvenverlauf des Stroms, um die Frequenz zu bestimmen und die Integrationszeit beträgt 10 Nulldurchläufe der Strom-Sinuskurve.

request/energy_monitor_bricklet/<UID>/reset_energy
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Setzt den Energiewert (siehe request/energy_monitor_bricklet/<UID>/get_energy_data) zurück auf 0Wh

request/energy_monitor_bricklet/<UID>/get_waveform
Anfrage:
  • keine Nutzdaten
Antwort:
  • waveform – Typ: [int, ...], Länge: 1536, Wertebereich: [-215 bis 215 - 1]

Gibt eine Momentaufnahme des Spannungs- und Stromkurvenverlaufs zurück. Die Werte im zurückgegebenen Array alternieren zwischen Spannung und Strom. Die Daten eines Getter-Aufrufs beinhalten 768 Datenpunkte für Spannung und Strom, diese korrespondieren zu ungefähr 3 vollen Sinuskurven.

Die Spannung hat eine Auflösung von 100mV und der Strom hat eine Auflösung von 10mA.

Die Daten können für eine grafische Repräsentation (nicht-Realzeit) der Kurvenverläufe genutzt werden.

request/energy_monitor_bricklet/<UID>/get_transformer_status
Anfrage:
  • keine Nutzdaten
Antwort:
  • voltage_transformer_connected – Typ: bool
  • current_transformer_connected – Typ: bool

Gibt true zurück wenn ein Spannungs-/Stromtransformator mit dem Bricklet verbunden ist.

request/energy_monitor_bricklet/<UID>/set_transformer_calibration
Anfrage:
  • voltage_ratio – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 1923
  • current_ratio – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 3000
  • phase_shift – Typ: int, Wertebereich: [0], Standardwert: 0
Antwort:
  • keine Antwort

Setzt das Transformer-Verhältnis für Strom und Spannung in Hundertstel.

Beispiel: Wenn die Netzspannung 230V beträgt und ein 9V Spannungstransformer sowie eine 1V:30A Spannungszange verwendet wird, ergibt das ein Spannungsverhältnis von 230/9 = 25,56 und ein Stromverhältnis von 30/1 = 30.

In diesem Fall müssten also die Werte 2556 und 3000 gesetzt werden.

Die Kalibrierung wird in nicht-flüchtigem Speicher gespeichert und muss nur einmal gesetzt werden.

Der Parameter Phase Shift muss auf 0 gesetzt werden. Dieser Parameter wird aktuell von der Firmware nicht genutzt.

request/energy_monitor_bricklet/<UID>/get_transformer_calibration
Anfrage:
  • keine Nutzdaten
Antwort:
  • voltage_ratio – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 1923
  • current_ratio – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 3000
  • phase_shift – Typ: int, Wertebereich: [0], Standardwert: 0

Gibt die Transformator-Kalibrierung zurück, wie von request/energy_monitor_bricklet/<UID>/set_transformer_calibration gesetzt.

request/energy_monitor_bricklet/<UID>/calibrate_offset
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Ein Aufruf dieser Funktion startet eine Offset-Kalibrierung. Dazu werden die Spannungs- und Stromkurvenverläufe über einen längeren Zeitraum aufsummiert, um den Nulldurchgangspunkt der Sinuskurve zu finden.

Der Offset für das Bricklet wird von Tinkerforge ab Werk kalibriert. Ein Aufruf dieser Funktion sollte also nicht notwendig sein.

Wenn der Offset rekalibriert werden soll, empfehlen wir entweder eine Last anzuschließen, die eine glatte Sinuskurve für Spannung und Strom erzeugt, oder die beiden Eingänge kurzzuschließen.

Die Kalibrierung wird in nicht-flüchtigem Speicher gespeichert und muss nur einmal gesetzt werden.

Fortgeschrittene Funktionen

request/energy_monitor_bricklet/<UID>/get_spitfp_error_count
Anfrage:
  • keine Nutzdaten
Antwort:
  • error_count_ack_checksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • error_count_message_checksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • error_count_frame – Typ: int, Wertebereich: [0 bis 232 - 1]
  • error_count_overflow – Typ: int, Wertebereich: [0 bis 232 - 1]

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

request/energy_monitor_bricklet/<UID>/set_status_led_config
Anfrage:
  • config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3
Antwort:
  • keine Antwort

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für config:

  • "off" = 0
  • "on" = 1
  • "show_heartbeat" = 2
  • "show_status" = 3
request/energy_monitor_bricklet/<UID>/get_status_led_config
Anfrage:
  • keine Nutzdaten
Antwort:
  • config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die Konfiguration zurück, wie von request/energy_monitor_bricklet/<UID>/set_status_led_config gesetzt.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für config:

  • "off" = 0
  • "on" = 1
  • "show_heartbeat" = 2
  • "show_status" = 3
request/energy_monitor_bricklet/<UID>/get_chip_temperature
Anfrage:
  • keine Nutzdaten
Antwort:
  • temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

request/energy_monitor_bricklet/<UID>/reset
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

request/energy_monitor_bricklet/<UID>/get_identity
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: string, Länge: bis zu 8
  • connected_uid – Typ: string, Länge: bis zu 8
  • position – Typ: char, Wertebereich: ["a" bis "h", "z"]
  • hardware_version – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]
  • firmware_version – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]
  • device_identifier – Typ: int, Wertebereich: [0 bis 216 - 1]
  • _display_name – Typ: string

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden. Falls die symbolische Ausgabe nicht deaktiviert wurde, wird der Device Identifier auf den entsprechenden Namen im Format, welches die Topics verwenden, abgebildet.

Der Display Name enthält den Anzeigenamen des Energy Monitor.

Konfigurationsfunktionen für Callbacks

request/energy_monitor_bricklet/<UID>/set_energy_data_callback_configuration
Anfrage:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
Antwort:
  • keine Antwort

Die Periode ist die Periode mit der der register/energy_monitor_bricklet/<UID>/energy_data Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

request/energy_monitor_bricklet/<UID>/get_energy_data_callback_configuration
Anfrage:
  • keine Nutzdaten
Antwort:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels request/energy_monitor_bricklet/<UID>/set_energy_data_callback_configuration gesetzt.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit dem entsprechenden .../register/...-Topic und einem optionalen Suffix durchgeführt werden. Mit diesem Suffix kann das Callback später deregistriert werden.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

register/energy_monitor_bricklet/<UID>/energy_data
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • voltage – Typ: int, Einheit: 1/100 V, Wertebereich: [-231 bis 231 - 1]
  • current – Typ: int, Einheit: 1/100 A, Wertebereich: [-231 bis 231 - 1]
  • energy – Typ: int, Einheit: 1/100 Wh, Wertebereich: [-231 bis 231 - 1]
  • real_power – Typ: int, Einheit: 1/100 W, Wertebereich: [-231 bis 231 - 1]
  • apparent_power – Typ: int, Einheit: 1/100 VA, Wertebereich: [-231 bis 231 - 1]
  • reactive_power – Typ: int, Einheit: 1/100 var, Wertebereich: [-231 bis 231 - 1]
  • power_factor – Typ: int, Einheit: 1/1000, Wertebereich: [0 bis 216 - 1]
  • frequency – Typ: int, Einheit: 1/100 Hz, Wertebereich: [0 bis 216 - 1]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/energy_monitor_bricklet/<UID>/energy_data[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/energy_monitor_bricklet/<UID>/energy_data[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird periodisch ausgelöst abhängig von der mittels request/energy_monitor_bricklet/<UID>/set_energy_data_callback_configuration gesetzten Konfiguration

Die Payload-Member des Callbacks sind der gleiche wie request/energy_monitor_bricklet/<UID>/get_energy_data.

Interne Funktionen

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

request/energy_monitor_bricklet/<UID>/set_bootloader_mode
Anfrage:
  • mode – Typ: int, Wertebereich: Siehe Symbole
Antwort:
  • status – Typ: int, Wertebereich: Siehe Symbole

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für mode:

  • "bootloader" = 0
  • "firmware" = 1
  • "bootloader_wait_for_reboot" = 2
  • "firmware_wait_for_reboot" = 3
  • "firmware_wait_for_erase_and_reboot" = 4

Für status:

  • "ok" = 0
  • "invalid_mode" = 1
  • "no_change" = 2
  • "entry_function_not_present" = 3
  • "device_identifier_incorrect" = 4
  • "crc_mismatch" = 5
request/energy_monitor_bricklet/<UID>/get_bootloader_mode
Anfrage:
  • keine Nutzdaten
Antwort:
  • mode – Typ: int, Wertebereich: Siehe Symbole

Gibt den aktuellen Bootloader-Modus zurück, siehe request/energy_monitor_bricklet/<UID>/set_bootloader_mode.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für mode:

  • "bootloader" = 0
  • "firmware" = 1
  • "bootloader_wait_for_reboot" = 2
  • "firmware_wait_for_reboot" = 3
  • "firmware_wait_for_erase_and_reboot" = 4
request/energy_monitor_bricklet/<UID>/set_write_firmware_pointer
Anfrage:
  • pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Antwort:
  • keine Antwort

Setzt den Firmware-Pointer für request/energy_monitor_bricklet/<UID>/write_firmware. Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

request/energy_monitor_bricklet/<UID>/write_firmware
Anfrage:
  • data – Typ: [int, ...], Länge: 64, Wertebereich: [0 bis 255]
Antwort:
  • status – Typ: int, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von request/energy_monitor_bricklet/<UID>/set_write_firmware_pointer gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

request/energy_monitor_bricklet/<UID>/write_uid
Anfrage:
  • uid – Typ: int, Wertebereich: [0 bis 232 - 1]
Antwort:
  • keine Antwort

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

request/energy_monitor_bricklet/<UID>/read_uid
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: int, Wertebereich: [0 bis 232 - 1]

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.