C/C++ - Analog Out Bricklet 2.0

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

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
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_analog_out_v2.h"

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

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

    // Create device object
    AnalogOutV2 ao;
    analog_out_v2_create(&ao, 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
    analog_out_v2_set_output_voltage(&ao, 3300);

    printf("Press key to exit\n");
    getchar();
    analog_out_v2_destroy(&ao);
    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 analog_out_v2_create(AnalogOutV2 *analog_out_v2, const char *uid, IPConnection *ipcon)
Parameter:
  • analog_out_v2 – Typ: AnalogOutV2 *
  • uid – Typ: const char *
  • ipcon – Typ: IPConnection *

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

AnalogOutV2 analog_out_v2;
analog_out_v2_create(&analog_out_v2, "YOUR_DEVICE_UID", &ipcon);

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

void analog_out_v2_destroy(AnalogOutV2 *analog_out_v2)
Parameter:
  • analog_out_v2 – Typ: AnalogOutV2 *

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

int analog_out_v2_set_output_voltage(AnalogOutV2 *analog_out_v2, uint16_t voltage)
Parameter:
  • analog_out_v2 – Typ: AnalogOutV2 *
  • voltage – Typ: uint16_t, Einheit: 1 mV, Wertebereich: [0 bis 12000], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

Setzt die Spannung.

int analog_out_v2_get_output_voltage(AnalogOutV2 *analog_out_v2, uint16_t *ret_voltage)
Parameter:
  • analog_out_v2 – Typ: AnalogOutV2 *
Ausgabeparameter:
  • ret_voltage – Typ: uint16_t, Einheit: 1 mV, Wertebereich: [0 bis 12000], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

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

Fortgeschrittene Funktionen

int analog_out_v2_get_input_voltage(AnalogOutV2 *analog_out_v2, uint16_t *ret_voltage)
Parameter:
  • analog_out_v2 – Typ: AnalogOutV2 *
Ausgabeparameter:
  • ret_voltage – Typ: uint16_t, Einheit: 1 mV, Wertebereich: [0 bis 15000]
Rückgabe:
  • error_code – Typ: int

Gibt die Eingangsspannung zurück.

int analog_out_v2_get_api_version(AnalogOutV2 *analog_out_v2, uint8_t ret_api_version[3])
Parameter:
  • analog_out_v2 – Typ: AnalogOutV2 *
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 analog_out_v2_get_response_expected(AnalogOutV2 *analog_out_v2, uint8_t function_id, bool *ret_response_expected)
Parameter:
  • analog_out_v2 – Typ: AnalogOutV2 *
  • 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 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:

  • ANALOG_OUT_V2_FUNCTION_SET_OUTPUT_VOLTAGE = 1
int analog_out_v2_set_response_expected(AnalogOutV2 *analog_out_v2, uint8_t function_id, bool response_expected)
Parameter:
  • analog_out_v2 – Typ: AnalogOutV2 *
  • 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:

  • ANALOG_OUT_V2_FUNCTION_SET_OUTPUT_VOLTAGE = 1
int analog_out_v2_set_response_expected_all(AnalogOutV2 *analog_out_v2, bool response_expected)
Parameter:
  • analog_out_v2 – Typ: AnalogOutV2 *
  • 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 analog_out_v2_get_identity(AnalogOutV2 *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:
  • analog_out_v2 – Typ: AnalogOutV2 *
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.

Konstanten

ANALOG_OUT_V2_DEVICE_IDENTIFIER

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

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

ANALOG_OUT_V2_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Analog Out Bricklet 2.0 dar.