C/C++ - Motion Detector Bricklet 2.0

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

Indicator

Download (example_indicator.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_motion_detector_v2.h"

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

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

    // Create device object
    MotionDetectorV2 md;
    motion_detector_v2_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

    // Turn blue backlight LEDs on (maximum brightness)
    motion_detector_v2_set_indicator(&md, 255, 255, 255);

    printf("Press key to exit\n");
    getchar();
    motion_detector_v2_destroy(&md);
    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
54
55
56
57
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_motion_detector_v2.h"

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

// 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 ~2 seconds)\n");
}

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

    // Create device object
    MotionDetectorV2 md;
    motion_detector_v2_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_v2_register_callback(&md,
                                         MOTION_DETECTOR_V2_CALLBACK_MOTION_DETECTED,
                                         (void (*)(void))cb_motion_detected,
                                         NULL);

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

    printf("Press key to exit\n");
    getchar();
    motion_detector_v2_destroy(&md);
    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 motion_detector_v2_create(MotionDetectorV2 *motion_detector_v2, const char *uid, IPConnection *ipcon)
Parameter:
  • motion_detector_v2 – Typ: MotionDetectorV2 *
  • uid – Typ: const char *
  • ipcon – Typ: IPConnection *

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

MotionDetectorV2 motion_detector_v2;
motion_detector_v2_create(&motion_detector_v2, "YOUR_DEVICE_UID", &ipcon);

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

void motion_detector_v2_destroy(MotionDetectorV2 *motion_detector_v2)
Parameter:
  • motion_detector_v2 – Typ: MotionDetectorV2 *

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

int motion_detector_v2_get_motion_detected(MotionDetectorV2 *motion_detector_v2, uint8_t *ret_motion)
Parameter:
  • motion_detector_v2 – Typ: MotionDetectorV2 *
Ausgabeparameter:
  • ret_motion – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

Gibt 1 zurück wenn eine Bewegung detektiert wurde. 1 wird für ca. 1,8 Sekunden zurückgegeben bevor der Sensor wieder erneut eine Bewegung detektieren kann.

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_V2_MOTION_NOT_DETECTED = 0
  • MOTION_DETECTOR_V2_MOTION_DETECTED = 1
int motion_detector_v2_set_sensitivity(MotionDetectorV2 *motion_detector_v2, uint8_t sensitivity)
Parameter:
  • motion_detector_v2 – Typ: MotionDetectorV2 *
  • sensitivity – Typ: uint8_t, Wertebereich: [0 bis 100], Standardwert: 50
Rückgabe:
  • error_code – Typ: int

Setzt die Empfindlichkeit des PIR Sensors. Bei maximaler Empfindlichkeit (100) kann das Bricklet Bewegung bin in ca. 12m Entfernung erkennen.

Die wirkliche Entfernung hängt von vielen Dingen in der Umgebung ab (z.B. Ruflektionen) und der Größe des zu erkennenden Objekts. Während eine große Person bei 10m erkannt werden kann, wird eine Katze vielleicht erst an 2m erkannt mit den gleichen Einstellungen.

Daher muss die passenden Empfindlichkeit je nach Anwendung experimentell bestimmt werden.

int motion_detector_v2_get_sensitivity(MotionDetectorV2 *motion_detector_v2, uint8_t *ret_sensitivity)
Parameter:
  • motion_detector_v2 – Typ: MotionDetectorV2 *
Ausgabeparameter:
  • ret_sensitivity – Typ: uint8_t, Wertebereich: [0 bis 100], Standardwert: 50
Rückgabe:
  • error_code – Typ: int

Gibt die Empfindlichkeit zurück, wie von motion_detector_v2_set_sensitivity() gesetzt.

int motion_detector_v2_set_indicator(MotionDetectorV2 *motion_detector_v2, uint8_t top_left, uint8_t top_right, uint8_t bottom)
Parameter:
  • motion_detector_v2 – Typ: MotionDetectorV2 *
  • top_left – Typ: uint8_t, Wertebereich: [0 bis 255], Standardwert: 0
  • top_right – Typ: uint8_t, Wertebereich: [0 bis 255], Standardwert: 0
  • bottom – Typ: uint8_t, Wertebereich: [0 bis 255], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

Stellt die blaue Beleuchtung der Fresnel-Linse ein. Die Beleuchtung besteht aus drei LEDs. Die Helligkeit jeder LED kann einzeln mit einem 8-Bit Wert (0-255) eingestellt werden. Ein Wert von 0 deaktiviert die LED und ein Wert von 255 aktiviert die LED mit voller Helligkeit.

int motion_detector_v2_get_indicator(MotionDetectorV2 *motion_detector_v2, uint8_t *ret_top_left, uint8_t *ret_top_right, uint8_t *ret_bottom)
Parameter:
  • motion_detector_v2 – Typ: MotionDetectorV2 *
Ausgabeparameter:
  • ret_top_left – Typ: uint8_t, Wertebereich: [0 bis 255], Standardwert: 0
  • ret_top_right – Typ: uint8_t, Wertebereich: [0 bis 255], Standardwert: 0
  • ret_bottom – Typ: uint8_t, Wertebereich: [0 bis 255], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

Gibt die Indikatorkonfiguration zurück, wie von motion_detector_v2_set_indicator() gesetzt.

Fortgeschrittene Funktionen

int motion_detector_v2_get_spitfp_error_count(MotionDetectorV2 *motion_detector_v2, 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:
  • motion_detector_v2 – Typ: MotionDetectorV2 *
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 motion_detector_v2_set_bootloader_mode(MotionDetectorV2 *motion_detector_v2, uint8_t mode, uint8_t *ret_status)
Parameter:
  • motion_detector_v2 – Typ: MotionDetectorV2 *
  • 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:

  • MOTION_DETECTOR_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • MOTION_DETECTOR_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • MOTION_DETECTOR_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • MOTION_DETECTOR_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • MOTION_DETECTOR_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

  • MOTION_DETECTOR_V2_BOOTLOADER_STATUS_OK = 0
  • MOTION_DETECTOR_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
  • MOTION_DETECTOR_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
  • MOTION_DETECTOR_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • MOTION_DETECTOR_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • MOTION_DETECTOR_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5
int motion_detector_v2_get_bootloader_mode(MotionDetectorV2 *motion_detector_v2, uint8_t *ret_mode)
Parameter:
  • motion_detector_v2 – Typ: MotionDetectorV2 *
Ausgabeparameter:
  • ret_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

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

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

Für ret_mode:

  • MOTION_DETECTOR_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • MOTION_DETECTOR_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • MOTION_DETECTOR_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • MOTION_DETECTOR_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • MOTION_DETECTOR_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
int motion_detector_v2_set_write_firmware_pointer(MotionDetectorV2 *motion_detector_v2, uint32_t pointer)
Parameter:
  • motion_detector_v2 – Typ: MotionDetectorV2 *
  • pointer – Typ: uint32_t, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_code – Typ: int

Setzt den Firmware-Pointer für motion_detector_v2_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 motion_detector_v2_write_firmware(MotionDetectorV2 *motion_detector_v2, uint8_t data[64], uint8_t *ret_status)
Parameter:
  • motion_detector_v2 – Typ: MotionDetectorV2 *
  • 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 motion_detector_v2_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 motion_detector_v2_set_status_led_config(MotionDetectorV2 *motion_detector_v2, uint8_t config)
Parameter:
  • motion_detector_v2 – Typ: MotionDetectorV2 *
  • 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:

  • MOTION_DETECTOR_V2_STATUS_LED_CONFIG_OFF = 0
  • MOTION_DETECTOR_V2_STATUS_LED_CONFIG_ON = 1
  • MOTION_DETECTOR_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • MOTION_DETECTOR_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
int motion_detector_v2_get_status_led_config(MotionDetectorV2 *motion_detector_v2, uint8_t *ret_config)
Parameter:
  • motion_detector_v2 – Typ: MotionDetectorV2 *
Ausgabeparameter:
  • ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:
  • error_code – Typ: int

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

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

Für ret_config:

  • MOTION_DETECTOR_V2_STATUS_LED_CONFIG_OFF = 0
  • MOTION_DETECTOR_V2_STATUS_LED_CONFIG_ON = 1
  • MOTION_DETECTOR_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • MOTION_DETECTOR_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
int motion_detector_v2_get_chip_temperature(MotionDetectorV2 *motion_detector_v2, int16_t *ret_temperature)
Parameter:
  • motion_detector_v2 – Typ: MotionDetectorV2 *
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 motion_detector_v2_reset(MotionDetectorV2 *motion_detector_v2)
Parameter:
  • motion_detector_v2 – Typ: MotionDetectorV2 *
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 motion_detector_v2_write_uid(MotionDetectorV2 *motion_detector_v2, uint32_t uid)
Parameter:
  • motion_detector_v2 – Typ: MotionDetectorV2 *
  • 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 motion_detector_v2_read_uid(MotionDetectorV2 *motion_detector_v2, uint32_t *ret_uid)
Parameter:
  • motion_detector_v2 – Typ: MotionDetectorV2 *
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 motion_detector_v2_get_identity(MotionDetectorV2 *motion_detector_v2, 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_v2 – Typ: MotionDetectorV2 *
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 motion_detector_v2_register_callback(MotionDetectorV2 *motion_detector_v2, int16_t callback_id, void (*function)(void), void *user_data)
Parameter:
  • motion_detector_v2 – Typ: MotionDetectorV2 *
  • 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_v2_register_callback() Funktion durchgeführt werden:

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

motion_detector_v2_register_callback(&motion_detector_v2,
                                     MOTION_DETECTOR_V2_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_V2_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_V2_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_v2_get_api_version(MotionDetectorV2 *motion_detector_v2, uint8_t ret_api_version[3])
Parameter:
  • motion_detector_v2 – Typ: MotionDetectorV2 *
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 motion_detector_v2_get_response_expected(MotionDetectorV2 *motion_detector_v2, uint8_t function_id, bool *ret_response_expected)
Parameter:
  • motion_detector_v2 – Typ: MotionDetectorV2 *
  • 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 motion_detector_v2_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_V2_FUNCTION_SET_SENSITIVITY = 2
  • MOTION_DETECTOR_V2_FUNCTION_SET_INDICATOR = 4
  • MOTION_DETECTOR_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • MOTION_DETECTOR_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • MOTION_DETECTOR_V2_FUNCTION_RESET = 243
  • MOTION_DETECTOR_V2_FUNCTION_WRITE_UID = 248
int motion_detector_v2_set_response_expected(MotionDetectorV2 *motion_detector_v2, uint8_t function_id, bool response_expected)
Parameter:
  • motion_detector_v2 – Typ: MotionDetectorV2 *
  • 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:

  • MOTION_DETECTOR_V2_FUNCTION_SET_SENSITIVITY = 2
  • MOTION_DETECTOR_V2_FUNCTION_SET_INDICATOR = 4
  • MOTION_DETECTOR_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • MOTION_DETECTOR_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • MOTION_DETECTOR_V2_FUNCTION_RESET = 243
  • MOTION_DETECTOR_V2_FUNCTION_WRITE_UID = 248
int motion_detector_v2_set_response_expected_all(MotionDetectorV2 *motion_detector_v2, bool response_expected)
Parameter:
  • motion_detector_v2 – Typ: MotionDetectorV2 *
  • 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

MOTION_DETECTOR_V2_DEVICE_IDENTIFIER

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

Die motion_detector_v2_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_V2_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Motion Detector Bricklet 2.0 dar.