Go - Dual Button Bricklet

Dies ist die Beschreibung der Go API Bindings für das Dual Button Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Dual Button 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.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Callback

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
32
33
34
35
36
37
38
39
40
package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/dual_button_bricklet"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
)

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Dual Button Bricklet.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    db, _ := dual_button_bricklet.New(UID, &ipcon) // Create device object.

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // Don't use device before ipcon is connected.

    db.RegisterStateChangedCallback(func(buttonL dual_button_bricklet.ButtonState, buttonR dual_button_bricklet.ButtonState, ledL dual_button_bricklet.LEDState, ledR dual_button_bricklet.LEDState) {

        if buttonL == dual_button_bricklet.ButtonStatePressed {
            fmt.Println("Left Button: Pressed")
        } else if buttonL == dual_button_bricklet.ButtonStateReleased {
            fmt.Println("Left Button: Released")
        }

        if buttonR == dual_button_bricklet.ButtonStatePressed {
            fmt.Println("Right Button: Pressed")
        } else if buttonR == dual_button_bricklet.ButtonStateReleased {
            fmt.Println("Right Button: Released")
        }

        fmt.Println()
    })

    fmt.Print("Press enter to exit.")
    fmt.Scanln()
}

API

Die API des Dual Button Bricklet ist im Package github.com/Tinkerforge/go-api-bindings/dual_button_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:

  • ipconnection.DeviceErrorSuccess = 0
  • ipconnection.DeviceErrorInvalidParameter = 1
  • ipconnection.DeviceErrorFunctionNotSupported = 2
  • ipconnection.DeviceErrorUnknownError = 3

welche den Werten entsprechen, die der Brick oder das Bricklet zurückgeben.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

func dual_button_bricklet.New(uid string, ipcon *IPConnection) (device DualButtonBricklet, err error)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: *IPConnection
Rückgabe:
  • device – Typ: DualButtonBricklet
  • err – Typ: error

Erzeugt ein neues DualButtonBricklet-Objekt mit der eindeutigen Geräte ID uid und fügt es der IPConnection ipcon hinzu:

device, err := dual_button_bricklet.New("YOUR_DEVICE_UID", &ipcon)

Dieses Geräteobjekt kann benutzt werden, nachdem die IPConnection verbunden wurde (siehe Beispiele oben).

func (*DualButtonBricklet) SetLEDState(ledL uint8, ledR uint8) (err error)
Parameter:
  • ledL – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 1
  • ledR – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 1
Rückgabe:
  • err – Typ: error

Setzt den Zustand der LEDs. Möglich Zustände sind:

  • 0 = AutoToggleOn: Aktiviert Auto-Toggle und anfänglich aktiviert LED
  • 1 = AutoToggleOff: Aktiviert Auto-Toggle und anfänglich deaktiviert LED.
  • 2 = On: Aktiviert LED (Auto-Toggle is deaktiviert).
  • 3 = Off: Deaktiviert LED (Auto-Toggle is deaktiviert).

Im Auto-Toggle Modus wechselt die LED automatisch zwischen aus und an bei jedem Tasterdruck.

Wenn nur eine der LEDs gesetzt werden soll und der aktuelle Zustand der anderen LED nicht bekannt ist, dann kann der Zustand mit GetLEDState() ausgelesen werden oder es kann SetSelectedLEDState() genutzt werden.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für ledL:

  • dual_button_bricklet.LEDStateAutoToggleOn = 0
  • dual_button_bricklet.LEDStateAutoToggleOff = 1
  • dual_button_bricklet.LEDStateOn = 2
  • dual_button_bricklet.LEDStateOff = 3

Für ledR:

  • dual_button_bricklet.LEDStateAutoToggleOn = 0
  • dual_button_bricklet.LEDStateAutoToggleOff = 1
  • dual_button_bricklet.LEDStateOn = 2
  • dual_button_bricklet.LEDStateOff = 3
func (*DualButtonBricklet) GetLEDState() (ledL uint8, ledR uint8, err error)
Rückgabe:
  • ledL – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 1
  • ledR – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 1
  • err – Typ: error

Gibt den aktuellen Zustand der LEDs zurück, wie von SetLEDState() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für ledL:

  • dual_button_bricklet.LEDStateAutoToggleOn = 0
  • dual_button_bricklet.LEDStateAutoToggleOff = 1
  • dual_button_bricklet.LEDStateOn = 2
  • dual_button_bricklet.LEDStateOff = 3

Für ledR:

  • dual_button_bricklet.LEDStateAutoToggleOn = 0
  • dual_button_bricklet.LEDStateAutoToggleOff = 1
  • dual_button_bricklet.LEDStateOn = 2
  • dual_button_bricklet.LEDStateOff = 3
func (*DualButtonBricklet) GetButtonState() (buttonL uint8, buttonR uint8, err error)
Rückgabe:
  • buttonL – Typ: uint8, Wertebereich: Siehe Konstanten
  • buttonR – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

Gibt den aktuellen Zustand beider Taster zurück. Mögliche Zustände sind:

  • 0 = pressed (gedrückt)
  • 1 = released (losgelassen)

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für buttonL:

  • dual_button_bricklet.ButtonStatePressed = 0
  • dual_button_bricklet.ButtonStateReleased = 1

Für buttonR:

  • dual_button_bricklet.ButtonStatePressed = 0
  • dual_button_bricklet.ButtonStateReleased = 1

Fortgeschrittene Funktionen

func (*DualButtonBricklet) SetSelectedLEDState(led uint8, state uint8) (err error)
Parameter:
  • led – Typ: uint8, Wertebereich: Siehe Konstanten
  • state – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • err – Typ: error

Setzt den Zustand der selektierten LED (0 oder 1).

Die andere LED bleibt unangetastet.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für led:

  • dual_button_bricklet.LEDLeft = 0
  • dual_button_bricklet.LEDRight = 1

Für state:

  • dual_button_bricklet.LEDStateAutoToggleOn = 0
  • dual_button_bricklet.LEDStateAutoToggleOff = 1
  • dual_button_bricklet.LEDStateOn = 2
  • dual_button_bricklet.LEDStateOff = 3
func (*DualButtonBricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)
Rückgabe:
  • uid – Typ: string, Länge: bis zu 8
  • connectedUid – Typ: string, Länge: bis zu 8
  • position – Typ: rune, Wertebereich: ['a' bis 'h', 'i', 'z']
  • hardwareVersion – Typ: [3]uint8
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: [3]uint8
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das 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.

Callbacks

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.

func (*DualButtonBricklet) RegisterStateChangedCallback(func(buttonL uint8, buttonR uint8, ledL uint8, ledR uint8)) (registrationId uint64)
Callback-Parameter:
  • buttonL – Typ: uint8, Wertebereich: Siehe Konstanten
  • buttonR – Typ: uint8, Wertebereich: Siehe Konstanten
  • ledL – Typ: uint8, Wertebereich: Siehe Konstanten
  • ledR – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird aufgerufen wenn einer der Taster gedrückt wird.

Mögliche Zustände der Taster sind:

  • 0 = pressed (gedrückt)
  • 1 = released (losgelassen)

Mögliche Zustände der LEDs sind:

  • 0 = AutoToggleOn: Auto-Toggle aktiv und LED an.
  • 1 = AutoToggleOff: Auto-Toggle aktiv und LED aus.
  • 2 = On: Aktiviert LED (Auto-Toggle ist deaktiviert).
  • 3 = Off: Deaktiviert LED (Auto-Toggle ist deaktiviert).

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für buttonL:

  • dual_button_bricklet.ButtonStatePressed = 0
  • dual_button_bricklet.ButtonStateReleased = 1

Für buttonR:

  • dual_button_bricklet.ButtonStatePressed = 0
  • dual_button_bricklet.ButtonStateReleased = 1

Für ledL:

  • dual_button_bricklet.LEDStateAutoToggleOn = 0
  • dual_button_bricklet.LEDStateAutoToggleOff = 1
  • dual_button_bricklet.LEDStateOn = 2
  • dual_button_bricklet.LEDStateOff = 3

Für ledR:

  • dual_button_bricklet.LEDStateAutoToggleOn = 0
  • dual_button_bricklet.LEDStateAutoToggleOff = 1
  • dual_button_bricklet.LEDStateOn = 2
  • dual_button_bricklet.LEDStateOff = 3

Virtuelle Funktionen

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.

func (*DualButtonBricklet) GetAPIVersion() (apiVersion [3]uint8, err error)
Rückgabe:
  • apiVersion – Typ: [3]uint8
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • err – Typ: error

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.

func (*DualButtonBricklet) GetResponseExpected(functionId uint8) (responseExpected bool, err error)
Parameter:
  • functionId – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • responseExpected – Typ: bool
  • err – Typ: error

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:

  • dual_button_bricklet.FunctionSetLEDState = 1
  • dual_button_bricklet.FunctionSetSelectedLEDState = 5
func (*DualButtonBricklet) SetResponseExpected(functionId uint8, responseExpected bool) (err error)
Parameter:
  • functionId – Typ: uint8, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: bool
Rückgabe:
  • err – Typ: error

Ä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:

  • dual_button_bricklet.FunctionSetLEDState = 1
  • dual_button_bricklet.FunctionSetSelectedLEDState = 5
func (*DualButtonBricklet) SetResponseExpectedAll(responseExpected bool) (err error)
Parameter:
  • responseExpected – Typ: bool
Rückgabe:
  • err – Typ: error

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Konstanten

dual_button_bricklet.DeviceIdentifier

Diese Konstante wird verwendet um ein Dual Button 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.

dual_button_bricklet.DeviceDisplayName

Diese Konstante stellt den Anzeigenamen eines Dual Button Bricklet dar.