C/C++ - Energy Monitor Bricklet

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (example_simple.c)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_energy_monitor.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Energy Monitor Bricklet

int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    EnergyMonitor em;
    energy_monitor_create(&em, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

    // Get current Energy Data
    int32_t voltage, current, energy, real_power, apparent_power, reactive_power;
    uint16_t power_factor, frequency;
    if(energy_monitor_get_energy_data(&em, &voltage, &current, &energy, &real_power,
                                      &apparent_power, &reactive_power, &power_factor,
                                      &frequency) < 0) {
        fprintf(stderr, "Could not get Energy Data, probably timeout\n");
        return 1;
    }

    printf("Voltage: %f V\n", voltage/100.0);
    printf("Current: %f A\n", current/100.0);
    printf("Energy: %f Wh\n", energy/100.0);
    printf("Real Power: %f h\n", real_power/100.0);
    printf("Apparent Power: %f VA\n", apparent_power/100.0);
    printf("Reactive Power: %f VAR\n", reactive_power/100.0);
    printf("Power Factor: %f\n", power_factor/1000.0);
    printf("Frequency: %f Hz\n", frequency/100.0);

    printf("Press key to exit\n");
    getchar();
    energy_monitor_destroy(&em);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

Callback

Download (example_callback.c)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_energy_monitor.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Energy Monitor Bricklet

// Callback function for Energy Data callback
void cb_energy_data(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)user_data; // avoid unused parameter warning

    printf("Voltage: %f V\n", voltage/100.0);
    printf("Current: %f A\n", current/100.0);
    printf("Energy: %f Wh\n", energy/100.0);
    printf("Real Power: %f h\n", real_power/100.0);
    printf("Apparent Power: %f VA\n", apparent_power/100.0);
    printf("Reactive Power: %f VAR\n", reactive_power/100.0);
    printf("Power Factor: %f\n", power_factor/1000.0);
    printf("Frequency: %f Hz\n", frequency/100.0);
    printf("\n");
}

int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    EnergyMonitor em;
    energy_monitor_create(&em, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

    // Register Energy Data callback to function cb_energy_data
    energy_monitor_register_callback(&em,
                                     ENERGY_MONITOR_CALLBACK_ENERGY_DATA,
                                     (void (*)(void))cb_energy_data,
                                     NULL);

    // Set period for Energy Data callback to 1s (1000ms)
    energy_monitor_set_energy_data_callback_configuration(&em, 1000, false);

    printf("Press key to exit\n");
    getchar();
    energy_monitor_destroy(&em);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

API

Jede Funktion der C/C++ Bindings gibt einen Integer zurück, welcher einen Fehlercode beschreibt. Vom Gerät zurückgegebene Daten werden, wenn eine Abfrage aufgerufen wurde, über Ausgabeparameter gehandhabt. Diese Parameter sind mit dem ret_ Präfix gekennzeichnet.

Mögliche Fehlercodes sind:

  • E_OK = 0
  • E_TIMEOUT = -1
  • E_NO_STREAM_SOCKET = -2
  • E_HOSTNAME_INVALID = -3
  • E_NO_CONNECT = -4
  • E_NO_THREAD = -5
  • E_NOT_ADDED = -6 (wird seit C/C++ Bindings Version 2.0.0 nicht mehr verwendet)
  • E_ALREADY_CONNECTED = -7
  • E_NOT_CONNECTED = -8
  • E_INVALID_PARAMETER = -9
  • E_NOT_SUPPORTED = -10
  • E_UNKNOWN_ERROR_CODE = -11
  • E_STREAM_OUT_OF_SYNC = -12
  • E_INVALID_UID = -13
  • E_NON_ASCII_CHAR_IN_SECRET = -14

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

void energy_monitor_create(EnergyMonitor *energy_monitor, const char *uid, IPConnection *ipcon)
Parameter:
  • energy_monitor – Typ: EnergyMonitor *
  • uid – Typ: const char *
  • ipcon – Typ: IPConnection *

Erzeugt ein Geräteobjekt energy_monitor mit der eindeutigen Geräte ID uid und fügt es der IP Connection ipcon hinzu:

EnergyMonitor energy_monitor;
energy_monitor_create(&energy_monitor, "YOUR_DEVICE_UID", &ipcon);

Dieses Geräteobjekt kann benutzt werden, nachdem die IP Connection verbunden wurde (siehe Beispiele oben).

void energy_monitor_destroy(EnergyMonitor *energy_monitor)
Parameter:
  • energy_monitor – Typ: EnergyMonitor *

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

int energy_monitor_get_energy_data(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: EnergyMonitor *
Ausgabeparameter:
  • ret_voltage – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
  • ret_current – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
  • ret_energy – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
  • ret_real_power – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
  • ret_apparent_power – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
  • ret_reactive_power – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
  • ret_power_factor – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • ret_frequency – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int

Gibt alle Messdaten des Energy Monitor Bricklets zurück.

  • Voltage (V): RMS-Spannung (Effektivwert) mit einer Auflösung von 10mV (Beispiel: 230,05V = 23005)
  • Current (A): RMS-Strom (Effektivwert) mit einer Auflösung von 10mA (Beispiel: 1,42A = 142)
  • Energy (Wh): Energie (integriert über Zeit) mit einer Auflösung von 10mWh (Beispiel: 1,1kWh = 110000)
  • Real Power (W): Wirkleistung mit einer Auflösung von 10mW (Beispiel: 1234,56W = 123456)
  • Apparent Power (VA): Scheinleistung mit einer Auflösung von 10mVA (Beispiel: 1234,56VA = 123456)
  • Reactive Power (VAR): Blindleistung mit einer Auflösung von 10mVAR (Beispiel: 1234,56VAR = 123456)
  • Power Factor: Leistungsfaktor mit einer Auflösung von 1/1000 (Beispiel: PF 0,995 = 995)
  • Frequency (Hz): AC-Frequenz der Netzspannung mit einer Auflösung von 1/100 Hz (Beispiel: 50Hz = 5000)

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 energy_monitor_reset_energy(EnergyMonitor *energy_monitor)
Parameter:
  • energy_monitor – Typ: EnergyMonitor *
Rückgabe:
  • error_code – Typ: int

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

int energy_monitor_get_waveform(EnergyMonitor *energy_monitor, int16_t *ret_waveform, uint16_t *ret_waveform_length)
Parameter:
  • energy_monitor – Typ: EnergyMonitor *
Ausgabeparameter:
  • ret_waveform – Typ: int16_t[1536], Wertebereich: [-215 bis 215 - 1]
  • ret_waveform_length – Typ: uint16_t
Rückgabe:
  • error_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 energy_monitor_get_transformer_status(EnergyMonitor *energy_monitor, bool *ret_voltage_transformer_connected, bool *ret_current_transformer_connected)
Parameter:
  • energy_monitor – Typ: EnergyMonitor *
Ausgabeparameter:
  • ret_voltage_transformer_connected – Typ: bool
  • ret_current_transformer_connected – Typ: bool
Rückgabe:
  • error_code – Typ: int

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

int energy_monitor_set_transformer_calibration(EnergyMonitor *energy_monitor, uint16_t voltage_ratio, uint16_t current_ratio, int16_t phase_shift)
Parameter:
  • energy_monitor – Typ: EnergyMonitor *
  • voltage_ratio – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • current_ratio – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • phase_shift – Typ: int16_t, Wertebereich: [-215 bis 215 - 1]
Rückgabe:
  • error_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.

Im Auslieferungszustand ist das Spannungsverhältnis auf 1923 und das Stromverhältnis auf 3000 gesetzt.

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

int energy_monitor_get_transformer_calibration(EnergyMonitor *energy_monitor, uint16_t *ret_voltage_ratio, uint16_t *ret_current_ratio, int16_t *ret_phase_shift)
Parameter:
  • energy_monitor – Typ: EnergyMonitor *
Ausgabeparameter:
  • ret_voltage_ratio – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • ret_current_ratio – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • ret_phase_shift – Typ: int16_t, Wertebereich: [-215 bis 215 - 1]
Rückgabe:
  • error_code – Typ: int

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

int energy_monitor_calibrate_offset(EnergyMonitor *energy_monitor)
Parameter:
  • energy_monitor – Typ: EnergyMonitor *
Rückgabe:
  • error_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 energy_monitor_get_api_version(EnergyMonitor *energy_monitor, uint8_t ret_api_version[3])
Parameter:
  • energy_monitor – Typ: EnergyMonitor *
Ausgabeparameter:
  • ret_api_version – Typ: uint8_t[3], Wertebereich: [0 bis 255]
Rückgabe:
  • error_code – Typ: int

Gibt die Version der API Definition (Major, Minor, Revision) zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

int energy_monitor_get_response_expected(EnergyMonitor *energy_monitor, uint8_t function_id, bool *ret_response_expected)
Parameter:
  • energy_monitor – Typ: EnergyMonitor *
  • function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:
  • ret_response_expected – Typ: bool
Rückgabe:
  • error_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 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:

  • ENERGY_MONITOR_FUNCTION_RESET_ENERGY = 2
  • ENERGY_MONITOR_FUNCTION_SET_TRANSFORMER_CALIBRATION = 5
  • ENERGY_MONITOR_FUNCTION_CALIBRATE_OFFSET = 7
  • ENERGY_MONITOR_FUNCTION_SET_ENERGY_DATA_CALLBACK_CONFIGURATION = 8
  • ENERGY_MONITOR_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • ENERGY_MONITOR_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • ENERGY_MONITOR_FUNCTION_RESET = 243
  • ENERGY_MONITOR_FUNCTION_WRITE_UID = 248
int energy_monitor_set_response_expected(EnergyMonitor *energy_monitor, uint8_t function_id, bool response_expected)
Parameter:
  • energy_monitor – Typ: EnergyMonitor *
  • function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • response_expected – Typ: bool
Rückgabe:
  • error_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.

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:

  • ENERGY_MONITOR_FUNCTION_RESET_ENERGY = 2
  • ENERGY_MONITOR_FUNCTION_SET_TRANSFORMER_CALIBRATION = 5
  • ENERGY_MONITOR_FUNCTION_CALIBRATE_OFFSET = 7
  • ENERGY_MONITOR_FUNCTION_SET_ENERGY_DATA_CALLBACK_CONFIGURATION = 8
  • ENERGY_MONITOR_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • ENERGY_MONITOR_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • ENERGY_MONITOR_FUNCTION_RESET = 243
  • ENERGY_MONITOR_FUNCTION_WRITE_UID = 248
int energy_monitor_set_response_expected_all(EnergyMonitor *energy_monitor, bool response_expected)
Parameter:
  • energy_monitor – Typ: EnergyMonitor *
  • response_expected – Typ: bool
Rückgabe:
  • error_code – Typ: int

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

int energy_monitor_get_spitfp_error_count(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: EnergyMonitor *
Ausgabeparameter:
  • ret_error_count_ack_checksum – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
  • ret_error_count_message_checksum – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
  • ret_error_count_frame – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
  • ret_error_count_overflow – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_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 energy_monitor_set_bootloader_mode(EnergyMonitor *energy_monitor, uint8_t mode, uint8_t *ret_status)
Parameter:
  • energy_monitor – Typ: EnergyMonitor *
  • mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:
  • ret_status – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_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 Bootlodaer- 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:

  • ENERGY_MONITOR_BOOTLOADER_MODE_BOOTLOADER = 0
  • ENERGY_MONITOR_BOOTLOADER_MODE_FIRMWARE = 1
  • ENERGY_MONITOR_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • ENERGY_MONITOR_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • ENERGY_MONITOR_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

  • ENERGY_MONITOR_BOOTLOADER_STATUS_OK = 0
  • ENERGY_MONITOR_BOOTLOADER_STATUS_INVALID_MODE = 1
  • ENERGY_MONITOR_BOOTLOADER_STATUS_NO_CHANGE = 2
  • ENERGY_MONITOR_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • ENERGY_MONITOR_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • ENERGY_MONITOR_BOOTLOADER_STATUS_CRC_MISMATCH = 5
int energy_monitor_get_bootloader_mode(EnergyMonitor *energy_monitor, uint8_t *ret_mode)
Parameter:
  • energy_monitor – Typ: EnergyMonitor *
Ausgabeparameter:
  • ret_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

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

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

Für ret_mode:

  • ENERGY_MONITOR_BOOTLOADER_MODE_BOOTLOADER = 0
  • ENERGY_MONITOR_BOOTLOADER_MODE_FIRMWARE = 1
  • ENERGY_MONITOR_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • ENERGY_MONITOR_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • ENERGY_MONITOR_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
int energy_monitor_set_write_firmware_pointer(EnergyMonitor *energy_monitor, uint32_t pointer)
Parameter:
  • energy_monitor – Typ: EnergyMonitor *
  • pointer – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_code – Typ: int

Setzt den Firmware-Pointer für 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 energy_monitor_write_firmware(EnergyMonitor *energy_monitor, uint8_t data[64], uint8_t *ret_status)
Parameter:
  • energy_monitor – Typ: EnergyMonitor *
  • data – Typ: uint8_t[64], Wertebereich: [0 bis 255]
Ausgabeparameter:
  • ret_status – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:
  • error_code – Typ: int

Schreibt 64 Bytes Firmware an die Position die vorher von 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 energy_monitor_set_status_led_config(EnergyMonitor *energy_monitor, uint8_t config)
Parameter:
  • energy_monitor – Typ: EnergyMonitor *
  • config – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_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:

  • ENERGY_MONITOR_STATUS_LED_CONFIG_OFF = 0
  • ENERGY_MONITOR_STATUS_LED_CONFIG_ON = 1
  • ENERGY_MONITOR_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • ENERGY_MONITOR_STATUS_LED_CONFIG_SHOW_STATUS = 3
int energy_monitor_get_status_led_config(EnergyMonitor *energy_monitor, uint8_t *ret_config)
Parameter:
  • energy_monitor – Typ: EnergyMonitor *
Ausgabeparameter:
  • ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

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

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

Für ret_config:

  • ENERGY_MONITOR_STATUS_LED_CONFIG_OFF = 0
  • ENERGY_MONITOR_STATUS_LED_CONFIG_ON = 1
  • ENERGY_MONITOR_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • ENERGY_MONITOR_STATUS_LED_CONFIG_SHOW_STATUS = 3
int energy_monitor_get_chip_temperature(EnergyMonitor *energy_monitor, int16_t *ret_temperature)
Parameter:
  • energy_monitor – Typ: EnergyMonitor *
Ausgabeparameter:
  • ret_temperature – Typ: int16_t, Wertebereich: [-215 bis 215 - 1]
Rückgabe:
  • error_code – Typ: int

Gibt die Temperatur in °C, 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 energy_monitor_reset(EnergyMonitor *energy_monitor)
Parameter:
  • energy_monitor – Typ: EnergyMonitor *
Rückgabe:
  • error_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 energy_monitor_write_uid(EnergyMonitor *energy_monitor, uint32_t uid)
Parameter:
  • energy_monitor – Typ: EnergyMonitor *
  • uid – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_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 energy_monitor_read_uid(EnergyMonitor *energy_monitor, uint32_t *ret_uid)
Parameter:
  • energy_monitor – Typ: EnergyMonitor *
Ausgabeparameter:
  • ret_uid – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_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.

int energy_monitor_get_identity(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: EnergyMonitor *
Ausgabeparameter:
  • ret_uid – Typ: char[8]
  • ret_connected_uid – Typ: char[8]
  • ret_position – Typ: char
  • ret_hardware_version – Typ: uint8_t[3], Wertebereich: [0 bis 255]
  • ret_firmware_version – Typ: uint8_t[3], Wertebereich: [0 bis 255]
  • ret_device_identifier – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_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 kann 'a', 'b', 'c' oder 'd' sein.

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

void energy_monitor_register_callback(EnergyMonitor *energy_monitor, int16_t callback_id, void (*function)(void), void *user_data)
Parameter:
  • energy_monitor – Typ: EnergyMonitor *
  • callback_id – Typ: int16_t
  • function – Typ: void (*)(void)
  • user_data – Typ: void *

Registriert die function für die gegebene callback_id. Die user_data werden der Funktion als letztes Parameter mit übergeben.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

int energy_monitor_set_energy_data_callback_configuration(EnergyMonitor *energy_monitor, uint32_t period, bool value_has_to_change)
Parameter:
  • energy_monitor – Typ: EnergyMonitor *
  • period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:
  • error_code – Typ: int

Die Periode ist die Periode mit der der ENERGY_MONITOR_CALLBACK_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 energy_monitor_get_energy_data_callback_configuration(EnergyMonitor *energy_monitor, uint32_t *ret_period, bool *ret_value_has_to_change)
Parameter:
  • energy_monitor – Typ: EnergyMonitor *
Ausgabeparameter:
  • ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • ret_value_has_to_change – Typ: bool, Standardwert: false
Rückgabe:
  • error_code – Typ: int

Gibt die Callback-Konfiguration zurück, wie mittels 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 energy_monitor_register_callback() Funktion durchgeführt werden:

void my_callback(int p, void *user_data) {
    printf("parameter: %d\n", p);
}

energy_monitor_register_callback(&energy_monitor, ENERGY_MONITOR_CALLBACK_EXAMPLE, (void (*)(void))my_callback, NULL);

Die verfügbaren Konstanten mit den zugehörigen Funktionssignaturen werden weiter unten beschrieben.

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.

ENERGY_MONITOR_CALLBACK_ENERGY_DATA
void callback(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:
  • voltage – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
  • current – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
  • energy – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
  • real_power – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
  • apparent_power – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
  • reactive_power – Typ: int32_t, Wertebereich: [-231 bis 231 - 1]
  • power_factor – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • frequency – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • user_data – Typ: void *

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

Die Parameter sind der gleiche wie energy_monitor_get_energy_data().

Konstanten

ENERGY_MONITOR_DEVICE_IDENTIFIER

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

Die energy_monitor_get_identity() Funktion und der IPCON_CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

ENERGY_MONITOR_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Energy Monitor Bricklet dar.