Shell - Performance DC Bricklet¶

Configuration¶

Download (example-configuration.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Performance DC Bricklet

tinkerforge call performance-dc-bricklet $uid set-drive-mode drive-mode-drive-coast
tinkerforge call performance-dc-bricklet $uid set-pwm-frequency 10000 # Use PWM frequency of 10 kHz
tinkerforge call performance-dc-bricklet $uid set-motion 4096 4096 # Slow ac-/deceleration (12.5 %/s)
tinkerforge call performance-dc-bricklet $uid set-velocity 32767 # Full speed forward (100 %)
tinkerforge call performance-dc-bricklet $uid set-enabled true # Enable motor power

echo "Press key to exit"; read dummy

# Stop motor before disabling motor power
tinkerforge call performance-dc-bricklet $uid set-motion 4096 16384 # Fast decceleration (50 %/s) for stopping
tinkerforge call performance-dc-bricklet $uid set-velocity 0 # Request motor stop
sleep 2 # Wait for motor to actually stop: velocity (100 %) / decceleration (50 %/s) = 2 s
tinkerforge call performance-dc-bricklet $uid set-enabled false # Disable motor power

Callback¶

Download (example-callback.sh)

 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

#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Performance DC Bricklet

# Use velocity reached callback to swing back and forth
# between full speed forward and full speed backward
tinkerforge dispatch performance-dc-bricklet $uid velocity-reached\
 --execute "if   [ {velocity} -eq  32767 ]; then tinkerforge call performance-dc-brick $uid set-velocity -32767;
            elif [ {velocity} -eq -32767 ]; then tinkerforge call performance-dc-brick $uid set-velocity  32767;
            else echo error; fi" &

# Enable velocity reached callback
tinkerforge call performance-dc-bricklet $uid 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
tinkerforge call performance-dc-bricklet $uid set-motion 4096 4096 # Slow acceleration (12.5 %/s)
tinkerforge call performance-dc-bricklet $uid set-velocity 32767 # Full speed forward (100 %)

# Enable motor power
tinkerforge call performance-dc-bricklet $uid set-enabled true

echo "Press key to exit"; read dummy

# Stop motor before disabling motor power
tinkerforge call performance-dc-bricklet $uid set-motion 4096 16384 # Fast decceleration (50 %/s) for stopping
tinkerforge call performance-dc-bricklet $uid set-velocity 0 # Request motor stop
sleep 2 # Wait for motor to actually stop: velocity (100 %) / decceleration (50 %/s) = 2 s
tinkerforge call performance-dc-bricklet $uid set-enabled false # Disable motor power

kill -- -$$ # Stop callback dispatch in background

Befehlsstruktur¶

Allgemeine Optionen des call und des dispatch Befehls sind hier zu finden. Im Folgenden wird die spezifische Befehlsstruktur dargestellt.

tinkerforge call performance-dc-bricklet [<option>..] <uid> <function> [<argument>..]¶

Parameter:	<uid> – Typ: String <function> – Typ: String

Der call Befehl wird verwendet um eine Funktion des Performance DC Bricklet aufzurufen. Der Befehl kennt mehrere Optionen:

• --help zeigt Hilfe für den spezifischen call Befehl an und endet dann
• --list-functions zeigt eine Liste der bekannten Funktionen des Performance DC Bricklet an und endet dann

tinkerforge dispatch performance-dc-bricklet [<option>..] <uid> <callback>¶

Parameter:	<uid> – Typ: String <callback> – Typ: String

Der dispatch Befehl wird verwendet um eingehende Callbacks des Performance DC Bricklet abzufertigen. Der Befehl kennt mehrere Optionen:

• --help zeigt Hilfe für den spezifischen dispatch Befehl an und endet dann
• --list-callbacks zeigt eine Liste der bekannten Callbacks des Performance DC Bricklet an und endet dann

tinkerforge call performance-dc-bricklet <uid> <function> [<option>..] [<argument>..]¶

Parameter:	<uid> – Typ: String <function> – Typ: String

Abhängig von der Art der aufzurufenden <function> kennt diese verschiedene Optionen. Alle Funktionen kennen die folgenden Optionen:

• --help zeigt Hilfe für die spezifische <function> an und endet dann

Getter-Funktionen kennen zusätzlich die folgenden Optionen:

• --execute <command> Shell-Befehl der für jede eingehende Antwort ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)

Setter-Funktionen kennen zusätzlich die folgenden Optionen:

• --expect-response fragt Antwort an und wartet auf diese

Mit der --expect-response Option für Setter-Funktionen können Timeouts und andere Fehlerfälle auch für Aufrufe von Setter-Funktionen detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn diese Option für eine Setter-Funktion nicht angegeben ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

tinkerforge dispatch performance-dc-bricklet <uid> <callback> [<option>..]¶

Parameter:	<uid> – Typ: String <callback> – Typ: String

Der abzufertigende <callback> kennt mehrere Optionen:

• --help zeigt Hilfe für den spezifische <callback> an und endet dann
• --execute <command> Shell-Befehlszeile der für jede eingehende Antwort ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)

Grundfunktionen¶

tinkerforge call performance-dc-bricklet <uid> set-enabled <enabled>¶

Parameter:	<enabled> – Typ: Bool
Ausgabe:	keine Ausgabe

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

tinkerforge call performance-dc-bricklet <uid> get-enabled¶

Ausgabe:	enabled – Typ: Bool, Standardwert: false

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

tinkerforge call performance-dc-bricklet <uid> set-velocity <velocity>¶

Parameter:	<velocity> – Typ: Int, Einheit: 100/32767 %, Wertebereich: [-215 + 1 bis 215 - 1], Standardwert: 0
Ausgabe:	keine Ausgabe

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.

tinkerforge call performance-dc-bricklet <uid> get-velocity¶

Ausgabe:	velocity – Typ: Int, Einheit: 100/32767 %, Wertebereich: [-215 + 1 bis 215 - 1], Standardwert: 0

Gibt die Geschwindigkeit zurück, wie gesetzt von set-velocity.

tinkerforge call performance-dc-bricklet <uid> get-current-velocity¶

Ausgabe:	velocity – Typ: Int, Einheit: 100/32767 %, Wertebereich: [-215 + 1 bis 215 - 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.

tinkerforge call performance-dc-bricklet <uid> set-motion <acceleration> <deceleration>¶

Parameter:	<acceleration> – Typ: Int, Einheit: 100/32767 %/s, Wertebereich: [0 bis 216 - 1], Standardwert: 10000 <deceleration> – Typ: Int, Einheit: 100/32767 %/s, Wertebereich: [0 bis 216 - 1], Standardwert: 10000
Ausgabe:	keine Ausgabe

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.

tinkerforge call performance-dc-bricklet <uid> get-motion¶

Ausgabe:	acceleration – Typ: Int, Einheit: 100/32767 %/s, Wertebereich: [0 bis 216 - 1], Standardwert: 10000 deceleration – Typ: Int, Einheit: 100/32767 %/s, Wertebereich: [0 bis 216 - 1], Standardwert: 10000

Gibt die Beschleunigung/Debeschleunigung zurück, wie gesetzt von set-motion.

tinkerforge call performance-dc-bricklet <uid> full-brake¶

Ausgabe:	keine Ausgabe

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.

tinkerforge call performance-dc-bricklet <uid> get-pwm-frequency¶

Ausgabe:	frequency – Typ: Int, Einheit: 1 Hz, Wertebereich: [1 bis 20000], Standardwert: 15000

Gibt die PWM Frequenz zurück, wie gesetzt von set-pwm-frequency.

tinkerforge call performance-dc-bricklet <uid> get-power-statistics¶

Ausgabe:	voltage – Typ: Int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1] current – Typ: Int, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1] temperature – Typ: Int, Einheit: 1/10 °, Wertebereich: [-215 bis 215 - 1]

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

tinkerforge call performance-dc-bricklet <uid> set-thermal-shutdown <temperature>¶

Parameter:	<temperature> – Typ: Int, Einheit: 1 °, Wertebereich: [0 bis 255], Standardwert: 125
Ausgabe:	keine Ausgabe

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.

tinkerforge call performance-dc-bricklet <uid> get-thermal-shutdown¶

Ausgabe:	temperature – Typ: Int, Einheit: 1 °, Wertebereich: [0 bis 255]

Gibt die thermale Abschalttemperatur zurück, wie von set-thermal-shutdown gesetzt.

tinkerforge call performance-dc-bricklet <uid> set-gpio-configuration <channel> <debounce> <stop-deceleration>¶

Parameter:	<channel> – Typ: Int, Wertebereich: [0 bis 1] <debounce> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 200 <stop-deceleration> – Typ: Int, Einheit: 100/32767 %/s, Wertebereich: [0 bis 216 - 1], Standardwert: 216 - 1
Ausgabe:	keine Ausgabe

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.

tinkerforge call performance-dc-bricklet <uid> get-gpio-configuration <channel>¶

Parameter:	<channel> – Typ: Int, Wertebereich: [0 bis 1]
Ausgabe:	debounce – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 200 stop-deceleration – Typ: Int, Einheit: 100/32767 %/s, Wertebereich: [0 bis 216 - 1], Standardwert: 216 - 1

Gibt die GPIO-Konfiguration für einen Kanal zurück, wie von set-gpio-configuration gesetzt.

tinkerforge call performance-dc-bricklet <uid> set-gpio-action <channel> <action>¶

Parameter:	<channel> – Typ: Int, Wertebereich: [0 bis 1] <action> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0
Ausgabe:	keine Ausgabe

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 Symbole sind für diese Funktion verfügbar:

Für <action>:

• gpio-action-none = 0
• gpio-action-normal-stop-rising-edge = 1
• gpio-action-normal-stop-falling-edge = 2
• gpio-action-full-brake-rising-edge = 4
• gpio-action-full-brake-falling-edge = 8
• gpio-action-callback-rising-edge = 16
• gpio-action-callback-falling-edge = 32

tinkerforge call performance-dc-bricklet <uid> get-gpio-action <channel>¶

Parameter:	<channel> – Typ: Int, Wertebereich: [0 bis 1]
Ausgabe:	action – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0

Gibt die GPIO-Action für einen Kanal zurück, wie von set-gpio-action gesetzt.

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

Für action:

• gpio-action-none = 0
• gpio-action-normal-stop-rising-edge = 1
• gpio-action-normal-stop-falling-edge = 2
• gpio-action-full-brake-rising-edge = 4
• gpio-action-full-brake-falling-edge = 8
• gpio-action-callback-rising-edge = 16
• gpio-action-callback-falling-edge = 32

tinkerforge call performance-dc-bricklet <uid> get-gpio-state¶

Ausgabe:	gpio-state – Typ: Bool Array, 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¶

tinkerforge call performance-dc-bricklet <uid> set-drive-mode <mode>¶

Parameter:	<mode> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0
Ausgabe:	keine Ausgabe

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 Symbole sind für diese Funktion verfügbar:

Für <mode>:

• drive-mode-drive-brake = 0
• drive-mode-drive-coast = 1

tinkerforge call performance-dc-bricklet <uid> get-drive-mode¶

Ausgabe:	mode – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0

Gibt den Fahrmodus zurück, wie von set-drive-mode gesetzt.

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

Für mode:

• drive-mode-drive-brake = 0
• drive-mode-drive-coast = 1

tinkerforge call performance-dc-bricklet <uid> set-pwm-frequency <frequency>¶

Parameter:	<frequency> – Typ: Int, Einheit: 1 Hz, Wertebereich: [1 bis 20000], Standardwert: 15000
Ausgabe:	keine Ausgabe

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.

tinkerforge call performance-dc-bricklet <uid> set-error-led-config <config>¶

Parameter:	<config> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3
Ausgabe:	keine Ausgabe

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 Symbole sind für diese Funktion verfügbar:

Für <config>:

• error-led-config-off = 0
• error-led-config-on = 1
• error-led-config-show-heartbeat = 2
• error-led-config-show-error = 3

tinkerforge call performance-dc-bricklet <uid> get-error-led-config¶

Ausgabe:	config – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die LED-Konfiguration zurück, wie von set-error-led-config gesetzt.

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

Für config:

• error-led-config-off = 0
• error-led-config-on = 1
• error-led-config-show-heartbeat = 2
• error-led-config-show-error = 3

tinkerforge call performance-dc-bricklet <uid> set-cw-led-config <config>¶

Parameter:	<config> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3
Ausgabe:	keine Ausgabe

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 Symbole sind für diese Funktion verfügbar:

Für <config>:

• cw-led-config-off = 0
• cw-led-config-on = 1
• cw-led-config-show-heartbeat = 2
• cw-led-config-show-cw-as-forward = 3
• cw-led-config-show-cw-as-backward = 4

tinkerforge call performance-dc-bricklet <uid> get-cw-led-config¶

Ausgabe:	config – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die LED-Konfiguration zurück, wie von set-cw-led-config gesetzt.

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

Für config:

• cw-led-config-off = 0
• cw-led-config-on = 1
• cw-led-config-show-heartbeat = 2
• cw-led-config-show-cw-as-forward = 3
• cw-led-config-show-cw-as-backward = 4

tinkerforge call performance-dc-bricklet <uid> set-ccw-led-config <config>¶

Parameter:	<config> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3
Ausgabe:	keine Ausgabe

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 Symbole sind für diese Funktion verfügbar:

Für <config>:

• ccw-led-config-off = 0
• ccw-led-config-on = 1
• ccw-led-config-show-heartbeat = 2
• ccw-led-config-show-ccw-as-forward = 3
• ccw-led-config-show-ccw-as-backward = 4

tinkerforge call performance-dc-bricklet <uid> get-ccw-led-config¶

Ausgabe:	config – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die LED-Konfiguration zurück, wie von set-ccw-led-config gesetzt.

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

Für config:

• ccw-led-config-off = 0
• ccw-led-config-on = 1
• ccw-led-config-show-heartbeat = 2
• ccw-led-config-show-ccw-as-forward = 3
• ccw-led-config-show-ccw-as-backward = 4

tinkerforge call performance-dc-bricklet <uid> set-gpio-led-config <channel> <config>¶

Parameter:	<channel> – Typ: Int, Wertebereich: [0 bis 1] <config> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 4
Ausgabe:	keine Ausgabe

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 Symbole sind für diese Funktion verfügbar:

Für <config>:

• gpio-led-config-off = 0
• gpio-led-config-on = 1
• gpio-led-config-show-heartbeat = 2
• gpio-led-config-show-gpio-active-high = 3
• gpio-led-config-show-gpio-active-low = 4

tinkerforge call performance-dc-bricklet <uid> get-gpio-led-config <channel>¶

Parameter:	<channel> – Typ: Int, Wertebereich: [0 bis 1]
Ausgabe:	config – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 4

Gibt die LED-Konfiguration zurück, wie von set-gpio-led-config gesetzt.

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

Für config:

• gpio-led-config-off = 0
• gpio-led-config-on = 1
• gpio-led-config-show-heartbeat = 2
• gpio-led-config-show-gpio-active-high = 3
• gpio-led-config-show-gpio-active-low = 4

tinkerforge call performance-dc-bricklet <uid> get-spitfp-error-count¶

Ausgabe:	error-count-ack-checksum – Typ: Int, Wertebereich: [0 bis 232 - 1] error-count-message-checksum – Typ: Int, Wertebereich: [0 bis 232 - 1] error-count-frame – Typ: Int, Wertebereich: [0 bis 232 - 1] 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 Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

tinkerforge call performance-dc-bricklet <uid> set-status-led-config <config>¶

Parameter:	<config> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3
Ausgabe:	keine Ausgabe

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 Symbole sind für diese Funktion verfügbar:

Für <config>:

• status-led-config-off = 0
• status-led-config-on = 1
• status-led-config-show-heartbeat = 2
• status-led-config-show-status = 3

tinkerforge call performance-dc-bricklet <uid> get-status-led-config¶

Ausgabe:	config – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die Konfiguration zurück, wie von set-status-led-config gesetzt.

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

Für config:

• status-led-config-off = 0
• status-led-config-on = 1
• status-led-config-show-heartbeat = 2
• status-led-config-show-status = 3

tinkerforge call performance-dc-bricklet <uid> get-chip-temperature¶

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

tinkerforge call performance-dc-bricklet <uid> reset¶

Ausgabe:	keine Ausgabe

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.

tinkerforge call performance-dc-bricklet <uid> get-identity¶

Ausgabe:

uid – Typ: String, Länge: bis zu 8 connected-uid – Typ: String, Länge: bis zu 8 position – Typ: Char, Wertebereich: [a bis h, z] hardware-version – Typ: Int Array, 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] firmware-version – Typ: Int Array, 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] device-identifier – Typ: Int, Wertebereich: [0 bis 216 - 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. 

Konfigurationsfunktionen für Callbacks¶

tinkerforge call performance-dc-bricklet <uid> set-emergency-shutdown-callback-configuration <enabled>¶

Parameter:	<enabled> – Typ: Bool, Standardwert: false
Ausgabe:	keine Ausgabe

Aktiviert/Deaktiviert emergency-shutdown Callback.

tinkerforge call performance-dc-bricklet <uid> get-emergency-shutdown-callback-configuration¶

Ausgabe:	enabled – Typ: Bool, Standardwert: true

Gibt die Callback-Konfiguration zurück, wie mittels set-emergency-shutdown-callback-configuration gesetzt.

tinkerforge call performance-dc-bricklet <uid> set-velocity-reached-callback-configuration <enabled>¶

Parameter:	<enabled> – Typ: Bool, Standardwert: false
Ausgabe:	keine Ausgabe

Aktiviert/Deaktiviert velocity-reached Callback.

tinkerforge call performance-dc-bricklet <uid> get-velocity-reached-callback-configuration¶

Ausgabe:	enabled – Typ: Bool, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels set-velocity-reached-callback-configuration gesetzt.

tinkerforge call performance-dc-bricklet <uid> set-current-velocity-callback-configuration <period> <value-has-to-change>¶

Parameter:	<period> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 <value-has-to-change> – Typ: Bool, Standardwert: false
Ausgabe:	keine Ausgabe

Die Periode ist die Periode mit der der 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.

tinkerforge call performance-dc-bricklet <uid> get-current-velocity-callback-configuration¶

Ausgabe:	period – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 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:

tinkerforge dispatch performance-dc-bricklet <uid> example

Die verfügbaren Callbacks werden weiter unten beschrieben.

tinkerforge dispatch performance-dc-bricklet <uid> emergency-shutdown¶

Ausgabe:	keine Ausgabe

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.

tinkerforge dispatch performance-dc-bricklet <uid> velocity-reached¶

Ausgabe:	velocity – Typ: Int, Einheit: 100/32767 %, Wertebereich: [-215 + 1 bis 215 - 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 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.

tinkerforge dispatch performance-dc-bricklet <uid> current-velocity¶

Ausgabe:	velocity – Typ: Int, Einheit: 100/32767 %, Wertebereich: [-215 + 1 bis 215 - 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 current-velocity Callback wird nur nach Ablauf der Periode ausgelöst, wenn sich die Geschwindigkeit geändert hat.

tinkerforge dispatch performance-dc-bricklet <uid> gpio-state¶

Ausgabe:	gpio-state – Typ: Bool Array, 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).

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.

tinkerforge call performance-dc-bricklet <uid> set-bootloader-mode <mode>¶

Parameter:	<mode> – Typ: Int, Wertebereich: Siehe Symbole
Ausgabe:	status – Typ: Int, Wertebereich: Siehe Symbole

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 Symbole sind für diese Funktion verfügbar:

Für <mode>:

• bootloader-mode-bootloader = 0
• bootloader-mode-firmware = 1
• bootloader-mode-bootloader-wait-for-reboot = 2
• bootloader-mode-firmware-wait-for-reboot = 3
• bootloader-mode-firmware-wait-for-erase-and-reboot = 4

Für status:

• bootloader-status-ok = 0
• bootloader-status-invalid-mode = 1
• bootloader-status-no-change = 2
• bootloader-status-entry-function-not-present = 3
• bootloader-status-device-identifier-incorrect = 4
• bootloader-status-crc-mismatch = 5

tinkerforge call performance-dc-bricklet <uid> get-bootloader-mode¶

Ausgabe:	mode – Typ: Int, Wertebereich: Siehe Symbole

Gibt den aktuellen Bootloader-Modus zurück, siehe set-bootloader-mode.

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

Für mode:

• bootloader-mode-bootloader = 0
• bootloader-mode-firmware = 1
• bootloader-mode-bootloader-wait-for-reboot = 2
• bootloader-mode-firmware-wait-for-reboot = 3
• bootloader-mode-firmware-wait-for-erase-and-reboot = 4

tinkerforge call performance-dc-bricklet <uid> set-write-firmware-pointer <pointer>¶

Parameter:	<pointer> – Typ: Int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Ausgabe:	keine Ausgabe

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.

tinkerforge call performance-dc-bricklet <uid> write-firmware <data>¶

Parameter:	<data> – Typ: Int Array, Länge: 64, Wertebereich: [0 bis 255]
Ausgabe:	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.

tinkerforge call performance-dc-bricklet <uid> write-uid <uid>¶

Parameter:	<uid> – Typ: Int, Wertebereich: [0 bis 232 - 1]
Ausgabe:	keine Ausgabe

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.

tinkerforge call performance-dc-bricklet <uid> read-uid¶

Ausgabe:	uid – Typ: Int, Wertebereich: [0 bis 232 - 1]

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