Go - Rotary Encoder Bricklet

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

Simple

Download (example_simple.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
package main

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

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

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    re, _ := rotary_encoder_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 count without reset.
    count, _ := re.GetCount(false)
    fmt.Printf("Count: \n", count)

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

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
package main

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

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

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

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

    re.RegisterCountCallback(func(count int32) {
        fmt.Printf("Count: %d\n", count)
    })

    // Set period for count receiver to 0.05s (50ms).
    // Note: The count callback is only called every 0.05 seconds
    //       if the count has changed since the last call!
    re.SetCountCallbackPeriod(50)

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

API

Die API des Rotary Encoder Bricklet ist im Package github.com/Tinkerforge/go-api-bindings/rotary_encoder_bricklet definiert.

Fast alle Funktionen der Go Bindings können einen DeviceError, der das error-Interface implementiert, zurückgeben. Dieser kann folgende Werte annehmen:

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

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

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

func NewRotaryEncoderBricklet(uid string, ipcon *IPConnection) (device RotaryEncoderBricklet, err error)

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

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

func (*RotaryEncoderBricklet) GetCount(reset bool) (count int32, err error)

Gibt den aktuellen Zählerwert des Encoders zurück. Wenn reset auf true gesetzt wird, wird der Zählerstand direkt nach dem auslesen auf 0 zurück gesetzt.

Der Encoder hat 24 Schritte pro Umdrehung.

Wenn der Encoder nach links gedreht wird wird der Zählerwert dekrementiert, d.h. negative Zählerwerte sind möglich.

func (*RotaryEncoderBricklet) IsPressed() (pressed bool, err error)

Gibt true zurück wenn der Taster gedrückt ist und sonst false.

Es wird empfohlen die RegisterPressedCallback und RegisterReleasedCallback Callbacks zu nutzen, um den Taster programmatisch zu behandeln.

Fortgeschrittene Funktionen

func (*RotaryEncoderBricklet) GetAPIVersion() (apiVersion [3]uint8, err error)

Gibt die Version der API Definition (Major, Minor, Revision) 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 (*RotaryEncoderBricklet) GetResponseExpected(functionId uint8) (responseExpected bool, err 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.

Siehe SetResponseExpected() für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

func (*RotaryEncoderBricklet) SetResponseExpected(functionId uint8, responseExpected bool) (err 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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • FunctionSetCountCallbackPeriod = 2
  • FunctionSetCountCallbackThreshold = 4
  • FunctionSetDebouncePeriod = 6
func (*RotaryEncoderBricklet) SetResponseExpectedAll(responseExpected bool) (err error)

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

func (*RotaryEncoderBricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err 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 kann 'a', 'b', 'c' oder 'd' sein.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks

func (*RotaryEncoderBricklet) SetCountCallbackPeriod(period uint32) (err error)

Setzt die Periode in ms mit welcher der RegisterCountCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der RegisterCountCallback Callback wird nur ausgelöst, wenn sich der Zählerwert seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

func (*RotaryEncoderBricklet) GetCountCallbackPeriod() (period uint32, err error)

Gibt die Periode zurück, wie von SetCountCallbackPeriod() gesetzt.

func (*RotaryEncoderBricklet) SetCountCallbackThreshold(option ThresholdOption, min int32, max int32) (err error)

Setzt den Schwellwert für den RegisterCountReachedCallback Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn der Zählerwert außerhalb der min und max Werte ist
'i' Callback wird ausgelöst, wenn die Zählerwert innerhalb der min und max Werte ist
'<' Callback wird ausgelöst, wenn die Zählerwert kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Zählerwert größer als der min Wert ist (max wird ignoriert)

Der Standardwert ist ('x', 0, 0).

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

  • ThresholdOptionOff = 'x'
  • ThresholdOptionOutside = 'o'
  • ThresholdOptionInside = 'i'
  • ThresholdOptionSmaller = '<'
  • ThresholdOptionGreater = '>'
func (*RotaryEncoderBricklet) GetCountCallbackThreshold() (option ThresholdOption, min int32, max int32, err error)

Gibt den Schwellwert zurück, wie von SetCountCallbackThreshold() gesetzt.

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

  • ThresholdOptionOff = 'x'
  • ThresholdOptionOutside = 'o'
  • ThresholdOptionInside = 'i'
  • ThresholdOptionSmaller = '<'
  • ThresholdOptionGreater = '>'
func (*RotaryEncoderBricklet) SetDebouncePeriod(debounce uint32) (err error)

Setzt die Periode in ms mit welcher der Schwellwert-Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

Der Standardwert ist 100.

func (*RotaryEncoderBricklet) GetDebouncePeriod() (debounce uint32, err error)

Gibt die Entprellperiode zurück, wie von SetDebouncePeriod() gesetzt.

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 (*RotaryEncoderBricklet) RegisterCountCallback(func(count int32)) (registrationId uint64)

Ein Callback für dieses Event kann mit der Funktion RegisterCountCallback() hinzugefügt werden. Diese gibt die ID des registrierten Callbacks zurück. Ein hinzugefügtes Callback kann mit der Funktion DeregisterCountCallback(registrationId uint64) wieder entfernt werden.

Dieser Callback wird mit der Periode, wie gesetzt mit SetCountCallbackPeriod(), ausgelöst. Der Parameter des Callbacks ist der Zählerwert des Encoders.

Der RegisterCountCallback Callback wird nur ausgelöst, wenn sich der Zähler seit der letzten Auslösung geändert hat.

func (*RotaryEncoderBricklet) RegisterCountReachedCallback(func(count int32)) (registrationId uint64)

Ein Callback für dieses Event kann mit der Funktion RegisterCountReachedCallback() hinzugefügt werden. Diese gibt die ID des registrierten Callbacks zurück. Ein hinzugefügtes Callback kann mit der Funktion DeregisterCountReachedCallback(registrationId uint64) wieder entfernt werden.

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetCountCallbackThreshold() gesetzt, erreicht wird. Der Parameter des Callbacks ist der Zählerwert des Encoders.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit SetDebouncePeriod() gesetzt, ausgelöst.

func (*RotaryEncoderBricklet) RegisterPressedCallback(func()) (registrationId uint64)

Ein Callback für dieses Event kann mit der Funktion RegisterPressedCallback() hinzugefügt werden. Diese gibt die ID des registrierten Callbacks zurück. Ein hinzugefügtes Callback kann mit der Funktion DeregisterPressedCallback(registrationId uint64) wieder entfernt werden.

Dieser Callback wird ausgelöst, wenn der Taster gedrückt wird.

func (*RotaryEncoderBricklet) RegisterReleasedCallback(func()) (registrationId uint64)

Ein Callback für dieses Event kann mit der Funktion RegisterReleasedCallback() hinzugefügt werden. Diese gibt die ID des registrierten Callbacks zurück. Ein hinzugefügtes Callback kann mit der Funktion DeregisterReleasedCallback(registrationId uint64) wieder entfernt werden.

Dieser Callback wird ausgelöst, wenn der Taster losgelassen wird.

Konstanten

rotary_encoder_bricklet.DeviceIdentifier

Diese Konstante wird verwendet um ein Rotary Encoder 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.

rotary_encoder_bricklet.DeviceDisplayName

Diese Konstante stellt den Anzeigenamen eines Rotary Encoder Bricklet dar.