Dies ist die Beschreibung des Modbus Protokolls für den DC Brick. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des DC Brick sind in dessen Hardware Beschreibung zusammengefasst.
Eine allgemeine Beschreibung der Modbus Protokollstruktur findet sich hier.
BrickDC.
set_velocity
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Setzt die Geschwindigkeit des Motors. Hierbei sind -32767 maximale
Geschwindigkeit rückwärts, 0 ist Halt und 32767 maximale Geschwindigkeit
vorwärts. In Abhängigkeit von der Beschleunigung (siehe set_acceleration
)
wird der Motor nicht direkt auf die Geschwindigkeit gebracht sondern
gleichmäßig beschleunigt.
Die Geschwindigkeit beschreibt das Tastverhältnis der PWM für die
Motoransteuerung. Z.B. entspricht ein Geschwindigkeitswert von 3277 einer PWM
mit einem Tastverhältnis von 10%. Weiterhin kann neben dem Tastverhältnis auch
die Frequenz der PWM verändert werden, siehe set_pwm_frequency
.
BrickDC.
get_velocity
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Geschwindigkeit zurück, wie gesetzt von set_velocity
.
BrickDC.
get_current_velocity
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die aktuelle Geschwindigkeit des Motors zurück. Dieser Wert
unterscheidet sich von get_velocity
, sobald der Motor auf einen
neuen Zielwert, wie von set_velocity
vorgegeben, beschleunigt.
BrickDC.
set_acceleration
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Setzt die Beschleunigung des Motors. Die Einheit dieses Wertes ist Geschwindigkeit/s. Ein Beschleunigungswert von 10000 bedeutet, dass jede Sekunde die Geschwindigkeit um 10000 erhöht wird (entspricht rund 30% Tastverhältnis).
Beispiel: Soll die Geschwindigkeit von 0 auf 16000 (entspricht ungefähr 50% Tastverhältnis) in 10 Sekunden beschleunigt werden, so ist die Beschleunigung auf 1600 einzustellen.
Eine Beschleunigung von 0 bedeutet ein direkter Sprung des Motors auf die Zielgeschwindigkeit. Es Wird keine Beschleunigungsrampe gefahren.
BrickDC.
get_acceleration
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Beschleunigung zurück, wie gesetzt von set_acceleration
.
BrickDC.
full_brake
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Führt eine aktive Vollbremsung aus.
Warnung
Diese Funktion ist für Notsituationen bestimmt, in denen ein unverzüglicher Halt notwendig ist. Abhängig von der aktuellen Geschwindigkeit und der Kraft des Motors kann eine Vollbremsung brachial sein.
Ein Aufruf von set_velocity
mit 0 erlaubt einen normalen Stopp des Motors.
BrickDC.
enable
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Aktiviert die Treiberstufe. Die Treiberparameter können vor der Aktivierung konfiguriert werden (Geschwindigkeit, Beschleunigung, etc.).
BrickDC.
disable
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Deaktiviert die Treiberstufe. Die Konfiguration (Geschwindigkeit, Beschleunigung, etc.) bleibt erhalten aber der Motor wird nicht angesteuert bis eine erneute Aktivierung erfolgt.
Warnung
Die Treiberstufe zu deaktivieren während der Motor sich noch dreht kann zur
Beschädigung der Treiberstufe führen. Der Motor sollte durch Aufrufen von
set_velocity
mit 0 gestoppt werden, bevor die Treiberstufe deaktiviert
wird. Die set_velocity
Funktion wartet nicht bis der Motor wirklich
zum Stillstand gekommen ist. Dazu muss nach dem Aufruf der set_velocity
Funktion eine angemessen Zeit gewartet werden bevor die disable
Funktion
aufgerufen wird.
BrickDC.
is_enabled
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt true zurück wenn die Treiberstufe aktiv ist, sonst false.
BrickDC.
set_pwm_frequency
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Setzt die Frequenz der PWM, welche den Motor steuert. Oftmals ist eine hohe Frequenz geräuschärmer und der Motor läuft dadurch ruhiger. Trotz dessen führt eine geringe Frequenz zu weniger Schaltvorgängen und somit zu weniger Schaltverlusten. Bei einer Vielzahl von Motoren ermöglichen geringere Frequenzen höhere Drehmomente.
Im Allgemeinen kann diese Funktion ignoriert werden, da der Standardwert höchstwahrscheinlich zu einem akzeptablen Ergebnis führt.
BrickDC.
get_pwm_frequency
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die PWM Frequenz zurück, wie gesetzt von set_pwm_frequency
.
BrickDC.
get_stack_input_voltage
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Eingangsspannung des Stapels zurück. Die Eingangsspannung des Stapel wird über diesen bereitgestellt und von einer Step-Down oder Step-Up Power Supply erzeugt.
BrickDC.
get_external_input_voltage
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die externe Eingangsspannung zurück. Die externe Eingangsspannung wird über die schwarze Stromversorgungsbuchse, in den DC Brick, eingespeist.
Sobald eine externe Eingangsspannung und die Spannungsversorgung des Stapels anliegt, wird der Motor über die externe Spannung versorgt. Sollte nur die Spannungsversorgung des Stapels verfügbar sein, erfolgt die Versorgung des Motors über diese.
Warnung
Das bedeutet, bei einer hohen Versorgungsspannung des Stapels und einer geringen externen Versorgungsspannung erfolgt die Spannungsversorgung des Motors über die geringere externe Versorgungsspannung. Wenn dann die externe Spannungsversorgung getrennt wird, erfolgt sofort die Versorgung des Motors über die höhere Versorgungsspannung des Stapels.
BrickDC.
get_current_consumption
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Stromaufnahme des Motors zurück.
BrickDC.
set_drive_mode
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Setzt den Fahrmodus. Verfügbare Modi sind:
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 Bedeutungen sind für die Elemente dieser Funktion definiert:
Für mode:
BrickDC.
get_drive_mode
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt den Fahrmodus zurück, wie von set_drive_mode
gesetzt.
Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:
Für mode:
BrickDC.
set_spitfp_baudrate_config
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Das SPITF-Protokoll kann mit einer dynamischen Baudrate genutzt werden. Wenn die dynamische Baudrate aktiviert ist, versucht der Brick die Baudrate anhand des Datenaufkommens zwischen Brick und Bricklet anzupassen.
Die Baudrate wird exponentiell erhöht wenn viele Daten gesendet/empfangen werden und linear verringert wenn wenig Daten gesendet/empfangen werden.
Diese Vorgehensweise verringert die Baudrate in Anwendungen wo nur wenig Daten ausgetauscht werden müssen (z.B. eine Wetterstation) und erhöht die Robustheit. Wenn immer viele Daten ausgetauscht werden (z.B. Thermal Imaging Bricklet), wird die Baudrate automatisch erhöht.
In Fällen wo wenige Daten all paar Sekunden so schnell wie Möglich übertragen werden sollen (z.B. RS485 Bricklet mit hoher Baudrate aber kleinem Payload) kann die dynamische Baudrate zum maximieren der Performance ausgestellt werden.
Die maximale Baudrate kann pro Port mit der Funktion set_spitfp_baudrate
.
gesetzt werden. Falls die dynamische Baudrate nicht aktiviert ist, wird die Baudrate
wie von set_spitfp_baudrate
gesetzt statisch verwendet.
Neu in Version 2.3.5 (Firmware).
BrickDC.
get_spitfp_baudrate_config
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Baudratenkonfiguration zurück, siehe set_spitfp_baudrate_config
.
Neu in Version 2.3.5 (Firmware).
BrickDC.
get_send_timeout_count
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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.
Neu in Version 2.3.3 (Firmware).
Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:
Für communication_method:
BrickDC.
set_spitfp_baudrate
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Setzt die Baudrate eines spezifischen Bricklet Ports .
Für einen höheren Durchsatz der Bricklets kann die Baudrate erhöht werden.
Wenn der Fehlerzähler auf Grund von lokaler Störeinstrahlung hoch ist
(siehe get_spitfp_error_count
) kann die Baudrate verringert werden.
Wenn das Feature der dynamische Baudrate aktiviert ist, setzt diese Funktion
die maximale Baudrate (siehe set_spitfp_baudrate_config
).
EMV Tests werden mit der Standardbaudrate durchgeführt. Falls eine CE-Kompatibilität o.ä. in der Anwendung notwendig ist empfehlen wir die Baudrate nicht zu ändern.
Neu in Version 2.3.3 (Firmware).
BrickDC.
get_spitfp_baudrate
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Baudrate für einen Bricklet Port zurück, siehe
set_spitfp_baudrate
.
Neu in Version 2.3.3 (Firmware).
BrickDC.
get_spitfp_error_count
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.
Die Fehler sind aufgeteilt in
Die Fehlerzähler sind für Fehler die auf der Seite des Bricks auftreten. Jedes Bricklet hat eine ähnliche Funktion welche die Fehler auf Brickletseite ausgibt.
Neu in Version 2.3.3 (Firmware).
BrickDC.
enable_status_led
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Aktiviert die Status LED.
Die Status LED ist die blaue LED neben dem USB-Stecker. Wenn diese aktiviert ist, ist sie an und sie flackert wenn Daten transferiert werden. Wenn sie deaktiviert ist, ist sie immer aus.
Der Standardzustand ist aktiviert.
Neu in Version 2.3.1 (Firmware).
BrickDC.
disable_status_led
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Deaktiviert die Status LED.
Die Status LED ist die blaue LED neben dem USB-Stecker. Wenn diese aktiviert ist, ist sie an und sie flackert wenn Daten transferiert werden. Wenn sie deaktiviert ist, ist sie immer aus.
Der Standardzustand ist aktiviert.
Neu in Version 2.3.1 (Firmware).
BrickDC.
is_status_led_enabled
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt true zurück wenn die Status LED aktiviert ist, false sonst.
Neu in Version 2.3.1 (Firmware).
BrickDC.
get_chip_temperature
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.
Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine Genauigkeit von ±15%. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.
BrickDC.
reset
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Ein Aufruf dieser Funktion setzt den Brick zurück. Befindet sich der Brick innerhalb eines Stapels wird der gesamte Stapel zurück gesetzt.
Nach dem Zurücksetzen ist es notwendig neue Geräteobjekte zu erzeugen, Funktionsaufrufe auf bestehende führt zu undefiniertem Verhalten.
BrickDC.
get_identity
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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.
BrickDC.
set_minimum_voltage
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Setzt die minimale Spannung, bei welcher der CALLBACK_UNDER_VOLTAGE
Callback
ausgelöst wird. Der kleinste mögliche Wert mit dem der DC Brick noch funktioniert,
ist 6V. Mit dieser Funktion kann eine Entladung der versorgenden Batterie detektiert
werden. Beim Einsatz einer Netzstromversorgung wird diese Funktionalität
höchstwahrscheinlich nicht benötigt.
BrickDC.
get_minimum_voltage
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die minimale Spannung zurück, wie von set_minimum_voltage
gesetzt.
BrickDC.
set_current_velocity_period
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Setzt die Periode mit welcher der CALLBACK_CURRENT_VELOCITY
Callback
ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.
BrickDC.
get_current_velocity_period
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Periode zurück, wie von set_current_velocity_period
gesetzt.
BrickDC.
CALLBACK_UNDER_VOLTAGE
¶Funktions-ID: |
|
---|---|
Antwort: |
|
Dieser Callback wird ausgelöst, wenn die Eingangsspannung unter den, mittels
set_minimum_voltage
gesetzten, Schwellwert sinkt. Der Rückgabewert
ist die aktuelle Spannung.
BrickDC.
CALLBACK_EMERGENCY_SHUTDOWN
¶Funktions-ID: |
|
---|---|
Antwort: |
|
Dieser Callback wird ausgelöst, wenn entweder der Stromverbrauch (über 5A) oder die Temperatur der Treiberstufe zu hoch ist (über 175°C). Beide Möglichkeiten sind letztendlich gleichbedeutend, da die Temperatur ihren Schwellwert überschreitet sobald der Motor zu viel Strom verbraucht. Im Falle einer Spannung unter 3,3V (Stapel- oder externe Spannungsversorgung) wird dieser Callback auch ausgelöst.
Sobald dieser Callback ausgelöst wird, wird die Treiberstufe deaktiviert.
Das bedeutet enable
muss aufgerufen werden, um den Motor
erneut zu fahren.
Bemerkung
Dieser Callback funktioniert nur im Fahren/Bremsen Modus (siehe
set_drive_mode
). Im Fahren/Leerlauf Modus ist es leider nicht möglich
das Überstrom/Übertemperatur-Signal zuverlässig aus dem Chip der Treiberstufe
auszulesen.
BrickDC.
CALLBACK_VELOCITY_REACHED
¶Funktions-ID: |
|
---|---|
Antwort: |
|
Dieser Callback wird ausgelöst immer wenn eine konfigurierte Geschwindigkeit
erreicht wird. Beispiel: Wenn die aktuelle Geschwindigkeit 0 ist, die
Beschleunigung auf 5000 und die Geschwindigkeit auf 10000 konfiguriert ist,
wird der CALLBACK_VELOCITY_REACHED
Callback nach ungefähr 2 Sekunden ausgelöst,
wenn die konfigurierte Geschwindigkeit letztendlich erreicht ist.
Bemerkung
Da es nicht möglich ist eine Rückmeldung vom Gleichstrommotor zu erhalten,
funktioniert dies nur wenn die konfigurierte Beschleunigung (siehe
set_acceleration
) kleiner oder gleich der maximalen Beschleunigung
des Motors ist. Andernfalls wird der Motor hinter dem Vorgabewert
zurückbleiben und der Callback wird zu früh ausgelöst.
BrickDC.
CALLBACK_CURRENT_VELOCITY
¶Funktions-ID: |
|
---|---|
Antwort: |
|
Dieser Callback wird mit der Periode, wie gesetzt mit
set_current_velocity_period
, ausgelöst. Der Rückgabewert 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.
Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.
BrickDC.
get_protocol1_bricklet_name
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Firmware und Protokoll Version und den Namen des Bricklets für einen gegebenen Port zurück.
Der einzige Zweck dieser Funktion ist es, automatischen Flashen von Bricklet v1.x.y Plugins zu ermöglichen.
BrickDC.
write_bricklet_plugin
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Schreibt 32 Bytes Firmware auf das Bricklet, dass am gegebenen Port angeschlossen ist. Die Bytes werden an die Position offset * 32 geschrieben.
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
BrickDC.
read_bricklet_plugin
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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.