LabVIEW - Servo Brick

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

API

Prinzipiell kann jede Funktion der LabVIEW Bindings, welche einen Wert ausgibt eine Tinkerforge.TimeoutException melden. Dieser Fehler wird gemeldet 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.

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

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

BrickServo(uid, ipcon) → servo
Eingabe:
  • uid – Typ: String
  • ipcon – Typ: .NET Refnum (IPConnection)
Ausgabe:
  • servo – Typ: .NET Refnum (BrickServo)

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid. Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

BrickServo.Enable(servoNum)
Eingabe:
  • servoNum – Typ: Byte, 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.

BrickServo.Disable(servoNum)
Eingabe:
  • servoNum – Typ: Byte, 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.

BrickServo.IsEnabled(servoNum) → enabled
Eingabe:
  • servoNum – Typ: Byte, Wertebereich: [0 bis 6]
Ausgabe:
  • enabled – Typ: Boolean

Gibt zurück ob ein Servo aktiviert ist.

BrickServo.SetPosition(servoNum, position)
Eingabe:
  • servoNum – Typ: Byte, Wertebereich: [0 bis 6, 128 bis 255]
  • position – Typ: Int16, 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.

BrickServo.GetPosition(servoNum) → position
Eingabe:
  • servoNum – Typ: Byte, Wertebereich: [0 bis 6]
Ausgabe:
  • position – Typ: Int16, Einheit: 1/100 °, Wertebereich: ?

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

BrickServo.GetCurrentPosition(servoNum) → position
Eingabe:
  • servoNum – Typ: Byte, Wertebereich: [0 bis 6]
Ausgabe:
  • position – Typ: Int16, 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.

BrickServo.SetVelocity(servoNum, velocity)
Eingabe:
  • servoNum – Typ: Byte, Wertebereich: [0 bis 6, 128 bis 255]
  • velocity – Typ: Int32, 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).

BrickServo.GetVelocity(servoNum) → velocity
Eingabe:
  • servoNum – Typ: Byte, Wertebereich: [0 bis 6]
Ausgabe:
  • velocity – Typ: Int32, Einheit: 1/100 °/s, Wertebereich: [0 bis 216 - 1], Standardwert: 216 - 1

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

BrickServo.GetCurrentVelocity(servoNum) → velocity
Eingabe:
  • servoNum – Typ: Byte, Wertebereich: [0 bis 6]
Ausgabe:
  • velocity – Typ: Int32, 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.

BrickServo.SetAcceleration(servoNum, acceleration)
Eingabe:
  • servoNum – Typ: Byte, Wertebereich: [0 bis 6, 128 bis 255]
  • acceleration – Typ: Int32, 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).

BrickServo.GetAcceleration(servoNum) → acceleration
Eingabe:
  • servoNum – Typ: Byte, Wertebereich: [0 bis 6]
Ausgabe:
  • acceleration – Typ: Int32, Einheit: 1/100 °/s², Wertebereich: [0 bis 216 - 1], Standardwert: 216 - 1

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

BrickServo.SetOutputVoltage(voltage)
Eingabe:
  • voltage – Typ: Int32, 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

BrickServo.GetOutputVoltage() → voltage
Ausgabe:
  • voltage – Typ: Int32, Einheit: 1 mV, Wertebereich: [2000 bis 9000], Standardwert: 5000

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

BrickServo.SetPulseWidth(servoNum, min, max)
Eingabe:
  • servoNum – Typ: Byte, Wertebereich: [0 bis 6, 128 bis 255]
  • min – Typ: Int32, Einheit: 1 µs, Wertebereich: [0 bis 216 - 1], Standardwert: 1000
  • max – Typ: Int32, 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.GetPulseWidth(servoNum) → min, max
Eingabe:
  • servoNum – Typ: Byte, Wertebereich: [0 bis 6]
Ausgabe:
  • min – Typ: Int32, Einheit: 1 µs, Wertebereich: [0 bis 216 - 1], Standardwert: 1000
  • max – Typ: Int32, 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.

BrickServo.SetDegree(servoNum, min, max)
Eingabe:
  • servoNum – Typ: Byte, Wertebereich: [0 bis 6, 128 bis 255]
  • min – Typ: Int16, Einheit: 1/100 °, Wertebereich: [-215 bis 215 - 1], Standardwert: -9000
  • max – Typ: Int16, 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.GetDegree(servoNum) → min, max
Eingabe:
  • servoNum – Typ: Byte, Wertebereich: [0 bis 6]
Ausgabe:
  • min – Typ: Int16, Einheit: 1/100 °, Wertebereich: [-215 bis 215 - 1], Standardwert: -9000
  • max – Typ: Int16, 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.

BrickServo.SetPeriod(servoNum, period)
Eingabe:
  • servoNum – Typ: Byte, Wertebereich: [0 bis 6, 128 bis 255]
  • period – Typ: Int32, 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.

BrickServo.GetPeriod(servoNum) → period
Eingabe:
  • servoNum – Typ: Byte, Wertebereich: [0 bis 6]
Ausgabe:
  • period – Typ: Int32, Einheit: 1 µs, Wertebereich: [0 bis 216 - 1], Standardwert: 19500

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

BrickServo.GetServoCurrent(servoNum) → current
Eingabe:
  • servoNum – Typ: Byte, Wertebereich: [0 bis 6]
Ausgabe:
  • current – Typ: Int32, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1]

Gibt den Stromverbrauch des angegebenen Servos zurück.

BrickServo.GetOverallCurrent() → current
Ausgabe:
  • current – Typ: Int32, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1]

Gibt den Stromverbrauch aller Servos zusammen zurück.

BrickServo.GetStackInputVoltage() → voltage
Ausgabe:
  • voltage – Typ: Int32, 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.

BrickServo.GetExternalInputVoltage() → voltage
Ausgabe:
  • voltage – Typ: Int32, 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

BrickServo.SetSPITFPBaudrateConfig(enableDynamicBaudrate, minimumDynamicBaudrate)
Eingabe:
  • enableDynamicBaudrate – Typ: Boolean, Standardwert: T
  • minimumDynamicBaudrate – Typ: Int64, 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.GetSPITFPBaudrateConfig() → enableDynamicBaudrate, minimumDynamicBaudrate
Ausgabe:
  • enableDynamicBaudrate – Typ: Boolean, Standardwert: T
  • minimumDynamicBaudrate – Typ: Int64, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 400000

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

Neu in Version 2.3.4 (Firmware).

BrickServo.GetSendTimeoutCount(communicationMethod) → timeoutCount
Eingabe:
  • communicationMethod – Typ: Byte, Wertebereich: Siehe Konstanten
Ausgabe:
  • timeoutCount – Typ: Int64, 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).

BrickServo.SetSPITFPBaudrate(brickletPort, baudrate)
Eingabe:
  • brickletPort – Typ: Char, Wertebereich: ["a" bis "b"]
  • baudrate – Typ: Int64, 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).

BrickServo.GetSPITFPBaudrate(brickletPort) → baudrate
Eingabe:
  • brickletPort – Typ: Char, Wertebereich: ["a" bis "b"]
Ausgabe:
  • baudrate – Typ: Int64, 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.GetSPITFPErrorCount(brickletPort) → errorCountACKChecksum, errorCountMessageChecksum, errorCountFrame, errorCountOverflow
Eingabe:
  • brickletPort – Typ: Char, Wertebereich: ["a" bis "b"]
Ausgabe:
  • errorCountACKChecksum – Typ: Int64, Wertebereich: [0 bis 232 - 1]
  • errorCountMessageChecksum – Typ: Int64, Wertebereich: [0 bis 232 - 1]
  • errorCountFrame – Typ: Int64, Wertebereich: [0 bis 232 - 1]
  • errorCountOverflow – Typ: Int64, 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).

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

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

BrickServo.IsStatusLEDEnabled() → enabled
Ausgabe:
  • enabled – Typ: Boolean, Standardwert: T

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

Neu in Version 2.3.1 (Firmware).

BrickServo.GetChipTemperature() → temperature
Ausgabe:
  • temperature – Typ: Int16, 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.

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.GetIdentity() → uid, connectedUid, position, hardwareVersion, firmwareVersion, deviceIdentifier
Ausgabe:
  • 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: Byte[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[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: Int32, Wertebereich: [0 bis 216 - 1]

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

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

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

Konfigurationsfunktionen für Callbacks

BrickServo.SetMinimumVoltage(voltage)
Eingabe:
  • voltage – Typ: Int32, Einheit: 1 mV, Wertebereich: [0 bis 216 - 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.

BrickServo.GetMinimumVoltage() → voltage
Ausgabe:
  • voltage – Typ: Int32, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 5000

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

BrickServo.EnablePositionReachedCallback()

Aktiviert den PositionReachedCallback Callback.

Voreinstellung ist deaktiviert.

Neu in Version 2.0.1 (Firmware).

BrickServo.DisablePositionReachedCallback()

Deaktiviert den PositionReachedCallback Callback.

Neu in Version 2.0.1 (Firmware).

BrickServo.IsPositionReachedCallbackEnabled() → enabled
Ausgabe:
  • enabled – Typ: Boolean, Standardwert: F

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

Neu in Version 2.0.1 (Firmware).

BrickServo.EnableVelocityReachedCallback()

Aktiviert den VelocityReachedCallback Callback.

Voreinstellung ist deaktiviert.

Neu in Version 2.0.1 (Firmware).

BrickServo.DisableVelocityReachedCallback()

Deaktiviert den VelocityReachedCallback Callback.

Voreinstellung ist deaktiviert.

Neu in Version 2.0.1 (Firmware).

BrickServo.IsVelocityReachedCallbackEnabled() → enabled
Ausgabe:
  • enabled – Typ: Boolean, Standardwert: F

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

Neu in Version 2.0.1 (Firmware).

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung erfolgt indem eine Funktion einem Callback Property des Geräte Objektes zugewiesen wird. Die verfügbaren Callback Properties und ihre Parametertypen 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 BrickServo.UnderVoltageCallback → sender, voltage
Callback-Ausgabe:
  • sender – Typ: .NET Refnum (BrickServo)
  • voltage – Typ: Int32, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

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

event BrickServo.PositionReachedCallback → sender, servoNum, position
Callback-Ausgabe:
  • sender – Typ: .NET Refnum (BrickServo)
  • servoNum – Typ: Byte, Wertebereich: [0 bis 6]
  • position – Typ: Int16, 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 EnablePositionReachedCallback() aktiviert werden.

Bemerkung

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

event BrickServo.VelocityReachedCallback → sender, servoNum, velocity
Callback-Ausgabe:
  • sender – Typ: .NET Refnum (BrickServo)
  • servoNum – Typ: Byte, Wertebereich: [0 bis 6]
  • velocity – Typ: Int16, Einheit: 1/100 °/s, Wertebereich: [-215 bis 215 - 1]

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

Dieser Callback kann mit EnableVelocityReachedCallback() aktiviert werden.

Bemerkung

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

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.

BrickServo.GetAPIVersion() → apiVersion
Ausgabe:
  • apiVersion – Typ: Byte[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.

BrickServo.GetResponseExpected(functionId) → responseExpected
Eingabe:
  • functionId – Typ: Byte, Wertebereich: Siehe Konstanten
Ausgabe:
  • responseExpected – Typ: Boolean

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

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

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

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

Für functionId:

  • 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
BrickServo.SetResponseExpected(functionId, responseExpected)
Eingabe:
  • functionId – Typ: Byte, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: Boolean

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

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

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

Für functionId:

  • 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
BrickServo.SetResponseExpectedAll(responseExpected)
Eingabe:
  • responseExpected – Typ: Boolean

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

Interne Funktionen

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

BrickServo.GetProtocol1BrickletName(port) → protocolVersion, firmwareVersion, name
Eingabe:
  • port – Typ: Char, Wertebereich: ["a" bis "b"]
Ausgabe:
  • protocolVersion – Typ: Byte, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: Byte[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]
  • 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.

BrickServo.WriteBrickletPlugin(port, offset, chunk)
Eingabe:
  • port – Typ: Char, Wertebereich: ["a" bis "b"]
  • offset – Typ: Byte, Wertebereich: [0 bis 255]
  • chunk – Typ: Byte[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.

BrickServo.ReadBrickletPlugin(port, offset) → chunk
Eingabe:
  • port – Typ: Char, Wertebereich: ["a" bis "b"]
  • offset – Typ: Byte, Wertebereich: [0 bis 255]
Ausgabe:
  • chunk – Typ: Byte[32], Wertebereich: [0 bis 255]

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

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

Konstanten

BrickServo.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um einen Servo Brick zu identifizieren.

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

BrickServo.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Servo Brick dar.