Software / API Bindings / MATLAB/Octave / API Referenz und Beispiele / Bricks (Abgekündigt) / Servo Brick

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)

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)

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)

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)

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¶

class BrickServo(String uid, IPConnection ipcon)¶

Parameter:	uid – Typ: String ipcon – Typ: IPConnection
Rückgabe:	servo – Typ: BrickServo

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.

void BrickServo.enable(short servoNum)¶

Parameter:	servoNum – Typ: short, Wertebereich: [0 bis 6, 128 bis 255]

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

void BrickServo.disable(short servoNum)¶

Parameter:	servoNum – Typ: short, Wertebereich: [0 bis 6, 128 bis 255]

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

boolean BrickServo.isEnabled(short servoNum)¶

Parameter:	servoNum – Typ: short, Wertebereich: [0 bis 6]
Rückgabe:	enabled – Typ: boolean, Standardwert: false

Gibt zurück ob ein Servo aktiviert ist.

void BrickServo.setPosition(short servoNum, short position)¶

Parameter:	servoNum – Typ: short, Wertebereich: [0 bis 6, 128 bis 255] position – Typ: short, Einheit: 1/100 °, Wertebereich: ?

Setzt die Position 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.

short BrickServo.getPosition(short servoNum)¶

Parameter:	servoNum – Typ: short, Wertebereich: [0 bis 6]
Rückgabe:	position – Typ: short, Einheit: 1/100 °, Wertebereich: ?

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

short BrickServo.getCurrentPosition(short servoNum)¶

Parameter:	servoNum – Typ: short, Wertebereich: [0 bis 6]
Rückgabe:	position – Typ: short, Einheit: 1/100 °, Wertebereich: ?

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

void BrickServo.setVelocity(short servoNum, int velocity)¶

Parameter:	servoNum – Typ: short, Wertebereich: [0 bis 6, 128 bis 255] velocity – Typ: int, Einheit: 1/100 °/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 2¹⁶ - 1

Setzt die maximale Geschwindigkeit des angegebenen Servos. 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).

int BrickServo.getVelocity(short servoNum)¶

Parameter:	servoNum – Typ: short, Wertebereich: [0 bis 6]
Rückgabe:	velocity – Typ: int, Einheit: 1/100 °/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 2¹⁶ - 1

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

int BrickServo.getCurrentVelocity(short servoNum)¶

Parameter:	servoNum – Typ: short, Wertebereich: [0 bis 6]
Rückgabe:	velocity – Typ: int, Einheit: 1/100 °/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 2¹⁶ - 1

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

void BrickServo.setAcceleration(short servoNum, int acceleration)¶

Parameter:	servoNum – Typ: short, Wertebereich: [0 bis 6, 128 bis 255] acceleration – Typ: int, Einheit: 1/100 °/s², Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 2¹⁶ - 1

Setzt die Beschleunigung des angegebenen Servos.

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

int BrickServo.getAcceleration(short servoNum)¶

Parameter:	servoNum – Typ: short, Wertebereich: [0 bis 6]
Rückgabe:	acceleration – Typ: int, Einheit: 1/100 °/s², Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 2¹⁶ - 1

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

void BrickServo.setOutputVoltage(int voltage)¶

Parameter:	voltage – Typ: int, Einheit: 1 mV, Wertebereich: [2000 bis 9000], Standardwert: 5000

Setzt die Ausgangsspannung mit welchem der Servo angetrieben wird.

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

int BrickServo.getOutputVoltage()¶

Rückgabe:	voltage – Typ: int, Einheit: 1 mV, Wertebereich: [2000 bis 9000], Standardwert: 5000

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

void BrickServo.setPulseWidth(short servoNum, int min, int max)¶

Parameter:	servoNum – Typ: short, Wertebereich: [0 bis 6, 128 bis 255] min – Typ: int, Einheit: 1 µs, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 1000 max – Typ: int, Einheit: 1 µs, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 2000

Setzt die minimale und maximale Pulsweite des angegebenen Servos.

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.

Der minimale Wert muss kleiner als der maximale sein.

BrickServo.PulseWidth BrickServo.getPulseWidth(short servoNum)¶

Parameter:	servoNum – Typ: short, Wertebereich: [0 bis 6]
Rückgabeobjekt:	min – Typ: int, Einheit: 1 µs, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 1000 max – Typ: int, Einheit: 1 µs, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 2000

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

void BrickServo.setDegree(short servoNum, short min, short max)¶

Parameter:	servoNum – Typ: short, Wertebereich: [0 bis 6, 128 bis 255] min – Typ: short, Einheit: 1/100 °, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: -9000 max – Typ: short, Einheit: 1/100 °, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 9000

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.

Der minimale Wert muss kleiner als der maximale sein.

BrickServo.Degree BrickServo.getDegree(short servoNum)¶

Parameter:	servoNum – Typ: short, Wertebereich: [0 bis 6]
Rückgabeobjekt:	min – Typ: short, Einheit: 1/100 °, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: -9000 max – Typ: short, Einheit: 1/100 °, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1], Standardwert: 9000

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

void BrickServo.setPeriod(short servoNum, int period)¶

Parameter:	servoNum – Typ: short, Wertebereich: [0 bis 6, 128 bis 255] period – Typ: int, Einheit: 1 µs, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 19500

Setzt die Periode des angegebenen Servos.

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 meist funktionieren.

int BrickServo.getPeriod(short servoNum)¶

Parameter:	servoNum – Typ: short, Wertebereich: [0 bis 6]
Rückgabe:	period – Typ: int, Einheit: 1 µs, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 19500

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

int BrickServo.getServoCurrent(short servoNum)¶

Parameter:	servoNum – Typ: short, Wertebereich: [0 bis 6]
Rückgabe:	current – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 2¹⁶ - 1]

Gibt den Stromverbrauch des angegebenen Servos zurück.

int BrickServo.getOverallCurrent()¶

Rückgabe:	current – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 2¹⁶ - 1]

Gibt den Stromverbrauch aller Servos zusammen zurück.

int BrickServo.getStackInputVoltage()¶

Rückgabe:	voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1]

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

int BrickServo.getExternalInputVoltage()¶

Rückgabe:	voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1]

Gibt die externe Eingangsspannung 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¶

void BrickServo.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.4 (Firmware).

BrickServo.SPITFPBaudrateConfig BrickServo.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.4 (Firmware).

long BrickServo.getSendTimeoutCount(short communicationMethod)¶

Parameter:	communicationMethod – Typ: short, Wertebereich: Siehe Konstanten
Rückgabe:	timeoutCount – Typ: long, Wertebereich: [0 bis 2³² - 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:

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

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

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

BrickServo.SPITFPErrorCount BrickServo.getSPITFPErrorCount(char brickletPort)¶

Parameter:	brickletPort – Typ: char, Wertebereich: ['a' bis 'b']
Rückgabeobjekt:	errorCountACKChecksum – Typ: long, Wertebereich: [0 bis 2³² - 1] errorCountMessageChecksum – Typ: long, Wertebereich: [0 bis 2³² - 1] errorCountFrame – Typ: long, Wertebereich: [0 bis 2³² - 1] errorCountOverflow – Typ: long, Wertebereich: [0 bis 2³² - 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.2 (Firmware).

void BrickServo.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 BrickServo.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 BrickServo.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 BrickServo.getChipTemperature()¶

Rückgabe:	temperature – Typ: short, Einheit: 1/10 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 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 BrickServo.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.

BrickServo.Identity BrickServo.getIdentity()¶

Rückgabeobjekt:

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 2¹⁶ - 1]

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 2¹⁶ - 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 BrickServo.setMinimumVoltage(int voltage)¶

Parameter:	voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 5000

Setzt die minimale Spannung, 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.

int BrickServo.getMinimumVoltage()¶

Rückgabe:	voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 5000

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

void BrickServo.enablePositionReachedCallback()¶

Aktiviert den PositionReachedCallback Callback.

Voreinstellung ist deaktiviert.