Java - Servo Brick

Dies ist die Beschreibung der Java 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 Java API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Configuration

Download (ExampleConfiguration.java)

 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
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickServo;

public class ExampleConfiguration {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XXYYZZ to the UID of your Servo Brick
    private static final String UID = "XXYYZZ";

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickServo servo = new 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((short)0, (short)-10000, (short)10000);
        servo.setPulseWidth((short)0, 1000, 2000);
        servo.setPeriod((short)0, 19500);
        servo.setAcceleration((short)0, 1000); // Slow acceleration
        servo.setVelocity((short)0, 65535); // Full speed

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

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

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

        System.out.println("Press key to exit"); System.in.read();
        servo.disable((short)0);
        servo.disable((short)5);
        ipcon.disconnect();
    }
}

Callback

Download (ExampleCallback.java)

 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
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickServo;
import com.tinkerforge.TinkerforgeException;

public class ExampleCallback {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XXYYZZ to the UID of your Servo Brick
    private static final String UID = "XXYYZZ";

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        // Note: Declare servo as final, so the listener can access it
        final BrickServo servo = new BrickServo(UID, ipcon); // Create device object

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

        // Use position reached callback to swing back and forth
        servo.addPositionReachedListener(new BrickServo.PositionReachedListener() {
            public void positionReached(short servoNum, short position) {
                if (position == 9000) {
                    System.out.println("Position: 90°, going to -90°");
                    try {
                        servo.setPosition(servoNum, (short)-9000);
                    } catch(TinkerforgeException e) {
                    }
                } else if (position == -9000) {
                    System.out.println("Position: -90°, going to 90°");
                    try {
                        servo.setPosition(servoNum, (short)9000);
                    } catch(TinkerforgeException e) {
                    }
                } else {
                    // Can only happen if another program sets velocity
                    System.out.println("Error");
                }
            }
        });

        // 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((short)0, 10000);
        servo.setPosition((short)0, (short)9000);
        servo.enable((short)0);

        System.out.println("Press key to exit"); System.in.read();
        servo.disable((short)0);
        ipcon.disconnect();
    }
}

PWM Generator

Download (ExamplePWMGenerator.java)

 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
61
62
63
64
65
66
67
68
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickServo;

public class ExamplePWMGenerator {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XXYYZZ to the UID of your Servo Brick
    private static final String UID = "XXYYZZ";

    // Due to the internal clock dividing mechanism of the Servo Brick not all
    // arbitrary PWM frequency values can be achieved. For example, the upper
    // most three available PWM frequency values are 1MHz, 500kHz and 250kHz.
    // The steps are coarser on the high frequency end and much finer on the
    // low end. You can set any value here between 15Hz and 1MHz and the Servo
    // Brick will try to match it as closely as possible.
    private static int PWM_FREQUENCY = 175000; // in Hz [15Hz to 1MHz]
    private static int PWM_DUTY_CYCLE = 20; // in % [0% to 100%]

    private static short SERVO_NUMBER = 0; // [0 to 6]

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickServo servo = new BrickServo(UID, ipcon); // Create device object

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

        // Set degree range to 0-100, this will allow to set the PWM duty cycle in 1% steps
        servo.setDegree(SERVO_NUMBER, (short)0, (short)100);

        // Set PWM frequency (1-65535µs == 1MHz-15Hz)
        int period = 1000000 / PWM_FREQUENCY;

        if (period < 1) {
            period = 1; // 1MHz
        } else if (period > 65535) {
            period = 65535; // ~15Hz
        }

        servo.setPulseWidth(SERVO_NUMBER, 0, period);
        servo.setPeriod(SERVO_NUMBER, period);

        // Fast acceleration and full speed
        servo.setAcceleration(SERVO_NUMBER, 65535);
        servo.setVelocity(SERVO_NUMBER, 65535);

        // Set PWM duty cycle (0-100 %)
        int position = PWM_DUTY_CYCLE;

        if (position < 0) {
            position = 0;
        } else if (position > 100) {
            position = 100;
        }

        servo.setPosition(SERVO_NUMBER, (short)position);

        // Enable PWM signal
        servo.enable(SERVO_NUMBER);

        System.out.println("Press key to exit"); System.in.read();
        servo.disable(SERVO_NUMBER);
        ipcon.disconnect();
    }
}

API

Prinzipiell kann jede Methode der Java 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 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:

BrickServo servo = new BrickServo("YOUR_DEVICE_UID", ipcon);

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

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

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 216 - 1], Standardwert: 216 - 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 216 - 1], Standardwert: 216 - 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 216 - 1], Standardwert: 216 - 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 216 - 1], Standardwert: 216 - 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 216 - 1], Standardwert: 216 - 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 216 - 1], Standardwert: 1000
  • max – Typ: int, Einheit: 1 µs, Wertebereich: [0 bis 216 - 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 216 - 1], Standardwert: 1000
  • max – Typ: int, Einheit: 1 µs, Wertebereich: [0 bis 216 - 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: [-215 bis 215 - 1], Standardwert: -9000
  • max – Typ: short, Einheit: 1/100 °, Wertebereich: [-215 bis 215 - 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: [-215 bis 215 - 1], Standardwert: -9000
  • max – Typ: short, Einheit: 1/100 °, Wertebereich: [-215 bis 215 - 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 216 - 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 216 - 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 216 - 1]

Gibt den Stromverbrauch des angegebenen Servos zurück.

int BrickServo.getOverallCurrent()
Rückgabe:
  • current – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1]

Gibt den Stromverbrauch aller Servos zusammen zurück.

int BrickServo.getStackInputVoltage()
Rückgabe:
  • voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 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 216 - 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 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:

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

BrickServo.Protocol1BrickletName BrickServo.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
    • 0: major – Typ: short, Wertebereich: [0 bis 255]
    • 1: minor – Typ: short, Wertebereich: [0 bis 255]
    • 2: 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.

short BrickServo.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 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.

void BrickServo.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[] BrickServo.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.

BrickServo.Identity BrickServo.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
    • 0: major – Typ: short, Wertebereich: [0 bis 255]
    • 1: minor – Typ: short, Wertebereich: [0 bis 255]
    • 2: revision – Typ: short, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: short[], Länge: 3
    • 0: major – Typ: short, Wertebereich: [0 bis 255]
    • 1: minor – Typ: short, Wertebereich: [0 bis 255]
    • 2: 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 Listener

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

Setzt die minimale Spannung, bei welcher der UnderVoltageListener Listener 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 216 - 1], Standardwert: 5000

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

void BrickServo.enablePositionReachedCallback()

Aktiviert den PositionReachedListener Listener.

Voreinstellung ist deaktiviert.

Neu in Version 2.0.1 (Firmware).

void BrickServo.disablePositionReachedCallback()

Deaktiviert den PositionReachedListener Listener.

Neu in Version 2.0.1 (Firmware).

boolean BrickServo.isPositionReachedCallbackEnabled()
Rückgabe:
  • enabled – Typ: boolean, Standardwert: false

Gibt true zurück wenn der PositionReachedListener Listener aktiviert ist, false sonst.

Neu in Version 2.0.1 (Firmware).

void BrickServo.enableVelocityReachedCallback()

Aktiviert den VelocityReachedListener Listener.

Voreinstellung ist deaktiviert.

Neu in Version 2.0.1 (Firmware).

void BrickServo.disableVelocityReachedCallback()

Deaktiviert den VelocityReachedListener Listener.

Voreinstellung ist deaktiviert.

Neu in Version 2.0.1 (Firmware).

boolean BrickServo.isVelocityReachedCallbackEnabled()
Rückgabe:
  • enabled – Typ: boolean, Standardwert: false

Gibt true zurück wenn der VelocityReachedListener Listener aktiviert ist, false sonst.

Neu in Version 2.0.1 (Firmware).

Listener

Listener können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit add*Listener() Funktionen eines Geräteobjekts durchgeführt werden.

Der Parameter ist ein Listener Klassen Objekt, z.B.:

device.addExampleListener(new BrickServo.ExampleListener() {
    public void property(int value) {
        System.out.println("Value: " + value);
    }
});

Die verfügbaren Listener Klassen mit den Methoden welche überschrieben werden können werden unterhalb beschrieben. Es ist möglich mehrere Listener hinzuzufügen und auch mit einem korrespondierenden remove*Listener() wieder zu entfernen.

Bemerkung

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

class BrickServo.UnderVoltageListener()

Dieser Listener kann mit der Funktion addUnderVoltageListener() hinzugefügt werde. Ein hinzugefügter Listener kann mit der Funktion removeUnderVoltageListener() wieder entfernt werden.

void underVoltage(int voltage)
Parameter:
  • voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

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

class BrickServo.PositionReachedListener()

Dieser Listener kann mit der Funktion addPositionReachedListener() hinzugefügt werde. Ein hinzugefügter Listener kann mit der Funktion removePositionReachedListener() wieder entfernt werden.

void positionReached(short servoNum, short position)
Parameter:
  • servoNum – Typ: short, Wertebereich: [0 bis 6]
  • position – Typ: short, Einheit: 1/100 °, Wertebereich: ?

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

Dieser Listener 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 Listener wird zu früh ausgelöst.

class BrickServo.VelocityReachedListener()

Dieser Listener kann mit der Funktion addVelocityReachedListener() hinzugefügt werde. Ein hinzugefügter Listener kann mit der Funktion removeVelocityReachedListener() wieder entfernt werden.

void velocityReached(short servoNum, short velocity)
Parameter:
  • servoNum – Typ: short, Wertebereich: [0 bis 6]
  • velocity – Typ: short, Einheit: 1/100 °/s, Wertebereich: [-215 bis 215 - 1]

Dieser Listener 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 Listener 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 Listener wird zu früh ausgelöst.

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[] BrickServo.getAPIVersion()
Rückgabeobjekt:
  • apiVersion – Typ: short[], Länge: 3
    • 0: major – Typ: short, Wertebereich: [0 bis 255]
    • 1: minor – Typ: short, Wertebereich: [0 bis 255]
    • 2: 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 BrickServo.getResponseExpected(short functionId)
Parameter:
  • functionId – Typ: short, 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 Listeners 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:

  • 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
  • BrickServo.FUNCTION_WRITE_BRICKLET_PLUGIN = 246
void BrickServo.setResponseExpected(short functionId, boolean responseExpected)
Parameter:
  • functionId – Typ: short, 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 Listeners (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:

  • 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
  • BrickServo.FUNCTION_WRITE_BRICKLET_PLUGIN = 246
void BrickServo.setResponseExpectedAll(boolean responseExpected)
Parameter:
  • responseExpected – Typ: boolean

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

Konstanten

int BrickServo.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um einen Servo Brick zu identifizieren.

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

String BrickServo.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Servo Brick dar.