Shell - DC Brick

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

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=XXYYZZ # Change XXYYZZ to the UID of your DC Brick

tinkerforge call dc-brick $uid set-drive-mode drive-mode-drive-coast
tinkerforge call dc-brick $uid set-pwm-frequency 10000 # Use PWM frequency of 10 kHz
tinkerforge call dc-brick $uid set-acceleration 4096 # Slow acceleration (12.5 %/s)
tinkerforge call dc-brick $uid set-velocity 32767 # Full speed forward (100 %)
tinkerforge call dc-brick $uid enable # Enable motor power

echo "Press key to exit"; read dummy

# Stop motor before disabling motor power
tinkerforge call dc-brick $uid set-acceleration 16384 # Fast decceleration (50 %/s) for stopping
tinkerforge call dc-brick $uid set-velocity 0 # Request motor stop
sleep 2 # Wait for motor to actually stop: velocity (100 %) / decceleration (50 %/s) = 2 s
tinkerforge call dc-brick $uid disable # 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
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XXYYZZ # Change XXYYZZ to the UID of your DC Brick

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

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

# Enable motor power
tinkerforge call dc-brick $uid enable

echo "Press key to exit"; read dummy

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

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

API

Mögliche Exit Codes für alle tinkerforge Befehle sind:

  • 1: Unterbrochen (Ctrl+C)
  • 2: Syntaxfehler
  • 21: Python 2.5 oder neuer wird benötigt
  • 22: Python argparse Modul fehlt
  • 23: Socket-Fehler
  • 24: Andere Exception
  • 25: Ungültiger Platzhalter in Format-String
  • 26: Authentifizierungsfehler
  • 201: Timeout ist aufgetreten
  • 209: Ungültiger Argumentwert
  • 210: Funktion wird nicht unterstützt
  • 211: Unbekannter Fehler

Befehlsstruktur

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

tinkerforge call dc-brick [<option>..] <uid> <function> [<argument>..]
Parameter:
  • <uid> – Typ: String
  • <function> – Typ: String

Der call Befehl wird verwendet um eine Funktion des DC Brick 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 DC Brick an und endet dann
tinkerforge dispatch dc-brick [<option>..] <uid> <callback>
Parameter:
  • <uid> – Typ: String
  • <callback> – Typ: String

Der dispatch Befehl wird verwendet um eingehende Callbacks des DC Brick 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 DC Brick an und endet dann
tinkerforge call dc-brick <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 dc-brick <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 dc-brick <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-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.

tinkerforge call dc-brick <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 dc-brick <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 dc-brick <uid> set-acceleration <acceleration>
Parameter:
  • <acceleration> – Typ: Int, Einheit: 100/32767 %/s, Wertebereich: [0 bis 216 - 1], Standardwert: 10000
Ausgabe:
  • keine Ausgabe

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.

tinkerforge call dc-brick <uid> get-acceleration
Ausgabe:
  • acceleration – Typ: Int, Einheit: 100/32767 %/s, Wertebereich: [0 bis 216 - 1], Standardwert: 10000

Gibt die Beschleunigung zurück, wie gesetzt von set-acceleration.

tinkerforge call dc-brick <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 dc-brick <uid> enable
Ausgabe:
  • keine Ausgabe

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

tinkerforge call dc-brick <uid> disable
Ausgabe:
  • keine Ausgabe

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.

tinkerforge call dc-brick <uid> is-enabled
Ausgabe:
  • enabled – Typ: Bool, Standardwert: false

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

Fortgeschrittene Funktionen

tinkerforge call dc-brick <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 dc-brick <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 dc-brick <uid> get-stack-input-voltage
Ausgabe:
  • voltage – Typ: Int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 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.

tinkerforge call dc-brick <uid> get-external-input-voltage
Ausgabe:
  • voltage – Typ: Int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

Gibt die externe Eingangsspannung zurück. Die externe Eingangsspannung wird über die schwarze Stromversorgungsbuchse, in den 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.

tinkerforge call dc-brick <uid> get-current-consumption
Ausgabe:
  • voltage – Typ: Int, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1]

Gibt die Stromaufnahme des Motors zurück.

tinkerforge call dc-brick <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 dc-brick <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 dc-brick <uid> set-spitfp-baudrate-config <enable-dynamic-baudrate> <minimum-dynamic-baudrate>
Parameter:
  • <enable-dynamic-baudrate> – Typ: Bool, Standardwert: true
  • <minimum-dynamic-baudrate> – Typ: Int, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 400000
Ausgabe:
  • keine Ausgabe

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

tinkerforge call dc-brick <uid> get-spitfp-baudrate-config
Ausgabe:
  • enable-dynamic-baudrate – Typ: Bool, Standardwert: true
  • 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).

tinkerforge call dc-brick <uid> get-send-timeout-count <communication-method>
Parameter:
  • <communication-method> – Typ: Int, Wertebereich: Siehe Symbole
Ausgabe:
  • timeout-count – Typ: Int, Wertebereich: [0 bis 232 - 1]

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

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

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

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

Für <communication-method>:

  • communication-method-none = 0
  • communication-method-usb = 1
  • communication-method-spi-stack = 2
  • communication-method-chibi = 3
  • communication-method-rs485 = 4
  • communication-method-wifi = 5
  • communication-method-ethernet = 6
  • communication-method-wifi-v2 = 7

Neu in Version 2.3.3 (Firmware).

tinkerforge call dc-brick <uid> set-spitfp-baudrate <bricklet-port> <baudrate>
Parameter:
  • <bricklet-port> – Typ: Char, Wertebereich: [a bis b]
  • <baudrate> – Typ: Int, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 1400000
Ausgabe:
  • keine Ausgabe

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

tinkerforge call dc-brick <uid> get-spitfp-baudrate <bricklet-port>
Parameter:
  • <bricklet-port> – Typ: Char, Wertebereich: [a bis b]
Ausgabe:
  • 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).

tinkerforge call dc-brick <uid> get-spitfp-error-count <bricklet-port>
Parameter:
  • <bricklet-port> – Typ: Char, Wertebereich: [a bis b]
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 Bricks auftreten. Jedes Bricklet hat eine ähnliche Funktion welche die Fehler auf Brickletseite ausgibt.

Neu in Version 2.3.3 (Firmware).

tinkerforge call dc-brick <uid> enable-status-led
Ausgabe:
  • keine Ausgabe

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

tinkerforge call dc-brick <uid> disable-status-led
Ausgabe:
  • keine Ausgabe

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

tinkerforge call dc-brick <uid> is-status-led-enabled
Ausgabe:
  • enabled – Typ: Bool, Standardwert: true

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

Neu in Version 2.3.1 (Firmware).

tinkerforge call dc-brick <uid> get-chip-temperature
Ausgabe:
  • temperature – Typ: Int, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1]

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

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

tinkerforge call dc-brick <uid> reset
Ausgabe:
  • keine Ausgabe

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.

tinkerforge call dc-brick <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: [0 bis 8]
  • 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 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. 

Konfigurationsfunktionen für Callbacks

tinkerforge call dc-brick <uid> set-minimum-voltage <voltage>
Parameter:
  • <voltage> – Typ: Int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 6000
Ausgabe:
  • keine Ausgabe

Setzt die minimale Spannung, bei welcher der 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.

tinkerforge call dc-brick <uid> get-minimum-voltage
Ausgabe:
  • voltage – Typ: Int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 6000

Gibt die minimale Spannung zurück, wie von set-minimum-voltage gesetzt.

tinkerforge call dc-brick <uid> set-current-velocity-period <period>
Parameter:
  • <period> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 0
Ausgabe:
  • keine Ausgabe

Setzt die Periode mit welcher der current-velocity Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

tinkerforge call dc-brick <uid> get-current-velocity-period
Ausgabe:
  • period – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 216 - 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:

tinkerforge dispatch dc-brick <uid> example

Die verfügbaren Callbacks 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.

tinkerforge dispatch dc-brick <uid> under-voltage
Ausgabe:
  • voltage – Typ: Int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird ausgelöst, wenn die Eingangsspannung unter den, mittels set-minimum-voltage gesetzten, Schwellwert sinkt. Der Parameter ist die aktuelle Spannung.

tinkerforge dispatch dc-brick <uid> emergency-shutdown
Ausgabe:
  • keine Ausgabe

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.

tinkerforge dispatch dc-brick <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-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.

tinkerforge dispatch dc-brick <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-period, 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.

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 dc-brick <uid> get-protocol1-bricklet-name <port>
Parameter:
  • <port> – Typ: Char, Wertebereich: [a bis b]
Ausgabe:
  • protocol-version – 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]
  • name – Typ: String, Länge: bis zu 40

Gibt die Firmware und Protokoll Version und den Namen des Bricklets für einen gegebenen Port zurück.

Der einzige Zweck dieser Funktion ist es, automatischen Flashen von Bricklet v1.x.y Plugins zu ermöglichen.

tinkerforge call dc-brick <uid> write-bricklet-plugin <port> <offset> <chunk>
Parameter:
  • <port> – Typ: Char, Wertebereich: [a bis b]
  • <offset> – Typ: Int, Wertebereich: [0 bis 255]
  • <chunk> – Typ: Int Array, Länge: 32, Wertebereich: [0 bis 255]
Ausgabe:
  • keine Ausgabe

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.

tinkerforge call dc-brick <uid> read-bricklet-plugin <port> <offset>
Parameter:
  • <port> – Typ: Char, Wertebereich: [a bis b]
  • <offset> – Typ: Int, Wertebereich: [0 bis 255]
Ausgabe:
  • chunk – Typ: Int Array, 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.