Software / API Bindings / Ruby / API Referenz und Beispiele / Bricklets / Performance DC Bricklet

Ruby - Performance DC Bricklet¶

Dies ist die Beschreibung der Ruby API Bindings für das Performance DC Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Performance DC Bricklet 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/bricklet_performance_dc'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Performance DC Bricklet

ipcon = IPConnection.new # Create IP connection
pdc = BrickletPerformanceDC.new UID, ipcon # Create device object

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

pdc.set_drive_mode BrickletPerformanceDC::DRIVE_MODE_DRIVE_COAST
pdc.set_pwm_frequency 10000 # Use PWM frequency of 10 kHz
pdc.set_motion 4096, 4096 # Slow ac-/deceleration (12.5 %/s)
pdc.set_velocity 32767 # Full speed forward (100 %)
pdc.set_enabled true # Enable motor power

puts 'Press key to exit'
$stdin.gets

# Stop motor before disabling motor power
pdc.set_motion 4096, 16384 # Fast decceleration (50 %/s) for stopping
pdc.set_velocity 0 # Request motor stop
sleep 2 # Wait for motor to actually stop: velocity (100 %) / decceleration (50 %/s) = 2 s
pdc.set_enabled false # Disable motor power

ipcon.disconnect

Callback¶

Download (example_callback.rb)

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

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_performance_dc'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Performance DC Bricklet

ipcon = IPConnection.new # Create IP connection
pdc = BrickletPerformanceDC.new UID, ipcon # Create device object

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

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

# Enable velocity reached callback
pdc.set_velocity_reached_callback_configuration true

# 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
pdc.set_motion 4096, 4096 # Slow acceleration (12.5 %/s)
pdc.set_velocity 32767 # Full speed forward (100 %)

# Enable motor power
pdc.set_enabled true

puts 'Press key to exit'
$stdin.gets

# Stop motor before disabling motor power
pdc.set_motion 4096, 16384 # Fast decceleration (50 %/s) for stopping
pdc.set_velocity 0 # Request motor stop
sleep 2 # Wait for motor to actually stop: velocity (100 %) / decceleration (50 %/s) = 2 s
pdc.set_enabled false # Disable motor power

ipcon.disconnect

API¶

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen¶

BrickletPerformanceDC::new(uid, ipcon) → performance_dc¶

Parameter:	uid – Typ: str ipcon – Typ: IPConnection
Rückgabe:	performance_dc – Typ: BrickletPerformanceDC

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

performance_dc = BrickletPerformanceDC.new 'YOUR_DEVICE_UID', ipcon

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

BrickletPerformanceDC#set_enabled(enabled) → nil¶

Parameter:	enabled – Typ: bool

Aktiviert/Deaktiviert die Treiberstufe. Die Treiberparameter können vor der Aktivierung konfiguriert werden (Geschwindigkeit, Beschleunigung, etc.).

BrickletPerformanceDC#get_enabled → bool¶

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

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

BrickletPerformanceDC#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_motion) 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.

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

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

BrickletPerformanceDC#set_motion(acceleration, deceleration) → nil¶

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

Setzt die Beschleunigung/Debeschleunigung 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/Debeschleunigung von 0 bedeutet ein direkter Sprung des Motors auf die Zielgeschwindigkeit. Es Wird keine Rampe gefahren.

BrickletPerformanceDC#get_motion → [int, int]¶

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

Gibt die Beschleunigung/Debeschleunigung zurück, wie gesetzt von #set_motion.

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

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

BrickletPerformanceDC#get_power_statistics → [int, int, int]¶

Rückgabe-Array:	0: voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1] 1: current – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 2¹⁶ - 1] 2: temperature – Typ: int, Einheit: 1/10 °, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]

Gibt die Eingangsspannung, den Stromverbrauch und die Temperatur des Treibers zurück.

BrickletPerformanceDC#set_thermal_shutdown(temperature) → nil¶

Parameter:	temperature – Typ: int, Einheit: 1 °, Wertebereich: [0 bis 255], Standardwert: 125

Setzt den Temperatur-Grenzwert für eine thermale Abschaltung.

Neben diesem nutzerdefinierten Grenzwert schaltet er Treiber selbst ab einer Temperatur von 150° ab.

Wenn es zu einer thermalen Abschaltung kommt wird der Treiber deaktiviert und er muss explizit per #set_enabled wieder aktiviert werden.

BrickletPerformanceDC#get_thermal_shutdown → int¶

Rückgabe:	temperature – Typ: int, Einheit: 1 °, Wertebereich: [0 bis 255]

Gibt die thermale Abschalttemperatur zurück, wie von #set_thermal_shutdown gesetzt.

BrickletPerformanceDC#set_gpio_configuration(channel, debounce, stop_deceleration) → nil¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 1] debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 200 stop_deceleration – Typ: int, Einheit: 100/32767 %/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 2¹⁶ - 1

Setzt die GPIO-Konfiguration für einen Kanal. Es kann ein Debounce und eine Debeschleunigung gesetzt werden. Letzteres wird genutzt wenn die Action auf normal stop konfiguriert ist. Siehe #set_gpio_action.

BrickletPerformanceDC#get_gpio_configuration(channel) → [int, int]¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 1]
Rückgabe-Array:	0: debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 200 1: stop_deceleration – Typ: int, Einheit: 100/32767 %/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 2¹⁶ - 1

Gibt die GPIO-Konfiguration für einen Kanal zurück, wie von #set_gpio_configuration gesetzt.

BrickletPerformanceDC#set_gpio_action(channel, action) → nil¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 1] action – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0

Setzt die GPIO-Action für einen Kanal.

Die Action kann ein normal stop, ein full brake oder ein callback sein. Jeweils für eine steigende oder fallende Flanke. Die Actions sind eine Bitmaske und sie können simultan verwendet werden. Es ist zum Beispiel möglich einen full brake und callback gleichzeitig zu triggern oder eine auf eine steigende und fallende Flanke gleichzeitig.

Die Debeschleunigung für den normal stop kann über #set_gpio_configuration konfiguriert werden.

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

Für action:

BrickletPerformanceDC::GPIO_ACTION_NONE = 0
BrickletPerformanceDC::GPIO_ACTION_NORMAL_STOP_RISING_EDGE = 1
BrickletPerformanceDC::GPIO_ACTION_NORMAL_STOP_FALLING_EDGE = 2
BrickletPerformanceDC::GPIO_ACTION_FULL_BRAKE_RISING_EDGE = 4
BrickletPerformanceDC::GPIO_ACTION_FULL_BRAKE_FALLING_EDGE = 8
BrickletPerformanceDC::GPIO_ACTION_CALLBACK_RISING_EDGE = 16
BrickletPerformanceDC::GPIO_ACTION_CALLBACK_FALLING_EDGE = 32

BrickletPerformanceDC#get_gpio_action(channel) → int¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 1]
Rückgabe:	action – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0

Gibt die GPIO-Action für einen Kanal zurück, wie von #set_gpio_action gesetzt.

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

Für action:

BrickletPerformanceDC::GPIO_ACTION_NONE = 0
BrickletPerformanceDC::GPIO_ACTION_NORMAL_STOP_RISING_EDGE = 1
BrickletPerformanceDC::GPIO_ACTION_NORMAL_STOP_FALLING_EDGE = 2
BrickletPerformanceDC::GPIO_ACTION_FULL_BRAKE_RISING_EDGE = 4
BrickletPerformanceDC::GPIO_ACTION_FULL_BRAKE_FALLING_EDGE = 8
BrickletPerformanceDC::GPIO_ACTION_CALLBACK_RISING_EDGE = 16
BrickletPerformanceDC::GPIO_ACTION_CALLBACK_FALLING_EDGE = 32

BrickletPerformanceDC#get_gpio_state → [bool, ...]¶

Rückgabe:	gpio_state – Typ: [bool, ...], Länge: 2

Gibt den GPIO-Zustand für beide Kanäle zurück. True wenn der der Zustand high ist und false wenn der Zustand low ist.

Fortgeschrittene Funktionen¶

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

BrickletPerformanceDC::DRIVE_MODE_DRIVE_BRAKE = 0
BrickletPerformanceDC::DRIVE_MODE_DRIVE_COAST = 1

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

BrickletPerformanceDC::DRIVE_MODE_DRIVE_BRAKE = 0
BrickletPerformanceDC::DRIVE_MODE_DRIVE_COAST = 1

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

BrickletPerformanceDC#set_error_led_config(config) → nil¶

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

Konfiguriert die Touch-LED. Die LED kann ausgeschaltet, eingeschaltet, im Herzschlagmodus betrieben werden. Zusätzlich gibt es die Option den Fehler-Status anzuzeigen.

Wenn die LED konfiguriert ist um Fehler anzuzeigen gibt es drei unterschiedliche Zustände:

Aus: Es liegt kein Fehler vor.
1s Intervall-Blinken: Eingangsspannung zu klein (unter 6V).
250ms Intervall-Blinken: Übertemperatur oder Überstrom.

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

Für config:

BrickletPerformanceDC::ERROR_LED_CONFIG_OFF = 0
BrickletPerformanceDC::ERROR_LED_CONFIG_ON = 1
BrickletPerformanceDC::ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletPerformanceDC::ERROR_LED_CONFIG_SHOW_ERROR = 3

BrickletPerformanceDC#get_error_led_config → int¶

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

Gibt die LED-Konfiguration zurück, wie von #set_error_led_config gesetzt.

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

Für config:

BrickletPerformanceDC::ERROR_LED_CONFIG_OFF = 0
BrickletPerformanceDC::ERROR_LED_CONFIG_ON = 1
BrickletPerformanceDC::ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletPerformanceDC::ERROR_LED_CONFIG_SHOW_ERROR = 3

BrickletPerformanceDC#set_cw_led_config(config) → nil¶

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

Konfiguriert die CW-LED. Die LED kann ausgeschaltet, eingeschaltet, im Herzschlagmodus betrieben werden. Zusätzlich gibt es die Option anzuzeigen ob der Motor im Uhrzeigersinn dreht.

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

Für config:

BrickletPerformanceDC::CW_LED_CONFIG_OFF = 0
BrickletPerformanceDC::CW_LED_CONFIG_ON = 1
BrickletPerformanceDC::CW_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletPerformanceDC::CW_LED_CONFIG_SHOW_CW_AS_FORWARD = 3
BrickletPerformanceDC::CW_LED_CONFIG_SHOW_CW_AS_BACKWARD = 4

BrickletPerformanceDC#get_cw_led_config → int¶

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

Gibt die LED-Konfiguration zurück, wie von #set_cw_led_config gesetzt.

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

Für config:

BrickletPerformanceDC::CW_LED_CONFIG_OFF = 0
BrickletPerformanceDC::CW_LED_CONFIG_ON = 1
BrickletPerformanceDC::CW_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletPerformanceDC::CW_LED_CONFIG_SHOW_CW_AS_FORWARD = 3
BrickletPerformanceDC::CW_LED_CONFIG_SHOW_CW_AS_BACKWARD = 4

BrickletPerformanceDC#set_ccw_led_config(config) → nil¶

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

Konfiguriert die CCW-LED. Die LED kann ausgeschaltet, eingeschaltet, im Herzschlagmodus betrieben werden. Zusätzlich gibt es die Option anzuzeigen ob der Motor gegen den Uhrzeigersinn dreht.

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

Für config:

BrickletPerformanceDC::CCW_LED_CONFIG_OFF = 0
BrickletPerformanceDC::CCW_LED_CONFIG_ON = 1
BrickletPerformanceDC::CCW_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletPerformanceDC::CCW_LED_CONFIG_SHOW_CCW_AS_FORWARD = 3
BrickletPerformanceDC::CCW_LED_CONFIG_SHOW_CCW_AS_BACKWARD = 4

BrickletPerformanceDC#get_ccw_led_config → int¶

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

Gibt die LED-Konfiguration zurück, wie von #set_ccw_led_config gesetzt.

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

Für config:

BrickletPerformanceDC::CCW_LED_CONFIG_OFF = 0
BrickletPerformanceDC::CCW_LED_CONFIG_ON = 1
BrickletPerformanceDC::CCW_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletPerformanceDC::CCW_LED_CONFIG_SHOW_CCW_AS_FORWARD = 3
BrickletPerformanceDC::CCW_LED_CONFIG_SHOW_CCW_AS_BACKWARD = 4

BrickletPerformanceDC#set_gpio_led_config(channel, config) → nil¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 1] config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 4

Konfiguriert die GPIO-LED. Die LED kann ausgeschaltet, eingeschaltet, im Herzschlagmodus betrieben werden. Zusätzlich gibt es die Option den GPIO-Zustand anzuzeigen.

Die GPIO-LED kann für beide Kanäle konfiguriert werden.

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

Für config:

BrickletPerformanceDC::GPIO_LED_CONFIG_OFF = 0
BrickletPerformanceDC::GPIO_LED_CONFIG_ON = 1
BrickletPerformanceDC::GPIO_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletPerformanceDC::GPIO_LED_CONFIG_SHOW_GPIO_ACTIVE_HIGH = 3
BrickletPerformanceDC::GPIO_LED_CONFIG_SHOW_GPIO_ACTIVE_LOW = 4

BrickletPerformanceDC#get_gpio_led_config(channel) → int¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 1]
Rückgabe:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 4

Gibt die LED-Konfiguration zurück, wie von #set_gpio_led_config gesetzt.

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

Für config:

BrickletPerformanceDC::GPIO_LED_CONFIG_OFF = 0
BrickletPerformanceDC::GPIO_LED_CONFIG_ON = 1
BrickletPerformanceDC::GPIO_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletPerformanceDC::GPIO_LED_CONFIG_SHOW_GPIO_ACTIVE_HIGH = 3
BrickletPerformanceDC::GPIO_LED_CONFIG_SHOW_GPIO_ACTIVE_LOW = 4

BrickletPerformanceDC#get_spitfp_error_count → [int, int, int, int]¶

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

BrickletPerformanceDC#set_status_led_config(config) → nil¶

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

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

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

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

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

Für config:

BrickletPerformanceDC::STATUS_LED_CONFIG_OFF = 0
BrickletPerformanceDC::STATUS_LED_CONFIG_ON = 1
BrickletPerformanceDC::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletPerformanceDC::STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletPerformanceDC#get_status_led_config → int¶

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

Gibt die Konfiguration zurück, wie von #set_status_led_config gesetzt.

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

Für config:

BrickletPerformanceDC::STATUS_LED_CONFIG_OFF = 0
BrickletPerformanceDC::STATUS_LED_CONFIG_ON = 1
BrickletPerformanceDC::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletPerformanceDC::STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletPerformanceDC#get_chip_temperature → int¶

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

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

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

BrickletPerformanceDC#reset → nil¶

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

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

BrickletPerformanceDC#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: ['a' bis 'h', 'z'] 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: ['a' bis 'h', 'z']
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 das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

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

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

Konfigurationsfunktionen für Callbacks¶

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

BrickletPerformanceDC#set_emergency_shutdown_callback_configuration(enabled) → nil¶

Parameter:	enabled – Typ: bool, Standardwert: false

Aktiviert/Deaktiviert ::CALLBACK_EMERGENCY_SHUTDOWN Callback.

BrickletPerformanceDC#get_emergency_shutdown_callback_configuration → bool¶

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

Gibt die Callback-Konfiguration zurück, wie mittels #set_emergency_shutdown_callback_configuration gesetzt.

BrickletPerformanceDC#set_velocity_reached_callback_configuration(enabled) → nil¶

Parameter:	enabled – Typ: bool, Standardwert: false

Aktiviert/Deaktiviert ::CALLBACK_VELOCITY_REACHED Callback.

BrickletPerformanceDC#get_velocity_reached_callback_configuration → bool¶

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

Gibt die Callback-Konfiguration zurück, wie mittels #set_velocity_reached_callback_configuration gesetzt.

BrickletPerformanceDC#set_current_velocity_callback_configuration(period, value_has_to_change) → nil¶

Parameter:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false

Die Periode ist die Periode mit der der ::CALLBACK_CURRENT_VELOCITY Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

BrickletPerformanceDC#get_current_velocity_callback_configuration → [int, bool]¶

Rückgabe-Array:	0: period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 1: value_has_to_change – Typ: bool, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels #set_current_velocity_callback_configuration 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:

performance_dc.register_callback BrickletPerformanceDC::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.

BrickletPerformanceDC::CALLBACK_EMERGENCY_SHUTDOWN¶

Callback-Parameter:	keine Parameter

Dieser Callback wird ausgelöst, wenn entweder der Stromverbrauch oder die Temperatur der Treiberstufe zu hoch ist (über 150°C) oder die nutzerdefinierte Abschaltungstemperatur überstiegen wird (siehe #set_thermal_shutdown). Im Falle einer Spannung unter 6V (Eingangsspannung) wird dieser Callback auch ausgelöst.

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

BrickletPerformanceDC::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_motion) 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.

BrickletPerformanceDC::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_callback_configuration, 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.

BrickletPerformanceDC::CALLBACK_GPIO_STATE¶

Callback-Parameter:	gpio_state – Typ: [bool, ...], Länge: 2

Dieser Callback wird ausgelöst durch GPIO-Änderungen wenn er über #set_gpio_action aktiviert wurde.

Neu in Version 2.0.1 (Plugin).

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.

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

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

BrickletPerformanceDC::FUNCTION_SET_ENABLED = 1
BrickletPerformanceDC::FUNCTION_SET_VELOCITY = 3
BrickletPerformanceDC::FUNCTION_SET_MOTION = 6
BrickletPerformanceDC::FUNCTION_FULL_BRAKE = 8
BrickletPerformanceDC::FUNCTION_SET_DRIVE_MODE = 9
BrickletPerformanceDC::FUNCTION_SET_PWM_FREQUENCY = 11
BrickletPerformanceDC::FUNCTION_SET_THERMAL_SHUTDOWN = 14
BrickletPerformanceDC::FUNCTION_SET_GPIO_CONFIGURATION = 16
BrickletPerformanceDC::FUNCTION_SET_GPIO_ACTION = 18
BrickletPerformanceDC::FUNCTION_SET_ERROR_LED_CONFIG = 21
BrickletPerformanceDC::FUNCTION_SET_CW_LED_CONFIG = 23
BrickletPerformanceDC::FUNCTION_SET_CCW_LED_CONFIG = 25
BrickletPerformanceDC::FUNCTION_SET_GPIO_LED_CONFIG = 27
BrickletPerformanceDC::FUNCTION_SET_EMERGENCY_SHUTDOWN_CALLBACK_CONFIGURATION = 29
BrickletPerformanceDC::FUNCTION_SET_VELOCITY_REACHED_CALLBACK_CONFIGURATION = 31
BrickletPerformanceDC::FUNCTION_SET_CURRENT_VELOCITY_CALLBACK_CONFIGURATION = 33
BrickletPerformanceDC::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletPerformanceDC::FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletPerformanceDC::FUNCTION_RESET = 243
BrickletPerformanceDC::FUNCTION_WRITE_UID = 248

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

BrickletPerformanceDC::FUNCTION_SET_ENABLED = 1
BrickletPerformanceDC::FUNCTION_SET_VELOCITY = 3
BrickletPerformanceDC::FUNCTION_SET_MOTION = 6
BrickletPerformanceDC::FUNCTION_FULL_BRAKE = 8
BrickletPerformanceDC::FUNCTION_SET_DRIVE_MODE = 9
BrickletPerformanceDC::FUNCTION_SET_PWM_FREQUENCY = 11
BrickletPerformanceDC::FUNCTION_SET_THERMAL_SHUTDOWN = 14
BrickletPerformanceDC::FUNCTION_SET_GPIO_CONFIGURATION = 16
BrickletPerformanceDC::FUNCTION_SET_GPIO_ACTION = 18
BrickletPerformanceDC::FUNCTION_SET_ERROR_LED_CONFIG = 21
BrickletPerformanceDC::FUNCTION_SET_CW_LED_CONFIG = 23
BrickletPerformanceDC::FUNCTION_SET_CCW_LED_CONFIG = 25
BrickletPerformanceDC::FUNCTION_SET_GPIO_LED_CONFIG = 27
BrickletPerformanceDC::FUNCTION_SET_EMERGENCY_SHUTDOWN_CALLBACK_CONFIGURATION = 29
BrickletPerformanceDC::FUNCTION_SET_VELOCITY_REACHED_CALLBACK_CONFIGURATION = 31
BrickletPerformanceDC::FUNCTION_SET_CURRENT_VELOCITY_CALLBACK_CONFIGURATION = 33
BrickletPerformanceDC::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletPerformanceDC::FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletPerformanceDC::FUNCTION_RESET = 243
BrickletPerformanceDC::FUNCTION_WRITE_UID = 248

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

BrickletPerformanceDC#set_bootloader_mode(mode) → int¶

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

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

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

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

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

Für mode:

BrickletPerformanceDC::BOOTLOADER_MODE_BOOTLOADER = 0
BrickletPerformanceDC::BOOTLOADER_MODE_FIRMWARE = 1
BrickletPerformanceDC::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BrickletPerformanceDC::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BrickletPerformanceDC::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

BrickletPerformanceDC::BOOTLOADER_STATUS_OK = 0
BrickletPerformanceDC::BOOTLOADER_STATUS_INVALID_MODE = 1
BrickletPerformanceDC::BOOTLOADER_STATUS_NO_CHANGE = 2
BrickletPerformanceDC::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
BrickletPerformanceDC::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
BrickletPerformanceDC::BOOTLOADER_STATUS_CRC_MISMATCH = 5

BrickletPerformanceDC#get_bootloader_mode → int¶

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

Gibt den aktuellen Bootloader-Modus zurück, siehe #set_bootloader_mode.

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

Für mode:

BrickletPerformanceDC::BOOTLOADER_MODE_BOOTLOADER = 0
BrickletPerformanceDC::BOOTLOADER_MODE_FIRMWARE = 1
BrickletPerformanceDC::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BrickletPerformanceDC::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BrickletPerformanceDC::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

BrickletPerformanceDC#set_write_firmware_pointer(pointer) → nil¶

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

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

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

BrickletPerformanceDC#write_firmware(data) → int¶

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

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

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

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

BrickletPerformanceDC#write_uid(uid) → nil¶

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

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

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

BrickletPerformanceDC#read_uid → int¶

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

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

Konstanten¶

BrickletPerformanceDC::DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Performance DC Bricklet 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.

BrickletPerformanceDC::DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Performance DC Bricklet dar.