Software / API Bindings / C/C++ / API Referenz und Beispiele / Bricklets / Industrial Analog Out Bricklet 2.0

C/C++ - Industrial Analog Out Bricklet 2.0¶

Dies ist die Beschreibung der C/C++ API Bindings für das Industrial Analog Out Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Industrial Analog Out Bricklet 2.0 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 Current¶

Download (example_simple_current.c)

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_industrial_analog_out_v2.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Industrial Analog Out Bricklet 2.0

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

    // Create device object
    IndustrialAnalogOutV2 iao;
    industrial_analog_out_v2_create(&iao, 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

    // Set output current to 4.5mA
    industrial_analog_out_v2_set_current(&iao, 4500);
    industrial_analog_out_v2_set_enabled(&iao, true);

    printf("Press key to exit\n");
    getchar();

    industrial_analog_out_v2_set_enabled(&iao, false);

    industrial_analog_out_v2_destroy(&iao);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

Simple Voltage¶

Download (example_simple_voltage.c)

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_industrial_analog_out_v2.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Industrial Analog Out Bricklet 2.0

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

    // Create device object
    IndustrialAnalogOutV2 iao;
    industrial_analog_out_v2_create(&iao, 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

    // Set output voltage to 3.3V
    industrial_analog_out_v2_set_voltage(&iao, 3300);
    industrial_analog_out_v2_set_enabled(&iao, true);

    printf("Press key to exit\n");
    getchar();

    industrial_analog_out_v2_set_enabled(&iao, false);

    industrial_analog_out_v2_destroy(&iao);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

API¶

Die meistens Funktionen der C/C++ Bindings geben einen Fehlercode (e_code) zurück. 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 (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
E_WRONG_DEVICE_TYPE = -15
E_DEVICE_REPLACED = -16
E_WRONG_RESPONSE_LENGTH = -17

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen¶

void industrial_analog_out_v2_create(IndustrialAnalogOutV2 *industrial_analog_out_v2, const char *uid, IPConnection *ipcon)¶

Parameter:	industrial_analog_out_v2 – Typ: IndustrialAnalogOutV2 * uid – Typ: const char * ipcon – Typ: IPConnection *

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

IndustrialAnalogOutV2 industrial_analog_out_v2;
industrial_analog_out_v2_create(&industrial_analog_out_v2, "YOUR_DEVICE_UID", &ipcon);

Dieses Geräteobjekt kann benutzt werden, nachdem die IP Connection verbunden.

void industrial_analog_out_v2_destroy(IndustrialAnalogOutV2 *industrial_analog_out_v2)¶

Parameter:	industrial_analog_out_v2 – Typ: IndustrialAnalogOutV2 *

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

int industrial_analog_out_v2_set_enabled(IndustrialAnalogOutV2 *industrial_analog_out_v2, bool enabled)¶

Parameter:	industrial_analog_out_v2 – Typ: IndustrialAnalogOutV2 * enabled – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Aktiviert/deaktiviert die Ausgabe von Spannung und Strom.

int industrial_analog_out_v2_get_enabled(IndustrialAnalogOutV2 *industrial_analog_out_v2, bool *ret_enabled)¶

Parameter:	industrial_analog_out_v2 – Typ: IndustrialAnalogOutV2 *
Ausgabeparameter:	ret_enabled – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Gibt true zurück falls die Ausgabe von Spannung und Strom aktiviert ist, false sonst.

int industrial_analog_out_v2_set_voltage(IndustrialAnalogOutV2 *industrial_analog_out_v2, uint16_t voltage)¶

Parameter:	industrial_analog_out_v2 – Typ: IndustrialAnalogOutV2 * voltage – Typ: uint16_t, Einheit: 1 mV, Wertebereich: [0 bis 10000]
Rückgabe:	e_code – Typ: int

Setzt die Ausgangsspannung.

Die Ausgangsspannung und der Ausgangsstrom sind gekoppelt. Eine Änderung der Ausgangsspannung führt auch zu einer Änderung des Ausgangsstroms.

int industrial_analog_out_v2_get_voltage(IndustrialAnalogOutV2 *industrial_analog_out_v2, uint16_t *ret_voltage)¶

Parameter:	industrial_analog_out_v2 – Typ: IndustrialAnalogOutV2 *
Ausgabeparameter:	ret_voltage – Typ: uint16_t, Einheit: 1 mV, Wertebereich: [0 bis 10000]
Rückgabe:	e_code – Typ: int

Gibt die Spannung zurück, wie von industrial_analog_out_v2_set_voltage() gesetzt.

int industrial_analog_out_v2_set_current(IndustrialAnalogOutV2 *industrial_analog_out_v2, uint16_t current)¶

Parameter:	industrial_analog_out_v2 – Typ: IndustrialAnalogOutV2 * current – Typ: uint16_t, Einheit: 1 µA, Wertebereich: [0 bis 24000]
Rückgabe:	e_code – Typ: int

Setzt den Ausgangsstrom.

Der Ausgangsstrom und die Ausgangsspannung sind gekoppelt. Eine Änderung des Ausgangsstroms führt auch zu einer Änderung der Ausgangsspannung.

int industrial_analog_out_v2_get_current(IndustrialAnalogOutV2 *industrial_analog_out_v2, uint16_t *ret_current)¶

Parameter:	industrial_analog_out_v2 – Typ: IndustrialAnalogOutV2 *
Ausgabeparameter:	ret_current – Typ: uint16_t, Einheit: 1 µA, Wertebereich: [0 bis 24000]
Rückgabe:	e_code – Typ: int

Gibt die Spannung zurück, wie von industrial_analog_out_v2_set_current() gesetzt.

int industrial_analog_out_v2_set_out_led_config(IndustrialAnalogOutV2 *industrial_analog_out_v2, uint8_t config)¶

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

Die Out LED kann an- oder ausgeschaltet werden. Zusätzlich kann ein Heartbeat oder der "Out-Status" angezeigt werden. Falls Out-Status gewählt wird kann die LED entweder ab einem vordefinierten Schwellwert eingeschaltet werden oder ihre Helligkeit anhand des Ausgabewertes (Spannung oder Strom) skaliert werden.

Das Verhalten des Out-Status kann mittels industrial_analog_out_v2_set_out_led_status_config() eingestellt werden.

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

Für config:

INDUSTRIAL_ANALOG_OUT_V2_OUT_LED_CONFIG_OFF = 0
INDUSTRIAL_ANALOG_OUT_V2_OUT_LED_CONFIG_ON = 1
INDUSTRIAL_ANALOG_OUT_V2_OUT_LED_CONFIG_SHOW_HEARTBEAT = 2
INDUSTRIAL_ANALOG_OUT_V2_OUT_LED_CONFIG_SHOW_OUT_STATUS = 3

int industrial_analog_out_v2_get_out_led_config(IndustrialAnalogOutV2 *industrial_analog_out_v2, uint8_t *ret_config)¶

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

Gibt die Out-LED-Konfiguration zurück, wie von industrial_analog_out_v2_set_out_led_config() gesetzt.

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

Für ret_config:

INDUSTRIAL_ANALOG_OUT_V2_OUT_LED_CONFIG_OFF = 0
INDUSTRIAL_ANALOG_OUT_V2_OUT_LED_CONFIG_ON = 1
INDUSTRIAL_ANALOG_OUT_V2_OUT_LED_CONFIG_SHOW_HEARTBEAT = 2
INDUSTRIAL_ANALOG_OUT_V2_OUT_LED_CONFIG_SHOW_OUT_STATUS = 3

int industrial_analog_out_v2_set_out_led_status_config(IndustrialAnalogOutV2 *industrial_analog_out_v2, uint16_t min, uint16_t max, uint8_t config)¶

Parameter:	industrial_analog_out_v2 – Typ: IndustrialAnalogOutV2 * min – Typ: uint16_t, Wertebereich: [0 bis 24000], Standardwert: 0 max – Typ: uint16_t, Wertebereich: [0 bis 24000], Standardwert: 10000 config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 1
Rückgabe:	e_code – Typ: int

Setzt die Out-LED-Status-Konfiguration. Diese Einstellung wird verwendet wenn die Out-LED auf Out-Status eingestellt ist, siehe industrial_analog_out_v2_set_out_led_config().

Für jeden Kanal kann zwischen Schwellwert- und Intensitätsmodus gewählt werden.

Im Schwellwertmodus kann ein positiver oder negativer Schwellwert definiert werden. Für einen positiven Schwellwert muss der "min" Parameter auf den gewünschten Schwellwert in mV oder µA gesetzt werden, über dem die LED eingeschaltet werden soll. Der "max" Parameter muss auf 0 gesetzt werden. Beispiel: Bei einem positiven Schwellwert von 5V wird die LED eingeschaltet sobald der Ausgabewert über 5V steigt und wieder ausgeschaltet sobald der Ausgabewert unter 5V fällt. Für einen negativen Schwellwert muss der "max" Parameter auf den gewünschten Schwellwert in mV oder µA gesetzt werden, unter dem die LED eingeschaltet werden soll. Der "max" Parameter muss auf 0 gesetzt werden. Beispiel: Bei einem negativen Schwellwert von 5V wird die LED eingeschaltet sobald der Ausgabewert unter 5V fällt und wieder ausgeschaltet sobald der Ausgabewert über 5V steigt.

Im Intensitätsmodus kann ein Bereich in mV oder µA angegeben werden über den die Helligkeit der LED skaliert wird. Beispiel mit min=2V und max=8V: Die LED ist bei 2V und darunter aus, bei 8V und darüber an und zwischen 2V und 8V wird die Helligkeit linear skaliert. Wenn der min Wert größer als der max Wert ist, dann wird die Helligkeit andersherum skaliert.

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

Für config:

INDUSTRIAL_ANALOG_OUT_V2_OUT_LED_STATUS_CONFIG_THRESHOLD = 0
INDUSTRIAL_ANALOG_OUT_V2_OUT_LED_STATUS_CONFIG_INTENSITY = 1

int industrial_analog_out_v2_get_out_led_status_config(IndustrialAnalogOutV2 *industrial_analog_out_v2, uint16_t *ret_min, uint16_t *ret_max, uint8_t *ret_config)¶

Parameter:	industrial_analog_out_v2 – Typ: IndustrialAnalogOutV2 *
Ausgabeparameter:	ret_min – Typ: uint16_t, Wertebereich: [0 bis 24000], Standardwert: 0 ret_max – Typ: uint16_t, Wertebereich: [0 bis 24000], Standardwert: 10000 ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 1
Rückgabe:	e_code – Typ: int

Gibt die Out-LED-Status-Konfiguration zurück, wie von industrial_analog_out_v2_set_out_led_status_config() gesetzt.

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

Für ret_config:

INDUSTRIAL_ANALOG_OUT_V2_OUT_LED_STATUS_CONFIG_THRESHOLD = 0
INDUSTRIAL_ANALOG_OUT_V2_OUT_LED_STATUS_CONFIG_INTENSITY = 1

Fortgeschrittene Funktionen¶

int industrial_analog_out_v2_set_configuration(IndustrialAnalogOutV2 *industrial_analog_out_v2, uint8_t voltage_range, uint8_t current_range)¶

Parameter:	industrial_analog_out_v2 – Typ: IndustrialAnalogOutV2 * voltage_range – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 1 current_range – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	e_code – Typ: int

Konfiguriert die Spannungs- und Stromwertebereiche.

Einstellbare Spannungswertebereiche sind:

0V bis 5V
0V bis 10V

Einstellbare Stromwertebereiche sind:

4mA bis 20mA
0mA bis 20mA
0mA bis 24mA

Die Auflösung ist immer 12 Bit. Dass heißt, die Genauigkeit erhöht sich bei kleineren Wertebereichen.

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

Für voltage_range:

INDUSTRIAL_ANALOG_OUT_V2_VOLTAGE_RANGE_0_TO_5V = 0
INDUSTRIAL_ANALOG_OUT_V2_VOLTAGE_RANGE_0_TO_10V = 1

Für current_range:

INDUSTRIAL_ANALOG_OUT_V2_CURRENT_RANGE_4_TO_20MA = 0
INDUSTRIAL_ANALOG_OUT_V2_CURRENT_RANGE_0_TO_20MA = 1
INDUSTRIAL_ANALOG_OUT_V2_CURRENT_RANGE_0_TO_24MA = 2

int industrial_analog_out_v2_get_configuration(IndustrialAnalogOutV2 *industrial_analog_out_v2, uint8_t *ret_voltage_range, uint8_t *ret_current_range)¶

Parameter:	industrial_analog_out_v2 – Typ: IndustrialAnalogOutV2 *
Ausgabeparameter:	ret_voltage_range – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 1 ret_current_range – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	e_code – Typ: int

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

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

Für ret_voltage_range:

INDUSTRIAL_ANALOG_OUT_V2_VOLTAGE_RANGE_0_TO_5V = 0
INDUSTRIAL_ANALOG_OUT_V2_VOLTAGE_RANGE_0_TO_10V = 1

Für ret_current_range:

INDUSTRIAL_ANALOG_OUT_V2_CURRENT_RANGE_4_TO_20MA = 0
INDUSTRIAL_ANALOG_OUT_V2_CURRENT_RANGE_0_TO_20MA = 1
INDUSTRIAL_ANALOG_OUT_V2_CURRENT_RANGE_0_TO_24MA = 2

int industrial_analog_out_v2_get_spitfp_error_count(IndustrialAnalogOutV2 *industrial_analog_out_v2, 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:	industrial_analog_out_v2 – Typ: IndustrialAnalogOutV2 *
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 industrial_analog_out_v2_set_status_led_config(IndustrialAnalogOutV2 *industrial_analog_out_v2, uint8_t config)¶

Parameter:	industrial_analog_out_v2 – Typ: IndustrialAnalogOutV2 * 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:

INDUSTRIAL_ANALOG_OUT_V2_STATUS_LED_CONFIG_OFF = 0
INDUSTRIAL_ANALOG_OUT_V2_STATUS_LED_CONFIG_ON = 1
INDUSTRIAL_ANALOG_OUT_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
INDUSTRIAL_ANALOG_OUT_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int industrial_analog_out_v2_get_status_led_config(IndustrialAnalogOutV2 *industrial_analog_out_v2, uint8_t *ret_config)¶

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

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

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

Für ret_config:

INDUSTRIAL_ANALOG_OUT_V2_STATUS_LED_CONFIG_OFF = 0
INDUSTRIAL_ANALOG_OUT_V2_STATUS_LED_CONFIG_ON = 1
INDUSTRIAL_ANALOG_OUT_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
INDUSTRIAL_ANALOG_OUT_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int industrial_analog_out_v2_get_chip_temperature(IndustrialAnalogOutV2 *industrial_analog_out_v2, int16_t *ret_temperature)¶

Parameter:	industrial_analog_out_v2 – Typ: IndustrialAnalogOutV2 *
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 industrial_analog_out_v2_reset(IndustrialAnalogOutV2 *industrial_analog_out_v2)¶

Parameter:	industrial_analog_out_v2 – Typ: IndustrialAnalogOutV2 *
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 industrial_analog_out_v2_get_identity(IndustrialAnalogOutV2 *industrial_analog_out_v2, 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:	industrial_analog_out_v2 – Typ: IndustrialAnalogOutV2 *
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.

Virtuelle Funktionen¶

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

int industrial_analog_out_v2_get_api_version(IndustrialAnalogOutV2 *industrial_analog_out_v2, uint8_t ret_api_version[3])¶

Parameter:	industrial_analog_out_v2 – Typ: IndustrialAnalogOutV2 *
Ausgabeparameter:	ret_api_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]
Rückgabe:	e_code – Typ: int

Gibt die Version der API Definition 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 industrial_analog_out_v2_get_response_expected(IndustrialAnalogOutV2 *industrial_analog_out_v2, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	industrial_analog_out_v2 – Typ: IndustrialAnalogOutV2 * 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 industrial_analog_out_v2_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:

INDUSTRIAL_ANALOG_OUT_V2_FUNCTION_SET_ENABLED = 1
INDUSTRIAL_ANALOG_OUT_V2_FUNCTION_SET_VOLTAGE = 3
INDUSTRIAL_ANALOG_OUT_V2_FUNCTION_SET_CURRENT = 5
INDUSTRIAL_ANALOG_OUT_V2_FUNCTION_SET_CONFIGURATION = 7
INDUSTRIAL_ANALOG_OUT_V2_FUNCTION_SET_OUT_LED_CONFIG = 9
INDUSTRIAL_ANALOG_OUT_V2_FUNCTION_SET_OUT_LED_STATUS_CONFIG = 11
INDUSTRIAL_ANALOG_OUT_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
INDUSTRIAL_ANALOG_OUT_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
INDUSTRIAL_ANALOG_OUT_V2_FUNCTION_RESET = 243
INDUSTRIAL_ANALOG_OUT_V2_FUNCTION_WRITE_UID = 248

int industrial_analog_out_v2_set_response_expected(IndustrialAnalogOutV2 *industrial_analog_out_v2, uint8_t function_id, bool response_expected)¶

Parameter:	industrial_analog_out_v2 – Typ: IndustrialAnalogOutV2 * 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:

INDUSTRIAL_ANALOG_OUT_V2_FUNCTION_SET_ENABLED = 1
INDUSTRIAL_ANALOG_OUT_V2_FUNCTION_SET_VOLTAGE = 3
INDUSTRIAL_ANALOG_OUT_V2_FUNCTION_SET_CURRENT = 5
INDUSTRIAL_ANALOG_OUT_V2_FUNCTION_SET_CONFIGURATION = 7
INDUSTRIAL_ANALOG_OUT_V2_FUNCTION_SET_OUT_LED_CONFIG = 9
INDUSTRIAL_ANALOG_OUT_V2_FUNCTION_SET_OUT_LED_STATUS_CONFIG = 11
INDUSTRIAL_ANALOG_OUT_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
INDUSTRIAL_ANALOG_OUT_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
INDUSTRIAL_ANALOG_OUT_V2_FUNCTION_RESET = 243
INDUSTRIAL_ANALOG_OUT_V2_FUNCTION_WRITE_UID = 248

int industrial_analog_out_v2_set_response_expected_all(IndustrialAnalogOutV2 *industrial_analog_out_v2, bool response_expected)¶

Parameter:	industrial_analog_out_v2 – Typ: IndustrialAnalogOutV2 * 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 industrial_analog_out_v2_set_bootloader_mode(IndustrialAnalogOutV2 *industrial_analog_out_v2, uint8_t mode, uint8_t *ret_status)¶

Parameter:	industrial_analog_out_v2 – Typ: IndustrialAnalogOutV2 * 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:

INDUSTRIAL_ANALOG_OUT_V2_BOOTLOADER_MODE_BOOTLOADER = 0
INDUSTRIAL_ANALOG_OUT_V2_BOOTLOADER_MODE_FIRMWARE = 1
INDUSTRIAL_ANALOG_OUT_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
INDUSTRIAL_ANALOG_OUT_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
INDUSTRIAL_ANALOG_OUT_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

INDUSTRIAL_ANALOG_OUT_V2_BOOTLOADER_STATUS_OK = 0
INDUSTRIAL_ANALOG_OUT_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
INDUSTRIAL_ANALOG_OUT_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
INDUSTRIAL_ANALOG_OUT_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
INDUSTRIAL_ANALOG_OUT_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
INDUSTRIAL_ANALOG_OUT_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int industrial_analog_out_v2_get_bootloader_mode(IndustrialAnalogOutV2 *industrial_analog_out_v2, uint8_t *ret_mode)¶

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

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

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

Für ret_mode:

INDUSTRIAL_ANALOG_OUT_V2_BOOTLOADER_MODE_BOOTLOADER = 0
INDUSTRIAL_ANALOG_OUT_V2_BOOTLOADER_MODE_FIRMWARE = 1
INDUSTRIAL_ANALOG_OUT_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
INDUSTRIAL_ANALOG_OUT_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
INDUSTRIAL_ANALOG_OUT_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int industrial_analog_out_v2_set_write_firmware_pointer(IndustrialAnalogOutV2 *industrial_analog_out_v2, uint32_t pointer)¶

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

Setzt den Firmware-Pointer für industrial_analog_out_v2_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 industrial_analog_out_v2_write_firmware(IndustrialAnalogOutV2 *industrial_analog_out_v2, uint8_t data[64], uint8_t *ret_status)¶

Parameter:	industrial_analog_out_v2 – Typ: IndustrialAnalogOutV2 * data – Typ: 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 industrial_analog_out_v2_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 industrial_analog_out_v2_write_uid(IndustrialAnalogOutV2 *industrial_analog_out_v2, uint32_t uid)¶

Parameter:	industrial_analog_out_v2 – Typ: IndustrialAnalogOutV2 * 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 industrial_analog_out_v2_read_uid(IndustrialAnalogOutV2 *industrial_analog_out_v2, uint32_t *ret_uid)¶

Parameter:	industrial_analog_out_v2 – Typ: IndustrialAnalogOutV2 *
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¶

INDUSTRIAL_ANALOG_OUT_V2_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Industrial Analog Out Bricklet 2.0 zu identifizieren.

Die industrial_analog_out_v2_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.

INDUSTRIAL_ANALOG_OUT_V2_DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Industrial Analog Out Bricklet 2.0 dar.