TCP/IP - Motorized Linear Poti Bricklet

Dies ist die Beschreibung des TCP/IP Protokolls für das Motorized Linear Poti Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Motorized Linear Poti Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

API

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

Grundfunktionen

BrickletMotorizedLinearPoti.get_position
Funktions-ID:
  • 1
Anfrage:
  • keine Nutzdaten
Antwort:
  • position – Typ: uint16, Wertebereich: [0 bis 216 - 1]

Gibt die Position des Linearpotentiometers zurück. Der Wertebereich ist von 0 (Schieberegler unten) und 100 (Schieberegler oben).

Wenn der Wert periodisch benötigt wird, kann auch der CALLBACK_POSITION Callback verwendet werden. Der Callback wird mit der Funktion set_position_callback_configuration konfiguriert.

BrickletMotorizedLinearPoti.set_motor_position
Funktions-ID:
  • 5
Anfrage:
  • position – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • drive_mode – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • hold_position – Typ: bool
Antwort:
  • keine Antwort

Setzt die Position des Potentiometers. Nach Aufruf der Funktion wird das Potentiometer sofort diese Position anfahren. Abhängig von dem gewählten Driver Mode wird die Position entweder so schnell wie möglich angefahren oder langsam dafür aber gleichmäßig (smooth).

Die Position kann zwischen 0 (Regler unten) und 100 (Regler oben) festgelegt werden.

Wenn der Hold Position Parameter auf True gesetzt wird, wird die Position automatisch gehalten. Wenn ein Nutzer die Position ändert, fährt das Potentiometer die alte Position anschließend wieder an.

Wenn der Hold Position Parameter auf False gesetzt wird, kann die Position vom Nutzer geändert werden, nachdem die Sollposition erreicht wurde.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für drive_mode:

  • 0 = Fast
  • 1 = Smooth
BrickletMotorizedLinearPoti.get_motor_position
Funktions-ID:
  • 6
Anfrage:
  • keine Nutzdaten
Antwort:
  • position – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • drive_mode – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • hold_position – Typ: bool
  • position_reached – Typ: bool

Gibt die letzte Motor Position, die mittels set_motor_position gesetzt wurde zurück. Dies ist nicht die aktuelle Position des Potentiometers (dafür ist get_position gedacht). Zusätzlich wird die letzte Konfiguration zurückgegeben.

Der Position Reached Parameter ist True, wenn der letzte Sollwert (Motor Position) erreicht wurde. Die reale Position könnte sich seitdem jedoch geändert haben.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für drive_mode:

  • 0 = Fast
  • 1 = Smooth

Fortgeschrittene Funktionen

BrickletMotorizedLinearPoti.calibrate
Funktions-ID:
  • 7
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Startet die Kalibrierung. Das Potentiometer fährt dabei die Extrempunkte an.

Die Kalibrierung wird im internen Flash gespeichert und muss nicht bei jedem Start neu durchgeführt werden.

Das Motorized Linear Poti Bricklet wird von Tinkerforge während des Funktionstests kalibriert.

BrickletMotorizedLinearPoti.get_spitfp_error_count
Funktions-ID:
  • 234
Anfrage:
  • keine Nutzdaten
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 Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

BrickletMotorizedLinearPoti.set_bootloader_mode
Funktions-ID:
  • 235
Anfrage:
  • mode – Typ: uint8, Wertebereich: Siehe Bedeutungen
Antwort:
  • status – Typ: uint8, Wertebereich: Siehe Bedeutungen

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

Für mode:

  • 0 = Bootloader
  • 1 = Firmware
  • 2 = Bootloader Wait For Reboot
  • 3 = Firmware Wait For Reboot
  • 4 = Firmware Wait For Erase And Reboot

Für status:

  • 0 = OK
  • 1 = Invalid Mode
  • 2 = No Change
  • 3 = Entry Function Not Present
  • 4 = Device Identifier Incorrect
  • 5 = CRC Mismatch
BrickletMotorizedLinearPoti.get_bootloader_mode
Funktions-ID:
  • 236
Anfrage:
  • keine Nutzdaten
Antwort:
  • mode – Typ: uint8, Wertebereich: Siehe Bedeutungen

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

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für mode:

  • 0 = Bootloader
  • 1 = Firmware
  • 2 = Bootloader Wait For Reboot
  • 3 = Firmware Wait For Reboot
  • 4 = Firmware Wait For Erase And Reboot
BrickletMotorizedLinearPoti.set_write_firmware_pointer
Funktions-ID:
  • 237
Anfrage:
  • pointer – Typ: uint32, Wertebereich: [0 bis 232 - 1]
Antwort:
  • keine Antwort

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.

BrickletMotorizedLinearPoti.write_firmware
Funktions-ID:
  • 238
Anfrage:
  • data – Typ: uint8[64], Wertebereich: [0 bis 255]
Antwort:
  • status – Typ: uint8, 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.

BrickletMotorizedLinearPoti.set_status_led_config
Funktions-ID:
  • 239
Anfrage:
  • config – Typ: uint8, Wertebereich: Siehe Bedeutungen
Antwort:
  • keine Antwort

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

Für config:

  • 0 = Off
  • 1 = On
  • 2 = Show Heartbeat
  • 3 = Show Status
BrickletMotorizedLinearPoti.get_status_led_config
Funktions-ID:
  • 240
Anfrage:
  • keine Nutzdaten
Antwort:
  • config – Typ: uint8, Wertebereich: Siehe Bedeutungen

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

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für config:

  • 0 = Off
  • 1 = On
  • 2 = Show Heartbeat
  • 3 = Show Status
BrickletMotorizedLinearPoti.get_chip_temperature
Funktions-ID:
  • 242
Anfrage:
  • keine Nutzdaten
Antwort:
  • temperature – Typ: int16, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur in °C, 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.

BrickletMotorizedLinearPoti.reset
Funktions-ID:
  • 243
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

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.

BrickletMotorizedLinearPoti.write_uid
Funktions-ID:
  • 248
Anfrage:
  • uid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
Antwort:
  • keine Antwort

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.

BrickletMotorizedLinearPoti.read_uid
Funktions-ID:
  • 249
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: uint32, 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.

BrickletMotorizedLinearPoti.get_identity
Funktions-ID:
  • 255
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: char[8]
  • connected_uid – Typ: char[8]
  • position – Typ: char
  • hardware_version – Typ: uint8[3], Wertebereich: [0 bis 255]
  • firmware_version – Typ: uint8[3], Wertebereich: [0 bis 255]
  • device_identifier – Typ: uint16, 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 kann 'a', 'b', 'c' oder 'd' sein.

Eine Liste der Device Identifier Werte ist hier zu finden. 

Konfigurationsfunktionen für Callbacks

BrickletMotorizedLinearPoti.set_position_callback_configuration
Funktions-ID:
  • 2
Anfrage:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x'
  • min – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
Antwort:
  • keine Antwort

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

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den CALLBACK_POSITION Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für option:

  • 'x' = Off
  • 'o' = Outside
  • 'i' = Inside
  • '<' = Smaller
  • '>' = Greater
BrickletMotorizedLinearPoti.get_position_callback_configuration
Funktions-ID:
  • 3
Anfrage:
  • keine Nutzdaten
Antwort:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x'
  • min – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0

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

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für option:

  • 'x' = Off
  • 'o' = Outside
  • 'i' = Inside
  • '<' = Smaller
  • '>' = Greater
BrickletMotorizedLinearPoti.set_position_reached_callback_configuration
Funktions-ID:
  • 8
Anfrage:
  • enabled – Typ: bool
Antwort:
  • keine Antwort

Aktiviert/Deaktiviert den CALLBACK_POSITION_REACHED Callback.

Standardmäßig ist der Callback aktiviert.

BrickletMotorizedLinearPoti.get_position_reached_callback_configuration
Funktions-ID:
  • 9
Anfrage:
  • keine Nutzdaten
Antwort:
  • enabled – Typ: bool

Gibt die CALLBACK_POSITION_REACHED Callback Konfiguration zurück, wie von set_position_reached_callback_configuration gesetzt.

Callbacks

BrickletMotorizedLinearPoti.CALLBACK_POSITION
Funktions-ID:
  • 4
Antwort:
  • position – Typ: uint16, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird periodisch ausgelöst abhängig von der mittels set_position_callback_configuration gesetzten Konfiguration

Der Rückgabewert ist der gleiche wie get_position.

BrickletMotorizedLinearPoti.CALLBACK_POSITION_REACHED
Funktions-ID:
  • 10
Antwort:
  • position – Typ: uint16, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird ausgelöst, wenn die mittels set_motor_position gesetzte Position erreicht wird.

Der Rückgabewert ist die aktuelle Position.