Software / API Bindings / C# / API Referenz und Beispiele / Bricklets / Servo Bricklet 2.0

C# - Servo Bricklet 2.0¶

Dies ist die Beschreibung der C# API Bindings für das Servo Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Servo Bricklet 2.0 sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die C# API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Configuration¶

Download (ExampleConfiguration.cs)

using System;
using Tinkerforge;

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XYZ"; // Change XYZ to the UID of your Servo Bricklet 2.0

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletServoV2 s = new BrickletServoV2(UID, ipcon); // Create device object

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

        // Servo 1: Connected to port 0, period of 19.5ms, pulse width of 1 to 2ms
        //          and operating angle -100 to 100°
        s.SetDegree(0, -10000, 10000);
        s.SetPulseWidth(0, 1000, 2000);
        s.SetPeriod(0, 19500);
        s.SetMotionConfiguration(0, 500000, 1000,
                                 1000); // Full velocity with slow ac-/deceleration


        // Servo 2: Connected to port 5, period of 20ms, pulse width of 0.95 to 1.95ms
        //          and operating angle -90 to 90°
        s.SetDegree(5, -9000, 9000);
        s.SetPulseWidth(5, 950, 1950);
        s.SetPeriod(5, 20000);
        s.SetMotionConfiguration(5, 500000, 500000,
                                 500000); // Full velocity with full ac-/deceleration

        s.SetPosition(0, 10000); // Set to most right position
        s.SetEnable(0, true);

        s.SetPosition(5, -9000); // Set to most left position
        s.SetEnable(5, true);

        Console.WriteLine("Press enter to exit");
        Console.ReadLine();

        s.SetEnable(0, false);
        s.SetEnable(5, false);

        ipcon.Disconnect();
    }
}

Callback¶

Download (ExampleCallback.cs)

using System;
using Tinkerforge;

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XYZ"; // Change XYZ to the UID of your Servo Bricklet 2.0

    // Use position reached callback to swing back and forth
    static void PositionReachedCB(BrickletServoV2 sender, int servoChannel,
                                  short position)
    {
        if(position == 9000)
        {
            Console.WriteLine("Position: 90°, going to -90°");
            sender.SetPosition(servoChannel, -9000);
        }
        else if(position == -9000)
        {
            Console.WriteLine("Position: -90°, going to 90°");
            sender.SetPosition(servoChannel, 9000);
        }
        else
        {
            // Can only happen if another program sets position
            Console.WriteLine("Error");
        }
    }

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletServoV2 s = new BrickletServoV2(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 PositionReachedCB
        s.PositionReachedCallback += PositionReachedCB;

        // Enable position reached callback
        s.SetPositionReachedCallbackConfiguration(0, true);

        // 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
        s.SetMotionConfiguration(0, 10000, 500000, 500000);
        s.SetPosition(0, 9000);
        s.SetEnable(0, true);

        Console.WriteLine("Press enter to exit");
        Console.ReadLine();

        s.SetEnable(0, false);

        ipcon.Disconnect();
    }
}

API¶

Prinzipiell kann jede Funktion der C# Bindings, welche einen Wert zurück gibt eine Tinkerforge.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.

Da C# nicht mehrere Rückgabewerte direkt unterstützt, wird das out Schlüsselwort genutzt, um mehrere Werte aus einer Funktion zurückzugeben.

Der Namensraum für alle Brick/Bricklet Bindings und die IPConnection ist Tinkerforge.*.

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Jede Funktion der Servo Brick API, welche den servo_channel Parameter verwendet, kann einen Servo über die Servo-Kanal (0 bis 9) 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 << 15) adressiert die Servos 1 und 5. 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 BrickletServoV2(string uid, IPConnection ipcon)¶

Parameter:	uid – Typ: string ipcon – Typ: IPConnection
Rückgabe:	servoV2 – Typ: BrickletServoV2

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

BrickletServoV2 servoV2 = new BrickletServoV2("YOUR_DEVICE_UID", ipcon);

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

void BrickletServoV2.GetStatus(out bool[] enabled, out short[] currentPosition, out short[] currentVelocity, out int[] current, out int inputVoltage)¶

Ausgabeparameter:	enabled – Typ: bool[], Länge: 10 currentPosition – Typ: short[], Länge: 10, Einheit: 1/100 °, Wertebereich: ? currentVelocity – Typ: short[], Länge: 10, Einheit: 1/100 °/s, Wertebereich: [0 bis 500000] current – Typ: int[], Länge: 10, Einheit: 1 mA, Wertebereich: [0 bis 2¹⁶ - 1] inputVoltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1]

Gibt die Status-Informationen des Servo Bricklet 2.0 zurück.

Der Status umfasst

für jeden Kanal die Information ob dieser gerade aktiviert oder deaktiviert ist,
für jeden Kanal die aktuelle Position
für jeden Kanal die aktuelle Geschwindigkeit,
für jeden Kanal den Stromverbrauch und
die Eingangsspannung

Hinweis: Die Position und Geschwindigkeit ist eine Momentaufnahme der aktuellen Position und Geschwindigkeit eines sich in Bewegung befindlichen Servos.

void BrickletServoV2.SetEnable(int servoChannel, bool enable)¶

Parameter:	servoChannel – Typ: int, Wertebereich: [0 bis 9, 2¹⁵ bis 33791] enable – Typ: bool, Standardwert: false

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

bool BrickletServoV2.GetEnabled(int servoChannel)¶

Parameter:	servoChannel – Typ: int, Wertebereich: [0 bis 9]
Rückgabe:	enable – Typ: bool, Standardwert: false

Gibt zurück ob ein Servo-Kanal aktiviert ist.

void BrickletServoV2.SetPosition(int servoChannel, short position)¶

Parameter:	servoChannel – Typ: int, Wertebereich: [0 bis 9, 2¹⁵ bis 33791] position – Typ: short, Einheit: 1/100 °, Wertebereich: ?

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

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 BrickletServoV2.GetPosition(int servoChannel)¶

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

Gibt die Position des angegebenen Servo-Kanals zurück, wie von SetPosition() gesetzt.

short BrickletServoV2.GetCurrentPosition(int servoChannel)¶

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

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

int BrickletServoV2.GetCurrentVelocity(int servoChannel)¶

Parameter:	servoChannel – Typ: int, Wertebereich: [0 bis 9]
Rückgabe:	velocity – Typ: int, Einheit: 1/100 °/s, Wertebereich: [0 bis 500000]

Gibt die aktuelle Geschwindigkeit des angegebenen Servo-Kanals zurück. Dies kann von der Geschwindigkeit die per SetMotionConfiguration() gesetzt wurde abweichen, wenn der Servo gerade sein Geschwindigkeitsziel anfährt.

void BrickletServoV2.SetMotionConfiguration(int servoChannel, long velocity, long acceleration, long deceleration)¶

Parameter:	servoChannel – Typ: int, Wertebereich: [0 bis 9, 2¹⁵ bis 33791] velocity – Typ: long, Einheit: 1/100 °/s, Wertebereich: [0 bis 500000], Standardwert: 100000 acceleration – Typ: long, Einheit: 1/100 °/s², Wertebereich: [0 bis 500000], Standardwert: 50000 deceleration – Typ: long, Einheit: 1/100 °/s², Wertebereich: [0 bis 500000], Standardwert: 50000

Setzt die maximale Geschwindigkeit des angegebenen Servo-Kanals in °/100s sowie die Beschleunigung und Verzögerung in °/100s².

Mit einer Geschwindigkeit von 0 °/100s wird die Position sofort gesetzt (keine Geschwindigkeit).

Mit einer Beschleunigung/Verzögerung von 0 °/100s² wird die Geschwindigkeit sofort gesetzt (keine Beschleunigung/Verzögerung).

void BrickletServoV2.GetMotionConfiguration(int servoChannel, out long velocity, out long acceleration, out long deceleration)¶

Parameter:	servoChannel – Typ: int, Wertebereich: [0 bis 9]
Ausgabeparameter:	velocity – Typ: long, Einheit: 1/100 °/s, Wertebereich: [0 bis 500000], Standardwert: 100000 acceleration – Typ: long, Einheit: 1/100 °/s², Wertebereich: [0 bis 500000], Standardwert: 50000 deceleration – Typ: long, Einheit: 1/100 °/s², Wertebereich: [0 bis 500000], Standardwert: 50000

Gibt die 'Motion Configuration' zurück, wie von SetMotionConfiguration() gesetzt.

void BrickletServoV2.SetPulseWidth(int servoChannel, long min, long max)¶

Parameter:	servoChannel – Typ: int, Wertebereich: [0 bis 9, 2¹⁵ bis 33791] min – Typ: long, Einheit: 1 µs, Wertebereich: [0 bis 2³² - 1], Standardwert: 1000 max – Typ: long, Einheit: 1 µs, Wertebereich: [0 bis 2³² - 1], Standardwert: 2000

Setzt die minimale und maximale Pulsweite des angegebenen Servo-Kanals 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.

void BrickletServoV2.GetPulseWidth(int servoChannel, out long min, out long max)¶

Parameter:	servoChannel – Typ: int, Wertebereich: [0 bis 9]
Ausgabeparameter:	min – Typ: long, Einheit: 1 µs, Wertebereich: [0 bis 2³² - 1], Standardwert: 1000 max – Typ: long, Einheit: 1 µs, Wertebereich: [0 bis 2³² - 1], Standardwert: 2000

Gibt die minimale und maximale Pulsweite des angegebenen Servo-Kanals zurück, wie von SetPulseWidth() gesetzt.

void BrickletServoV2.SetDegree(int servoChannel, short min, short max)¶

Parameter:	servoChannel – Typ: int, Wertebereich: [0 bis 9, 2¹⁵ bis 33791] 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 Servo-Kanals (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.

void BrickletServoV2.GetDegree(int servoChannel, out short min, out short max)¶

Parameter:	servoChannel – Typ: int, Wertebereich: [0 bis 9]
Ausgabeparameter:	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-Kanals zurück, wie von SetDegree() gesetzt.

void BrickletServoV2.SetPeriod(int servoChannel, long period)¶

Parameter:	servoChannel – Typ: int, Wertebereich: [0 bis 9, 2¹⁵ bis 33791] period – Typ: long, Einheit: 1 µs, Wertebereich: [1 bis 1000000], Standardwert: 19500

Setzt die Periode des angegebenen Servo-Kanals 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 1000000µs.

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

long BrickletServoV2.GetPeriod(int servoChannel)¶

Parameter:	servoChannel – Typ: int, Wertebereich: [0 bis 9]
Rückgabe:	period – Typ: long, Einheit: 1 µs, Wertebereich: [1 bis 1000000], Standardwert: 19500

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

int BrickletServoV2.GetServoCurrent(int servoChannel)¶

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

Gibt den Stromverbrauch des angegebenen Servo-Kanals in mA zurück.

void BrickletServoV2.SetServoCurrentConfiguration(int servoChannel, byte averagingDuration)¶

Parameter:	servoChannel – Typ: int, Wertebereich: [0 bis 9, 2¹⁵ bis 33791] averagingDuration – Typ: byte, Einheit: 1 ms, Wertebereich: [1 bis 255], Standardwert: 255

Setzt die Durchschnittsberechnungsdauer der Strommessung des angegebenen Servo-Kanals in ms.

byte BrickletServoV2.GetServoCurrentConfiguration(int servoChannel)¶

Parameter:	servoChannel – Typ: int, Wertebereich: [0 bis 9]
Rückgabe:	averagingDuration – Typ: byte, Einheit: 1 ms, Wertebereich: [1 bis 255], Standardwert: 255

Gibt die Servo-Stromverbrauchskonfiguration für den angegebenen Servo-Kanal zurück, wie von SetServoCurrentConfiguration() gesetzt.

void BrickletServoV2.SetInputVoltageConfiguration(byte averagingDuration)¶

Parameter:	averagingDuration – Typ: byte, Einheit: 1 ms, Wertebereich: [1 bis 255], Standardwert: 255

Setzt die Durchschnittsberechnungsdauer der Eingangsspannungsmessung des angegebenen Servo-Kanals in ms.

byte BrickletServoV2.GetInputVoltageConfiguration()¶

Rückgabe:	averagingDuration – Typ: byte, Einheit: 1 ms, Wertebereich: [1 bis 255], Standardwert: 255

Gibt die Servo-Eingangsspannungskonfiguration zurück, wie von SetInputVoltageConfiguration() gesetzt.

int BrickletServoV2.GetOverallCurrent()¶

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

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

int BrickletServoV2.GetInputVoltage()¶

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

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

Fortgeschrittene Funktionen¶

void BrickletServoV2.SetCurrentCalibration(short[] offset)¶

Parameter:	offset – Typ: short[], Länge: 10, Einheit: 1 mA, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]

Setzt einen Offset-Wert (in mA) für jeden Kanal.

Hinweis: Im Auslieferungszustand ist das Servo Bricklet 2.0 bereits kalibriert.

short[] BrickletServoV2.GetCurrentCalibration()¶

Rückgabe:	offset – Typ: short[], Länge: 10, Einheit: 1 mA, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]

Gibt die Stromkalibrierung zurück, wie von SetCurrentCalibration().

void BrickletServoV2.GetSPITFPErrorCount(out long errorCountAckChecksum, out long errorCountMessageChecksum, out long errorCountFrame, out long errorCountOverflow)¶

Ausgabeparameter:	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 Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

void BrickletServoV2.SetStatusLEDConfig(byte config)¶

Parameter:	config – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 3

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

Für config:

BrickletServoV2.STATUS_LED_CONFIG_OFF = 0
BrickletServoV2.STATUS_LED_CONFIG_ON = 1
BrickletServoV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletServoV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

byte BrickletServoV2.GetStatusLEDConfig()¶

Rückgabe:	config – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 3

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

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

Für config:

BrickletServoV2.STATUS_LED_CONFIG_OFF = 0
BrickletServoV2.STATUS_LED_CONFIG_ON = 1
BrickletServoV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletServoV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

short BrickletServoV2.GetChipTemperature()¶

Rückgabe:	temperature – Typ: short, Einheit: 1 °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 hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

void BrickletServoV2.Reset()¶

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

void BrickletServoV2.GetIdentity(out string uid, out string connectedUid, out char position, out byte[] hardwareVersion, out byte[] firmwareVersion, out int deviceIdentifier)¶

Ausgabeparameter:

Ausgabeparameter:	uid – Typ: string, Länge: bis zu 8 connectedUid – Typ: string, Länge: bis zu 8 position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] hardwareVersion – Typ: byte[], Länge: 3 0: major – Typ: byte, Wertebereich: [0 bis 255] 1: minor – Typ: byte, Wertebereich: [0 bis 255] 2: revision – Typ: byte, Wertebereich: [0 bis 255] firmwareVersion – Typ: byte[], Länge: 3 0: major – Typ: byte, Wertebereich: [0 bis 255] 1: minor – Typ: byte, Wertebereich: [0 bis 255] 2: revision – Typ: byte, 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: ['a' bis 'h', 'z']
hardwareVersion – Typ: byte[], Länge: 3

0: major – Typ: byte, Wertebereich: [0 bis 255]
1: minor – Typ: byte, Wertebereich: [0 bis 255]
2: revision – Typ: byte, Wertebereich: [0 bis 255]

firmwareVersion – Typ: byte[], Länge: 3

0: major – Typ: byte, Wertebereich: [0 bis 255]
1: minor – Typ: byte, Wertebereich: [0 bis 255]
2: revision – Typ: byte, Wertebereich: [0 bis 255]

deviceIdentifier – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

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

Die Position ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

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

Konfigurationsfunktionen für Callbacks¶

void BrickletServoV2.SetPositionReachedCallbackConfiguration(int servoChannel, bool enabled)¶

Parameter:	servoChannel – Typ: int, Wertebereich: [0 bis 9, 2¹⁵ bis 33791] enabled – Typ: bool, Standardwert: false

Aktiviert/Deaktiviert PositionReachedCallback Callback.

bool BrickletServoV2.GetPositionReachedCallbackConfiguration(int servoChannel)¶

Parameter:	servoChannel – Typ: int, Wertebereich: [0 bis 9]
Rückgabe:	enabled – Typ: bool, Standardwert: false

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

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung geschieht durch Anhängen des Callback Handlers an den passenden Event:

void MyCallback(BrickletServoV2 sender, int value)
{
    System.Console.WriteLine("Value: " + value);
}

servoV2.ExampleCallback += MyCallback;

Die verfügbaren Events werden weiter unten 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.

event BrickletServoV2.PositionReachedCallback(BrickletServoV2 sender, int servoChannel, short position)¶

Callback-Parameter:	sender – Typ: BrickletServoV2 servoChannel – Typ: int, Wertebereich: [0 bis 9] position – Typ: short, Einheit: 1/100 °, Wertebereich: ?

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 SetPositionReachedCallbackConfiguration() aktiviert werden.

Bemerkung

Da es nicht möglich ist eine Rückmeldung vom Servo zu erhalten, funktioniert dies nur wenn die konfigurierte Geschwindigkeit (siehe SetMotionConfiguration()) 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.

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.

byte[] BrickletServoV2.GetAPIVersion()¶

Ausgabeparameter:	apiVersion – Typ: byte[], Länge: 3 0: major – Typ: byte, Wertebereich: [0 bis 255] 1: minor – Typ: byte, Wertebereich: [0 bis 255] 2: revision – Typ: byte, 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.

bool BrickletServoV2.GetResponseExpected(byte functionId)¶

Parameter:	functionId – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:	responseExpected – Typ: bool

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels SetResponseExpected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

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

Für functionId:

BrickletServoV2.FUNCTION_SET_ENABLE = 2
BrickletServoV2.FUNCTION_SET_POSITION = 4
BrickletServoV2.FUNCTION_SET_MOTION_CONFIGURATION = 8
BrickletServoV2.FUNCTION_SET_PULSE_WIDTH = 10
BrickletServoV2.FUNCTION_SET_DEGREE = 12
BrickletServoV2.FUNCTION_SET_PERIOD = 14
BrickletServoV2.FUNCTION_SET_SERVO_CURRENT_CONFIGURATION = 17
BrickletServoV2.FUNCTION_SET_INPUT_VOLTAGE_CONFIGURATION = 19
BrickletServoV2.FUNCTION_SET_CURRENT_CALIBRATION = 23
BrickletServoV2.FUNCTION_SET_POSITION_REACHED_CALLBACK_CONFIGURATION = 25
BrickletServoV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletServoV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletServoV2.FUNCTION_RESET = 243
BrickletServoV2.FUNCTION_WRITE_UID = 248

void BrickletServoV2.SetResponseExpected(byte functionId, bool responseExpected)¶

Parameter:	functionId – Typ: byte, Wertebereich: Siehe Konstanten responseExpected – Typ: bool

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

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

Für functionId:

BrickletServoV2.FUNCTION_SET_ENABLE = 2
BrickletServoV2.FUNCTION_SET_POSITION = 4
BrickletServoV2.FUNCTION_SET_MOTION_CONFIGURATION = 8
BrickletServoV2.FUNCTION_SET_PULSE_WIDTH = 10
BrickletServoV2.FUNCTION_SET_DEGREE = 12
BrickletServoV2.FUNCTION_SET_PERIOD = 14
BrickletServoV2.FUNCTION_SET_SERVO_CURRENT_CONFIGURATION = 17
BrickletServoV2.FUNCTION_SET_INPUT_VOLTAGE_CONFIGURATION = 19
BrickletServoV2.FUNCTION_SET_CURRENT_CALIBRATION = 23
BrickletServoV2.FUNCTION_SET_POSITION_REACHED_CALLBACK_CONFIGURATION = 25
BrickletServoV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletServoV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletServoV2.FUNCTION_RESET = 243
BrickletServoV2.FUNCTION_WRITE_UID = 248

void BrickletServoV2.SetResponseExpectedAll(bool responseExpected)¶

Parameter:	responseExpected – Typ: bool

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

Interne Funktionen¶

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

byte BrickletServoV2.SetBootloaderMode(byte mode)¶

Parameter:	mode – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:	status – Typ: byte, Wertebereich: Siehe Konstanten

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

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

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

Für mode:

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

Für status:

BrickletServoV2.BOOTLOADER_STATUS_OK = 0
BrickletServoV2.BOOTLOADER_STATUS_INVALID_MODE = 1
BrickletServoV2.BOOTLOADER_STATUS_NO_CHANGE = 2
BrickletServoV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
BrickletServoV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
BrickletServoV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5

byte BrickletServoV2.GetBootloaderMode()¶

Rückgabe:	mode – Typ: byte, Wertebereich: Siehe Konstanten

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

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

Für mode:

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

void BrickletServoV2.SetWriteFirmwarePointer(long pointer)¶

Parameter:	pointer – Typ: long, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]

Setzt den Firmware-Pointer für WriteFirmware(). Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

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

byte BrickletServoV2.WriteFirmware(byte[] data)¶

Parameter:	data – Typ: byte[], Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:	status – Typ: byte, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von SetWriteFirmwarePointer() gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

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

void BrickletServoV2.WriteUID(long uid)¶

Parameter:	uid – Typ: long, Wertebereich: [0 bis 2³² - 1]

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

long BrickletServoV2.ReadUID()¶

Rückgabe:	uid – Typ: long, Wertebereich: [0 bis 2³² - 1]

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

Konstanten¶

int BrickletServoV2.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Servo Bricklet 2.0 zu identifizieren.

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

string BrickletServoV2.DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Servo Bricklet 2.0 dar.