Software / API Bindings / Ruby / API Referenz und Beispiele / Bricks (Abgekündigt) / DC Brick

Ruby - DC Brick¶

Dies ist die Beschreibung der Ruby API Bindings für den DC Brick. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des DC 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).

Configuration¶

Download (example_configuration.rb)

#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/brick_dc'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
dc = BrickDC.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

dc.set_drive_mode BrickDC::DRIVE_MODE_DRIVE_COAST
dc.set_pwm_frequency 10000 # Use PWM frequency of 10 kHz
dc.set_acceleration 4096 # Slow acceleration (12.5 %/s)
dc.set_velocity 32767 # Full speed forward (100 %)
dc.enable # Enable motor power

puts 'Press key to exit'
$stdin.gets

# Stop motor before disabling motor power
dc.set_acceleration 16384 # Fast decceleration (50 %/s) for stopping
dc.set_velocity 0 # Request motor stop
sleep 2 # Wait for motor to actually stop: velocity (100 %) / decceleration (50 %/s) = 2 s
dc.disable # Disable motor power

ipcon.disconnect

Callback¶

Download (example_callback.rb)

#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/brick_dc'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
dc = BrickDC.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# The acceleration has to be smaller or equal to the maximum
# acceleration of the DC motor, otherwise the velocity reached
# callback will be called too early
dc.set_acceleration 4096 # Slow acceleration (12.5 %/s)
dc.set_velocity 32767 # Full speed forward (100 %)

# Use velocity reached callback to swing back and forth
# between full speed forward and full speed backward
dc.register_callback(BrickDC::CALLBACK_VELOCITY_REACHED) do |velocity|
  if velocity == 32767
    puts 'Velocity: Full speed forward, now turning backward'
    dc.set_velocity(-32767)
  elsif velocity == -32767
    puts 'Velocity: Full speed backward, now turning forward'
    dc.set_velocity 32767
  else
    puts 'Error' # Can only happen if another program sets velocity
  end
end

# Enable motor power
dc.enable

puts 'Press key to exit'
$stdin.gets

# Stop motor before disabling motor power
dc.set_acceleration 16384 # Fast decceleration (50 %/s) for stopping
dc.set_velocity 0 # Request motor stop
sleep 2 # Wait for motor to actually stop: velocity (100 %) / decceleration (50 %/s) = 2 s
dc.disable # Disable motor power

ipcon.disconnect

API¶

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen¶

BrickDC::new(uid, ipcon) → dc¶

Parameter:	uid – Typ: str ipcon – Typ: IPConnection
Rückgabe:	dc – Typ: BrickDC

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

dc = BrickDC.new 'YOUR_DEVICE_UID', ipcon

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

BrickDC#set_velocity(velocity) → nil¶

Parameter:	velocity – Typ: int, Einheit: 100/32767 %, Wertebereich: [-2¹⁵ + 1 bis 2¹⁵ - 1], Standardwert: 0

Setzt die Geschwindigkeit des Motors. Hierbei sind -32767 maximale Geschwindigkeit rückwärts, 0 ist Halt und 32767 maximale Geschwindigkeit vorwärts. In Abhängigkeit von der Beschleunigung (siehe #set_acceleration) wird der Motor nicht direkt auf die Geschwindigkeit gebracht sondern gleichmäßig beschleunigt.

Die Geschwindigkeit beschreibt das Tastverhältnis der PWM für die Motoransteuerung. Z.B. entspricht ein Geschwindigkeitswert von 3277 einer PWM mit einem Tastverhältnis von 10%. Weiterhin kann neben dem Tastverhältnis auch die Frequenz der PWM verändert werden, siehe #set_pwm_frequency.

BrickDC#get_velocity → int¶

Rückgabe:	velocity – Typ: int, Einheit: 100/32767 %, Wertebereich: [-2¹⁵ + 1 bis 2¹⁵ - 1], Standardwert: 0

Gibt die Geschwindigkeit zurück, wie gesetzt von #set_velocity.

BrickDC#get_current_velocity → int¶

Rückgabe:	velocity – Typ: int, Einheit: 100/32767 %, Wertebereich: [-2¹⁵ + 1 bis 2¹⁵ - 1], Standardwert: 0

Gibt die aktuelle Geschwindigkeit des Motors zurück. Dieser Wert unterscheidet sich von #get_velocity, sobald der Motor auf einen neuen Zielwert, wie von #set_velocity vorgegeben, beschleunigt.

BrickDC#set_acceleration(acceleration) → nil¶

Parameter:	acceleration – Typ: int, Einheit: 100/32767 %/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 10000

Setzt die Beschleunigung des Motors. Die Einheit dieses Wertes ist Geschwindigkeit/s. Ein Beschleunigungswert von 10000 bedeutet, dass jede Sekunde die Geschwindigkeit um 10000 erhöht wird (entspricht rund 30% Tastverhältnis).

Beispiel: Soll die Geschwindigkeit von 0 auf 16000 (entspricht ungefähr 50% Tastverhältnis) in 10 Sekunden beschleunigt werden, so ist die Beschleunigung auf 1600 einzustellen.

Eine Beschleunigung von 0 bedeutet ein direkter Sprung des Motors auf die Zielgeschwindigkeit. Es Wird keine Beschleunigungsrampe gefahren.

BrickDC#get_acceleration → int¶

Rückgabe:	acceleration – Typ: int, Einheit: 100/32767 %/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 10000

Gibt die Beschleunigung zurück, wie gesetzt von #set_acceleration.

BrickDC#full_brake → nil¶

Führt eine aktive Vollbremsung aus.

Warnung

Diese Funktion ist für Notsituationen bestimmt, in denen ein unverzüglicher Halt notwendig ist. Abhängig von der aktuellen Geschwindigkeit und der Kraft des Motors kann eine Vollbremsung brachial sein.

Ein Aufruf von #set_velocity mit 0 erlaubt einen normalen Stopp des Motors.

BrickDC#enable → nil¶: Aktiviert die Treiberstufe. Die Treiberparameter können vor der Aktivierung konfiguriert werden (Geschwindigkeit, Beschleunigung, etc.).

BrickDC#disable → nil¶: Deaktiviert die Treiberstufe. Die Konfiguration (Geschwindigkeit, Beschleunigung, etc.) bleibt erhalten aber der Motor wird nicht angesteuert bis eine erneute Aktivierung erfolgt.

Warnung

Die Treiberstufe zu deaktivieren während der Motor sich noch dreht kann zur Beschädigung der Treiberstufe führen. Der Motor sollte durch Aufrufen von #set_velocity mit 0 gestoppt werden, bevor die Treiberstufe deaktiviert wird. Die #set_velocity Funktion wartet nicht bis der Motor wirklich zum Stillstand gekommen ist. Dazu muss nach dem Aufruf der #set_velocity Funktion eine angemessen Zeit gewartet werden bevor die #disable Funktion aufgerufen wird.

BrickDC#is_enabled → bool¶

Rückgabe:	enabled – Typ: bool, Standardwert: false

Gibt true zurück wenn die Treiberstufe aktiv ist, sonst false.

Fortgeschrittene Funktionen¶

BrickDC#set_pwm_frequency(frequency) → nil¶

Parameter:	frequency – Typ: int, Einheit: 1 Hz, Wertebereich: [1 bis 20000], Standardwert: 15000

Setzt die Frequenz der PWM, welche den Motor steuert. Oftmals ist eine hohe Frequenz geräuschärmer und der Motor läuft dadurch ruhiger. Trotz dessen führt eine geringe Frequenz zu weniger Schaltvorgängen und somit zu weniger Schaltverlusten. Bei einer Vielzahl von Motoren ermöglichen geringere Frequenzen höhere Drehmomente.

Im Allgemeinen kann diese Funktion ignoriert werden, da der Standardwert höchstwahrscheinlich zu einem akzeptablen Ergebnis führt.

BrickDC#get_pwm_frequency → int¶

Rückgabe:	frequency – Typ: int, Einheit: 1 Hz, Wertebereich: [1 bis 20000], Standardwert: 15000

Gibt die PWM Frequenz zurück, wie gesetzt von #set_pwm_frequency.

BrickDC#get_stack_input_voltage → int¶

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

Gibt die Eingangsspannung des Stapels zurück. Die Eingangsspannung des Stapel wird über diesen bereitgestellt und von einer Step-Down oder Step-Up Power Supply erzeugt.

BrickDC#get_external_input_voltage → int¶

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

Gibt die externe Eingangsspannung zurück. Die externe Eingangsspannung wird über die schwarze Stromversorgungsbuchse, in den DC Brick, eingespeist.

Sobald eine externe Eingangsspannung und die Spannungsversorgung des Stapels anliegt, wird der Motor über die externe Spannung versorgt. Sollte nur die Spannungsversorgung des Stapels verfügbar sein, erfolgt die Versorgung des Motors über diese.

Warnung

Das bedeutet, bei einer hohen Versorgungsspannung des Stapels und einer geringen externen Versorgungsspannung erfolgt die Spannungsversorgung des Motors über die geringere externe Versorgungsspannung. Wenn dann die externe Spannungsversorgung getrennt wird, erfolgt sofort die Versorgung des Motors über die höhere Versorgungsspannung des Stapels.

BrickDC#get_current_consumption → int¶

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

Gibt die Stromaufnahme des Motors zurück.

BrickDC#set_drive_mode(mode) → nil¶

Parameter:	mode – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0

Setzt den Fahrmodus. Verfügbare Modi sind:

0 = Fahren/Bremsen
1 = Fahren/Leerlauf

Diese Modi sind verschiedene Arten der Motoransteuerung.

Im Fahren/Bremsen Modus wird der Motor entweder gefahren oder gebremst. Es gibt keinen Leerlauf. Vorteile sind die lineare Korrelation zwischen PWM und Geschwindigkeit, präzisere Beschleunigungen und die Möglichkeit mit geringeren Geschwindigkeiten zu fahren.

Im Fahren/Leerlauf Modus wir der Motor entweder gefahren oder befindet sich im Leerlauf. Vorteile sind die geringere Stromaufnahme und geringere Belastung des Motors und der Treiberstufe.

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

Für mode:

BrickDC::DRIVE_MODE_DRIVE_BRAKE = 0
BrickDC::DRIVE_MODE_DRIVE_COAST = 1

BrickDC#get_drive_mode → int¶

Rückgabe:	mode – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0

Gibt den Fahrmodus zurück, wie von #set_drive_mode gesetzt.

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

Für mode:

BrickDC::DRIVE_MODE_DRIVE_BRAKE = 0
BrickDC::DRIVE_MODE_DRIVE_COAST = 1

BrickDC#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.5 (Firmware).

BrickDC#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.5 (Firmware).

BrickDC#get_send_timeout_count(communication_method) → int¶

Parameter:	communication_method – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	timeout_count – Typ: int, Wertebereich: [0 bis 2³² - 1]

Gibt den Timeout-Zähler für die verschiedenen Kommunikationsmöglichkeiten zurück

Die Kommunikationsmöglichkeiten 0-2 stehen auf allen Bricks zur verfügung, 3-7 nur auf Master Bricks.

Diese Funktion ist hauptsächlich zum debuggen während der Entwicklung gedacht. Im normalen Betrieb sollten alle Zähler fast immer auf 0 stehen bleiben.

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

Für communication_method:

BrickDC::COMMUNICATION_METHOD_NONE = 0
BrickDC::COMMUNICATION_METHOD_USB = 1
BrickDC::COMMUNICATION_METHOD_SPI_STACK = 2
BrickDC::COMMUNICATION_METHOD_CHIBI = 3
BrickDC::COMMUNICATION_METHOD_RS485 = 4
BrickDC::COMMUNICATION_METHOD_WIFI = 5
BrickDC::COMMUNICATION_METHOD_ETHERNET = 6
BrickDC::COMMUNICATION_METHOD_WIFI_V2 = 7

Neu in Version 2.3.3 (Firmware).

BrickDC#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.3 (Firmware).

BrickDC#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.3 (Firmware).

BrickDC#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 2³² - 1] 1: error_count_message_checksum – Typ: int, Wertebereich: [0 bis 2³² - 1] 2: error_count_frame – Typ: int, Wertebereich: [0 bis 2³² - 1] 3: error_count_overflow – Typ: int, Wertebereich: [0 bis 2³² - 1]

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

ACK-Checksummen Fehler,
Message-Checksummen Fehler,
Framing Fehler und
Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricks auftreten. Jedes Bricklet hat eine ähnliche Funktion welche die Fehler auf Brickletseite ausgibt.

Neu in Version 2.3.3 (Firmware).

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

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

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

BrickDC#get_chip_temperature → int¶

Rückgabe:	temperature – Typ: int, Einheit: 1/10 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]

Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine Genauigkeit von ±15%. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

BrickDC#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.

BrickDC#get_identity → [str, str, chr, [int, ...], [int, ...], int]¶

Rückgabe-Array:

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

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

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

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

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

Konfigurationsfunktionen für Callbacks¶

BrickDC#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.

BrickDC#set_minimum_voltage(voltage) → nil¶

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

Setzt die minimale Spannung, bei welcher der ::CALLBACK_UNDER_VOLTAGE Callback ausgelöst wird. Der kleinste mögliche Wert mit dem der DC Brick noch funktioniert, ist 6V. Mit dieser Funktion kann eine Entladung der versorgenden Batterie detektiert werden. Beim Einsatz einer Netzstromversorgung wird diese Funktionalität höchstwahrscheinlich nicht benötigt.

BrickDC#get_minimum_voltage → int¶

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

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

BrickDC#set_current_velocity_period(period) → nil¶

Parameter:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0

Setzt die Periode mit welcher der ::CALLBACK_CURRENT_VELOCITY Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

BrickDC#get_current_velocity_period → int¶

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

Gibt die Periode zurück, wie von #set_current_velocity_period gesetzt.

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:

dc.register_callback BrickDC::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.

BrickDC::CALLBACK_UNDER_VOLTAGE¶

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

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

BrickDC::CALLBACK_EMERGENCY_SHUTDOWN¶

Callback-Parameter:	keine Parameter

Dieser Callback wird ausgelöst, wenn entweder der Stromverbrauch (über 5A) oder die Temperatur der Treiberstufe zu hoch ist (über 175°C). Beide Möglichkeiten sind letztendlich gleichbedeutend, da die Temperatur ihren Schwellwert überschreitet sobald der Motor zu viel Strom verbraucht. Im Falle einer Spannung unter 3,3V (Stapel- oder externe Spannungsversorgung) wird dieser Callback auch ausgelöst.

Sobald dieser Callback ausgelöst wird, wird die Treiberstufe deaktiviert. Das bedeutet #enable muss aufgerufen werden, um den Motor erneut zu fahren.

Bemerkung

Dieser Callback funktioniert nur im Fahren/Bremsen Modus (siehe #set_drive_mode). Im Fahren/Leerlauf Modus ist es leider nicht möglich das Überstrom/Übertemperatur-Signal zuverlässig aus dem Chip der Treiberstufe auszulesen.

BrickDC::CALLBACK_VELOCITY_REACHED¶

Callback-Parameter:	velocity – Typ: int, Einheit: 100/32767 %, Wertebereich: [-2¹⁵ + 1 bis 2¹⁵ - 1]

Dieser Callback wird ausgelöst immer wenn eine konfigurierte Geschwindigkeit erreicht wird. Beispiel: Wenn die aktuelle Geschwindigkeit 0 ist, die Beschleunigung auf 5000 und die Geschwindigkeit auf 10000 konfiguriert ist, wird der ::CALLBACK_VELOCITY_REACHED Callback nach ungefähr 2 Sekunden ausgelöst, wenn die konfigurierte Geschwindigkeit letztendlich erreicht ist.

Bemerkung

Da es nicht möglich ist eine Rückmeldung vom Gleichstrommotor 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.

BrickDC::CALLBACK_CURRENT_VELOCITY¶

Callback-Parameter:	velocity – Typ: int, Einheit: 100/32767 %, Wertebereich: [-2¹⁵ + 1 bis 2¹⁵ - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit #set_current_velocity_period, ausgelöst. Der Parameter ist die aktuelle vom Motor genutzte Geschwindigkeit.

Der ::CALLBACK_CURRENT_VELOCITY Callback wird nur nach Ablauf der Periode ausgelöst, wenn sich die Geschwindigkeit geändert hat.

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.

BrickDC#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.

BrickDC#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:

BrickDC::FUNCTION_SET_VELOCITY = 1
BrickDC::FUNCTION_SET_ACCELERATION = 4
BrickDC::FUNCTION_SET_PWM_FREQUENCY = 6
BrickDC::FUNCTION_FULL_BRAKE = 8
BrickDC::FUNCTION_ENABLE = 12
BrickDC::FUNCTION_DISABLE = 13
BrickDC::FUNCTION_SET_MINIMUM_VOLTAGE = 15
BrickDC::FUNCTION_SET_DRIVE_MODE = 17
BrickDC::FUNCTION_SET_CURRENT_VELOCITY_PERIOD = 19
BrickDC::FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231
BrickDC::FUNCTION_SET_SPITFP_BAUDRATE = 234
BrickDC::FUNCTION_ENABLE_STATUS_LED = 238
BrickDC::FUNCTION_DISABLE_STATUS_LED = 239
BrickDC::FUNCTION_RESET = 243
BrickDC::FUNCTION_WRITE_BRICKLET_PLUGIN = 246

BrickDC#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.

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

Für function_id:

BrickDC::FUNCTION_SET_VELOCITY = 1
BrickDC::FUNCTION_SET_ACCELERATION = 4
BrickDC::FUNCTION_SET_PWM_FREQUENCY = 6
BrickDC::FUNCTION_FULL_BRAKE = 8
BrickDC::FUNCTION_ENABLE = 12
BrickDC::FUNCTION_DISABLE = 13
BrickDC::FUNCTION_SET_MINIMUM_VOLTAGE = 15
BrickDC::FUNCTION_SET_DRIVE_MODE = 17
BrickDC::FUNCTION_SET_CURRENT_VELOCITY_PERIOD = 19
BrickDC::FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231
BrickDC::FUNCTION_SET_SPITFP_BAUDRATE = 234
BrickDC::FUNCTION_ENABLE_STATUS_LED = 238
BrickDC::FUNCTION_DISABLE_STATUS_LED = 239
BrickDC::FUNCTION_RESET = 243
BrickDC::FUNCTION_WRITE_BRICKLET_PLUGIN = 246

BrickDC#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.

BrickDC#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.

BrickDC#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.

BrickDC#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¶

BrickDC::DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um einen DC 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.

BrickDC::DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines DC Brick dar.