C/C++ - Motion Detector Bricklet¶

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

Callback¶

Download (example_callback.c)

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_motion_detector.h"

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

// Callback function for motion detected callback
void cb_motion_detected(void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Motion Detected\n");
}

// Callback function for detection cycle ended callback
void cb_detection_cycle_ended(void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Detection Cycle Ended (next detection possible in ~3 seconds)\n");
}

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

    // Create device object
    MotionDetector md;
    motion_detector_create(&md, 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 motion detected callback to function cb_motion_detected
    motion_detector_register_callback(&md,
                                      MOTION_DETECTOR_CALLBACK_MOTION_DETECTED,
                                      (void (*)(void))cb_motion_detected,
                                      NULL);

    // Register detection cycle ended callback to function cb_detection_cycle_ended
    motion_detector_register_callback(&md,
                                      MOTION_DETECTOR_CALLBACK_DETECTION_CYCLE_ENDED,
                                      (void (*)(void))cb_detection_cycle_ended,
                                      NULL);

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

API¶

Die meistens Funktionen der C/C++ Bindings geben einen Fehlercode (e_code) zurück. 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 (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
E_WRONG_DEVICE_TYPE = -15
E_DEVICE_REPLACED = -16
E_WRONG_RESPONSE_LENGTH = -17

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen¶

void motion_detector_create(MotionDetector *motion_detector, const char *uid, IPConnection *ipcon)¶

Parameter:	motion_detector – Typ: MotionDetector * uid – Typ: const char * ipcon – Typ: IPConnection *

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

MotionDetector motion_detector;
motion_detector_create(&motion_detector, "YOUR_DEVICE_UID", &ipcon);

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

void motion_detector_destroy(MotionDetector *motion_detector)¶

Parameter:	motion_detector – Typ: MotionDetector *

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

int motion_detector_get_motion_detected(MotionDetector *motion_detector, uint8_t *ret_motion)¶

Parameter:	motion_detector – Typ: MotionDetector *
Ausgabeparameter:	ret_motion – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

Gibt 1 zurück wenn eine Bewegung detektiert wurde. Wie lange 1 zurückgegeben wird nachdem eine Bewegung detektiert wurde kann mit einem kleinen Poti auf dem Motion Detector Bricklet eingestellt werden, siehe hier.

Auf dem Bricklet selbst ist eine blaue LED, die leuchtet solange das Bricklet im "Bewegung detektiert" Zustand ist.

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

Für ret_motion:

MOTION_DETECTOR_MOTION_NOT_DETECTED = 0
MOTION_DETECTOR_MOTION_DETECTED = 1

Fortgeschrittene Funktionen¶

int motion_detector_set_status_led_config(MotionDetector *motion_detector, uint8_t config)¶

Parameter:	motion_detector – Typ: MotionDetector * config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 2
Rückgabe:	e_code – Typ: int

Setzt die Konfiguration der Status-LED.

Standardmäßig geht die LED an, wenn eine Bewegung erkannt wird und aus wenn keine Bewegung erkannt wird.

Die LED kann auch permanent an/aus gestellt werden.

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

Für config:

MOTION_DETECTOR_STATUS_LED_CONFIG_OFF = 0
MOTION_DETECTOR_STATUS_LED_CONFIG_ON = 1
MOTION_DETECTOR_STATUS_LED_CONFIG_SHOW_STATUS = 2

Added in version 2.0.1$nbsp;(Plugin).

int motion_detector_get_status_led_config(MotionDetector *motion_detector, uint8_t *ret_config)¶

Parameter:	motion_detector – Typ: MotionDetector *
Ausgabeparameter:	ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 2
Rückgabe:	e_code – Typ: int

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

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

Für ret_config:

MOTION_DETECTOR_STATUS_LED_CONFIG_OFF = 0
MOTION_DETECTOR_STATUS_LED_CONFIG_ON = 1
MOTION_DETECTOR_STATUS_LED_CONFIG_SHOW_STATUS = 2

Added in version 2.0.1$nbsp;(Plugin).

int motion_detector_get_identity(MotionDetector *motion_detector, 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:	motion_detector – Typ: MotionDetector *
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 2¹⁶ - 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 motion_detector_register_callback(MotionDetector *motion_detector, int16_t callback_id, void (*function)(void), void *user_data)¶

Parameter:	motion_detector – Typ: MotionDetector * 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.

Callbacks¶

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

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

motion_detector_register_callback(&motion_detector,
                                  MOTION_DETECTOR_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.

MOTION_DETECTOR_CALLBACK_MOTION_DETECTED¶

void callback(void *user_data)

Callback-Parameter:	user_data – Typ: void *

Dieser Callback wird aufgerufen nachdem eine Bewegung detektiert wurde.

MOTION_DETECTOR_CALLBACK_DETECTION_CYCLE_ENDED¶

void callback(void *user_data)

Callback-Parameter:	user_data – Typ: void *

Dieser Callback wird aufgerufen wenn ein Bewegungserkennungszyklus beendet ist. Wenn dieser Callback aufgerufen wurde kann wieder eine weitere Bewegung erkannt werden nach ungefähr 2 Sekunden.

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 motion_detector_get_api_version(MotionDetector *motion_detector, uint8_t ret_api_version[3])¶

Parameter:	motion_detector – Typ: MotionDetector *
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 motion_detector_get_response_expected(MotionDetector *motion_detector, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	motion_detector – Typ: MotionDetector * 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 motion_detector_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:

MOTION_DETECTOR_FUNCTION_SET_STATUS_LED_CONFIG = 4

int motion_detector_set_response_expected(MotionDetector *motion_detector, uint8_t function_id, bool response_expected)¶

Parameter:	motion_detector – Typ: MotionDetector * 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.

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

Für function_id:

MOTION_DETECTOR_FUNCTION_SET_STATUS_LED_CONFIG = 4

int motion_detector_set_response_expected_all(MotionDetector *motion_detector, bool response_expected)¶

Parameter:	motion_detector – Typ: MotionDetector * 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¶

MOTION_DETECTOR_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Motion Detector Bricklet zu identifizieren.

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

MOTION_DETECTOR_DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Motion Detector Bricklet dar.