Go - Rotary Poti Bricklet

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

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_poti_bricklet"
)

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

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    rp, _ := rotary_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, _ := rp.GetPosition()
    fmt.Printf("Position: \n", position) // Range: -150 to 150

    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_poti_bricklet"
)

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

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    rp, _ := rotary_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.

    rp.RegisterPositionCallback(func(position int16) {
        fmt.Printf("Position: %d\n", position) // Range: -150 to 150
    })

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

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

API

Die API des Rotary Poti Bricklet ist im Package github.com/Tinkerforge/go-api-bindings/rotary_poti_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 NewRotaryPotiBricklet(uid string, ipcon *IPConnection) (device RotaryPotiBricklet, err error)

Erzeugt ein neues RotaryPotiBricklet-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 (*RotaryPotiBricklet) GetPosition() (position int16, err error)

Gibt die Position des Drehpotentiometers zurück. Der Wertebereich ist in Grad und ist von -150° (links gedreht) und 150° (rechts gedreht).

Wenn die Position periodisch abgefragt werden soll, wird empfohlen den RegisterPositionCallback Callback zu nutzen und die Periode mit SetPositionCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen

func (*RotaryPotiBricklet) GetAnalogValue() (value uint16, err error)

Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück. Der Wertebereich ist 0 bis 4095.

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 der Analogwert periodisch abgefragt werden soll, wird empfohlen den RegisterAnalogValueCallback Callback zu nutzen und die Periode mit SetAnalogValueCallbackPeriod() vorzugeben.

func (*RotaryPotiBricklet) 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 (*RotaryPotiBricklet) 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 (*RotaryPotiBricklet) 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:

  • FunctionSetPositionCallbackPeriod = 3
  • FunctionSetAnalogValueCallbackPeriod = 5
  • FunctionSetPositionCallbackThreshold = 7
  • FunctionSetAnalogValueCallbackThreshold = 9
  • FunctionSetDebouncePeriod = 11
func (*RotaryPotiBricklet) SetResponseExpectedAll(responseExpected bool) (err error)

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

func (*RotaryPotiBricklet) 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 (*RotaryPotiBricklet) SetPositionCallbackPeriod(period uint32) (err error)

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

Der RegisterPositionCallback Callback wird nur ausgelöst, wenn sich die Position seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

func (*RotaryPotiBricklet) GetPositionCallbackPeriod() (period uint32, err error)

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

func (*RotaryPotiBricklet) SetAnalogValueCallbackPeriod(period uint32) (err error)

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

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

Der Standardwert ist 0.

func (*RotaryPotiBricklet) GetAnalogValueCallbackPeriod() (period uint32, err error)

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

func (*RotaryPotiBricklet) SetPositionCallbackThreshold(option ThresholdOption, min int16, max int16) (err error)

Setzt den Schwellwert für den RegisterPositionReachedCallback 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 der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Position 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 (*RotaryPotiBricklet) GetPositionCallbackThreshold() (option ThresholdOption, min int16, max int16, err error)

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

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

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

Setzt den Schwellwert für den RegisterAnalogValueReachedCallback Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn der Analogwert außerhalb der min und max Werte ist
'i' Callback wird ausgelöst, wenn der Analogwert innerhalb der min und max Werte ist
'<' Callback wird ausgelöst, wenn der Analogwert kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn der Analogwert 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 (*RotaryPotiBricklet) GetAnalogValueCallbackThreshold() (option ThresholdOption, min uint16, max uint16, err error)

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

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

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

Setzt die Periode in ms mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

Der Standardwert ist 100.

func (*RotaryPotiBricklet) 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 (*RotaryPotiBricklet) RegisterPositionCallback(func(position int16)) (registrationId uint64)

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

Dieser Callback wird mit der Periode, wie gesetzt mit SetPositionCallbackPeriod(), ausgelöst. Der Parameter des Callbacks ist die Position des Drehpotentiometers.

Der RegisterPositionCallback Callback wird nur ausgelöst, wenn sich die Position seit der letzten Auslösung geändert hat.

func (*RotaryPotiBricklet) RegisterAnalogValueCallback(func(value uint16)) (registrationId uint64)

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

Dieser Callback wird mit der Periode, wie gesetzt mit SetAnalogValueCallbackPeriod(), ausgelöst. Der Parameter des Callbacks ist der Analogwert des Drehpotentiometers.

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

func (*RotaryPotiBricklet) RegisterPositionReachedCallback(func(position int16)) (registrationId uint64)

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetPositionCallbackThreshold() gesetzt, erreicht wird. Der Parameter des Callbacks ist die Position des Drehpotentiometers.

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

func (*RotaryPotiBricklet) RegisterAnalogValueReachedCallback(func(value uint16)) (registrationId uint64)

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetAnalogValueCallbackThreshold() gesetzt, erreicht wird. Der Parameter des Callbacks ist der Analogwert des Drehpotentiometers.

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

Konstanten

rotary_poti_bricklet.DeviceIdentifier

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

rotary_poti_bricklet.DeviceDisplayName

Diese Konstante stellt den Anzeigenamen eines Rotary Poti Bricklet dar.