C/C++ - Motorized Linear Poti Bricklet

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

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

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

    // Create device object
    MotorizedLinearPoti mlp;
    motorized_linear_poti_create(&mlp, 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(motorized_linear_poti_get_position(&mlp, &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();
    motorized_linear_poti_destroy(&mlp);
    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
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_motorized_linear_poti.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Motorized 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
    MotorizedLinearPoti mlp;
    motorized_linear_poti_create(&mlp, 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
    motorized_linear_poti_register_callback(&mlp,
                                            MOTORIZED_LINEAR_POTI_CALLBACK_POSITION,
                                            (void (*)(void))cb_position,
                                            NULL);

    // Set period for position callback to 0.05s (50ms) without a threshold
    motorized_linear_poti_set_position_callback_configuration(&mlp, 50, false, 'x', 0, 0);

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

Motor

Download (example_motor.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_motorized_linear_poti.h"

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

// Callback function for position reached callback
void cb_position_reached(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
    MotorizedLinearPoti mlp;
    motorized_linear_poti_create(&mlp, 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 reached callback to function cb_position_reached
    motorized_linear_poti_register_callback(&mlp,
                                            MOTORIZED_LINEAR_POTI_CALLBACK_POSITION_REACHED,
                                            (void (*)(void))cb_position_reached,
                                            NULL);

    // Move slider smooth to the middle
    motorized_linear_poti_set_motor_position(&mlp, 50,
                                             MOTORIZED_LINEAR_POTI_DRIVE_MODE_SMOOTH,
                                             false);

    printf("Press key to exit\n");
    getchar();
    motorized_linear_poti_destroy(&mlp);
    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 motorized_linear_poti_create(MotorizedLinearPoti *motorized_linear_poti, const char *uid, IPConnection *ipcon)
Parameter:
  • motorized_linear_poti – Typ: MotorizedLinearPoti *
  • uid – Typ: const char *
  • ipcon – Typ: IPConnection *

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

MotorizedLinearPoti motorized_linear_poti;
motorized_linear_poti_create(&motorized_linear_poti, "YOUR_DEVICE_UID", &ipcon);

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

void motorized_linear_poti_destroy(MotorizedLinearPoti *motorized_linear_poti)
Parameter:
  • motorized_linear_poti – Typ: MotorizedLinearPoti *

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

int motorized_linear_poti_get_position(MotorizedLinearPoti *motorized_linear_poti, uint16_t *ret_position)
Parameter:
  • motorized_linear_poti – Typ: MotorizedLinearPoti *
Ausgabeparameter:
  • ret_position – Typ: uint16_t, Wertebereich: [0 bis 100]
Rückgabe:
  • error_code – Typ: int

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

Wenn der Wert periodisch benötigt wird, kann auch der MOTORIZED_LINEAR_POTI_CALLBACK_POSITION Callback verwendet werden. Der Callback wird mit der Funktion motorized_linear_poti_set_position_callback_configuration() konfiguriert.

int motorized_linear_poti_set_motor_position(MotorizedLinearPoti *motorized_linear_poti, uint16_t position, uint8_t drive_mode, bool hold_position)
Parameter:
  • motorized_linear_poti – Typ: MotorizedLinearPoti *
  • position – Typ: uint16_t, Wertebereich: [0 bis 100]
  • drive_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • hold_position – Typ: bool
Rückgabe:
  • error_code – Typ: int

Setzt die Position des Potentiometers. Nach Aufruf der Funktion wird das Potentiometer sofort diese Position anfahren. Abhängig von dem gewählten Drive Mode wird die Position entweder so schnell wie möglich angefahren oder langsam dafür aber gleichmäßig (smooth).

Die Position kann zwischen 0 (Regler unten) und 100 (Regler oben) festgelegt werden.

Wenn der Hold Position Parameter auf True gesetzt wird, wird die Position automatisch gehalten. Wenn ein Nutzer die Position ändert, fährt das Potentiometer die alte Position anschließend wieder an.

Wenn der Hold Position Parameter auf False gesetzt wird, kann die Position vom Nutzer geändert werden, nachdem die Sollposition erreicht wurde.

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

Für drive_mode:

  • MOTORIZED_LINEAR_POTI_DRIVE_MODE_FAST = 0
  • MOTORIZED_LINEAR_POTI_DRIVE_MODE_SMOOTH = 1
int motorized_linear_poti_get_motor_position(MotorizedLinearPoti *motorized_linear_poti, uint16_t *ret_position, uint8_t *ret_drive_mode, bool *ret_hold_position, bool *ret_position_reached)
Parameter:
  • motorized_linear_poti – Typ: MotorizedLinearPoti *
Ausgabeparameter:
  • ret_position – Typ: uint16_t, Wertebereich: [0 bis 100]
  • ret_drive_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • ret_hold_position – Typ: bool
  • ret_position_reached – Typ: bool
Rückgabe:
  • error_code – Typ: int

Gibt die letzte Motor Position, die mittels motorized_linear_poti_set_motor_position() gesetzt wurde zurück. Dies ist nicht die aktuelle Position des Potentiometers (dafür ist motorized_linear_poti_get_position() gedacht). Zusätzlich wird die letzte Konfiguration zurückgegeben.

Der Position Reached Parameter ist True, wenn der letzte Sollwert (Motor Position) erreicht wurde. Die reale Position könnte sich seitdem jedoch geändert haben.

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

Für ret_drive_mode:

  • MOTORIZED_LINEAR_POTI_DRIVE_MODE_FAST = 0
  • MOTORIZED_LINEAR_POTI_DRIVE_MODE_SMOOTH = 1

Fortgeschrittene Funktionen

int motorized_linear_poti_calibrate(MotorizedLinearPoti *motorized_linear_poti)
Parameter:
  • motorized_linear_poti – Typ: MotorizedLinearPoti *
Rückgabe:
  • error_code – Typ: int

Startet die Kalibrierung. Das Potentiometer fährt dabei die Extrempunkte an.

Die Kalibrierung wird im internen Flash gespeichert und muss nicht bei jedem Start neu durchgeführt werden.

Das Motorized Linear Poti Bricklet wird von Tinkerforge während des Funktionstests kalibriert.

int motorized_linear_poti_get_spitfp_error_count(MotorizedLinearPoti *motorized_linear_poti, 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:
  • motorized_linear_poti – Typ: MotorizedLinearPoti *
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 motorized_linear_poti_set_bootloader_mode(MotorizedLinearPoti *motorized_linear_poti, uint8_t mode, uint8_t *ret_status)
Parameter:
  • motorized_linear_poti – Typ: MotorizedLinearPoti *
  • 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 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:

  • MOTORIZED_LINEAR_POTI_BOOTLOADER_MODE_BOOTLOADER = 0
  • MOTORIZED_LINEAR_POTI_BOOTLOADER_MODE_FIRMWARE = 1
  • MOTORIZED_LINEAR_POTI_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • MOTORIZED_LINEAR_POTI_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • MOTORIZED_LINEAR_POTI_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

  • MOTORIZED_LINEAR_POTI_BOOTLOADER_STATUS_OK = 0
  • MOTORIZED_LINEAR_POTI_BOOTLOADER_STATUS_INVALID_MODE = 1
  • MOTORIZED_LINEAR_POTI_BOOTLOADER_STATUS_NO_CHANGE = 2
  • MOTORIZED_LINEAR_POTI_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • MOTORIZED_LINEAR_POTI_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • MOTORIZED_LINEAR_POTI_BOOTLOADER_STATUS_CRC_MISMATCH = 5
int motorized_linear_poti_get_bootloader_mode(MotorizedLinearPoti *motorized_linear_poti, uint8_t *ret_mode)
Parameter:
  • motorized_linear_poti – Typ: MotorizedLinearPoti *
Ausgabeparameter:
  • ret_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

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

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

Für ret_mode:

  • MOTORIZED_LINEAR_POTI_BOOTLOADER_MODE_BOOTLOADER = 0
  • MOTORIZED_LINEAR_POTI_BOOTLOADER_MODE_FIRMWARE = 1
  • MOTORIZED_LINEAR_POTI_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • MOTORIZED_LINEAR_POTI_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • MOTORIZED_LINEAR_POTI_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
int motorized_linear_poti_set_write_firmware_pointer(MotorizedLinearPoti *motorized_linear_poti, uint32_t pointer)
Parameter:
  • motorized_linear_poti – Typ: MotorizedLinearPoti *
  • pointer – Typ: uint32_t, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_code – Typ: int

Setzt den Firmware-Pointer für motorized_linear_poti_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 motorized_linear_poti_write_firmware(MotorizedLinearPoti *motorized_linear_poti, uint8_t data[64], uint8_t *ret_status)
Parameter:
  • motorized_linear_poti – Typ: MotorizedLinearPoti *
  • 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 motorized_linear_poti_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 motorized_linear_poti_set_status_led_config(MotorizedLinearPoti *motorized_linear_poti, uint8_t config)
Parameter:
  • motorized_linear_poti – Typ: MotorizedLinearPoti *
  • config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
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:

  • MOTORIZED_LINEAR_POTI_STATUS_LED_CONFIG_OFF = 0
  • MOTORIZED_LINEAR_POTI_STATUS_LED_CONFIG_ON = 1
  • MOTORIZED_LINEAR_POTI_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • MOTORIZED_LINEAR_POTI_STATUS_LED_CONFIG_SHOW_STATUS = 3
int motorized_linear_poti_get_status_led_config(MotorizedLinearPoti *motorized_linear_poti, uint8_t *ret_config)
Parameter:
  • motorized_linear_poti – Typ: MotorizedLinearPoti *
Ausgabeparameter:
  • ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:
  • error_code – Typ: int

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

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

Für ret_config:

  • MOTORIZED_LINEAR_POTI_STATUS_LED_CONFIG_OFF = 0
  • MOTORIZED_LINEAR_POTI_STATUS_LED_CONFIG_ON = 1
  • MOTORIZED_LINEAR_POTI_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • MOTORIZED_LINEAR_POTI_STATUS_LED_CONFIG_SHOW_STATUS = 3
int motorized_linear_poti_get_chip_temperature(MotorizedLinearPoti *motorized_linear_poti, int16_t *ret_temperature)
Parameter:
  • motorized_linear_poti – Typ: MotorizedLinearPoti *
Ausgabeparameter:
  • ret_temperature – Typ: int16_t, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]
Rückgabe:
  • error_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 motorized_linear_poti_reset(MotorizedLinearPoti *motorized_linear_poti)
Parameter:
  • motorized_linear_poti – Typ: MotorizedLinearPoti *
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 motorized_linear_poti_write_uid(MotorizedLinearPoti *motorized_linear_poti, uint32_t uid)
Parameter:
  • motorized_linear_poti – Typ: MotorizedLinearPoti *
  • 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 motorized_linear_poti_read_uid(MotorizedLinearPoti *motorized_linear_poti, uint32_t *ret_uid)
Parameter:
  • motorized_linear_poti – Typ: MotorizedLinearPoti *
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 motorized_linear_poti_get_identity(MotorizedLinearPoti *motorized_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)
Parameter:
  • motorized_linear_poti – Typ: MotorizedLinearPoti *
Ausgabeparameter:
  • ret_uid – Typ: char[8]
  • ret_connected_uid – Typ: char[8]
  • ret_position – Typ: char, Wertebereich: ['a' bis 'h', 'i', '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 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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das 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.

Konfigurationsfunktionen für Callbacks

void motorized_linear_poti_register_callback(MotorizedLinearPoti *motorized_linear_poti, int16_t callback_id, void (*function)(void), void *user_data)
Parameter:
  • motorized_linear_poti – Typ: MotorizedLinearPoti *
  • 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 motorized_linear_poti_set_position_callback_configuration(MotorizedLinearPoti *motorized_linear_poti, uint32_t period, bool value_has_to_change, char option, uint16_t min, uint16_t max)
Parameter:
  • motorized_linear_poti – Typ: MotorizedLinearPoti *
  • period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: uint16_t, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: uint16_t, Wertebereich: [0 bis 216 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

Die Periode ist die Periode mit der der MOTORIZED_LINEAR_POTI_CALLBACK_POSITION 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.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den MOTORIZED_LINEAR_POTI_CALLBACK_POSITION Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

Für option:

  • MOTORIZED_LINEAR_POTI_THRESHOLD_OPTION_OFF = 'x'
  • MOTORIZED_LINEAR_POTI_THRESHOLD_OPTION_OUTSIDE = 'o'
  • MOTORIZED_LINEAR_POTI_THRESHOLD_OPTION_INSIDE = 'i'
  • MOTORIZED_LINEAR_POTI_THRESHOLD_OPTION_SMALLER = '<'
  • MOTORIZED_LINEAR_POTI_THRESHOLD_OPTION_GREATER = '>'
int motorized_linear_poti_get_position_callback_configuration(MotorizedLinearPoti *motorized_linear_poti, uint32_t *ret_period, bool *ret_value_has_to_change, char *ret_option, uint16_t *ret_min, uint16_t *ret_max)
Parameter:
  • motorized_linear_poti – Typ: MotorizedLinearPoti *
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
  • ret_option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • ret_min – Typ: uint16_t, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • ret_max – Typ: uint16_t, Wertebereich: [0 bis 216 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

Gibt die Callback-Konfiguration zurück, wie mittels motorized_linear_poti_set_position_callback_configuration() gesetzt.

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

Für ret_option:

  • MOTORIZED_LINEAR_POTI_THRESHOLD_OPTION_OFF = 'x'
  • MOTORIZED_LINEAR_POTI_THRESHOLD_OPTION_OUTSIDE = 'o'
  • MOTORIZED_LINEAR_POTI_THRESHOLD_OPTION_INSIDE = 'i'
  • MOTORIZED_LINEAR_POTI_THRESHOLD_OPTION_SMALLER = '<'
  • MOTORIZED_LINEAR_POTI_THRESHOLD_OPTION_GREATER = '>'
int motorized_linear_poti_set_position_reached_callback_configuration(MotorizedLinearPoti *motorized_linear_poti, bool enabled)
Parameter:
  • motorized_linear_poti – Typ: MotorizedLinearPoti *
  • enabled – Typ: bool, Standardwert: true
Rückgabe:
  • error_code – Typ: int

Aktiviert/Deaktiviert den MOTORIZED_LINEAR_POTI_CALLBACK_POSITION_REACHED Callback.

int motorized_linear_poti_get_position_reached_callback_configuration(MotorizedLinearPoti *motorized_linear_poti, bool *ret_enabled)
Parameter:
  • motorized_linear_poti – Typ: MotorizedLinearPoti *
Ausgabeparameter:
  • ret_enabled – Typ: bool, Standardwert: true
Rückgabe:
  • error_code – Typ: int

Gibt die MOTORIZED_LINEAR_POTI_CALLBACK_POSITION_REACHED Callback Konfiguration zurück, wie von motorized_linear_poti_set_position_reached_callback_configuration() gesetzt.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der motorized_linear_poti_register_callback() Funktion durchgeführt werden:

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

motorized_linear_poti_register_callback(&motorized_linear_poti,
                                        MOTORIZED_LINEAR_POTI_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.

MOTORIZED_LINEAR_POTI_CALLBACK_POSITION
void callback(uint16_t position, void *user_data)
Callback-Parameter:
  • position – Typ: uint16_t, Wertebereich: [0 bis 100]
  • user_data – Typ: void *

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

Der Parameter ist der gleiche wie motorized_linear_poti_get_position().

MOTORIZED_LINEAR_POTI_CALLBACK_POSITION_REACHED
void callback(uint16_t position, void *user_data)
Callback-Parameter:
  • position – Typ: uint16_t, Wertebereich: [0 bis 100]
  • user_data – Typ: void *

Dieser Callback wird ausgelöst, wenn die mittels motorized_linear_poti_set_motor_position() gesetzte Position erreicht wird.

Der Parameter ist die aktuelle Position.

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 motorized_linear_poti_get_api_version(MotorizedLinearPoti *motorized_linear_poti, uint8_t ret_api_version[3])
Parameter:
  • motorized_linear_poti – Typ: MotorizedLinearPoti *
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:
  • error_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 motorized_linear_poti_get_response_expected(MotorizedLinearPoti *motorized_linear_poti, uint8_t function_id, bool *ret_response_expected)
Parameter:
  • motorized_linear_poti – Typ: MotorizedLinearPoti *
  • 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 motorized_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:

Für function_id:

  • MOTORIZED_LINEAR_POTI_FUNCTION_SET_POSITION_CALLBACK_CONFIGURATION = 2
  • MOTORIZED_LINEAR_POTI_FUNCTION_SET_MOTOR_POSITION = 5
  • MOTORIZED_LINEAR_POTI_FUNCTION_CALIBRATE = 7
  • MOTORIZED_LINEAR_POTI_FUNCTION_SET_POSITION_REACHED_CALLBACK_CONFIGURATION = 8
  • MOTORIZED_LINEAR_POTI_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • MOTORIZED_LINEAR_POTI_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • MOTORIZED_LINEAR_POTI_FUNCTION_RESET = 243
  • MOTORIZED_LINEAR_POTI_FUNCTION_WRITE_UID = 248
int motorized_linear_poti_set_response_expected(MotorizedLinearPoti *motorized_linear_poti, uint8_t function_id, bool response_expected)
Parameter:
  • motorized_linear_poti – Typ: MotorizedLinearPoti *
  • 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:

  • MOTORIZED_LINEAR_POTI_FUNCTION_SET_POSITION_CALLBACK_CONFIGURATION = 2
  • MOTORIZED_LINEAR_POTI_FUNCTION_SET_MOTOR_POSITION = 5
  • MOTORIZED_LINEAR_POTI_FUNCTION_CALIBRATE = 7
  • MOTORIZED_LINEAR_POTI_FUNCTION_SET_POSITION_REACHED_CALLBACK_CONFIGURATION = 8
  • MOTORIZED_LINEAR_POTI_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • MOTORIZED_LINEAR_POTI_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • MOTORIZED_LINEAR_POTI_FUNCTION_RESET = 243
  • MOTORIZED_LINEAR_POTI_FUNCTION_WRITE_UID = 248
int motorized_linear_poti_set_response_expected_all(MotorizedLinearPoti *motorized_linear_poti, bool response_expected)
Parameter:
  • motorized_linear_poti – Typ: MotorizedLinearPoti *
  • 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.

Konstanten

MOTORIZED_LINEAR_POTI_DEVICE_IDENTIFIER

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

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

MOTORIZED_LINEAR_POTI_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Motorized Linear Poti Bricklet dar.