Software / API Bindings / C/C++ für Mikrocontroller / API Referenz und Beispiele / Bricklets / Energy Monitor Bricklet

C/C++ für Mikrocontroller - Energy Monitor Bricklet¶

Dies ist die Beschreibung der C/C++ für Mikrocontroller 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 C/C++ für Mikrocontroller API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple¶

Download (example_simple.c)

// This example is not self-contained.
// It requires usage of the example driver specific to your platform.
// See the HAL documentation.

#include "src/bindings/hal_common.h"
#include "src/bindings/bricklet_energy_monitor.h"

void check(int rc, const char *msg);
void example_setup(TF_HAL *hal);
void example_loop(TF_HAL *hal);

static TF_EnergyMonitor em;

void example_setup(TF_HAL *hal) {
    // Create device object
    check(tf_energy_monitor_create(&em, NULL, hal), "create device object");

    // Get current energy data
    int32_t voltage, current, energy, real_power, apparent_power, reactive_power;
    uint16_t power_factor, frequency;
    check(tf_energy_monitor_get_energy_data(&em, &voltage, &current, &energy, &real_power,
                                            &apparent_power, &reactive_power,
                                            &power_factor,
                                            &frequency), "get energy data");

    tf_hal_printf("Voltage: %d 1/%d V\n", voltage, 100);
    tf_hal_printf("Current: %d 1/%d A\n", current, 100);
    tf_hal_printf("Energy: %d 1/%d Wh\n", energy, 100);
    tf_hal_printf("Real Power: %d 1/%d h\n", real_power, 100);
    tf_hal_printf("Apparent Power: %d 1/%d VA\n", apparent_power, 100);
    tf_hal_printf("Reactive Power: %d 1/%d var\n", reactive_power, 100);
    tf_hal_printf("Power Factor: %d 1/%d\n", power_factor, 1000);
    tf_hal_printf("Frequency: %d 1/%d Hz\n", frequency, 100);
}

void example_loop(TF_HAL *hal) {
    // Poll for callbacks
    tf_hal_callback_tick(hal, 0);
}

Callback¶

Download (example_callback.c)

// This example is not self-contained.
// It requires usage of the example driver specific to your platform.
// See the HAL documentation.

#include "src/bindings/hal_common.h"
#include "src/bindings/bricklet_energy_monitor.h"

void check(int rc, const char *msg);
void example_setup(TF_HAL *hal);
void example_loop(TF_HAL *hal);

// Callback function for energy data callback
static void energy_data_handler(TF_EnergyMonitor *device, int32_t voltage,
                                int32_t current, int32_t energy, int32_t real_power,
                                int32_t apparent_power, int32_t reactive_power,
                                uint16_t power_factor, uint16_t frequency,
                                void *user_data) {
    (void)device; (void)user_data; // avoid unused parameter warning

    tf_hal_printf("Voltage: %d 1/%d V\n", voltage, 100);
    tf_hal_printf("Current: %d 1/%d A\n", current, 100);
    tf_hal_printf("Energy: %d 1/%d Wh\n", energy, 100);
    tf_hal_printf("Real Power: %d 1/%d h\n", real_power, 100);
    tf_hal_printf("Apparent Power: %d 1/%d VA\n", apparent_power, 100);
    tf_hal_printf("Reactive Power: %d 1/%d var\n", reactive_power, 100);
    tf_hal_printf("Power Factor: %d 1/%d\n", power_factor, 1000);
    tf_hal_printf("Frequency: %d 1/%d Hz\n", frequency, 100);
    tf_hal_printf("\n");
}

static TF_EnergyMonitor em;

void example_setup(TF_HAL *hal) {
    // Create device object
    check(tf_energy_monitor_create(&em, NULL, hal), "create device object");

    // Register energy data callback to function energy_data_handler
    tf_energy_monitor_register_energy_data_callback(&em,
                                                    energy_data_handler,
                                                    NULL);

    // Set period for energy data callback to 1s (1000ms)
    tf_energy_monitor_set_energy_data_callback_configuration(&em, 1000, false);
}

void example_loop(TF_HAL *hal) {
    // Poll for callbacks
    tf_hal_callback_tick(hal, 0);
}

API¶

Die meistens Funktionen der C/C++ Bindings für Mikrocontroller geben einen Fehlercode (e_code) zurück

Mögliche Fehlercodes sind:

TF_E_OK = 0
TF_E_TIMEOUT = -1
TF_E_INVALID_PARAMETER = -2
TF_E_NOT_SUPPORTED = -3
TF_E_UNKNOWN_ERROR_CODE = -4
TF_E_STREAM_OUT_OF_SYNC = -5
TF_E_INVALID_CHAR_IN_UID = -6
TF_E_UID_TOO_LONG = -7
TF_E_UID_OVERFLOW = -8
TF_E_TOO_MANY_DEVICES = -9
TF_E_DEVICE_NOT_FOUND = -10
TF_E_WRONG_DEVICE_TYPE = -11
TF_E_CALLBACK_EXEC = -12
TF_E_PORT_NOT_FOUND = -13

(wie in errors.h definiert), sowie die Fehlercodes des verwendeten Hardware-Abstraction-Layers (HALs). Mit tf_hal_strerror (im Header das HALs definiert) kann ein Fehlerstring zu einem Fehlercode abgefragt werden.

Vom Gerät zurückgegebene Daten werden, wenn eine Abfrage aufgerufen wurde, über Ausgabeparameter gehandhabt. Diese Parameter sind mit dem ret_ Präfix gekennzeichnet. Die Bindings schreiben einen Ausgabeparameter nicht, wenn NULL bzw. nullptr übergeben wird. So können uninteressante Ausgaben ignoriert werden.

Keine der folgend aufgelisteten Funktionen ist Thread-sicher. Details finden sich in der Beschreibung der API-Bindings.

Grundfunktionen¶

int tf_energy_monitor_create(TF_EnergyMonitor *energy_monitor, const char *uid, TF_HAL *hal)¶

Parameter:	energy_monitor – Typ: TF_EnergyMonitor * uid – Typ: const char * hal – Typ: TF_HAL *
Rückgabe:	e_code – Typ: int

Erzeugt ein Geräteobjekt energy_monitor mit der optionalen eindeutigen Geräte ID oder dem Portnamen uid_or_port_name und fügt es dem HAL hal hinzu:

TF_EnergyMonitor energy_monitor;
tf_energy_monitor_create(&energy_monitor, NULL, &ipcon);

Im Normalfall kann uid_or_port_name auf NULL belassen werden. Für weitere Details siehe Abschnitt UID oder Port-Name.

int tf_energy_monitor_destroy(TF_EnergyMonitor *energy_monitor)¶

Parameter:	energy_monitor – Typ: TF_EnergyMonitor *
Rückgabe:	e_code – Typ: int

Entfernt das Geräteobjekt energy_monitor von dessen HAL und zerstört es. Das Geräteobjekt kann hiernach nicht mehr verwendet werden.

int tf_energy_monitor_get_energy_data(TF_EnergyMonitor *energy_monitor, int32_t *ret_voltage, int32_t *ret_current, int32_t *ret_energy, int32_t *ret_real_power, int32_t *ret_apparent_power, int32_t *ret_reactive_power, uint16_t *ret_power_factor, uint16_t *ret_frequency)¶

Parameter:	energy_monitor – Typ: TF_EnergyMonitor *
Ausgabeparameter:	ret_voltage – Typ: int32_t, Einheit: 1/100 V, Wertebereich: [-2³¹ bis 2³¹ - 1] ret_current – Typ: int32_t, Einheit: 1/100 A, Wertebereich: [-2³¹ bis 2³¹ - 1] ret_energy – Typ: int32_t, Einheit: 1/100 Wh, Wertebereich: [-2³¹ bis 2³¹ - 1] ret_real_power – Typ: int32_t, Einheit: 1/100 W, Wertebereich: [-2³¹ bis 2³¹ - 1] ret_apparent_power – Typ: int32_t, Einheit: 1/100 VA, Wertebereich: [-2³¹ bis 2³¹ - 1] ret_reactive_power – Typ: int32_t, Einheit: 1/100 var, Wertebereich: [-2³¹ bis 2³¹ - 1] ret_power_factor – Typ: uint16_t, Einheit: 1/1000, Wertebereich: [0 bis 2¹⁶ - 1] ret_frequency – Typ: uint16_t, Einheit: 1/100 Hz, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

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.

int tf_energy_monitor_reset_energy(TF_EnergyMonitor *energy_monitor)¶

Parameter:	energy_monitor – Typ: TF_EnergyMonitor *
Rückgabe:	e_code – Typ: int

Setzt den Energiewert (siehe tf_energy_monitor_get_energy_data()) zurück auf 0Wh

int tf_energy_monitor_get_waveform(TF_EnergyMonitor *energy_monitor, int16_t *ret_waveform, uint16_t *ret_waveform_length)¶

Parameter:	energy_monitor – Typ: TF_EnergyMonitor *
Ausgabeparameter:	ret_waveform – Typ: int16_t[1536], Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] ret_waveform_length – Typ: uint16_t
Rückgabe:	e_code – Typ: int

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.

int tf_energy_monitor_get_transformer_status(TF_EnergyMonitor *energy_monitor, bool *ret_voltage_transformer_connected, bool *ret_current_transformer_connected)¶

Parameter:	energy_monitor – Typ: TF_EnergyMonitor *
Ausgabeparameter:	ret_voltage_transformer_connected – Typ: bool ret_current_transformer_connected – Typ: bool
Rückgabe:	e_code – Typ: int

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

int tf_energy_monitor_set_transformer_calibration(TF_EnergyMonitor *energy_monitor, uint16_t voltage_ratio, uint16_t current_ratio, int16_t phase_shift)¶

Parameter:	energy_monitor – Typ: TF_EnergyMonitor * voltage_ratio – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 1923 current_ratio – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 3000 phase_shift – Typ: int16_t, Wertebereich: [0], Standardwert: 0
Rückgabe:	e_code – Typ: int

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.

int tf_energy_monitor_get_transformer_calibration(TF_EnergyMonitor *energy_monitor, uint16_t *ret_voltage_ratio, uint16_t *ret_current_ratio, int16_t *ret_phase_shift)¶

Parameter:	energy_monitor – Typ: TF_EnergyMonitor *
Ausgabeparameter:	ret_voltage_ratio – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 1923 ret_current_ratio – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 3000 ret_phase_shift – Typ: int16_t, Wertebereich: [0], Standardwert: 0
Rückgabe:	e_code – Typ: int

Gibt die Transformator-Kalibrierung zurück, wie von tf_energy_monitor_set_transformer_calibration() gesetzt.

int tf_energy_monitor_calibrate_offset(TF_EnergyMonitor *energy_monitor)¶

Parameter:	energy_monitor – Typ: TF_EnergyMonitor *
Rückgabe:	e_code – Typ: int

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¶

int tf_energy_monitor_get_spitfp_error_count(TF_EnergyMonitor *energy_monitor, uint32_t *ret_error_count_ack_checksum, uint32_t *ret_error_count_message_checksum, uint32_t *ret_error_count_frame, uint32_t *ret_error_count_overflow)¶

Parameter:	energy_monitor – Typ: TF_EnergyMonitor *
Ausgabeparameter:	ret_error_count_ack_checksum – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_message_checksum – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_frame – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_overflow – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

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.

int tf_energy_monitor_set_status_led_config(TF_EnergyMonitor *energy_monitor, uint8_t config)¶

Parameter:	energy_monitor – Typ: TF_EnergyMonitor * config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

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 Konstanten sind für diese Funktion verfügbar:

Für config:

TF_ENERGY_MONITOR_STATUS_LED_CONFIG_OFF = 0
TF_ENERGY_MONITOR_STATUS_LED_CONFIG_ON = 1
TF_ENERGY_MONITOR_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_ENERGY_MONITOR_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_energy_monitor_get_status_led_config(TF_EnergyMonitor *energy_monitor, uint8_t *ret_config)¶

Parameter:	energy_monitor – Typ: TF_EnergyMonitor *
Ausgabeparameter:	ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

Gibt die Konfiguration zurück, wie von tf_energy_monitor_set_status_led_config() gesetzt.

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

Für ret_config:

TF_ENERGY_MONITOR_STATUS_LED_CONFIG_OFF = 0
TF_ENERGY_MONITOR_STATUS_LED_CONFIG_ON = 1
TF_ENERGY_MONITOR_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_ENERGY_MONITOR_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_energy_monitor_get_chip_temperature(TF_EnergyMonitor *energy_monitor, int16_t *ret_temperature)¶

Parameter:	energy_monitor – Typ: TF_EnergyMonitor *
Ausgabeparameter:	ret_temperature – Typ: int16_t, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
Rückgabe:	e_code – Typ: int

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.

int tf_energy_monitor_reset(TF_EnergyMonitor *energy_monitor)¶

Parameter:	energy_monitor – Typ: TF_EnergyMonitor *
Rückgabe:	e_code – Typ: int

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.

int tf_energy_monitor_get_identity(TF_EnergyMonitor *energy_monitor, char ret_uid[8], char ret_connected_uid[8], char *ret_position, uint8_t ret_hardware_version[3], uint8_t ret_firmware_version[3], uint16_t *ret_device_identifier)¶

Parameter:	energy_monitor – Typ: TF_EnergyMonitor *
Ausgabeparameter:	ret_uid – Typ: char[8] ret_connected_uid – Typ: char[8] ret_position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] ret_hardware_version – Typ: uint8_t[3] 0: major – Typ: uint8_t, Wertebereich: [0 bis 255] 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255] 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255] ret_firmware_version – Typ: uint8_t[3] 0: major – Typ: uint8_t, Wertebereich: [0 bis 255] 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255] 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255] ret_device_identifier – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

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. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks¶

int tf_energy_monitor_set_energy_data_callback_configuration(TF_EnergyMonitor *energy_monitor, uint32_t period, bool value_has_to_change)¶

Parameter:	energy_monitor – Typ: TF_EnergyMonitor * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Die Periode ist die Periode mit der der 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.

int tf_energy_monitor_get_energy_data_callback_configuration(TF_EnergyMonitor *energy_monitor, uint32_t *ret_period, bool *ret_value_has_to_change)¶

Parameter:	energy_monitor – Typ: TF_EnergyMonitor *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 ret_value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Gibt die Callback-Konfiguration zurück, wie mittels tf_energy_monitor_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 der entsprechenden tf_energy_monitor_register_*_callback Funktion durchgeführt werden. Die user_data, sowie das Gerät, dass das Callback ausgelöst hat, werden dem registrierten Callback-Handler übergeben.

Nur ein Handler kann gleichzeitig auf das selbe Callback registriert werden. Um einen Handler zu deregistrieren, kann die tf_energy_monitor_register_*_callback-Funktion mit NULL als Handler aufgerufen werden.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist gegenüber der Verwendung von Abfragen zu bevorzugen. Es muss nur ein Byte abgefragt werden um zu prüfen ob ein Callback vorliegt. Siehe hier Performanceoptimierungen.

Warnung

Aus Callback-Handlern heraus können keine Bindings-Funktionen verwendet werden. Siehe hier Callbacks.

int tf_energy_monitor_register_energy_data_callback(TF_EnergyMonitor *energy_monitor, TF_EnergyMonitor_EnergyDataHandler handler, void *user_data)¶

void handler(TF_EnergyMonitor *energy_monitor, int32_t voltage, int32_t current, int32_t energy, int32_t real_power, int32_t apparent_power, int32_t reactive_power, uint16_t power_factor, uint16_t frequency, void *user_data)

Callback-Parameter:

Callback-Parameter:	energy_monitor – Typ: TF_EnergyMonitor * voltage – Typ: int32_t, Einheit: 1/100 V, Wertebereich: [-2³¹ bis 2³¹ - 1] current – Typ: int32_t, Einheit: 1/100 A, Wertebereich: [-2³¹ bis 2³¹ - 1] energy – Typ: int32_t, Einheit: 1/100 Wh, Wertebereich: [-2³¹ bis 2³¹ - 1] real_power – Typ: int32_t, Einheit: 1/100 W, Wertebereich: [-2³¹ bis 2³¹ - 1] apparent_power – Typ: int32_t, Einheit: 1/100 VA, Wertebereich: [-2³¹ bis 2³¹ - 1] reactive_power – Typ: int32_t, Einheit: 1/100 var, Wertebereich: [-2³¹ bis 2³¹ - 1] power_factor – Typ: uint16_t, Einheit: 1/1000, Wertebereich: [0 bis 2¹⁶ - 1] frequency – Typ: uint16_t, Einheit: 1/100 Hz, Wertebereich: [0 bis 2¹⁶ - 1] user_data – Typ: void *

energy_monitor – Typ: TF_EnergyMonitor *
voltage – Typ: int32_t, Einheit: 1/100 V, Wertebereich: [-2³¹ bis 2³¹ - 1]
current – Typ: int32_t, Einheit: 1/100 A, Wertebereich: [-2³¹ bis 2³¹ - 1]
energy – Typ: int32_t, Einheit: 1/100 Wh, Wertebereich: [-2³¹ bis 2³¹ - 1]
real_power – Typ: int32_t, Einheit: 1/100 W, Wertebereich: [-2³¹ bis 2³¹ - 1]
apparent_power – Typ: int32_t, Einheit: 1/100 VA, Wertebereich: [-2³¹ bis 2³¹ - 1]
reactive_power – Typ: int32_t, Einheit: 1/100 var, Wertebereich: [-2³¹ bis 2³¹ - 1]
power_factor – Typ: uint16_t, Einheit: 1/1000, Wertebereich: [0 bis 2¹⁶ - 1]
frequency – Typ: uint16_t, Einheit: 1/100 Hz, Wertebereich: [0 bis 2¹⁶ - 1]
user_data – Typ: void *

Dieser Callback wird periodisch ausgelöst abhängig von der mittels tf_energy_monitor_set_energy_data_callback_configuration() gesetzten Konfiguration

Die Parameter sind der gleiche wie tf_energy_monitor_get_energy_data().

Virtuelle Funktionen¶

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt.

int tf_energy_monitor_get_response_expected(TF_EnergyMonitor *energy_monitor, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	energy_monitor – Typ: TF_EnergyMonitor * function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_response_expected – Typ: bool
Rückgabe:	e_code – Typ: int

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels tf_energy_monitor_set_response_expected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

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

Für function_id:

TF_ENERGY_MONITOR_FUNCTION_RESET_ENERGY = 2
TF_ENERGY_MONITOR_FUNCTION_SET_TRANSFORMER_CALIBRATION = 5
TF_ENERGY_MONITOR_FUNCTION_CALIBRATE_OFFSET = 7
TF_ENERGY_MONITOR_FUNCTION_SET_ENERGY_DATA_CALLBACK_CONFIGURATION = 8
TF_ENERGY_MONITOR_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_ENERGY_MONITOR_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_ENERGY_MONITOR_FUNCTION_RESET = 243
TF_ENERGY_MONITOR_FUNCTION_WRITE_UID = 248

int tf_energy_monitor_set_response_expected(TF_EnergyMonitor *energy_monitor, uint8_t function_id, bool response_expected)¶

Parameter:	energy_monitor – Typ: TF_EnergyMonitor * function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten response_expected – Typ: bool
Rückgabe:	e_code – Typ: int

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

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

Für function_id:

TF_ENERGY_MONITOR_FUNCTION_RESET_ENERGY = 2
TF_ENERGY_MONITOR_FUNCTION_SET_TRANSFORMER_CALIBRATION = 5
TF_ENERGY_MONITOR_FUNCTION_CALIBRATE_OFFSET = 7
TF_ENERGY_MONITOR_FUNCTION_SET_ENERGY_DATA_CALLBACK_CONFIGURATION = 8
TF_ENERGY_MONITOR_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_ENERGY_MONITOR_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_ENERGY_MONITOR_FUNCTION_RESET = 243
TF_ENERGY_MONITOR_FUNCTION_WRITE_UID = 248

int tf_energy_monitor_set_response_expected_all(TF_EnergyMonitor *energy_monitor, bool response_expected)¶

Parameter:	energy_monitor – Typ: TF_EnergyMonitor * response_expected – Typ: bool
Rückgabe:	e_code – Typ: int

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

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.

int tf_energy_monitor_set_bootloader_mode(TF_EnergyMonitor *energy_monitor, uint8_t mode, uint8_t *ret_status)¶

Parameter:	energy_monitor – Typ: TF_EnergyMonitor * mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_status – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

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 Konstanten sind für diese Funktion verfügbar:

Für mode:

TF_ENERGY_MONITOR_BOOTLOADER_MODE_BOOTLOADER = 0
TF_ENERGY_MONITOR_BOOTLOADER_MODE_FIRMWARE = 1
TF_ENERGY_MONITOR_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_ENERGY_MONITOR_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_ENERGY_MONITOR_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

TF_ENERGY_MONITOR_BOOTLOADER_STATUS_OK = 0
TF_ENERGY_MONITOR_BOOTLOADER_STATUS_INVALID_MODE = 1
TF_ENERGY_MONITOR_BOOTLOADER_STATUS_NO_CHANGE = 2
TF_ENERGY_MONITOR_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
TF_ENERGY_MONITOR_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
TF_ENERGY_MONITOR_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int tf_energy_monitor_get_bootloader_mode(TF_EnergyMonitor *energy_monitor, uint8_t *ret_mode)¶

Parameter:	energy_monitor – Typ: TF_EnergyMonitor *
Ausgabeparameter:	ret_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

Gibt den aktuellen Bootloader-Modus zurück, siehe tf_energy_monitor_set_bootloader_mode().

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

Für ret_mode:

TF_ENERGY_MONITOR_BOOTLOADER_MODE_BOOTLOADER = 0
TF_ENERGY_MONITOR_BOOTLOADER_MODE_FIRMWARE = 1
TF_ENERGY_MONITOR_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_ENERGY_MONITOR_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_ENERGY_MONITOR_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int tf_energy_monitor_set_write_firmware_pointer(TF_EnergyMonitor *energy_monitor, uint32_t pointer)¶

Parameter:	energy_monitor – Typ: TF_EnergyMonitor * pointer – Typ: uint32_t, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

Setzt den Firmware-Pointer für tf_energy_monitor_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.

int tf_energy_monitor_write_firmware(TF_EnergyMonitor *energy_monitor, const uint8_t data[64], uint8_t *ret_status)¶

Parameter:	energy_monitor – Typ: TF_EnergyMonitor * data – Typ: const uint8_t[64], Wertebereich: [0 bis 255]
Ausgabeparameter:	ret_status – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Schreibt 64 Bytes Firmware an die Position die vorher von tf_energy_monitor_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.

int tf_energy_monitor_write_uid(TF_EnergyMonitor *energy_monitor, uint32_t uid)¶

Parameter:	energy_monitor – Typ: TF_EnergyMonitor * uid – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

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.

int tf_energy_monitor_read_uid(TF_EnergyMonitor *energy_monitor, uint32_t *ret_uid)¶

Parameter:	energy_monitor – Typ: TF_EnergyMonitor *
Ausgabeparameter:	ret_uid – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

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

Konstanten¶

TF_ENERGY_MONITOR_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Energy Monitor Bricklet zu identifizieren.

Die Funktionen tf_energy_monitor_get_identity() und tf_hal_get_device_info() haben einen device_identifier Ausgabe-Parameter um den Typ des Bricks oder Bricklets anzugeben.

TF_ENERGY_MONITOR_DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Energy Monitor Bricklet dar.