C/C++ - Tilt Bricklet¶

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
41
42
43
44
45
46

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_tilt.h"

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

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

    // Create device object
    Tilt t;
    tilt_create(&t, 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 tilt state
    uint8_t state;
    if(tilt_get_tilt_state(&t, &state) < 0) {
        fprintf(stderr, "Could not get tilt state, probably timeout\n");
        return 1;
    }

    if(state == TILT_TILT_STATE_CLOSED) {
        printf("Tilt State: Closed\n");
    } else if(state == TILT_TILT_STATE_OPEN) {
        printf("Tilt State: Open\n");
    } else if(state == TILT_TILT_STATE_CLOSED_VIBRATING) {
        printf("Tilt State: Closed Vibrating\n");
    }

    printf("Press key to exit\n");
    getchar();
    tilt_destroy(&t);
    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
50
51
52
53

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_tilt.h"

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

// Callback function for tilt state callback
void cb_tilt_state(uint8_t state, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    if(state == TILT_TILT_STATE_CLOSED) {
        printf("Tilt State: Closed\n");
    } else if(state == TILT_TILT_STATE_OPEN) {
        printf("Tilt State: Open\n");
    } else if(state == TILT_TILT_STATE_CLOSED_VIBRATING) {
        printf("Tilt State: Closed Vibrating\n");
    }
}

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

    // Create device object
    Tilt t;
    tilt_create(&t, 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

    // Enable tilt state callback
    tilt_enable_tilt_state_callback(&t);

    // Register tilt state callback to function cb_tilt_state
    tilt_register_callback(&t,
                           TILT_CALLBACK_TILT_STATE,
                           (void (*)(void))cb_tilt_state,
                           NULL);

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

Grundfunktionen¶

void tilt_create(Tilt *tilt, const char *uid, IPConnection *ipcon)¶

Parameter:	tilt – Typ: Tilt * uid – Typ: const char * ipcon – Typ: IPConnection *

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

Tilt tilt;
tilt_create(&tilt, "YOUR_DEVICE_UID", &ipcon);

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

void tilt_destroy(Tilt *tilt)¶

Parameter:	tilt – Typ: Tilt *

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

int tilt_get_tilt_state(Tilt *tilt, uint8_t *ret_state)¶

Parameter:	tilt – Typ: Tilt *
Ausgabeparameter:	ret_state – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

Gibt den aktuellen Tilt-Zustand zurück. Der Zustand kann folgende Werte annehmen:

• 0 = Closed: Der Ball im Neigungsschalter schließt den Stromkreis.
• 1 = Open: Der Ball im Neigungsschalter schließt den Stromkreis nicht.
• 2 = Closed Vibrating: Der Neigungsschalter ist in Bewegung (schnelle Änderungen zwischen open und close).

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

Für ret_state:

• TILT_TILT_STATE_CLOSED = 0
• TILT_TILT_STATE_OPEN = 1
• TILT_TILT_STATE_CLOSED_VIBRATING = 2

Fortgeschrittene Funktionen¶

int tilt_get_identity(Tilt *tilt, 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:	tilt – Typ: Tilt *
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 216 - 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.

Konfigurationsfunktionen für Callbacks¶

void tilt_register_callback(Tilt *tilt, int16_t callback_id, void (*function)(void), void *user_data)¶

Parameter:	tilt – Typ: Tilt * 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 tilt_enable_tilt_state_callback(Tilt *tilt)¶

Parameter:	tilt – Typ: Tilt *
Rückgabe:	e_code – Typ: int

Aktiviert den TILT_CALLBACK_TILT_STATE Callback.

int tilt_disable_tilt_state_callback(Tilt *tilt)¶

Parameter:	tilt – Typ: Tilt *
Rückgabe:	e_code – Typ: int

Deaktiviert den TILT_CALLBACK_TILT_STATE Callback.

int tilt_is_tilt_state_callback_enabled(Tilt *tilt, bool *ret_enabled)¶

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

Gibt true zurück wenn der TILT_CALLBACK_TILT_STATE Callback aktiviert ist.

Callbacks¶

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

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

tilt_register_callback(&tilt,
                       TILT_CALLBACK_EXAMPLE,
                       (void (*)(void))my_callback,
                       NULL);

Die verfügbaren Konstanten mit den zugehörigen Funktionssignaturen werden weiter unten beschrieben.

TILT_CALLBACK_TILT_STATE¶

void callback(uint8_t state, void *user_data)

Callback-Parameter:	state – Typ: uint8_t, Wertebereich: Siehe Konstanten user_data – Typ: void *

Dieser Callback übergibt den aktuellen Tilt-Status. Der Callback wird aufgerufen wenn sich der Status ändert.

Siehe tilt_get_tilt_state() für eine Beschreibung der Zustände.

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

Für state:

• TILT_TILT_STATE_CLOSED = 0
• TILT_TILT_STATE_OPEN = 1
• TILT_TILT_STATE_CLOSED_VIBRATING = 2

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 tilt_get_api_version(Tilt *tilt, uint8_t ret_api_version[3])¶

Parameter:	tilt – Typ: Tilt *
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 tilt_get_response_expected(Tilt *tilt, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	tilt – Typ: Tilt * 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 tilt_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:

• TILT_FUNCTION_ENABLE_TILT_STATE_CALLBACK = 2
• TILT_FUNCTION_DISABLE_TILT_STATE_CALLBACK = 3

int tilt_set_response_expected(Tilt *tilt, uint8_t function_id, bool response_expected)¶

Parameter:	tilt – Typ: Tilt * 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.

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:

• TILT_FUNCTION_ENABLE_TILT_STATE_CALLBACK = 2
• TILT_FUNCTION_DISABLE_TILT_STATE_CALLBACK = 3

int tilt_set_response_expected_all(Tilt *tilt, bool response_expected)¶

Parameter:	tilt – Typ: Tilt * 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.

Konstanten¶

TILT_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Tilt Bricklet zu identifizieren.

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

TILT_DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Tilt Bricklet dar.