Dies ist die Beschreibung der Go API Bindings 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.
Eine Installationanleitung für die Go API Bindings ist Teil deren allgemeine Beschreibung. Zusätzliche Dokumentation findet sich auf godoc.org.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
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 | package main
import (
"fmt"
"github.com/Tinkerforge/go-api-bindings/ipconnection"
"github.com/Tinkerforge/go-api-bindings/motorized_linear_poti_bricklet"
)
const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Motorized Linear Poti Bricklet.
func main() {
ipcon := ipconnection.New()
defer ipcon.Close()
mlp, _ := motorized_linear_poti_bricklet.New(UID, &ipcon) // Create device object.
ipcon.Connect(ADDR) // Connect to brickd.
defer ipcon.Disconnect()
// Don't use device before ipcon is connected.
// Get current position.
position, _ := mlp.GetPosition()
fmt.Printf("Position: %d\n", position) // Range: 0 to 100
fmt.Print("Press enter to exit.")
fmt.Scanln()
}
|
Download (example_callback.go)
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 | package main
import (
"fmt"
"github.com/Tinkerforge/go-api-bindings/ipconnection"
"github.com/Tinkerforge/go-api-bindings/motorized_linear_poti_bricklet"
)
const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Motorized Linear Poti Bricklet.
func main() {
ipcon := ipconnection.New()
defer ipcon.Close()
mlp, _ := motorized_linear_poti_bricklet.New(UID, &ipcon) // Create device object.
ipcon.Connect(ADDR) // Connect to brickd.
defer ipcon.Disconnect()
// Don't use device before ipcon is connected.
mlp.RegisterPositionCallback(func(position uint16) {
fmt.Printf("Position: %d\n", position) // Range: 0 to 100
})
// Set period for position callback to 0.05s (50ms) without a threshold.
mlp.SetPositionCallbackConfiguration(50, false, 'x', 0, 0)
fmt.Print("Press enter to exit.")
fmt.Scanln()
}
|
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 | package main
import (
"fmt"
"github.com/Tinkerforge/go-api-bindings/ipconnection"
"github.com/Tinkerforge/go-api-bindings/motorized_linear_poti_bricklet"
)
const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Motorized Linear Poti Bricklet.
func main() {
ipcon := ipconnection.New()
defer ipcon.Close()
mlp, _ := motorized_linear_poti_bricklet.New(UID, &ipcon) // Create device object.
ipcon.Connect(ADDR) // Connect to brickd.
defer ipcon.Disconnect()
// Don't use device before ipcon is connected.
mlp.RegisterPositionReachedCallback(func(position uint16) {
fmt.Printf("Position: %d\n", position) // Range: 0 to 100
})
// Move slider smooth to the middle
mlp.SetMotorPosition(50, motorized_linear_poti_bricklet.DriveModeSmooth, false)
fmt.Print("Press enter to exit.")
fmt.Scanln()
}
|
Die API des Motorized Linear Poti Bricklet ist im Package github.com/Tinkerforge/go-api-bindings/motorized_linear_poti_bricklet
definiert.
Fast alle Funktionen der Go Bindings können einen ipconnection.DeviceError
, der das error-Interface implementiert,
zurückgeben. Dieser kann folgende Werte annehmen:
welche den Werten entsprechen, die der Brick oder das Bricklet zurückgeben.
Alle folgend aufgelisteten Funktionen sind Thread-sicher.
motorized_linear_poti_bricklet.
New
(uid string, ipcon *IPConnection) (device MotorizedLinearPotiBricklet, err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein neues MotorizedLinearPotiBricklet
-Objekt mit der eindeutigen Geräte ID uid
und
fügt es der IPConnection ipcon
hinzu:
device, err := motorized_linear_poti_bricklet.New("YOUR_DEVICE_UID", &ipcon)
Dieses Geräteobjekt kann benutzt werden, nachdem die IPConnection verbunden.
(*MotorizedLinearPotiBricklet)
GetPosition
() (position uint16, err error)¶Rückgabe: |
|
---|
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 PositionCallback
Callback
verwendet werden. Der Callback wird mit der Funktion
SetPositionCallbackConfiguration()
konfiguriert.
(*MotorizedLinearPotiBricklet)
SetMotorPosition
(position uint16, driveMode uint8, holdPosition bool) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Position des Potentiometers. Nach Aufruf der Funktion wird das Potentiometer sofort diese Position anfahren. Abhängig von dem gewählten Drive 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 Konstanten sind für diese Funktion verfügbar:
Für driveMode:
(*MotorizedLinearPotiBricklet)
GetMotorPosition
() (position uint16, driveMode uint8, holdPosition bool, positionReached bool, err error)¶Rückgabe: |
|
---|
Gibt die letzte Motor Position, die mittels SetMotorPosition()
gesetzt wurde
zurück. Dies ist nicht die aktuelle Position des Potentiometers (dafür ist
GetPosition()
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 Konstanten sind für diese Funktion verfügbar:
Für driveMode:
(*MotorizedLinearPotiBricklet)
Calibrate
() (err error)¶Rückgabe: |
|
---|
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.
(*MotorizedLinearPotiBricklet)
GetSPITFPErrorCount
() (errorCountAckChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err error)¶Rückgabe: |
|
---|
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 Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.
(*MotorizedLinearPotiBricklet)
SetStatusLEDConfig
(config uint8) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
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 Konstanten sind für diese Funktion verfügbar:
Für config:
(*MotorizedLinearPotiBricklet)
GetStatusLEDConfig
() (config uint8, err error)¶Rückgabe: |
|
---|
Gibt die Konfiguration zurück, wie von SetStatusLEDConfig()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
(*MotorizedLinearPotiBricklet)
GetChipTemperature
() (temperature int16, err error)¶Rückgabe: |
|
---|
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.
(*MotorizedLinearPotiBricklet)
Reset
() (err error)¶Rückgabe: |
|
---|
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.
(*MotorizedLinearPotiBricklet)
GetIdentity
() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)¶Rückgabe: |
|
---|
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. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.
(*MotorizedLinearPotiBricklet)
SetPositionCallbackConfiguration
(period uint32, valueHasToChange bool, option rune, min uint16, max uint16) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Die Periode ist die Periode mit der der PositionCallback
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 PositionCallback
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 Konstanten sind für diese Funktion verfügbar:
Für option:
(*MotorizedLinearPotiBricklet)
GetPositionCallbackConfiguration
() (period uint32, valueHasToChange bool, option rune, min uint16, max uint16, err error)¶Rückgabe: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels SetPositionCallbackConfiguration()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
(*MotorizedLinearPotiBricklet)
SetPositionReachedCallbackConfiguration
(enabled bool) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Aktiviert/Deaktiviert den PositionReachedCallback
Callback.
(*MotorizedLinearPotiBricklet)
GetPositionReachedCallbackConfiguration
() (enabled bool, err error)¶Rückgabe: |
|
---|
Gibt die PositionReachedCallback
Callback Konfiguration zurück, wie von
SetPositionReachedCallbackConfiguration()
gesetzt.
Callbacks können registriert werden um zeitkritische
oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann
mit der entsprechenden Register*Callback
-Function durchgeführt werden,
welche eine eindeutige Callback-ID zurück gibt. Mit dieser ID kann das Callback
später deregistriert werden.
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.
(*MotorizedLinearPotiBricklet)
RegisterPositionCallback
(func(position uint16)) (registrationId uint64)¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
Dieser Callback wird periodisch ausgelöst abhängig von der mittels
SetPositionCallbackConfiguration()
gesetzten Konfiguration
Der Parameter des Callbacks ist der gleiche wie GetPosition()
.
(*MotorizedLinearPotiBricklet)
RegisterPositionReachedCallback
(func(position uint16)) (registrationId uint64)¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
Dieser Callback wird ausgelöst, wenn die mittels
SetMotorPosition()
gesetzte Position erreicht wird.
Der Parameter des Callbacks ist die aktuelle Position.
Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.
(*MotorizedLinearPotiBricklet)
GetAPIVersion
() (apiVersion [3]uint8, err error)¶Rückgabe: |
|
---|
Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.
(*MotorizedLinearPotiBricklet)
GetResponseExpected
(functionId uint8) (responseExpected bool, err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.
Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt
werden, da diese Funktionen immer eine Antwort senden. Für
Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber
entfernt werden mittels SetResponseExpected()
. Für Setter-Funktionen ist
es standardmäßig nicht gesetzt, kann aber gesetzt werden.
Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für functionId:
(*MotorizedLinearPotiBricklet)
SetResponseExpected
(functionId uint8, responseExpected bool) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.
Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für functionId:
(*MotorizedLinearPotiBricklet)
SetResponseExpectedAll
(responseExpected bool) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
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.
(*MotorizedLinearPotiBricklet)
SetBootloaderMode
(mode uint8) (status uint8, err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
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 Konstanten sind für diese Funktion verfügbar:
Für mode:
Für status:
(*MotorizedLinearPotiBricklet)
GetBootloaderMode
() (mode uint8, err error)¶Rückgabe: |
|
---|
Gibt den aktuellen Bootloader-Modus zurück, siehe SetBootloaderMode()
.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
(*MotorizedLinearPotiBricklet)
SetWriteFirmwarePointer
(pointer uint32) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt den Firmware-Pointer für WriteFirmware()
. 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.
(*MotorizedLinearPotiBricklet)
WriteFirmware
(data [64]uint8) (status uint8, err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Schreibt 64 Bytes Firmware an die Position die vorher von
SetWriteFirmwarePointer()
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.
(*MotorizedLinearPotiBricklet)
WriteUID
(uid uint32) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
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.
(*MotorizedLinearPotiBricklet)
ReadUID
() (uid uint32, err error)¶Rückgabe: |
|
---|
Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.
motorized_linear_poti_bricklet.
DeviceIdentifier
¶Diese Konstante wird verwendet um ein Motorized Linear Poti Bricklet zu identifizieren.
Die GetIdentity()
Funktion und
der (*IPConnection) RegisterEnumerateCallback
Callback der IPConnection haben ein deviceIdentifier
Parameter um den Typ
des Bricks oder Bricklets anzugeben.
motorized_linear_poti_bricklet.
DeviceDisplayName
¶Diese Konstante stellt den Anzeigenamen eines Motorized Linear Poti Bricklet dar.