TCP/IP - DC Brick

Dies ist die Beschreibung des TCP/IP Protokolls für den DC Brick. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des DC Brick sind in dessen Hardware Beschreibung zusammengefasst.

API

Eine allgemeine Beschreibung der TCP/IP Protokollstruktur findet sich hier.

Grundfunktionen

BrickDC.set_velocity
Funktions-ID:
  • 1
Anfrage:
  • velocity – Typ: int16, Einheit: 100/32767 %, Wertebereich: [-32767 bis 215 - 1], Standardwert: 0
Antwort:
  • keine 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:
  • 2
Anfrage:
  • keine Nutzdaten
Antwort:
  • velocity – Typ: int16, Einheit: 100/32767 %, Wertebereich: [-32767 bis 215 - 1], Standardwert: 0

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

BrickDC.get_current_velocity
Funktions-ID:
  • 3
Anfrage:
  • keine Nutzdaten
Antwort:
  • velocity – Typ: int16, Einheit: 100/32767 %, Wertebereich: [-32767 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.

BrickDC.set_acceleration
Funktions-ID:
  • 4
Anfrage:
  • acceleration – Typ: uint16, Einheit: 100/32767 %, Wertebereich: [0 bis 216 - 1], Standardwert: 10000
Antwort:
  • keine 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:
  • 5
Anfrage:
  • keine Nutzdaten
Antwort:
  • acceleration – Typ: uint16, Einheit: 100/32767 %, Wertebereich: [0 bis 216 - 1], Standardwert: 10000

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

BrickDC.full_brake
Funktions-ID:
  • 8
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine 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:
  • 12
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

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

BrickDC.disable
Funktions-ID:
  • 13
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Deaktiviert die Treiberstufe. Die Konfiguration (Geschwindigkeit, Beschleunigung, etc.) bleibt erhalten aber der Motor wird nicht angesteuert bis eine erneute Aktivierung erfolgt.

BrickDC.is_enabled
Funktions-ID:
  • 14
Anfrage:
  • keine Nutzdaten
Antwort:
  • enabled – Typ: bool, Standardwert: false

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

Fortgeschrittene Funktionen

BrickDC.set_pwm_frequency
Funktions-ID:
  • 6
Anfrage:
  • frequency – Typ: uint16, Einheit: 1 Hz, Wertebereich: [1 bis 20000], Standardwert: 15000
Antwort:
  • keine 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:
  • 7
Anfrage:
  • keine Nutzdaten
Antwort:
  • frequency – Typ: uint16, Einheit: 1 Hz, Wertebereich: [1 bis 20000], Standardwert: 15000

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

BrickDC.get_stack_input_voltage
Funktions-ID:
  • 9
Anfrage:
  • keine Nutzdaten
Antwort:
  • voltage – Typ: uint16, 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.

BrickDC.get_external_input_voltage
Funktions-ID:
  • 10
Anfrage:
  • keine Nutzdaten
Antwort:
  • voltage – Typ: uint16, 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.

BrickDC.get_current_consumption
Funktions-ID:
  • 11
Anfrage:
  • keine Nutzdaten
Antwort:
  • voltage – Typ: uint16, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1]

Gibt die Stromaufnahme des Motors zurück.

BrickDC.set_drive_mode
Funktions-ID:
  • 17
Anfrage:
  • mode – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0
Antwort:
  • keine Antwort

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 Bedeutungen sind für die Elemente dieser Funktion definiert:

Für mode:

  • 0 = Drive Brake
  • 1 = Drive Coast
BrickDC.get_drive_mode
Funktions-ID:
  • 18
Anfrage:
  • keine Nutzdaten
Antwort:
  • mode – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0

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:

  • 0 = Drive Brake
  • 1 = Drive Coast
BrickDC.set_spitfp_baudrate_config
Funktions-ID:
  • 231
Anfrage:
  • enable_dynamic_baudrate – Typ: bool, Standardwert: true
  • minimum_dynamic_baudrate – Typ: uint32, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 400000
Antwort:
  • keine 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:
  • 232
Anfrage:
  • keine Nutzdaten
Antwort:
  • enable_dynamic_baudrate – Typ: bool, Standardwert: true
  • minimum_dynamic_baudrate – Typ: uint32, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 400000

Gibt die Baudratenkonfiguration zurück, siehe set_spitfp_baudrate_config.

Neu in Version 2.3.5 (Firmware).

BrickDC.get_send_timeout_count
Funktions-ID:
  • 233
Anfrage:
  • communication_method – Typ: uint8, Wertebereich: Siehe Bedeutungen
Antwort:
  • timeout_count – Typ: uint32, 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 Bedeutungen sind für die Elemente dieser Funktion definiert:

Für communication_method:

  • 0 = None
  • 1 = USB
  • 2 = SPI Stack
  • 3 = Chibi
  • 4 = RS485
  • 5 = WIFI
  • 6 = Ethernet
  • 7 = WIFI V2

Neu in Version 2.3.3 (Firmware).

BrickDC.set_spitfp_baudrate
Funktions-ID:
  • 234
Anfrage:
  • bricklet_port – Typ: char, Wertebereich: ['a' bis 'b']
  • baudrate – Typ: uint32, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 1400000
Antwort:
  • keine 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:
  • 235
Anfrage:
  • bricklet_port – Typ: char, Wertebereich: ['a' bis 'b']
Antwort:
  • baudrate – Typ: uint32, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 1400000

Gibt die Baudrate für einen Bricklet Port zurück, siehe set_spitfp_baudrate.

Neu in Version 2.3.3 (Firmware).

BrickDC.get_spitfp_error_count
Funktions-ID:
  • 237
Anfrage:
  • bricklet_port – Typ: char, Wertebereich: ['a' bis 'b']
Antwort:
  • error_count_ack_checksum – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • error_count_message_checksum – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • error_count_frame – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • error_count_overflow – Typ: uint32, 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).

BrickDC.enable_status_led
Funktions-ID:
  • 238
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine 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:
  • 239
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine 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:
  • 240
Anfrage:
  • keine Nutzdaten
Antwort:
  • enabled – Typ: bool, Standardwert: true

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

Neu in Version 2.3.1 (Firmware).

BrickDC.get_protocol1_bricklet_name
Funktions-ID:
  • 241
Anfrage:
  • port – Typ: char, Wertebereich: ['a' bis 'b']
Antwort:
  • protocol_version – Typ: uint8, Wertebereich: [0 bis 255]
  • firmware_version – Typ: uint8[3]
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • name – Typ: char[40]

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

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

BrickDC.get_chip_temperature
Funktions-ID:
  • 242
Anfrage:
  • keine Nutzdaten
Antwort:
  • temperature – Typ: int16, 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.

BrickDC.reset
Funktions-ID:
  • 243
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine 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:
  • 255
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: char[8]
  • connected_uid – Typ: char[8]
  • position – Typ: char, Wertebereich: ['0' bis '8']
  • hardware_version – Typ: uint8[3]
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • firmware_version – Typ: uint8[3]
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • device_identifier – Typ: uint16, 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

BrickDC.set_minimum_voltage
Funktions-ID:
  • 15
Anfrage:
  • voltage – Typ: uint16, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 6000
Antwort:
  • keine 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:
  • 16
Anfrage:
  • keine Nutzdaten
Antwort:
  • voltage – Typ: uint16, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 6000

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

BrickDC.set_current_velocity_period
Funktions-ID:
  • 19
Anfrage:
  • period – Typ: uint16, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 0
Antwort:
  • keine 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:
  • 20
Anfrage:
  • keine Nutzdaten
Antwort:
  • period – Typ: uint16, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 0

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

Callbacks

BrickDC.CALLBACK_UNDER_VOLTAGE
Funktions-ID:
  • 21
Antwort:
  • voltage – Typ: uint16, 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 Rückgabewert ist die aktuelle Spannung.

BrickDC.CALLBACK_EMERGENCY_SHUTDOWN
Funktions-ID:
  • 22
Antwort:
  • keine Nutzdaten

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:
  • 23
Antwort:
  • velocity – Typ: int16, Einheit: 100/32767 %, Wertebereich: [-32767 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 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:
  • 24
Antwort:
  • velocity – Typ: int16, Einheit: 100/32767 %, Wertebereich: [-32767 bis 215 - 1]

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.