MATLAB/Octave - Distance IR Bricklet 2.0

Dies ist die Beschreibung der MATLAB/Octave API Bindings für das Distance IR Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Distance IR Bricklet 2.0 sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die MATLAB/Octave API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple (MATLAB)

Download (matlab_example_simple.m)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
function matlab_example_simple()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletDistanceIRV2;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your Distance IR Bricklet 2.0

    ipcon = IPConnection(); % Create IP connection
    dir = handle(BrickletDistanceIRV2(UID, ipcon), 'CallbackProperties'); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Get current distance
    distance = dir.getDistance();
    fprintf('Distance: %g cm\n', distance/10.0);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

Callback (MATLAB)

Download (matlab_example_callback.m)

 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
function matlab_example_callback()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletDistanceIRV2;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your Distance IR Bricklet 2.0

    ipcon = IPConnection(); % Create IP connection
    dir = handle(BrickletDistanceIRV2(UID, ipcon), 'CallbackProperties'); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Register distance callback to function cb_distance
    set(dir, 'DistanceCallback', @(h, e) cb_distance(e));

    % Set period for distance callback to 1s (1000ms) without a threshold
    dir.setDistanceCallbackConfiguration(1000, false, 'x', 0, 0);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

% Callback function for distance callback
function cb_distance(e)
    fprintf('Distance: %g cm\n', e.distance/10.0);
end

Threshold (MATLAB)

Download (matlab_example_threshold.m)

 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
function matlab_example_threshold()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletDistanceIRV2;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your Distance IR Bricklet 2.0

    ipcon = IPConnection(); % Create IP connection
    dir = handle(BrickletDistanceIRV2(UID, ipcon), 'CallbackProperties'); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Register distance callback to function cb_distance
    set(dir, 'DistanceCallback', @(h, e) cb_distance(e));

    % Configure threshold for distance "smaller than 30 cm"
    % with a debounce period of 1s (1000ms)
    dir.setDistanceCallbackConfiguration(1000, false, '<', 30*10, 0);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

% Callback function for distance callback
function cb_distance(e)
    fprintf('Distance: %g cm\n', e.distance/10.0);
end

Simple (Octave)

Download (octave_example_simple.m)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
function octave_example_simple()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your Distance IR Bricklet 2.0

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    dir = javaObject("com.tinkerforge.BrickletDistanceIRV2", UID, ipcon); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Get current distance
    distance = dir.getDistance();
    fprintf("Distance: %g cm\n", distance/10.0);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

Callback (Octave)

Download (octave_example_callback.m)

 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
function octave_example_callback()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your Distance IR Bricklet 2.0

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    dir = javaObject("com.tinkerforge.BrickletDistanceIRV2", UID, ipcon); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Register distance callback to function cb_distance
    dir.addDistanceCallback(@cb_distance);

    % Set period for distance callback to 1s (1000ms) without a threshold
    dir.setDistanceCallbackConfiguration(1000, false, "x", 0, 0);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

% Callback function for distance callback
function cb_distance(e)
    fprintf("Distance: %g cm\n", e.distance/10.0);
end

Threshold (Octave)

Download (octave_example_threshold.m)

 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
function octave_example_threshold()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your Distance IR Bricklet 2.0

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    dir = javaObject("com.tinkerforge.BrickletDistanceIRV2", UID, ipcon); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Register distance callback to function cb_distance
    dir.addDistanceCallback(@cb_distance);

    % Configure threshold for distance "smaller than 30 cm"
    % with a debounce period of 1s (1000ms)
    dir.setDistanceCallbackConfiguration(1000, false, "<", 30*10, 0);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

% Callback function for distance callback
function cb_distance(e)
    fprintf("Distance: %g cm\n", e.distance/10.0);
end

API

Prinzipiell kann jede Methode der MATLAB Bindings eine TimeoutException werfen. Diese Exception wird geworfen wenn das Gerät nicht antwortet. Wenn eine Kabelverbindung genutzt wird, ist es unwahrscheinlich, dass die Exception geworfen wird (unter der Annahme, dass das Gerät nicht abgesteckt wird). Bei einer drahtlosen Verbindung können Zeitüberschreitungen auftreten, sobald die Entfernung zum Gerät zu groß wird.

Neben der TimeoutException kann auch noch eine NotConnectedException geworfen werden, wenn versucht wird mit einem Brick oder Bricklet zu kommunizieren, aber die IP Connection nicht verbunden ist.

Da die MATLAB Bindings auf Java basieren und Java nicht mehrere Rückgabewerte unterstützt und eine Referenzrückgabe für elementare Type nicht möglich ist, werden kleine Klassen verwendet, die nur aus Member-Variablen bestehen. Die Member-Variablen des zurückgegebenen Objektes werden in der jeweiligen Methodenbeschreibung erläutert.

Das Package für alle Brick/Bricklet Bindings und die IP Connection ist com.tinkerforge.*

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen

class BrickletDistanceIRV2(String uid, IPConnection ipcon)
Parameter:
  • uid – Typ: String
  • ipcon – Typ: IPConnection
Rückgabe:
  • distanceIRV2 – Typ: BrickletDistanceIRV2

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid.

In MATLAB:

import com.tinkerforge.BrickletDistanceIRV2;

distanceIRV2 = BrickletDistanceIRV2("YOUR_DEVICE_UID", ipcon);

In Octave:

distanceIRV2 = java_new("com.tinkerforge.BrickletDistanceIRV2", "YOUR_DEVICE_UID", ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

int BrickletDistanceIRV2.getDistance()
Rückgabe:
  • distance – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt die gemessene Entfernung des Sensors zurück. Der Wert ist in mm und die möglichen Entfernungsbereiche sind 40 bis 300, 100 bis 800 und 200 bis 1500, in Abhängigkeit vom gewählten IR Sensor.

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

long BrickletDistanceIRV2.getAnalogValue()
Rückgabe:
  • analogValue – Typ: long, Wertebereich: [0 bis 232 - 1]

Gibt den Analogwert des Analog/Digital-Wandler zurück. Der Wert hat 21 Bit und einen Wertebereich von 0 bis 2097151.

Dieser Wert ist ein unverarbeiteter Rohwert. Wir haben sichergestellt, dass die Integrationszeit des ADCs kleiner ist als das Messintervall des Sensors (10ms vs 16,5ms). Dadurch ist sichergestellt das keine Informationen verloren gehen können.

Der Analogwert kann genutzt werden wenn eine eigene Kalibrierung oder Lookup-Tabelle benötigt wird.

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

void BrickletDistanceIRV2.setMovingAverageConfiguration(int movingAverageLength)
Parameter:
  • movingAverageLength – Typ: int, Wertebereich: [0 bis 216 - 1]

Setzt die Länge eines gleitenden Mittelwerts für die Distanz.

Wenn die Länge auf 1 gesetzt wird, ist die Mittelwertbildung deaktiviert. Je kürzer die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

Der Wertebereich liegt bei 1-1000.

Einer neue Wert wird alle ~10ms gemessen. Mit einer Mittelwerts-Länge von 1000 hat das resultierende gleitende Fenster eine Zeitspanne von ca. 10s. Bei Langzeitmessungen gibt ein langer Mittelwert die saubersten Resultate.

Der Standardwert ist 25.

int BrickletDistanceIRV2.getMovingAverageConfiguration()
Rückgabe:
  • movingAverageLength – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt die Moving Average-Konfiguration zurück, wie von setMovingAverageConfiguration() gesetzt.

void BrickletDistanceIRV2.setDistanceLEDConfig(int config)
Parameter:
  • config – Typ: int, Wertebereich: Siehe Konstanten

Konfiguriert die Distanz-LED. Die LED kann ausgeschaltet, eingeschaltet, im Herzschlagmodus betrieben werden. Zusätzlich gibt es die Option mit der LED die Distanz anzuzeigen (heller = Objekt näher).

Der Standardwert ist 3 (Distanzanzeige).

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

Für config:

  • BrickletDistanceIRV2.DISTANCE_LED_CONFIG_OFF = 0
  • BrickletDistanceIRV2.DISTANCE_LED_CONFIG_ON = 1
  • BrickletDistanceIRV2.DISTANCE_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletDistanceIRV2.DISTANCE_LED_CONFIG_SHOW_DISTANCE = 3
int BrickletDistanceIRV2.getDistanceLEDConfig()
Rückgabe:
  • config – Typ: int, Wertebereich: Siehe Konstanten

Gibt die LED-Konfiguration zurück, wie von setDistanceLEDConfig() gesetzt.

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

Für config:

  • BrickletDistanceIRV2.DISTANCE_LED_CONFIG_OFF = 0
  • BrickletDistanceIRV2.DISTANCE_LED_CONFIG_ON = 1
  • BrickletDistanceIRV2.DISTANCE_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletDistanceIRV2.DISTANCE_LED_CONFIG_SHOW_DISTANCE = 3
void BrickletDistanceIRV2.setSensorType(int sensor)
Parameter:
  • sensor – Typ: int, Wertebereich: Siehe Konstanten

Setzt den Sensor-Typ.

Das Bricklet kommt vorkonfiguriert mit dem korrektem Sensor und der Sensor-Typ wird im Flash gespeichert (d.h. das Bricklet behält die Einstellung auch wenn es vom Strom getrennt wird).

Die Einstellung kann im Brick Viewer vorgenommen werden. Diese Funktion sollte in einem externen Programm also nicht ausgeführt werden müssen.

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

Für sensor:

  • BrickletDistanceIRV2.SENSOR_TYPE_2Y0A41 = 0
  • BrickletDistanceIRV2.SENSOR_TYPE_2Y0A21 = 1
  • BrickletDistanceIRV2.SENSOR_TYPE_2Y0A02 = 2
int BrickletDistanceIRV2.getSensorType()
Rückgabe:
  • sensor – Typ: int, Wertebereich: Siehe Konstanten

Gibt den Sensor-Typ zurück, wie von setSensorType() gesetzt.

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

Für sensor:

  • BrickletDistanceIRV2.SENSOR_TYPE_2Y0A41 = 0
  • BrickletDistanceIRV2.SENSOR_TYPE_2Y0A21 = 1
  • BrickletDistanceIRV2.SENSOR_TYPE_2Y0A02 = 2

Fortgeschrittene Funktionen

int[] BrickletDistanceIRV2.getAPIVersion()
Rückgabe:
  • apiVersion – Typ: int[], Länge: 3, Wertebereich: [0 bis 255]

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.

boolean BrickletDistanceIRV2.getResponseExpected(int functionId)
Parameter:
  • functionId – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • responseExpected – Typ: boolean

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 setResponseExpected(). 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 functionId:

  • BrickletDistanceIRV2.FUNCTION_SET_DISTANCE_CALLBACK_CONFIGURATION = 2
  • BrickletDistanceIRV2.FUNCTION_SET_ANALOG_VALUE_CALLBACK_CONFIGURATION = 6
  • BrickletDistanceIRV2.FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION = 9
  • BrickletDistanceIRV2.FUNCTION_SET_DISTANCE_LED_CONFIG = 11
  • BrickletDistanceIRV2.FUNCTION_SET_SENSOR_TYPE = 13
  • BrickletDistanceIRV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletDistanceIRV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletDistanceIRV2.FUNCTION_RESET = 243
  • BrickletDistanceIRV2.FUNCTION_WRITE_UID = 248
void BrickletDistanceIRV2.setResponseExpected(int functionId, boolean responseExpected)
Parameter:
  • functionId – Typ: int, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: boolean

Ä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 functionId:

  • BrickletDistanceIRV2.FUNCTION_SET_DISTANCE_CALLBACK_CONFIGURATION = 2
  • BrickletDistanceIRV2.FUNCTION_SET_ANALOG_VALUE_CALLBACK_CONFIGURATION = 6
  • BrickletDistanceIRV2.FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION = 9
  • BrickletDistanceIRV2.FUNCTION_SET_DISTANCE_LED_CONFIG = 11
  • BrickletDistanceIRV2.FUNCTION_SET_SENSOR_TYPE = 13
  • BrickletDistanceIRV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletDistanceIRV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletDistanceIRV2.FUNCTION_RESET = 243
  • BrickletDistanceIRV2.FUNCTION_WRITE_UID = 248
void BrickletDistanceIRV2.setResponseExpectedAll(boolean responseExpected)
Parameter:
  • responseExpected – Typ: boolean

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

BrickletDistanceIRV2.SPITFPErrorCount BrickletDistanceIRV2.getSPITFPErrorCount()
Rückgabeobjekt:
  • errorCountAckChecksum – Typ: long, Wertebereich: [0 bis 232 - 1]
  • errorCountMessageChecksum – Typ: long, Wertebereich: [0 bis 232 - 1]
  • errorCountFrame – Typ: long, Wertebereich: [0 bis 232 - 1]
  • errorCountOverflow – Typ: long, Wertebereich: [0 bis 232 - 1]

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 BrickletDistanceIRV2.setBootloaderMode(int mode)
Parameter:
  • mode – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • status – Typ: int, Wertebereich: Siehe Konstanten

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 Bootlodaer- 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:

  • BrickletDistanceIRV2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletDistanceIRV2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletDistanceIRV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletDistanceIRV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletDistanceIRV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

  • BrickletDistanceIRV2.BOOTLOADER_STATUS_OK = 0
  • BrickletDistanceIRV2.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletDistanceIRV2.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletDistanceIRV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletDistanceIRV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletDistanceIRV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5
int BrickletDistanceIRV2.getBootloaderMode()
Rückgabe:
  • mode – Typ: int, Wertebereich: Siehe Konstanten

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

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

Für mode:

  • BrickletDistanceIRV2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletDistanceIRV2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletDistanceIRV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletDistanceIRV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletDistanceIRV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
void BrickletDistanceIRV2.setWriteFirmwarePointer(long pointer)
Parameter:
  • pointer – Typ: long, Wertebereich: [0 bis 232 - 1]

Setzt den Firmware-Pointer für writeFirmware(). 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 BrickletDistanceIRV2.writeFirmware(int[] data)
Parameter:
  • data – Typ: int[], Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:
  • status – Typ: int, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von setWriteFirmwarePointer() 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.

void BrickletDistanceIRV2.setStatusLEDConfig(int config)
Parameter:
  • config – Typ: int, Wertebereich: Siehe Konstanten

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:

  • BrickletDistanceIRV2.STATUS_LED_CONFIG_OFF = 0
  • BrickletDistanceIRV2.STATUS_LED_CONFIG_ON = 1
  • BrickletDistanceIRV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletDistanceIRV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletDistanceIRV2.getStatusLEDConfig()
Rückgabe:
  • config – Typ: int, Wertebereich: Siehe Konstanten

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

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

Für config:

  • BrickletDistanceIRV2.STATUS_LED_CONFIG_OFF = 0
  • BrickletDistanceIRV2.STATUS_LED_CONFIG_ON = 1
  • BrickletDistanceIRV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletDistanceIRV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletDistanceIRV2.getChipTemperature()
Rückgabe:
  • temperature – Typ: int, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur in °C, 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.

void BrickletDistanceIRV2.reset()

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.

void BrickletDistanceIRV2.writeUID(long uid)
Parameter:
  • uid – Typ: long, Wertebereich: [0 bis 232 - 1]

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.

long BrickletDistanceIRV2.readUID()
Rückgabe:
  • uid – Typ: long, Wertebereich: [0 bis 232 - 1]

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

BrickletDistanceIRV2.Identity BrickletDistanceIRV2.getIdentity()
Rückgabeobjekt:
  • uid – Typ: String, Länge: bis zu 8
  • connectedUid – Typ: String, Länge: bis zu 8
  • position – Typ: char
  • hardwareVersion – Typ: int[], Länge: 3, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: int[], Länge: 3, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: int, Wertebereich: [0 bis 216 - 1]

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 BrickletDistanceIRV2.setDistanceCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max)
Parameter:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: boolean, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Wertebereich: [0 bis 216 - 1]
  • max – Typ: int, Wertebereich: [0 bis 216 - 1]

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

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

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

Für option:

  • BrickletDistanceIRV2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletDistanceIRV2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletDistanceIRV2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletDistanceIRV2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletDistanceIRV2.THRESHOLD_OPTION_GREATER = '>'
BrickletDistanceIRV2.DistanceCallbackConfiguration BrickletDistanceIRV2.getDistanceCallbackConfiguration()
Rückgabeobjekt:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: boolean, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Wertebereich: [0 bis 216 - 1]
  • max – Typ: int, Wertebereich: [0 bis 216 - 1]

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

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

Für option:

  • BrickletDistanceIRV2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletDistanceIRV2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletDistanceIRV2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletDistanceIRV2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletDistanceIRV2.THRESHOLD_OPTION_GREATER = '>'
void BrickletDistanceIRV2.setAnalogValueCallbackConfiguration(long period, boolean valueHasToChange, char option, long min, long max)
Parameter:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: boolean, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: long, Wertebereich: [0 bis 232 - 1]
  • max – Typ: long, Wertebereich: [0 bis 232 - 1]

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

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

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

Für option:

  • BrickletDistanceIRV2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletDistanceIRV2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletDistanceIRV2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletDistanceIRV2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletDistanceIRV2.THRESHOLD_OPTION_GREATER = '>'
BrickletDistanceIRV2.AnalogValueCallbackConfiguration BrickletDistanceIRV2.getAnalogValueCallbackConfiguration()
Rückgabeobjekt:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: boolean, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: long, Wertebereich: [0 bis 232 - 1]
  • max – Typ: long, Wertebereich: [0 bis 232 - 1]

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

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

Für option:

  • BrickletDistanceIRV2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletDistanceIRV2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletDistanceIRV2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletDistanceIRV2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletDistanceIRV2.THRESHOLD_OPTION_GREATER = '>'

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung wird mit MATLABs "set" Funktion durchgeführt. Die Parameter sind ein Gerätobjekt, der Callback-Name und die Callback-Funktion. Hier ein Beispiel in MATLAB:

function my_callback(e)
    fprintf('Parameter: %s\n', e.param);
end

set(device, 'ExampleCallback', @(h, e) my_callback(e));

Die Octave Java Unterstützung unterscheidet sich hier von MATLAB, die "set" Funktion kann hier nicht verwendet werden. Die Registrierung wird in Octave mit "add*Callback" Funktionen des Gerätobjekts durchgeführt. Hier ein Beispiel in Octave:

function my_callback(e)
    fprintf("Parameter: %s\n", e.param);
end

device.addExampleCallback(@my_callback);

Es ist möglich mehrere Callback-Funktion hinzuzufügen und auch mit einem korrespondierenden "remove*Callback" wieder zu entfernen.

Die Parameter des Callbacks werden der Callback-Funktion als Felder der Struktur e übergeben. Diese ist von der java.util.EventObject Klasse abgeleitete. Die verfügbaren Callback-Namen mit den entsprechenden Strukturfeldern werden unterhalb 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.

callback BrickletDistanceIRV2.DistanceCallback
Event-Objekt:
  • distance – Typ: int, Wertebereich: [0 bis 216 - 1]

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

Der Parameter ist der gleiche wie getDistance().

In MATLAB kann die set() Function verwendet werden um diesem Callback eine Callback-Function zuzuweisen.

In Octave kann diesem Callback mit addDistanceCallback() eine Callback-Function hinzugefügt werde. Eine hinzugefügter Callback-Function kann mit removeDistanceCallback() wieder entfernt werden.

callback BrickletDistanceIRV2.AnalogValueCallback
Event-Objekt:
  • analogValue – Typ: long, Wertebereich: [0 bis 232 - 1]

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

Der Parameter ist der gleiche wie getAnalogValue().

In MATLAB kann die set() Function verwendet werden um diesem Callback eine Callback-Function zuzuweisen.

In Octave kann diesem Callback mit addAnalogValueCallback() eine Callback-Function hinzugefügt werde. Eine hinzugefügter Callback-Function kann mit removeAnalogValueCallback() wieder entfernt werden.

Konstanten

int BrickletDistanceIRV2.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Distance IR Bricklet 2.0 zu identifizieren.

Die getIdentity() Funktion und der IPConnection.EnumerateCallback Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

String BrickletDistanceIRV2.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Distance IR Bricklet 2.0 dar.