MATLAB/Octave - DC Brick

Dies ist die Beschreibung der MATLAB/Octave API Bindings für den DC Brick. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des DC Brick 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).

Configuration (MATLAB)

Download (matlab_example_configuration.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
30
function matlab_example_configuration()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickDC;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XXYYZZ'; % Change XXYYZZ to the UID of your DC Brick

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

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

    dc.setDriveMode(BrickDC.DRIVE_MODE_DRIVE_COAST);
    dc.setPWMFrequency(10000); % Use PWM frequency of 10 kHz
    dc.setAcceleration(4096); % Slow acceleration (12.5 %/s)
    dc.setVelocity(32767); % Full speed forward (100 %)
    dc.enable(); % Enable motor power

    input('Press key to exit\n', 's');

    % Stop motor before disabling motor power
    dc.setAcceleration(16384); % Fast decceleration (50 %/s) for stopping
    dc.setVelocity(0); % Request motor stop
    pause(2); % Wait for motor to actually stop: velocity (100 %) / decceleration (50 %/s) = 2 s
    dc.disable(); % Disable motor power

    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
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
function matlab_example_callback()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickDC;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XXYYZZ'; % Change XXYYZZ to the UID of your DC Brick

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

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

    % The acceleration has to be smaller or equal to the maximum
    % acceleration of the DC motor, otherwise the velocity reached
    % callback will be called too early
    dc.setAcceleration(4096); % Slow acceleration (12.5 %/s)
    dc.setVelocity(32767); % Full speed forward (100 %)

    % Register velocity reached callback to function cb_velocity_reached
    set(dc, 'VelocityReachedCallback', @(h, e) cb_velocity_reached(e));

    % Enable motor power
    dc.enable();

    input('Press key to exit\n', 's');

    % Stop motor before disabling motor power
    dc.setAcceleration(16384); % Fast decceleration (50 %/s) for stopping
    dc.setVelocity(0); % Request motor stop
    pause(2); % Wait for motor to actually stop: velocity (100 %) / decceleration (50 %/s) = 2 s
    dc.disable(); % Disable motor power

    ipcon.disconnect();
end

% Use velocity reached callback to swing back and forth
% between full speed forward and full speed backward
function cb_velocity_reached(e)
    dc = e.getSource();

    if e.velocity == 32767
        fprintf('Velocity: Full speed forward, now turning backward\n');
        dc.setVelocity(-32767);
    elseif e.velocity == -32767
        fprintf('Velocity: Full speed backward, now turning forward\n');
        dc.setVelocity(32767);
    else
        fprintf('Error\n'); % Can only happen if another program sets velocity
    end
end

Configuration (Octave)

Download (octave_example_configuration.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 octave_example_configuration()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XXYYZZ"; % Change XXYYZZ to the UID of your DC Brick

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

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

    dc.setDriveMode(dc.DRIVE_MODE_DRIVE_COAST);
    dc.setPWMFrequency(10000); % Use PWM frequency of 10 kHz
    dc.setAcceleration(4096); % Slow acceleration (12.5 %/s)
    dc.setVelocity(32767); % Full speed forward (100 %)
    dc.enable(); % Enable motor power

    input("Press key to exit\n", "s");

    % Stop motor before disabling motor power
    dc.setAcceleration(16384); % Fast decceleration (50 %/s) for stopping
    dc.setVelocity(0); % Request motor stop
    pause(2); % Wait for motor to actually stop: velocity (100 %) / decceleration (50 %/s) = 2 s
    dc.disable(); % Disable motor power

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

    HOST = "localhost";
    PORT = 4223;
    UID = "XXYYZZ"; % Change XXYYZZ to the UID of your DC Brick

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

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

    % The acceleration has to be smaller or equal to the maximum
    % acceleration of the DC motor, otherwise the velocity reached
    % callback will be called too early
    dc.setAcceleration(4096); % Slow acceleration (12.5 %/s)
    dc.setVelocity(32767); % Full speed forward (100 %)

    % Register velocity reached callback to function cb_velocity_reached
    dc.addVelocityReachedCallback(@cb_velocity_reached);

    % Enable motor power
    dc.enable();

    input("Press key to exit\n", "s");

    % Stop motor before disabling motor power
    dc.setAcceleration(16384); % Fast decceleration (50 %/s) for stopping
    dc.setVelocity(0); % Request motor stop
    pause(2); % Wait for motor to actually stop: velocity (100 %) / decceleration (50 %/s) = 2 s
    dc.disable(); % Disable motor power

    ipcon.disconnect();
end

% Use velocity reached callback to swing back and forth
% between full speed forward and full speed backward
function cb_velocity_reached(e)
    dc = e.getSource();
    velocity = short2int(e.velocity);

    if velocity == 32767
        fprintf("Velocity: Full speed forward, now turning backward\n");
        dc.setVelocity(-32767);
    elseif velocity == -32767
        fprintf("Velocity: Full speed backward, now turning forward\n");
        dc.setVelocity(32767);
    else
        fprintf("Error\n"); % Can only happen if another program sets velocity
    end
end

function int = java2int(value)
    if compare_versions(version(), "3.8", "<=")
        int = value.intValue();
    else
        int = value;
    end
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 BrickDC(String uid, IPConnection ipcon)
Parameter:
  • uid – Typ: String
  • ipcon – Typ: IPConnection
Rückgabe:
  • dc – Typ: BrickDC

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

In MATLAB:

import com.tinkerforge.BrickDC;

dc = BrickDC("YOUR_DEVICE_UID", ipcon);

In Octave:

dc = java_new("com.tinkerforge.BrickDC", "YOUR_DEVICE_UID", ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

void BrickDC.setVelocity(short velocity)
Parameter:
  • velocity – Typ: short, Einheit: 100/32767 %, Wertebereich: [-215 + 1 bis 215 - 1], Standardwert: 0

Setzt die Geschwindigkeit des Motors. Hierbei sind -32767 maximale Geschwindigkeit rückwärts, 0 ist Halt und 32767 maximale Geschwindigkeit vorwärts. In Abhängigkeit von der Beschleunigung (siehe setAcceleration()) wird der Motor nicht direkt auf die Geschwindigkeit gebracht sondern gleichmäßig beschleunigt.

Die Geschwindigkeit beschreibt das Tastverhältnis der PWM für die Motoransteuerung. Z.B. entspricht ein Geschwindigkeitswert von 3277 einer PWM mit einem Tastverhältnis von 10%. Weiterhin kann neben dem Tastverhältnis auch die Frequenz der PWM verändert werden, siehe setPWMFrequency().

short BrickDC.getVelocity()
Rückgabe:
  • velocity – Typ: short, Einheit: 100/32767 %, Wertebereich: [-215 + 1 bis 215 - 1], Standardwert: 0

Gibt die Geschwindigkeit zurück, wie gesetzt von setVelocity().

short BrickDC.getCurrentVelocity()
Rückgabe:
  • velocity – Typ: short, Einheit: 100/32767 %, Wertebereich: [-215 + 1 bis 215 - 1], Standardwert: 0

Gibt die aktuelle Geschwindigkeit des Motors zurück. Dieser Wert unterscheidet sich von getVelocity(), sobald der Motor auf einen neuen Zielwert, wie von setVelocity() vorgegeben, beschleunigt.

void BrickDC.setAcceleration(int acceleration)
Parameter:
  • acceleration – Typ: int, Einheit: 100/32767 %/s, Wertebereich: [0 bis 216 - 1], Standardwert: 10000

Setzt die Beschleunigung des Motors. Die Einheit dieses Wertes ist Geschwindigkeit/s. Ein Beschleunigungswert von 10000 bedeutet, dass jede Sekunde die Geschwindigkeit um 10000 erhöht wird (entspricht rund 30% Tastverhältnis).

Beispiel: Soll die Geschwindigkeit von 0 auf 16000 (entspricht ungefähr 50% Tastverhältnis) in 10 Sekunden beschleunigt werden, so ist die Beschleunigung auf 1600 einzustellen.

Eine Beschleunigung von 0 bedeutet ein direkter Sprung des Motors auf die Zielgeschwindigkeit. Es Wird keine Beschleunigungsrampe gefahren.

int BrickDC.getAcceleration()
Rückgabe:
  • acceleration – Typ: int, Einheit: 100/32767 %/s, Wertebereich: [0 bis 216 - 1], Standardwert: 10000

Gibt die Beschleunigung zurück, wie gesetzt von setAcceleration().

void BrickDC.fullBrake()

Führt eine aktive Vollbremsung aus.

Warnung

Diese Funktion ist für Notsituationen bestimmt, in denen ein unverzüglicher Halt notwendig ist. Abhängig von der aktuellen Geschwindigkeit und der Kraft des Motors kann eine Vollbremsung brachial sein.

Ein Aufruf von setVelocity() mit 0 erlaubt einen normalen Stopp des Motors.

void BrickDC.enable()

Aktiviert die Treiberstufe. Die Treiberparameter können vor der Aktivierung konfiguriert werden (Geschwindigkeit, Beschleunigung, etc.).

void BrickDC.disable()

Deaktiviert die Treiberstufe. Die Konfiguration (Geschwindigkeit, Beschleunigung, etc.) bleibt erhalten aber der Motor wird nicht angesteuert bis eine erneute Aktivierung erfolgt.

Warnung

Die Treiberstufe zu deaktivieren während der Motor sich noch dreht kann zur Beschädigung der Treiberstufe führen. Der Motor sollte durch Aufrufen von setVelocity() mit 0 gestoppt werden, bevor die Treiberstufe deaktiviert wird. Die setVelocity() Funktion wartet nicht bis der Motor wirklich zum Stillstand gekommen ist. Dazu muss nach dem Aufruf der setVelocity() Funktion eine angemessen Zeit gewartet werden bevor die disable() Funktion aufgerufen wird.

boolean BrickDC.isEnabled()
Rückgabe:
  • enabled – Typ: boolean, Standardwert: false

Gibt true zurück wenn die Treiberstufe aktiv ist, sonst false.

Fortgeschrittene Funktionen

void BrickDC.setPWMFrequency(int frequency)
Parameter:
  • frequency – Typ: int, Einheit: 1 Hz, Wertebereich: [1 bis 20000], Standardwert: 15000

Setzt die Frequenz der PWM, welche den Motor steuert. Oftmals ist eine hohe Frequenz geräuschärmer und der Motor läuft dadurch ruhiger. Trotz dessen führt eine geringe Frequenz zu weniger Schaltvorgängen und somit zu weniger Schaltverlusten. Bei einer Vielzahl von Motoren ermöglichen geringere Frequenzen höhere Drehmomente.

Im Allgemeinen kann diese Funktion ignoriert werden, da der Standardwert höchstwahrscheinlich zu einem akzeptablen Ergebnis führt.

int BrickDC.getPWMFrequency()
Rückgabe:
  • frequency – Typ: int, Einheit: 1 Hz, Wertebereich: [1 bis 20000], Standardwert: 15000

Gibt die PWM Frequenz zurück, wie gesetzt von setPWMFrequency().

int BrickDC.getStackInputVoltage()
Rückgabe:
  • voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

Gibt die Eingangsspannung des Stapels zurück. Die Eingangsspannung des Stapel wird über diesen bereitgestellt und von einer Step-Down oder Step-Up Power Supply erzeugt.

int BrickDC.getExternalInputVoltage()
Rückgabe:
  • voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

Gibt die externe Eingangsspannung zurück. Die externe Eingangsspannung wird über die schwarze Stromversorgungsbuchse, in den DC Brick, eingespeist.

Sobald eine externe Eingangsspannung und die Spannungsversorgung des Stapels anliegt, wird der Motor über die externe Spannung versorgt. Sollte nur die Spannungsversorgung des Stapels verfügbar sein, erfolgt die Versorgung des Motors über diese.

Warnung

Das bedeutet, bei einer hohen Versorgungsspannung des Stapels und einer geringen externen Versorgungsspannung erfolgt die Spannungsversorgung des Motors über die geringere externe Versorgungsspannung. Wenn dann die externe Spannungsversorgung getrennt wird, erfolgt sofort die Versorgung des Motors über die höhere Versorgungsspannung des Stapels.

int BrickDC.getCurrentConsumption()
Rückgabe:
  • voltage – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1]

Gibt die Stromaufnahme des Motors zurück.

void BrickDC.setDriveMode(short mode)
Parameter:
  • mode – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 0

Setzt den Fahrmodus. Verfügbare Modi sind:

  • 0 = Fahren/Bremsen
  • 1 = Fahren/Leerlauf

Diese Modi sind verschiedene Arten der Motoransteuerung.

Im Fahren/Bremsen Modus wird der Motor entweder gefahren oder gebremst. Es gibt keinen Leerlauf. Vorteile sind die lineare Korrelation zwischen PWM und Geschwindigkeit, präzisere Beschleunigungen und die Möglichkeit mit geringeren Geschwindigkeiten zu fahren.

Im Fahren/Leerlauf Modus wir der Motor entweder gefahren oder befindet sich im Leerlauf. Vorteile sind die geringere Stromaufnahme und geringere Belastung des Motors und der Treiberstufe.

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

Für mode:

  • BrickDC.DRIVE_MODE_DRIVE_BRAKE = 0
  • BrickDC.DRIVE_MODE_DRIVE_COAST = 1
short BrickDC.getDriveMode()
Rückgabe:
  • mode – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 0

Gibt den Fahrmodus zurück, wie von setDriveMode() gesetzt.

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

Für mode:

  • BrickDC.DRIVE_MODE_DRIVE_BRAKE = 0
  • BrickDC.DRIVE_MODE_DRIVE_COAST = 1
void BrickDC.setSPITFPBaudrateConfig(boolean enableDynamicBaudrate, long minimumDynamicBaudrate)
Parameter:
  • enableDynamicBaudrate – Typ: boolean, Standardwert: true
  • minimumDynamicBaudrate – Typ: long, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 400000

Das SPITF-Protokoll kann mit einer dynamischen Baudrate genutzt werden. Wenn die dynamische Baudrate aktiviert ist, versucht der Brick die Baudrate anhand des Datenaufkommens zwischen Brick und Bricklet anzupassen.

Die Baudrate wird exponentiell erhöht wenn viele Daten gesendet/empfangen werden und linear verringert wenn wenig Daten gesendet/empfangen werden.

Diese Vorgehensweise verringert die Baudrate in Anwendungen wo nur wenig Daten ausgetauscht werden müssen (z.B. eine Wetterstation) und erhöht die Robustheit. Wenn immer viele Daten ausgetauscht werden (z.B. Thermal Imaging Bricklet), wird die Baudrate automatisch erhöht.

In Fällen wo wenige Daten all paar Sekunden so schnell wie Möglich übertragen werden sollen (z.B. RS485 Bricklet mit hoher Baudrate aber kleinem Payload) kann die dynamische Baudrate zum maximieren der Performance ausgestellt werden.

Die maximale Baudrate kann pro Port mit der Funktion setSPITFPBaudrate(). gesetzt werden. Falls die dynamische Baudrate nicht aktiviert ist, wird die Baudrate wie von setSPITFPBaudrate() gesetzt statisch verwendet.

Neu in Version 2.3.5 (Firmware).

BrickDC.SPITFPBaudrateConfig BrickDC.getSPITFPBaudrateConfig()
Rückgabeobjekt:
  • enableDynamicBaudrate – Typ: boolean, Standardwert: true
  • minimumDynamicBaudrate – Typ: long, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 400000

Gibt die Baudratenkonfiguration zurück, siehe setSPITFPBaudrateConfig().

Neu in Version 2.3.5 (Firmware).

long BrickDC.getSendTimeoutCount(short communicationMethod)
Parameter:
  • communicationMethod – Typ: short, Wertebereich: Siehe Konstanten
Rückgabe:
  • timeoutCount – Typ: long, Wertebereich: [0 bis 232 - 1]

Gibt den Timeout-Zähler für die verschiedenen Kommunikationsmöglichkeiten zurück

Die Kommunikationsmöglichkeiten 0-2 stehen auf allen Bricks zur verfügung, 3-7 nur auf Master Bricks.

Diese Funktion ist hauptsächlich zum debuggen während der Entwicklung gedacht. Im normalen Betrieb sollten alle Zähler fast immer auf 0 stehen bleiben.

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

Für communicationMethod:

  • BrickDC.COMMUNICATION_METHOD_NONE = 0
  • BrickDC.COMMUNICATION_METHOD_USB = 1
  • BrickDC.COMMUNICATION_METHOD_SPI_STACK = 2
  • BrickDC.COMMUNICATION_METHOD_CHIBI = 3
  • BrickDC.COMMUNICATION_METHOD_RS485 = 4
  • BrickDC.COMMUNICATION_METHOD_WIFI = 5
  • BrickDC.COMMUNICATION_METHOD_ETHERNET = 6
  • BrickDC.COMMUNICATION_METHOD_WIFI_V2 = 7

Neu in Version 2.3.3 (Firmware).

void BrickDC.setSPITFPBaudrate(char brickletPort, long baudrate)
Parameter:
  • brickletPort – Typ: char, Wertebereich: ['a' bis 'b']
  • baudrate – Typ: long, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 1400000

Setzt die Baudrate eines spezifischen Bricklet Ports .

Für einen höheren Durchsatz der Bricklets kann die Baudrate erhöht werden. Wenn der Fehlerzähler auf Grund von lokaler Störeinstrahlung hoch ist (siehe getSPITFPErrorCount()) kann die Baudrate verringert werden.

Wenn das Feature der dynamische Baudrate aktiviert ist, setzt diese Funktion die maximale Baudrate (siehe setSPITFPBaudrateConfig()).

EMV Tests werden mit der Standardbaudrate durchgeführt. Falls eine CE-Kompatibilität o.ä. in der Anwendung notwendig ist empfehlen wir die Baudrate nicht zu ändern.

Neu in Version 2.3.3 (Firmware).

long BrickDC.getSPITFPBaudrate(char brickletPort)
Parameter:
  • brickletPort – Typ: char, Wertebereich: ['a' bis 'b']
Rückgabe:
  • baudrate – Typ: long, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 1400000

Gibt die Baudrate für einen Bricklet Port zurück, siehe setSPITFPBaudrate().

Neu in Version 2.3.3 (Firmware).

BrickDC.SPITFPErrorCount BrickDC.getSPITFPErrorCount(char brickletPort)
Parameter:
  • brickletPort – Typ: char, Wertebereich: ['a' bis 'b']
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 Bricks auftreten. Jedes Bricklet hat eine ähnliche Funktion welche die Fehler auf Brickletseite ausgibt.

Neu in Version 2.3.3 (Firmware).

void BrickDC.enableStatusLED()

Aktiviert die Status LED.

Die Status LED ist die blaue LED neben dem USB-Stecker. Wenn diese aktiviert ist, ist sie an und sie flackert wenn Daten transferiert werden. Wenn sie deaktiviert ist, ist sie immer aus.

Der Standardzustand ist aktiviert.

Neu in Version 2.3.1 (Firmware).

void BrickDC.disableStatusLED()

Deaktiviert die Status LED.

Die Status LED ist die blaue LED neben dem USB-Stecker. Wenn diese aktiviert ist, ist sie an und sie flackert wenn Daten transferiert werden. Wenn sie deaktiviert ist, ist sie immer aus.

Der Standardzustand ist aktiviert.

Neu in Version 2.3.1 (Firmware).

boolean BrickDC.isStatusLEDEnabled()
Rückgabe:
  • enabled – Typ: boolean, Standardwert: true

Gibt true zurück wenn die Status LED aktiviert ist, false sonst.

Neu in Version 2.3.1 (Firmware).

short BrickDC.getChipTemperature()
Rückgabe:
  • temperature – Typ: short, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1]

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 Genauigkeit von ±15%. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

void BrickDC.reset()

Ein Aufruf dieser Funktion setzt den Brick zurück. Befindet sich der Brick innerhalb eines Stapels wird der gesamte Stapel zurück gesetzt.

Nach dem Zurücksetzen ist es notwendig neue Geräteobjekte zu erzeugen, Funktionsaufrufe auf bestehende führt zu undefiniertem Verhalten.

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

Gibt die UID, die UID zu der der Brick verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position ist die Position im Stack von '0' (unterster Brick) bis '8' (oberster Brick).

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricks.

Konfigurationsfunktionen für Callbacks

void BrickDC.setMinimumVoltage(int voltage)
Parameter:
  • voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 6000

Setzt die minimale Spannung, bei welcher der UnderVoltageCallback Callback ausgelöst wird. Der kleinste mögliche Wert mit dem der DC Brick noch funktioniert, ist 6V. Mit dieser Funktion kann eine Entladung der versorgenden Batterie detektiert werden. Beim Einsatz einer Netzstromversorgung wird diese Funktionalität höchstwahrscheinlich nicht benötigt.

int BrickDC.getMinimumVoltage()
Rückgabe:
  • voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 6000

Gibt die minimale Spannung zurück, wie von setMinimumVoltage() gesetzt.

void BrickDC.setCurrentVelocityPeriod(int period)
Parameter:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Setzt die Periode mit welcher der CurrentVelocityCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

int BrickDC.getCurrentVelocityPeriod()
Rückgabe:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Gibt die Periode zurück, wie von setCurrentVelocityPeriod() gesetzt.

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 BrickDC.UnderVoltageCallback
Event-Objekt:
  • voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird ausgelöst, wenn die Eingangsspannung unter den, mittels setMinimumVoltage() gesetzten, Schwellwert sinkt. Der Parameter ist die aktuelle Spannung.

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

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

callback BrickDC.EmergencyShutdownCallback
Event-Objekt:
  • leeres Objekt

Dieser Callback wird ausgelöst, wenn entweder der Stromverbrauch (über 5A) oder die Temperatur der Treiberstufe zu hoch ist (über 175°C). Beide Möglichkeiten sind letztendlich gleichbedeutend, da die Temperatur ihren Schwellwert überschreitet sobald der Motor zu viel Strom verbraucht. Im Falle einer Spannung unter 3,3V (Stapel- oder externe Spannungsversorgung) wird dieser Callback auch ausgelöst.

Sobald dieser Callback ausgelöst wird, wird die Treiberstufe deaktiviert. Das bedeutet enable() muss aufgerufen werden, um den Motor erneut zu fahren.

Bemerkung

Dieser Callback funktioniert nur im Fahren/Bremsen Modus (siehe setDriveMode()). Im Fahren/Leerlauf Modus ist es leider nicht möglich das Überstrom/Übertemperatur-Signal zuverlässig aus dem Chip der Treiberstufe auszulesen.

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

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

callback BrickDC.VelocityReachedCallback
Event-Objekt:
  • velocity – Typ: short, Einheit: 100/32767 %, Wertebereich: [-215 + 1 bis 215 - 1]

Dieser Callback wird ausgelöst immer wenn eine konfigurierte Geschwindigkeit erreicht wird. Beispiel: Wenn die aktuelle Geschwindigkeit 0 ist, die Beschleunigung auf 5000 und die Geschwindigkeit auf 10000 konfiguriert ist, wird der VelocityReachedCallback Callback nach ungefähr 2 Sekunden ausgelöst, wenn die konfigurierte Geschwindigkeit letztendlich erreicht ist.

Bemerkung

Da es nicht möglich ist eine Rückmeldung vom Gleichstrommotor zu erhalten, funktioniert dies nur wenn die konfigurierte Beschleunigung (siehe setAcceleration()) kleiner oder gleich der maximalen Beschleunigung des Motors ist. Andernfalls wird der Motor hinter dem Vorgabewert zurückbleiben und der Callback wird zu früh ausgelöst.

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

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

callback BrickDC.CurrentVelocityCallback
Event-Objekt:
  • velocity – Typ: short, Einheit: 100/32767 %, Wertebereich: [-215 + 1 bis 215 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit setCurrentVelocityPeriod(), ausgelöst. Der Parameter ist die aktuelle vom Motor genutzte Geschwindigkeit.

Der CurrentVelocityCallback Callback wird nur nach Ablauf der Periode ausgelöst, wenn sich die Geschwindigkeit geändert hat.

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

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

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.

short[] BrickDC.getAPIVersion()
Rückgabeobjekt:
  • apiVersion – Typ: short[], Länge: 3
    • 1: major – Typ: short, Wertebereich: [0 bis 255]
    • 2: minor – Typ: short, Wertebereich: [0 bis 255]
    • 3: revision – Typ: short, Wertebereich: [0 bis 255]

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.

boolean BrickDC.getResponseExpected(byte functionId)
Parameter:
  • functionId – Typ: byte, 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:

  • BrickDC.FUNCTION_SET_VELOCITY = 1
  • BrickDC.FUNCTION_SET_ACCELERATION = 4
  • BrickDC.FUNCTION_SET_PWM_FREQUENCY = 6
  • BrickDC.FUNCTION_FULL_BRAKE = 8
  • BrickDC.FUNCTION_ENABLE = 12
  • BrickDC.FUNCTION_DISABLE = 13
  • BrickDC.FUNCTION_SET_MINIMUM_VOLTAGE = 15
  • BrickDC.FUNCTION_SET_DRIVE_MODE = 17
  • BrickDC.FUNCTION_SET_CURRENT_VELOCITY_PERIOD = 19
  • BrickDC.FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231
  • BrickDC.FUNCTION_SET_SPITFP_BAUDRATE = 234
  • BrickDC.FUNCTION_ENABLE_STATUS_LED = 238
  • BrickDC.FUNCTION_DISABLE_STATUS_LED = 239
  • BrickDC.FUNCTION_RESET = 243
  • BrickDC.FUNCTION_WRITE_BRICKLET_PLUGIN = 246
void BrickDC.setResponseExpected(byte functionId, boolean responseExpected)
Parameter:
  • functionId – Typ: byte, 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:

  • BrickDC.FUNCTION_SET_VELOCITY = 1
  • BrickDC.FUNCTION_SET_ACCELERATION = 4
  • BrickDC.FUNCTION_SET_PWM_FREQUENCY = 6
  • BrickDC.FUNCTION_FULL_BRAKE = 8
  • BrickDC.FUNCTION_ENABLE = 12
  • BrickDC.FUNCTION_DISABLE = 13
  • BrickDC.FUNCTION_SET_MINIMUM_VOLTAGE = 15
  • BrickDC.FUNCTION_SET_DRIVE_MODE = 17
  • BrickDC.FUNCTION_SET_CURRENT_VELOCITY_PERIOD = 19
  • BrickDC.FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231
  • BrickDC.FUNCTION_SET_SPITFP_BAUDRATE = 234
  • BrickDC.FUNCTION_ENABLE_STATUS_LED = 238
  • BrickDC.FUNCTION_DISABLE_STATUS_LED = 239
  • BrickDC.FUNCTION_RESET = 243
  • BrickDC.FUNCTION_WRITE_BRICKLET_PLUGIN = 246
void BrickDC.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.

Interne Funktionen

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

BrickDC.Protocol1BrickletName BrickDC.getProtocol1BrickletName(char port)
Parameter:
  • port – Typ: char, Wertebereich: ['a' bis 'b']
Rückgabeobjekt:
  • protocolVersion – Typ: short, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: short[], Länge: 3
    • 1: major – Typ: short, Wertebereich: [0 bis 255]
    • 2: minor – Typ: short, Wertebereich: [0 bis 255]
    • 3: revision – Typ: short, Wertebereich: [0 bis 255]
  • name – Typ: String, Länge: bis zu 40

Gibt die Firmware und Protokoll Version und den Namen des Bricklets für einen gegebenen Port zurück.

Der einzige Zweck dieser Funktion ist es, automatischen Flashen von Bricklet v1.x.y Plugins zu ermöglichen.

void BrickDC.writeBrickletPlugin(char port, short offset, short[] chunk)
Parameter:
  • port – Typ: char, Wertebereich: ['a' bis 'b']
  • offset – Typ: short, Wertebereich: [0 bis 255]
  • chunk – Typ: short[], Länge: 32, Wertebereich: [0 bis 255]

Schreibt 32 Bytes Firmware auf das Bricklet, dass am gegebenen Port angeschlossen ist. Die Bytes werden an die Position offset * 32 geschrieben.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

short[] BrickDC.readBrickletPlugin(char port, short offset)
Parameter:
  • port – Typ: char, Wertebereich: ['a' bis 'b']
  • offset – Typ: short, Wertebereich: [0 bis 255]
Rückgabe:
  • chunk – Typ: short[], Länge: 32, Wertebereich: [0 bis 255]

Liest 32 Bytes Firmware vom Bricklet, dass am gegebenen Port angeschlossen ist. Die Bytes werden ab der Position offset * 32 gelesen.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

Konstanten

int BrickDC.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um einen DC Brick 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 BrickDC.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines DC Brick dar.