C/C++ - Linear Poti Bricklet

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

#include "ip_connection.h"
#include "bricklet_linear_poti.h"

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

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

    // Create device object
    LinearPoti lp;
    linear_poti_create(&lp, 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 position
    uint16_t position;
    if(linear_poti_get_position(&lp, &position) < 0) {
        fprintf(stderr, "Could not get position, probably timeout\n");
        return 1;
    }

    printf("Position: %u\n", position); // Range: 0 to 100

    printf("Press key to exit\n");
    getchar();
    linear_poti_destroy(&lp);
    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
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_linear_poti.h"

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

// Callback function for position callback
void cb_position(uint16_t position, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Position: %u\n", position); // Range: 0 to 100
}

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

    // Create device object
    LinearPoti lp;
    linear_poti_create(&lp, 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 position callback to function cb_position
    linear_poti_register_callback(&lp,
                                  LINEAR_POTI_CALLBACK_POSITION,
                                  (void (*)(void))cb_position,
                                  NULL);

    // Set period for position callback to 0.05s (50ms)
    // Note: The position callback is only called every 0.05 seconds
    //       if the position has changed since the last call!
    linear_poti_set_position_callback_period(&lp, 50);

    printf("Press key to exit\n");
    getchar();
    linear_poti_destroy(&lp);
    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
  • E_NON_ASCII_CHAR_IN_SECRET = -14

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

void linear_poti_create(LinearPoti *linear_poti, const char *uid, IPConnection *ipcon)

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

LinearPoti linear_poti;
linear_poti_create(&linear_poti, "YOUR_DEVICE_UID", &ipcon);

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

void linear_poti_destroy(LinearPoti *linear_poti)

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

int linear_poti_get_position(LinearPoti *linear_poti, uint16_t *ret_position)

Gibt die Position des Linearpotentiometers zurück. Der Wertebereich ist von 0 (Schieberegler unten) und 100 (Schieberegler oben).

Wenn die Position periodisch abgefragt werden soll, wird empfohlen den LINEAR_POTI_CALLBACK_POSITION Callback zu nutzen und die Periode mit linear_poti_set_position_callback_period() vorzugeben.

Fortgeschrittene Funktionen

int linear_poti_get_analog_value(LinearPoti *linear_poti, uint16_t *ret_value)

Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück. Der Wertebereich ist 0 bis 4095.

Bemerkung

Der von linear_poti_get_position() zurückgegebene Wert ist über mehrere Messwerte gemittelt um das Rauschen zu vermindern, während linear_poti_get_analog_value() unverarbeitete Analogwerte zurück gibt. Der einzige Grund linear_poti_get_analog_value() zu nutzen, ist die volle Auflösung des Analog-Digital-Wandlers zu erhalten.

Wenn der Analogwert periodisch abgefragt werden soll, wird empfohlen den LINEAR_POTI_CALLBACK_ANALOG_VALUE Callback zu nutzen und die Periode mit linear_poti_set_analog_value_callback_period() vorzugeben.

int linear_poti_get_api_version(LinearPoti *linear_poti, 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 linear_poti_get_response_expected(LinearPoti *linear_poti, 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 linear_poti_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:

  • LINEAR_POTI_FUNCTION_SET_POSITION_CALLBACK_PERIOD = 3
  • LINEAR_POTI_FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
  • LINEAR_POTI_FUNCTION_SET_POSITION_CALLBACK_THRESHOLD = 7
  • LINEAR_POTI_FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
  • LINEAR_POTI_FUNCTION_SET_DEBOUNCE_PERIOD = 11
int linear_poti_set_response_expected(LinearPoti *linear_poti, 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 Konstanten sind für diese Funktion verfügbar:

  • LINEAR_POTI_FUNCTION_SET_POSITION_CALLBACK_PERIOD = 3
  • LINEAR_POTI_FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
  • LINEAR_POTI_FUNCTION_SET_POSITION_CALLBACK_THRESHOLD = 7
  • LINEAR_POTI_FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
  • LINEAR_POTI_FUNCTION_SET_DEBOUNCE_PERIOD = 11
int linear_poti_set_response_expected_all(LinearPoti *linear_poti, bool response_expected)

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

int linear_poti_get_identity(LinearPoti *linear_poti, 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.

Konfigurationsfunktionen für Callbacks

void linear_poti_register_callback(LinearPoti *linear_poti, int16_t callback_id, void (*function)(void), void *user_data)

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 linear_poti_set_position_callback_period(LinearPoti *linear_poti, uint32_t period)

Setzt die Periode in ms mit welcher der LINEAR_POTI_CALLBACK_POSITION Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der LINEAR_POTI_CALLBACK_POSITION Callback wird nur ausgelöst, wenn sich die Position seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

int linear_poti_get_position_callback_period(LinearPoti *linear_poti, uint32_t *ret_period)

Gibt die Periode zurück, wie von linear_poti_set_position_callback_period() gesetzt.

int linear_poti_set_analog_value_callback_period(LinearPoti *linear_poti, uint32_t period)

Setzt die Periode in ms mit welcher der LINEAR_POTI_CALLBACK_ANALOG_VALUE Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der LINEAR_POTI_CALLBACK_ANALOG_VALUE Callback wird nur ausgelöst, wenn sich der Analogwert seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

int linear_poti_get_analog_value_callback_period(LinearPoti *linear_poti, uint32_t *ret_period)

Gibt die Periode zurück, wie von linear_poti_set_analog_value_callback_period() gesetzt.

int linear_poti_set_position_callback_threshold(LinearPoti *linear_poti, char option, uint16_t min, uint16_t max)

Setzt den Schwellwert für den LINEAR_POTI_CALLBACK_POSITION_REACHED Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Position außerhalb der min und max Werte ist
'i' Callback wird ausgelöst, wenn die Position innerhalb der min und max Werte ist
'<' Callback wird ausgelöst, wenn die Position kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Position größer als der min Wert ist (max wird ignoriert)

Der Standardwert ist ('x', 0, 0).

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

  • LINEAR_POTI_THRESHOLD_OPTION_OFF = 'x'
  • LINEAR_POTI_THRESHOLD_OPTION_OUTSIDE = 'o'
  • LINEAR_POTI_THRESHOLD_OPTION_INSIDE = 'i'
  • LINEAR_POTI_THRESHOLD_OPTION_SMALLER = '<'
  • LINEAR_POTI_THRESHOLD_OPTION_GREATER = '>'
int linear_poti_get_position_callback_threshold(LinearPoti *linear_poti, char *ret_option, uint16_t *ret_min, uint16_t *ret_max)

Gibt den Schwellwert zurück, wie von linear_poti_set_position_callback_threshold() gesetzt.

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

  • LINEAR_POTI_THRESHOLD_OPTION_OFF = 'x'
  • LINEAR_POTI_THRESHOLD_OPTION_OUTSIDE = 'o'
  • LINEAR_POTI_THRESHOLD_OPTION_INSIDE = 'i'
  • LINEAR_POTI_THRESHOLD_OPTION_SMALLER = '<'
  • LINEAR_POTI_THRESHOLD_OPTION_GREATER = '>'
int linear_poti_set_analog_value_callback_threshold(LinearPoti *linear_poti, char option, uint16_t min, uint16_t max)

Setzt den Schwellwert für den LINEAR_POTI_CALLBACK_ANALOG_VALUE_REACHED Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn der Analogwert außerhalb der min und max Werte ist
'i' Callback wird ausgelöst, wenn der Analogwert innerhalb der min und max Werte ist
'<' Callback wird ausgelöst, wenn der Analogwert kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn der Analogwert größer als der min Wert ist (max wird ignoriert)

Der Standardwert ist ('x', 0, 0).

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

  • LINEAR_POTI_THRESHOLD_OPTION_OFF = 'x'
  • LINEAR_POTI_THRESHOLD_OPTION_OUTSIDE = 'o'
  • LINEAR_POTI_THRESHOLD_OPTION_INSIDE = 'i'
  • LINEAR_POTI_THRESHOLD_OPTION_SMALLER = '<'
  • LINEAR_POTI_THRESHOLD_OPTION_GREATER = '>'
int linear_poti_get_analog_value_callback_threshold(LinearPoti *linear_poti, char *ret_option, uint16_t *ret_min, uint16_t *ret_max)

Gibt den Schwellwert zurück, wie von linear_poti_set_analog_value_callback_threshold() gesetzt.

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

  • LINEAR_POTI_THRESHOLD_OPTION_OFF = 'x'
  • LINEAR_POTI_THRESHOLD_OPTION_OUTSIDE = 'o'
  • LINEAR_POTI_THRESHOLD_OPTION_INSIDE = 'i'
  • LINEAR_POTI_THRESHOLD_OPTION_SMALLER = '<'
  • LINEAR_POTI_THRESHOLD_OPTION_GREATER = '>'
int linear_poti_set_debounce_period(LinearPoti *linear_poti, uint32_t debounce)

Setzt die Periode in ms mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

Der Standardwert ist 100.

int linear_poti_get_debounce_period(LinearPoti *linear_poti, uint32_t *ret_debounce)

Gibt die Entprellperiode zurück, wie von linear_poti_set_debounce_period() gesetzt.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der Funktion linear_poti_register_callback() durchgeführt werden. Die Parameter bestehen aus dem Geräteobjekt, der Callback ID, der Callback Funktion und optionalen Benutzer Daten:

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

linear_poti_register_callback(&linear_poti, LINEAR_POTI_CALLBACK_EXAMPLE, (void (*)(void))my_callback, NULL);

Die verfügbaren IDs mit den zugehörigen Callback 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.

LINEAR_POTI_CALLBACK_POSITION
void callback(uint16_t position, void *user_data)

Dieser Callback wird mit der Periode, wie gesetzt mit linear_poti_set_position_callback_period(), ausgelöst. Der Parameter ist die Position des Linearpotentiometers.

Der LINEAR_POTI_CALLBACK_POSITION Callback wird nur ausgelöst, wenn sich die Position seit der letzten Auslösung geändert hat.

LINEAR_POTI_CALLBACK_ANALOG_VALUE
void callback(uint16_t value, void *user_data)

Dieser Callback wird mit der Periode, wie gesetzt mit linear_poti_set_analog_value_callback_period(), ausgelöst. Der Parameter ist der Analogwert des Linearpotentiometers.

Der LINEAR_POTI_CALLBACK_ANALOG_VALUE Callback wird nur ausgelöst, wenn sich der Analogwert seit der letzten Auslösung geändert hat.

LINEAR_POTI_CALLBACK_POSITION_REACHED
void callback(uint16_t position, void *user_data)

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von linear_poti_set_position_callback_threshold() gesetzt, erreicht wird. Der Parameter ist die Position des Linearpotentiometers.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit linear_poti_set_debounce_period() gesetzt, ausgelöst.

LINEAR_POTI_CALLBACK_ANALOG_VALUE_REACHED
void callback(uint16_t value, void *user_data)

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von linear_poti_set_analog_value_callback_threshold() gesetzt, erreicht wird. Der Parameter ist der Analogwert des Linearpotentiometers.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit linear_poti_set_debounce_period() gesetzt, ausgelöst.

Konstanten

LINEAR_POTI_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Linear Poti Bricklet zu identifizieren.

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

LINEAR_POTI_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Linear Poti Bricklet dar.