MATLAB/Octave - Servo Brick

Dies ist die Beschreibung der MATLAB/Octave API Bindings für den Servo Brick. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Servo 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
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
function matlab_example_configuration()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickServo;

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

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

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

    % Configure two servos with voltage 5.5V
    % Servo 1: Connected to port 0, period of 19.5ms, pulse width of 1 to 2ms
    %          and operating angle -100 to 100°
    %
    % Servo 2: Connected to port 5, period of 20ms, pulse width of 0.95
    %          to 1.95ms and operating angle -90 to 90°
    servo.setOutputVoltage(5500);

    servo.setDegree(0, -10000, 10000);
    servo.setPulseWidth(0, 1000, 2000);
    servo.setPeriod(0, 19500);
    servo.setAcceleration(0, 1000); % Slow acceleration
    servo.setVelocity(0, 65535); % Full speed

    servo.setDegree(5, -9000, 9000);
    servo.setPulseWidth(5, 950, 1950);
    servo.setPeriod(5, 20000);
    servo.setAcceleration(5, 65535); % Full acceleration
    servo.setVelocity(5, 65535); % Full speed

    servo.setPosition(0, 10000); % Set to most right position
    servo.enable(0);

    servo.setPosition(5, -9000); % Set to most left position
    servo.enable(5);

    input('Press key to exit\n', 's');
    servo.disable(0);
    servo.disable(5);
    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
function matlab_example_callback()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickServo;

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

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

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

    % Register position reached callback to function cb_position_reached
    set(servo, 'PositionReachedCallback', @(h, e) cb_position_reached(e));

    % Enable position reached callback
    servo.enablePositionReachedCallback();

    % Set velocity to 100°/s. This has to be smaller or equal to the
    % maximum velocity of the servo you are using, otherwise the position
    % reached callback will be called too early
    servo.setVelocity(0, 10000);
    servo.setPosition(0, 9000);
    servo.enable(0);

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

% Use position reached callback to swing back and forth
function cb_position_reached(e)
    servo = e.getSource();

    if e.position == 9000
        fprintf('Position: 90°, going to -90°\n');
        servo.setPosition(e.servoNum, -9000);
    elseif e.position == -9000
        fprintf('Position: -90°, going to 90°\n');
        servo.setPosition(e.servoNum, 9000);
    else
        fprintf('Error\n'); % Can only happen if another program sets position
    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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
function octave_example_configuration()
    more off;

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

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

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

    % Configure two servos with voltage 5.5V
    % Servo 1: Connected to port 0, period of 19.5ms, pulse width of 1 to 2ms
    %          and operating angle -100 to 100°
    %
    % Servo 2: Connected to port 5, period of 20ms, pulse width of 0.95
    %          to 1.95ms and operating angle -90 to 90°
    servo.setOutputVoltage(5500);

    servo.setDegree(0, -10000, 10000);
    servo.setPulseWidth(0, 1000, 2000);
    servo.setPeriod(0, 19500);
    servo.setAcceleration(0, 1000); % Slow acceleration
    servo.setVelocity(0, 65535); % Full speed

    servo.setDegree(5, -9000, 9000);
    servo.setPulseWidth(5, 950, 1950);
    servo.setPeriod(5, 20000);
    servo.setAcceleration(5, 65535); % Full acceleration
    servo.setVelocity(5, 65535); % Full speed

    servo.setPosition(0, 10000); % Set to most right position
    servo.enable(0);

    servo.setPosition(5, -9000); % Set to most left position
    servo.enable(5);

    input("Press key to exit\n", "s");
    servo.disable(0);
    servo.disable(5);
    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
function octave_example_callback()
    more off;

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

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

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

    % Register position reached callback to function cb_position_reached
    servo.addPositionReachedCallback(@cb_position_reached);

    % Enable position reached callback
    servo.enablePositionReachedCallback();

    % Set velocity to 100°/s. This has to be smaller or equal to the
    % maximum velocity of the servo you are using, otherwise the position
    % reached callback will be called too early
    servo.setVelocity(0, 10000);
    servo.setPosition(0, 9000);
    servo.enable(0);

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

% Use position reached callback to swing back and forth
function cb_position_reached(e)
    servo = e.getSource();
    position = java2int(e.position);

    if position == 9000
        fprintf("Position: 90°, going to -90°\n");
        servo.setPosition(java2int(e.servoNum), -9000);
    elseif position == -9000
        fprintf("Position: -90°, going to 90°\n");
        servo.setPosition(java2int(e.servoNum), 9000);
    else
        fprintf("Error\n"); % Can only happen if another program sets position
    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.

Jede Funktion der Servo Brick API, welche den servo_num Parameter verwendet, kann einen Servo über die Servo Nummer (0 bis 6) adressieren. Falls es sich um eine Setter-Funktion handelt können mehrere Servos gleichzeitig mit einer Bitmaske adressiert werden. Um dies zu kennzeichnen muss das höchstwertigste Bit gesetzt werden. Beispiel: 1 adressiert den Servo 1, (1 << 1) | (1 << 5) | (1 << 7) adressiert die Servos 1 und 5, 0xFF adressiert alle 7 Servos, und so weiter. Das ermöglicht es Konfigurationen von verschiedenen Servos mit einem Funktionsaufruf durchzuführen. Es ist sichergestellt das die Änderungen in der selben PWM Periode vorgenommen werden, für alle Servos entsprechend der Bitmaske.

Grundfunktionen

public class BrickServo(String uid, IPConnection ipcon)

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

In MATLAB:

import com.tinkerforge.BrickServo;

servo = BrickServo("YOUR_DEVICE_UID", ipcon);

In Octave:

servo = java_new("com.tinkerforge.BrickServo", "YOUR_DEVICE_UID", ipcon);

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

public void enable(short servoNum)

Aktiviert einen Servo (0 bis 6). Wenn ein Servo aktiviert wird, wird die konfigurierte Position, Geschwindigkeit, Beschleunigung, etc. sofort übernommen.

public void disable(short servoNum)

Deaktiviert einen Servo (0 bis 6). Deaktivierte Servos werden nicht angesteuert, z.B. halten deaktivierte Servos nicht ihre Position wenn eine Last angebracht ist.

public boolean isEnabled(short servoNum)

Gibt zurück ob ein Servo aktiviert ist.

public void setPosition(short servoNum, short position)

Setzt die Position in °/100 für den angegebenen Servo.

Der Standardbereich für die Position ist -9000 bis 9000, aber dies kann, entsprechend dem verwendetem Servo, mit setDegree() definiert werden.

Wenn ein Linearservo oder RC Brushless Motor Controller oder ähnlich mit dem Servo Brick gesteuert werden soll, können Längen oder Geschwindigkeiten mit setDegree() definiert werden.

public short getPosition(short servoNum)

Gibt die Position des angegebenen Servos zurück, wie von setPosition() gesetzt.

public short getCurrentPosition(short servoNum)

Gibt die aktuelle Position des angegebenen Servos zurück. Dies kann vom Wert von setPosition() abweichen, wenn der Servo gerade sein Positionsziel anfährt.

public void setVelocity(short servoNum, int velocity)

Setzt die maximale Geschwindigkeit des angegebenen Servos in °/100s. Die Geschwindigkeit wird entsprechend mit dem Wert, wie von setAcceleration() gesetzt, beschleunigt.

Die minimale Geschwindigkeit ist 0 (keine Bewegung) und die maximale ist 65535. Mit einem Wert von 65535 wird die Position sofort gesetzt (keine Geschwindigkeit).

Der Standardwert ist 65535.

public int getVelocity(short servoNum)

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

public int getCurrentVelocity(short servoNum)

Gibt die aktuelle Geschwindigkeit des angegebenen Servos zurück. Dies kann vom Wert von setVelocity() abweichen, wenn der Servo gerade sein Geschwindigkeitsziel anfährt.

public void setAcceleration(short servoNum, int acceleration)

Setzt die Beschleunigung des angegebenen Servos in °/100s².

Die minimale Beschleunigung ist 1 und die maximale 65535. Mit einem Wert von 65535 wird die Geschwindigkeit sofort gesetzt (keine Beschleunigung).

Der Standardwert ist 65535.

public int getAcceleration(short servoNum)

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

public void setOutputVoltage(int voltage)

Setzt die Ausgangsspannung mit welchem der Servo angetrieben wird in mV. Die minimale Ausgangsspannung ist 2000mV und die maximale 9000mV.

Bemerkung

Es wird empfohlen diesen Wert auf die maximale Spannung laut Spezifikation des Servos zu setzten. Die meisten Servos erreichen ihre maximale Kraft nur mit hohen Spannungen

Der Standardwert ist 5000.

public int getOutputVoltage()

Gibt die Ausgangsspannung zurück, wie von setOutputVoltage() gesetzt.

public void setPulseWidth(short servoNum, int min, int max)

Setzt die minimale und maximale Pulsweite des angegebenen Servos in µs.

Normalerweise werden Servos mit einer PWM angesteuert, wobei die Länge des Pulses die Position des Servos steuert. Jeder Servo hat unterschiedliche minimale und maximale Pulsweiten, diese können mit dieser Funktion spezifiziert werden.

Wenn im Datenblatt des Servos die minimale und maximale Pulsweite spezifiziert ist, sollten diese Werte entsprechend gesetzt werden. Sollte der Servo ohne ein Datenblatt vorliegen, müssen die Werte durch Ausprobieren gefunden werden.

Beide Werte haben einen Wertebereich von 1 bis 65535 (unsigned 16-bit integer). Der minimale Wert muss kleiner als der maximale sein.

Die Standardwerte sind 1000µs (1ms) und 2000µs (2ms) für minimale und maximale Pulsweite.

public BrickServo.PulseWidth getPulseWidth(short servoNum)

Gibt die minimale und maximale Pulsweite des angegebenen Servos zurück, wie von setPulseWidth() gesetzt.

Das zurückgegebene Objekt enthält die Public-Member-Variablen int min und int max.

public void setDegree(short servoNum, short min, short max)

Setzt den minimalen und maximalen Winkel des angegebenen Servos (standardmäßig in °/100).

Dies definiert die abstrakten Werte zwischen welchen die minimale und maximale Pulsweite skaliert wird. Beispiel: Wenn eine Pulsweite von 1000µs bis 2000µs und ein Winkelbereich von -90° bis 90° spezifiziert ist, wird ein Aufruf von setPosition() mit 0 in einer Pulsweite von 1500µs resultieren (-90° = 1000µs, 90° = 2000µs, etc.).

Anwendungsfälle:

  • Das Datenblatt des Servos spezifiziert einen Bereich von 200° mit einer Mittelposition bei 110°. In diesem Fall kann das Minimum auf -9000 und das Maximum auf 11000 gesetzt werden.
  • Es wird ein Bereich von 220° am Servo gemessen und eine Mittelposition ist nicht bekannt bzw. wird nicht benötigt. In diesem Fall kann das Minimum auf 0 und das Maximum auf 22000 gesetzt werden.
  • Ein Linearservo mit einer Antriebslänge von 20cm. In diesem Fall kann das Minimum auf 0 und das Maximum auf 20000 gesetzt werden. Jetzt kann die Position mittels setPosition() mit einer Auflösung von cm/100 gesetzt werden. Auch die Geschwindigkeit hat eine Auflösung von cm/100s und die Beschleunigung von cm/100s².
  • Die Einheit ist irrelevant und eine möglichst hohe Auflösung ist gewünscht. In diesem Fall kann das Minimum auf -32767 und das Maximum auf 32767 gesetzt werden.
  • Ein Brushless Motor, mit einer maximalen Drehzahl von 1000 U/min, soll mit einem RC Brushless Motor Controller gesteuert werden. In diesem Fall kann das Minimum auf 0 und das Maximum auf 10000 gesetzt werden. setPosition() steuert jetzt die Drehzahl in U/min.

Beide Werte haben einen Wertebereich von -32767 bis 32767 (signed 16-bit integer). Der minimale Wert muss kleiner als der maximale sein.

Die Standardwerte sind -9000 und 9000 für den minimalen und maximalen Winkel.

public BrickServo.Degree getDegree(short servoNum)

Gibt den minimalen und maximalen Winkel für den angegebenen Servo zurück, wie von setDegree() gesetzt.

Das zurückgegebene Objekt enthält die Public-Member-Variablen short min und short max.

public void setPeriod(short servoNum, int period)

Setzt die Periode des angegebenen Servos in µs.

Normalerweise werden Servos mit einer PWM angesteuert. Unterschiedliche Servos erwarten PWMs mit unterschiedlichen Perioden. Die meisten Servos werden mit einer Periode von 20ms betrieben.

Wenn im Datenblatt des Servos die Periode spezifiziert ist, sollte dieser Wert entsprechend gesetzt werden. Sollte der Servo ohne ein Datenblatt vorliegen und die korrekte Periode unbekannt sein, wird der Standardwert (19,5ms) meinst funktionieren.

Die minimal mögliche Periode ist 1µs und die maximale 65535µs.

Der Standardwert ist 19,5ms (19500µs).

public int getPeriod(short servoNum)

Gibt die Periode für den angegebenen Servo zurück, wie von setPeriod() gesetzt.

public int getServoCurrent(short servoNum)

Gibt den Stromverbrauch des angegebenen Servos in mA zurück.

public int getOverallCurrent()

Gibt den Stromverbrauch aller Servos zusammen in mA zurück.

public int getStackInputVoltage()

Gibt die Eingangsspannung des Stapels in mV zurück. Die Eingangsspannung des Stapels wird über diesen verteilt, z.B. mittels einer Step-Down oder Step-Up Power Supply.

public int getExternalInputVoltage()

Gibt die externe Eingangsspannung (in mV) zurück. Die externe Eingangsspannung wird über die schwarze Stromversorgungsbuchse, in den Servo Brick, eingespeist.

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

Warnung

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

Fortgeschrittene Funktionen

public short[] getAPIVersion()

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.

public boolean getResponseExpected(short functionId)

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.

Siehe setResponseExpected() für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

public void setResponseExpected(short functionId, boolean responseExpected)

Ä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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • BrickServo.FUNCTION_ENABLE = 1
  • BrickServo.FUNCTION_DISABLE = 2
  • BrickServo.FUNCTION_SET_POSITION = 4
  • BrickServo.FUNCTION_SET_VELOCITY = 7
  • BrickServo.FUNCTION_SET_ACCELERATION = 10
  • BrickServo.FUNCTION_SET_OUTPUT_VOLTAGE = 12
  • BrickServo.FUNCTION_SET_PULSE_WIDTH = 14
  • BrickServo.FUNCTION_SET_DEGREE = 16
  • BrickServo.FUNCTION_SET_PERIOD = 18
  • BrickServo.FUNCTION_SET_MINIMUM_VOLTAGE = 24
  • BrickServo.FUNCTION_ENABLE_POSITION_REACHED_CALLBACK = 29
  • BrickServo.FUNCTION_DISABLE_POSITION_REACHED_CALLBACK = 30
  • BrickServo.FUNCTION_ENABLE_VELOCITY_REACHED_CALLBACK = 32
  • BrickServo.FUNCTION_DISABLE_VELOCITY_REACHED_CALLBACK = 33
  • BrickServo.FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231
  • BrickServo.FUNCTION_SET_SPITFP_BAUDRATE = 234
  • BrickServo.FUNCTION_ENABLE_STATUS_LED = 238
  • BrickServo.FUNCTION_DISABLE_STATUS_LED = 239
  • BrickServo.FUNCTION_RESET = 243
public void setResponseExpectedAll(boolean responseExpected)

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

public void setSPITFPBaudrateConfig(boolean enableDynamicBaudrate, long minimumDynamicBaudrate)

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.

Die minimale dynamische Baudrate hat einen Wertebereich von 400000 bis 2000000 Baud.

Standardmäßig ist die dynamische Baudrate aktiviert und die minimale dynamische Baudrate ist 400000.

Neu in Version 2.3.4 (Firmware).

public BrickServo.SPITFPBaudrateConfig getSPITFPBaudrateConfig()

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

Neu in Version 2.3.4 (Firmware).

Das zurückgegebene Objekt enthält die Public-Member-Variablen boolean enableDynamicBaudrate und long minimumDynamicBaudrate.

public long getSendTimeoutCount(short communicationMethod)

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:

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

Neu in Version 2.3.2 (Firmware).

public void setSPITFPBaudrate(char brickletPort, long baudrate)

Setzt die Baudrate eines spezifischen Bricklet Ports ('a' - 'd'). Die Baudrate hat einen möglichen Wertebereich von 400000 bis 2000000.

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.

Die Standardbaudrate für alle Ports ist 1400000.

Neu in Version 2.3.2 (Firmware).

public long getSPITFPBaudrate(char brickletPort)

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

Neu in Version 2.3.2 (Firmware).

public BrickServo.SPITFPErrorCount getSPITFPErrorCount(char brickletPort)

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.2 (Firmware).

Das zurückgegebene Objekt enthält die Public-Member-Variablen long errorCountACKChecksum, long errorCountMessageChecksum, long errorCountFrame und long errorCountOverflow.

public void 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).

public void 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).

public boolean isStatusLEDEnabled()

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

Neu in Version 2.3.1 (Firmware).

public BrickServo.Protocol1BrickletName getProtocol1BrickletName(char port)

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.

Das zurückgegebene Objekt enthält die Public-Member-Variablen short protocolVersion, short[] firmwareVersion und String name.

public short getChipTemperature()

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

public void 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.

public BrickServo.Identity getIdentity()

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 kann '0'-'8' (Stack Position) sein.

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

Das zurückgegebene Objekt enthält die Public-Member-Variablen String uid, String connectedUid, char position, short[] hardwareVersion, short[] firmwareVersion und int deviceIdentifier.

Konfigurationsfunktionen für Callbacks

public void setMinimumVoltage(int voltage)

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

Der Standardwert ist 5V (5000mV).

public int getMinimumVoltage()

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

public void enablePositionReachedCallback()

Aktiviert den PositionReachedCallback Callback.

Voreinstellung ist deaktiviert.

Neu in Version 2.0.1 (Firmware).

public void disablePositionReachedCallback()

Deaktiviert den PositionReachedCallback Callback.

Voreinstellung ist deaktiviert.

Neu in Version 2.0.1 (Firmware).

public boolean isPositionReachedCallbackEnabled()

Gibt true zurück wenn der PositionReachedCallback Callback aktiviert ist, false sonst.

Neu in Version 2.0.1 (Firmware).

public void enableVelocityReachedCallback()

Aktiviert den VelocityReachedCallback Callback.

Voreinstellung ist deaktiviert.

Neu in Version 2.0.1 (Firmware).

public void disableVelocityReachedCallback()

Deaktiviert den VelocityReachedCallback Callback.

Voreinstellung ist deaktiviert.

Neu in Version 2.0.1 (Firmware).

public boolean isVelocityReachedCallbackEnabled()

Gibt true zurück wenn der VelocityReachedCallback Callback aktiviert ist, false sonst.

Neu in Version 2.0.1 (Firmware).

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.

public callback BrickServo.UnderVoltageCallback
Parameter:voltage -- int

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

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.

public callback BrickServo.PositionReachedCallback
Parameter:
  • servoNum -- short
  • position -- short

Dieser Callback wird ausgelöst wenn eine konfigurierte Position, wie von setPosition() gesetzt, erreicht wird. Falls die neue Position der aktuellen Position entspricht, wird der Callback nicht ausgelöst, weil sich der Servo nicht bewegt hat. Die Parameter sind der Servo und die Position die erreicht wurde.

Dieser Callback kann mit enablePositionReachedCallback() aktiviert werden.

Bemerkung

Da es nicht möglich ist eine Rückmeldung vom Servo zu erhalten, funktioniert dies nur wenn die konfigurierte Geschwindigkeit (siehe setVelocity()) kleiner oder gleich der maximalen Geschwindigkeit 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 addPositionReachedCallback() eine Callback-Function hinzugefügt werde. Eine hinzugefügter Callback-Function kann mit removePositionReachedCallback() wieder entfernt werden.

public callback BrickServo.VelocityReachedCallback
Parameter:
  • servoNum -- short
  • velocity -- short

Dieser Callback wird ausgelöst immer wenn eine konfigurierte Geschwindigkeit, wie von setVelocity() gesetzt, erreicht wird. Die Parameter sind der Servo und die Geschwindigkeit die erreicht wurde.

Dieser Callback kann mit enableVelocityReachedCallback() aktiviert werden.

Bemerkung

Da es nicht möglich ist eine Rückmeldung vom Servo 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.

Konstanten

public static final int BrickServo.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um einen Servo Brick zu identifizieren.

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

public static final String BrickServo.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Servo Brick dar.