Ruby - Servo Brick

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Callback

Download (example_callback.rb)

 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
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/brick_servo'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
servo = BrickServo.new 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.register_callback(BrickServo::CALLBACK_POSITION_REACHED) do |servo_num, position|
  if position == 9000
    puts 'Position: 90°, going to -90°'
    servo.set_position servo_num, -9000
  elsif position == -9000
    puts 'Position: -90°, going to 90°'
    servo.set_position servo_num, 9000
  else
    puts 'Error' # Can only happen if another program sets position
  end
end

# Enable position reached callback
servo.enable_position_reached_callback

# 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.set_velocity 0, 10000
servo.set_position 0, 9000
servo.enable 0

puts 'Press key to exit'
$stdin.gets

servo.disable 0

ipcon.disconnect

Configuration

Download (example_configuration.rb)

 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
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/brick_servo'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
servo = BrickServo.new 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.set_output_voltage 5500

servo.set_degree 0, -10000, 10000
servo.set_pulse_width 0, 1000, 2000
servo.set_period 0, 19500
servo.set_acceleration 0, 1000 # Slow acceleration
servo.set_velocity 0, 65535 # Full speed

servo.set_degree 5, -9000, 9000
servo.set_pulse_width 5, 950, 1950
servo.set_period 5, 20000
servo.set_acceleration 5, 65535 # Full acceleration
servo.set_velocity 5, 65535 # Full speed

servo.set_position 0, 10000 # Set to most right position
servo.enable 0

servo.set_position 5, -9000 # Set to most left position
servo.enable 5

puts 'Press key to exit'
$stdin.gets

servo.disable 0
servo.disable 5

ipcon.disconnect

API

Alle folgend aufgelisteten Funktionen 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

BrickServo::new(uid, ipcon) → servo
Parameter:
  • uid – Typ: str
  • ipcon – Typ: IPConnection
Rückgabe:
  • servo – Typ: BrickServo

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

servo = BrickServo.new 'YOUR_DEVICE_UID', ipcon

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

BrickServo#enable(servo_num) → nil
Parameter:
  • servo_num – Typ: int, 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(servo_num) → nil
Parameter:
  • servo_num – Typ: int, 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#is_enabled(servo_num) → bool
Parameter:
  • servo_num – Typ: int, Wertebereich: [0 bis 6]
Rückgabe:
  • enabled – Typ: bool

Gibt zurück ob ein Servo aktiviert ist.

BrickServo#set_position(servo_num, position) → nil
Parameter:
  • servo_num – Typ: int, Wertebereich: [0 bis 6, 128 bis 255]
  • position – Typ: int, 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 #set_degree 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 #set_degree definiert werden.

BrickServo#get_position(servo_num) → int
Parameter:
  • servo_num – Typ: int, Wertebereich: [0 bis 6]
Rückgabe:
  • position – Typ: int, Einheit: 1/100 °, Wertebereich: ?

Gibt die Position des angegebenen Servos zurück, wie von #set_position gesetzt.

BrickServo#get_current_position(servo_num) → int
Parameter:
  • servo_num – Typ: int, Wertebereich: [0 bis 6]
Rückgabe:
  • position – Typ: int, Einheit: 1/100 °, Wertebereich: ?

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

BrickServo#set_velocity(servo_num, velocity) → nil
Parameter:
  • servo_num – Typ: int, 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 #set_acceleration 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#get_velocity(servo_num) → int
Parameter:
  • servo_num – Typ: int, 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 #set_velocity gesetzt.

BrickServo#get_current_velocity(servo_num) → int
Parameter:
  • servo_num – Typ: int, 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 #set_velocity abweichen, wenn der Servo gerade sein Geschwindigkeitsziel anfährt.

BrickServo#set_acceleration(servo_num, acceleration) → nil
Parameter:
  • servo_num – Typ: int, 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).

BrickServo#get_acceleration(servo_num) → int
Parameter:
  • servo_num – Typ: int, 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 #set_acceleration gesetzt.

BrickServo#set_output_voltage(voltage) → nil
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

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

Gibt die Ausgangsspannung zurück, wie von #set_output_voltage gesetzt.

BrickServo#set_pulse_width(servo_num, min, max) → nil
Parameter:
  • servo_num – Typ: int, 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#get_pulse_width(servo_num) → [int, int]
Parameter:
  • servo_num – Typ: int, Wertebereich: [0 bis 6]
Rückgabe-Array:
  • 0: min – Typ: int, Einheit: 1 µs, Wertebereich: [0 bis 216 - 1], Standardwert: 1000
  • 1: 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 #set_pulse_width gesetzt.

BrickServo#set_degree(servo_num, min, max) → nil
Parameter:
  • servo_num – Typ: int, Wertebereich: [0 bis 6, 128 bis 255]
  • min – Typ: int, Einheit: 1/100 °, Wertebereich: [-215 bis 215 - 1], Standardwert: -9000
  • max – Typ: int, 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 #set_position 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 #set_position 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. #set_position steuert jetzt die Drehzahl in U/min.

Der minimale Wert muss kleiner als der maximale sein.

BrickServo#get_degree(servo_num) → [int, int]
Parameter:
  • servo_num – Typ: int, Wertebereich: [0 bis 6]
Rückgabe-Array:
  • 0: min – Typ: int, Einheit: 1/100 °, Wertebereich: [-215 bis 215 - 1], Standardwert: -9000
  • 1: max – Typ: int, 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 #set_degree gesetzt.

BrickServo#set_period(servo_num, period) → nil
Parameter:
  • servo_num – Typ: int, 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.

BrickServo#get_period(servo_num) → int
Parameter:
  • servo_num – Typ: int, 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 #set_period gesetzt.

BrickServo#get_servo_current(servo_num) → int
Parameter:
  • servo_num – Typ: int, 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.

BrickServo#get_overall_current → int
Rückgabe:
  • current – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1]

Gibt den Stromverbrauch aller Servos zusammen zurück.

BrickServo#get_stack_input_voltage → int
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.

BrickServo#get_external_input_voltage → int
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

BrickServo#set_spitfp_baudrate_config(enable_dynamic_baudrate, minimum_dynamic_baudrate) → nil
Parameter:
  • enable_dynamic_baudrate – Typ: bool, Standardwert: true
  • minimum_dynamic_baudrate – Typ: int, 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 #set_spitfp_baudrate. gesetzt werden. Falls die dynamische Baudrate nicht aktiviert ist, wird die Baudrate wie von #set_spitfp_baudrate gesetzt statisch verwendet.

Neu in Version 2.3.4 (Firmware).

BrickServo#get_spitfp_baudrate_config → [bool, int]
Rückgabe-Array:
  • 0: enable_dynamic_baudrate – Typ: bool, Standardwert: true
  • 1: minimum_dynamic_baudrate – Typ: int, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 400000

Gibt die Baudratenkonfiguration zurück, siehe #set_spitfp_baudrate_config.

Neu in Version 2.3.4 (Firmware).

BrickServo#get_send_timeout_count(communication_method) → int
Parameter:
  • communication_method – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • timeout_count – Typ: int, 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 communication_method:

  • 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#set_spitfp_baudrate(bricklet_port, baudrate) → nil
Parameter:
  • bricklet_port – Typ: chr, Wertebereich: ['a' bis 'b']
  • baudrate – Typ: int, 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 #get_spitfp_error_count) kann die Baudrate verringert werden.

Wenn das Feature der dynamische Baudrate aktiviert ist, setzt diese Funktion die maximale Baudrate (siehe #set_spitfp_baudrate_config).

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#get_spitfp_baudrate(bricklet_port) → int
Parameter:
  • bricklet_port – Typ: chr, Wertebereich: ['a' bis 'b']
Rückgabe:
  • baudrate – Typ: int, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 1400000

Gibt die Baudrate für einen Bricklet Port zurück, siehe #set_spitfp_baudrate.

Neu in Version 2.3.2 (Firmware).

BrickServo#get_spitfp_error_count(bricklet_port) → [int, int, int, int]
Parameter:
  • bricklet_port – Typ: chr, Wertebereich: ['a' bis 'b']
Rückgabe-Array:
  • 0: error_count_ack_checksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 1: error_count_message_checksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 2: error_count_frame – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 3: error_count_overflow – Typ: int, 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#enable_status_led → nil

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#disable_status_led → nil

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#is_status_led_enabled → bool
Rückgabe:
  • enabled – Typ: bool, Standardwert: true

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

Neu in Version 2.3.1 (Firmware).

BrickServo#get_chip_temperature → int
Rückgabe:
  • temperature – Typ: int, 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 → nil

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#get_identity → [str, str, chr, [int, ...], [int, ...], int]
Rückgabe-Array:
  • 0: uid – Typ: str, Länge: bis zu 8
  • 1: connected_uid – Typ: str, Länge: bis zu 8
  • 2: position – Typ: chr, Wertebereich: ['0' bis '8']
  • 3: hardware_version – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]
  • 4: firmware_version – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]
  • 5: device_identifier – 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 Callbacks

BrickServo#register_callback(callback_id) { |param [, ...]| block } → nil
Parameter:
  • callback_id – Typ: int

Registriert den block für die gegebene callback_id.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

BrickServo#set_minimum_voltage(voltage) → nil
Parameter:
  • voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 5000

Setzt die minimale Spannung, bei welcher der ::CALLBACK_UNDER_VOLTAGE 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#get_minimum_voltage → int
Rückgabe:
  • voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 5000

Gibt die minimale Spannung zurück, wie von #set_minimum_voltage gesetzt.

BrickServo#enable_position_reached_callback → nil

Aktiviert den ::CALLBACK_POSITION_REACHED Callback.

Voreinstellung ist deaktiviert.

Neu in Version 2.0.1 (Firmware).

BrickServo#disable_position_reached_callback → nil

Deaktiviert den ::CALLBACK_POSITION_REACHED Callback.

Neu in Version 2.0.1 (Firmware).

BrickServo#is_position_reached_callback_enabled → bool
Rückgabe:
  • enabled – Typ: bool, Standardwert: false

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

Neu in Version 2.0.1 (Firmware).

BrickServo#enable_velocity_reached_callback → nil

Aktiviert den ::CALLBACK_VELOCITY_REACHED Callback.

Voreinstellung ist deaktiviert.

Neu in Version 2.0.1 (Firmware).

BrickServo#disable_velocity_reached_callback → nil

Deaktiviert den ::CALLBACK_VELOCITY_REACHED Callback.

Voreinstellung ist deaktiviert.

Neu in Version 2.0.1 (Firmware).

BrickServo#is_velocity_reached_callback_enabled → bool
Rückgabe:
  • enabled – Typ: bool, Standardwert: false

Gibt true zurück wenn der ::CALLBACK_VELOCITY_REACHED 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 kann mit der Funktion #register_callback des Geräte Objektes durchgeführt werden. Der erste Parameter ist der Callback ID und der zweite Parameter der Block:

servo.register_callback BrickServo::CALLBACK_EXAMPLE, do |param|
  puts "#{param}"
end

Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen 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.

BrickServo::CALLBACK_UNDER_VOLTAGE
Callback-Parameter:
  • voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

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

BrickServo::CALLBACK_POSITION_REACHED
Callback-Parameter:
  • servo_num – Typ: int, Wertebereich: [0 bis 6]
  • position – Typ: int, Einheit: 1/100 °, Wertebereich: ?

Dieser Callback wird ausgelöst, wenn eine konfigurierte Position, wie von #set_position 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 #enable_position_reached_callback aktiviert werden.

Bemerkung

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

BrickServo::CALLBACK_VELOCITY_REACHED
Callback-Parameter:
  • servo_num – Typ: int, Wertebereich: [0 bis 6]
  • velocity – Typ: int, Einheit: 1/100 °/s, Wertebereich: [-215 bis 215 - 1]

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

Dieser Callback kann mit #enable_velocity_reached_callback aktiviert werden.

Bemerkung

Da es nicht möglich ist eine Rückmeldung vom Servo zu erhalten, funktioniert dies nur wenn die konfigurierte Beschleunigung (siehe #set_acceleration) 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#get_api_version → [int, ...]
Rückgabe-Array:
  • 0: api_version – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, 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#get_response_expected(function_id) → bool
Parameter:
  • function_id – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • response_expected – 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 #set_response_expected. 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 function_id:

  • 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#set_response_expected(function_id, response_expected) → nil
Parameter:
  • function_id – Typ: int, Wertebereich: Siehe Konstanten
  • response_expected – 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.

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 function_id:

  • 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#set_response_expected_all(response_expected) → nil
Parameter:
  • response_expected – 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.

BrickServo#get_protocol1_bricklet_name(port) → [int, [int, ...], str]
Parameter:
  • port – Typ: chr, Wertebereich: ['a' bis 'b']
Rückgabe-Array:
  • 0: protocol_version – Typ: int, Wertebereich: [0 bis 255]
  • 1: firmware_version – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]
  • 2: name – Typ: str, 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#write_bricklet_plugin(port, offset, chunk) → nil
Parameter:
  • port – Typ: chr, Wertebereich: ['a' bis 'b']
  • offset – Typ: int, Wertebereich: [0 bis 255]
  • chunk – Typ: [int, ...], 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.

BrickServo#read_bricklet_plugin(port, offset) → [int, ...]
Parameter:
  • port – Typ: chr, Wertebereich: ['a' bis 'b']
  • offset – Typ: int, Wertebereich: [0 bis 255]
Rückgabe:
  • chunk – Typ: [int, ...], 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.

Konstanten

BrickServo::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um einen Servo Brick zu identifizieren.

Die #get_identity() Funktion und der IPConnection::CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

BrickServo::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Servo Brick dar.