Dies ist die Beschreibung der Go API Bindings für das Joystick Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Joystick 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 28 29 | package main
import (
"fmt"
"github.com/Tinkerforge/go-api-bindings/ipconnection"
"github.com/Tinkerforge/go-api-bindings/joystick_bricklet"
)
const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Joystick Bricklet.
func main() {
ipcon := ipconnection.New()
defer ipcon.Close()
j, _ := joystick_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.
x, y, _ := j.GetPosition()
fmt.Printf("Position [X]: %d\n", x)
fmt.Printf("Position [Y]: %d\n", y)
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 31 | package main
import (
"fmt"
"github.com/Tinkerforge/go-api-bindings/ipconnection"
"github.com/Tinkerforge/go-api-bindings/joystick_bricklet"
)
const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Joystick Bricklet.
func main() {
ipcon := ipconnection.New()
defer ipcon.Close()
j, _ := joystick_bricklet.New(UID, &ipcon) // Create device object.
ipcon.Connect(ADDR) // Connect to brickd.
defer ipcon.Disconnect()
// Don't use device before ipcon is connected.
j.RegisterPressedCallback(func() {
fmt.Println("Pressed")
})
j.RegisterReleasedCallback(func() {
fmt.Println("Released")
})
fmt.Print("Press enter to exit.")
fmt.Scanln()
}
|
Download (example_find_borders.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 31 32 33 34 35 36 37 38 39 40 41 42 | package main
import (
"fmt"
"github.com/Tinkerforge/go-api-bindings/ipconnection"
"github.com/Tinkerforge/go-api-bindings/joystick_bricklet"
)
const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Joystick Bricklet.
func main() {
ipcon := ipconnection.New()
defer ipcon.Close()
j, _ := joystick_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 threshold receivers with a debounce time of 0.2 seconds (200ms).
j.SetDebouncePeriod(200)
j.RegisterPositionReachedCallback(func(x int16, y int16) {
if y == 100 {
fmt.Println("Top")
} else if y == -100 {
fmt.Println("Bottom")
} else if x == 100 {
fmt.Println("Right")
} else if x == -100 {
fmt.Println("Left")
}
fmt.Println()
})
// Configure threshold for position "outside of -99, -99 to 99, 99".
j.SetPositionCallbackThreshold('o', -99, 99, -99, 99)
fmt.Print("Press enter to exit.")
fmt.Scanln()
}
|
Die API des Joystick Bricklet ist im Package github.com/Tinkerforge/go-api-bindings/joystick_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.
joystick_bricklet.
New
(uid string, ipcon *IPConnection) (device JoystickBricklet, err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein neues JoystickBricklet
-Objekt mit der eindeutigen Geräte ID uid
und
fügt es der IPConnection ipcon
hinzu:
device, err := joystick_bricklet.New("YOUR_DEVICE_UID", &ipcon)
Dieses Geräteobjekt kann benutzt werden, nachdem die IPConnection verbunden.
(*JoystickBricklet)
GetPosition
() (x int16, y int16, err error)¶Rückgabe: |
|
---|
Gibt die Position des Joystick zurück. Die Mittelposition des Joysticks ist x=0, y=0.
Die zurückgegebenen Werte sind gemittelt und kalibriert (siehe Calibrate()
).
Wenn die Position periodisch abgefragt werden sollen, wird empfohlen
den PositionCallback
Callback zu nutzen und die Periode mit
SetPositionCallbackPeriod()
vorzugeben.
(*JoystickBricklet)
IsPressed
() (pressed bool, err error)¶Rückgabe: |
|
---|
Gibt true zurück wenn die Taste gedrückt ist und sonst false.
Es wird empfohlen die PressedCallback
und ReleasedCallback
Callbacks
zu nutzen, um die Taste programmatisch zu behandeln.
(*JoystickBricklet)
GetAnalogValue
() (x uint16, y uint16, err error)¶Rückgabe: |
|
---|
Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück.
Bemerkung
Der von GetPosition()
zurückgegebene Wert ist über mehrere
Messwerte gemittelt um das Rauschen zu vermindern, während GetAnalogValue()
unverarbeitete Analogwerte zurück gibt. Der einzige Grund GetAnalogValue()
zu nutzen, ist die volle Auflösung des Analog-Digital-Wandlers zu erhalten.
Wenn die Analogwerte periodisch abgefragt werden sollen, wird empfohlen
den AnalogValueCallback
Callback zu nutzen und die Periode mit
SetAnalogValueCallbackPeriod()
vorzugeben.
(*JoystickBricklet)
Calibrate
() (err error)¶Rückgabe: |
|
---|
Kalibriert die Mittelposition des Joysticks. Sollte der Joystick Bricklet nicht x=0 und y=0 in der Mittelposition zurückgeben, kann diese Funktion aufgerufen werden wenn der Joystick sich unbewegt in der Mittelposition befindet.
Die resultierende Kalibrierung wird in den EEPROM des Joystick Bricklet gespeichert, somit ist die Kalibrierung nur einmalig notwendig.
(*JoystickBricklet)
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.
(*JoystickBricklet)
SetPositionCallbackPeriod
(period uint32) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Periode mit welcher der PositionCallback
Callback ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
The PositionCallback
Callback wird nur ausgelöst, wenn sich die Position seit der
letzten Auslösung geändert hat.
(*JoystickBricklet)
GetPositionCallbackPeriod
() (period uint32, err error)¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetPositionCallbackPeriod()
gesetzt.
(*JoystickBricklet)
SetAnalogValueCallbackPeriod
(period uint32) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Periode mit welcher der AnalogValueCallback
Callback ausgelöst
wird. Ein Wert von 0 deaktiviert den Callback.
Der AnalogValueCallback
Callback wird nur ausgelöst, wenn sich die Analogwerte
seit der letzten Auslösung geändert hat.
(*JoystickBricklet)
GetAnalogValueCallbackPeriod
() (period uint32, err error)¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetAnalogValueCallbackPeriod()
gesetzt.
(*JoystickBricklet)
SetPositionCallbackThreshold
(option rune, minX int16, maxX int16, minY int16, maxY int16) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt den Schwellwert für den PositionReachedCallback
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Callback ist inaktiv |
'o' | Callback wird ausgelöst, wenn die Position außerhalb der min und max Werte ist |
'i' | Callback wird ausgelöst, wenn die Position innerhalb der min und max Werte ist |
'<' | Callback wird ausgelöst, wenn die Position kleiner als die min Werte ist (max wird ignoriert) |
'>' | Callback wird ausgelöst, wenn die Position größer als die min Werte ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
(*JoystickBricklet)
GetPositionCallbackThreshold
() (option rune, minX int16, maxX int16, minY int16, maxY int16, err error)¶Rückgabe: |
|
---|
Gibt den Schwellwert zurück, wie von SetPositionCallbackThreshold()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
(*JoystickBricklet)
SetAnalogValueCallbackThreshold
(option rune, minX uint16, maxX uint16, minY uint16, maxY uint16) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt den Schwellwert für den AnalogValueReachedCallback
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Callback ist inaktiv |
'o' | Callback wird ausgelöst, wenn die Analogwerte außerhalb der min und max Werte ist |
'i' | Callback wird ausgelöst, wenn die Analogwerte innerhalb der min und max Werte ist |
'<' | Callback wird ausgelöst, wenn die Analogwerte kleiner als die min Werte ist (max wird ignoriert) |
'>' | Callback wird ausgelöst, wenn die Analogwerte größer als die min Werte ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
(*JoystickBricklet)
GetAnalogValueCallbackThreshold
() (option rune, minX uint16, maxX uint16, minY uint16, maxY uint16, err error)¶Rückgabe: |
|
---|
Gibt den Schwellwert zurück, wie von SetAnalogValueCallbackThreshold()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
(*JoystickBricklet)
SetDebouncePeriod
(debounce uint32) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Periode mit welcher die Schwellwert Callbacks
ausgelöst werden, wenn die Schwellwerte
weiterhin erreicht bleiben.
(*JoystickBricklet)
GetDebouncePeriod
() (debounce uint32, err error)¶Rückgabe: |
|
---|
Gibt die Entprellperiode zurück, wie von SetDebouncePeriod()
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.
(*JoystickBricklet)
RegisterPositionCallback
(func(x int16, y int16)) (registrationId uint64)¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
Dieser Callback wird mit der Periode, wie gesetzt mit SetPositionCallbackPeriod()
,
ausgelöst. Der Parameter des Callbacks ist die Position des Joysticks.
Der PositionCallback
Callback wird nur ausgelöst, wenn sich die Position seit der
letzten Auslösung geändert hat.
(*JoystickBricklet)
RegisterAnalogValueCallback
(func(x uint16, y uint16)) (registrationId uint64)¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
Dieser Callback wird mit der Periode, wie gesetzt mit SetAnalogValueCallbackPeriod()
,
ausgelöst. Der Parameter des Callbacks sind die Analogwerte des Joysticks.
Der AnalogValueCallback
Callback wird nur ausgelöst, wenn sich die Analogwerte
seit der letzten Auslösung geändert hat.
(*JoystickBricklet)
RegisterPositionReachedCallback
(func(x int16, y int16)) (registrationId uint64)¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
SetPositionCallbackThreshold()
gesetzt, erreicht wird.
Der Parameter des Callbacks ist die Position des Joysticks.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit SetDebouncePeriod()
gesetzt, ausgelöst.
(*JoystickBricklet)
RegisterAnalogValueReachedCallback
(func(x uint16, y uint16)) (registrationId uint64)¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
SetAnalogValueCallbackThreshold()
gesetzt, erreicht wird.
Der Parameter des Callbacks sind die Analogwerte des Joystick.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit SetDebouncePeriod()
gesetzt, ausgelöst.
(*JoystickBricklet)
RegisterPressedCallback
(func()) (registrationId uint64)¶Rückgabe: |
|
---|
Dieser Callback wird ausgelöst, wenn die Taste gedrückt wird.
(*JoystickBricklet)
RegisterReleasedCallback
(func()) (registrationId uint64)¶Rückgabe: |
|
---|
Dieser Callback wird ausgelöst, wenn die Taste losgelassen wird.
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.
(*JoystickBricklet)
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.
(*JoystickBricklet)
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:
(*JoystickBricklet)
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:
(*JoystickBricklet)
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.
joystick_bricklet.
DeviceIdentifier
¶Diese Konstante wird verwendet um ein Joystick 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.
joystick_bricklet.
DeviceDisplayName
¶Diese Konstante stellt den Anzeigenamen eines Joystick Bricklet dar.