C/C++ - Analog Out Bricklet

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

#include "ip_connection.h"
#include "bricklet_analog_out.h"

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

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

    // Create device object
    AnalogOut ao;
    analog_out_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_set_voltage(&ao, 3300);

    printf("Press key to exit\n");
    getchar();
    analog_out_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 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

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

void analog_out_create(AnalogOut *analog_out, const char *uid, IPConnection *ipcon)

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

AnalogOut analog_out;
analog_out_create(&analog_out, "YOUR_DEVICE_UID", &ipcon);

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

void analog_out_destroy(AnalogOut *analog_out)

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

int analog_out_set_voltage(AnalogOut *analog_out, uint16_t voltage)

Setzt die Spannung in mV. Der mögliche Bereich ist 0V bis 5V (0-5000). Dieser Funktionsaufruf setzt den Modus auf 0 (siehe analog_out_set_mode()).

Der Standardwert ist 0 (im Modus 1).

int analog_out_get_voltage(AnalogOut *analog_out, uint16_t *ret_voltage)

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

int analog_out_set_mode(AnalogOut *analog_out, uint8_t mode)

Setzt den Modus des Analogwertes. Mögliche Modi:

  • 0: normaler Modus (Analogwert, wie von analog_out_set_voltage() gesetzt, wird ausgegeben.)
  • 1: 1k Ohm Widerstand gegen Masse
  • 2: 100k Ohm Widerstand gegen Masse
  • 3: 500k Ohm Widerstand gegen Masse

Ein setzten des Modus auf 0 resultiert in einer Ausgabespannung von 0. Es kann auf eine höhere Ausgabespannung direkt gewechselt werden über einen Aufruf von analog_out_set_voltage().

Der Standardmodus ist 1.

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

  • ANALOG_OUT_MODE_ANALOG_VALUE = 0
  • ANALOG_OUT_MODE_1K_TO_GROUND = 1
  • ANALOG_OUT_MODE_100K_TO_GROUND = 2
  • ANALOG_OUT_MODE_500K_TO_GROUND = 3
int analog_out_get_mode(AnalogOut *analog_out, uint8_t *ret_mode)

Gibt den Modus zurück, wie von analog_out_set_mode() gesetzt.

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

  • ANALOG_OUT_MODE_ANALOG_VALUE = 0
  • ANALOG_OUT_MODE_1K_TO_GROUND = 1
  • ANALOG_OUT_MODE_100K_TO_GROUND = 2
  • ANALOG_OUT_MODE_500K_TO_GROUND = 3

Fortgeschrittene Funktionen

int analog_out_get_api_version(AnalogOut *analog_out, uint8_t ret_api_version[3])

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_get_response_expected(AnalogOut *analog_out, uint8_t function_id, bool *ret_response_expected)

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

Siehe analog_out_set_response_expected() für die Liste der verfügbaren Funktions ID Defines für diese Funktion.

int analog_out_set_response_expected(AnalogOut *analog_out, uint8_t function_id, bool response_expected)

Ä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 Funktions ID Defines sind für diese Funktion verfügbar:

  • ANALOG_OUT_FUNCTION_SET_VOLTAGE = 1
  • ANALOG_OUT_FUNCTION_SET_MODE = 3
int analog_out_set_response_expected_all(AnalogOut *analog_out, bool response_expected)

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

int analog_out_get_identity(AnalogOut *analog_out, 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)

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_DEVICE_IDENTIFIER

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

Die analog_out_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_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Analog Out Bricklet dar.