Dies ist die Beschreibung der Go API Bindings für das IO-16 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des IO-16 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/io16_bricklet"
"github.com/Tinkerforge/go-api-bindings/ipconnection"
)
const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your IO-16 Bricklet.
func main() {
ipcon := ipconnection.New()
defer ipcon.Close()
io, _ := io16_bricklet.New(UID, &ipcon) // Create device object.
ipcon.Connect(ADDR) // Connect to brickd.
defer ipcon.Disconnect()
// Don't use device before ipcon is connected.
// Set pin 0 on port A to output low
io.SetPortConfiguration('a', 1<<0, 'o', false)
// Set pin 0 and 7 on port B to output high
io.SetPortConfiguration('b', (1<<0)|(1<<7), 'o', true)
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 31 | package main
import (
"fmt"
"github.com/Tinkerforge/go-api-bindings/io16_bricklet"
"github.com/Tinkerforge/go-api-bindings/ipconnection"
)
const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your IO-16 Bricklet.
func main() {
ipcon := ipconnection.New()
defer ipcon.Close()
io, _ := io16_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 value from port A as bitmask.
valueMaskA, _ := io.GetPort('a')
fmt.Printf("Value Mask (Port A): %b\n", valueMaskA)
// Get current value from port B as bitmask.
valueMaskB, _ := io.GetPort('b')
fmt.Printf("Value Mask (Port B): %b\n", valueMaskB)
fmt.Print("Press enter to exit.")
fmt.Scanln()
}
|
Download (example_interrupt.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 | package main
import (
"fmt"
"github.com/Tinkerforge/go-api-bindings/io16_bricklet"
"github.com/Tinkerforge/go-api-bindings/ipconnection"
)
const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your IO-16 Bricklet.
func main() {
ipcon := ipconnection.New()
defer ipcon.Close()
io, _ := io16_bricklet.New(UID, &ipcon) // Create device object.
ipcon.Connect(ADDR) // Connect to brickd.
defer ipcon.Disconnect()
// Don't use device before ipcon is connected.
io.RegisterInterruptCallback(func(port rune, interruptMask uint8, valueMask uint8) {
fmt.Printf("Port: %c\n", port)
fmt.Printf("Interrupt Mask: %b\n", interruptMask)
fmt.Printf("Value Mask: %b\n", valueMask)
fmt.Println()
})
// Enable interrupt on pin 2 of port A
io.SetPortInterrupt('a', 1<<2)
fmt.Print("Press enter to exit.")
fmt.Scanln()
}
|
Die API des IO-16 Bricklet ist im Package github.com/Tinkerforge/go-api-bindings/io16_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.
io16_bricklet.
New
(uid string, ipcon *IPConnection) (device IO16Bricklet, err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein neues IO16Bricklet
-Objekt mit der eindeutigen Geräte ID uid
und
fügt es der IPConnection ipcon
hinzu:
device, err := io16_bricklet.New("YOUR_DEVICE_UID", &ipcon)
Dieses Geräteobjekt kann benutzt werden, nachdem die IPConnection verbunden.
(*IO16Bricklet)
SetPort
(port rune, valueMask uint8) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt den Ausgangszustand (logisch 1 oder logisch 0) für einen Port ("a" oder "b") mittels einer Bitmaske (8Bit). Eine 1 in der Bitmaske bedeutet logisch 1 und eine 0 in der Bitmaske bedeutet logisch 0.
Beispiel: Der Wert 15 bzw. 0b00001111 setzt die Pins 0-3 auf logisch 1 und die Pins 4-7 auf logisch 0.
Alle laufenden Monoflop Timer für den angegebenen Port werden abgebrochen, wenn diese Funktion aufgerufen wird.
Bemerkung
Diese Funktion bewirkt keine Änderung an Pins die als Eingang konfiguriert sind.
Pull-Up Widerstände können mit SetPortConfiguration()
zugeschaltet werden.
(*IO16Bricklet)
GetPort
(port rune) (valueMask uint8, err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt eine Bitmaske der aktuell gemessenen Zustände des gewählten Ports zurück. Diese Funktion gibt die Zustände aller Pins zurück, unabhängig ob diese als Ein- oder Ausgang konfiguriert sind.
(*IO16Bricklet)
SetPortConfiguration
(port rune, selectionMask uint8, direction rune, value bool) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Konfiguriert den Zustand und die Richtung des angegebenen Ports. Mögliche Richtungen sind 'i' und 'o' für Ein- und Ausgang.
Wenn die Richtung als Ausgang konfiguriert ist, ist der Zustand entweder logisch 1 oder logisch 0 (gesetzt als true oder false).
Wenn die Richtung als Eingang konfiguriert ist, ist der Zustand entweder Pull-Up oder Standard (gesetzt als true oder false).
Beispiele:
Laufende Monoflop Timer für die ausgewählten Pins werden abgebrochen, wenn diese Funktion aufgerufen wird.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für direction:
(*IO16Bricklet)
GetPortConfiguration
(port rune) (directionMask uint8, valueMask uint8, err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt eine Bitmaske für die Richtung und eine Bitmaske für den Zustand der Pins des gewählten Ports zurück. Eine 1 in der Bitmaske für die Richtung bedeutet Eingang und eine 0 in der Bitmaske bedeutet Ausgang.
Beispiel: Ein Rückgabewert von (15, 51) bzw. (0b00001111, 0b00110011) für Richtung und Zustand bedeutet:
(*IO16Bricklet)
GetEdgeCount
(pin uint8, resetCounter bool) (count uint32, err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt den aktuellen Wert des Flankenzählers für den ausgewählten Pin von Port A
zurück. Die zu zählenden Flanken können mit SetEdgeCountConfig()
konfiguriert werden.
Wenn reset counter auf true gesetzt wird, wird der Zählerstand direkt nach dem auslesen auf 0 zurückgesetzt.
Neu in Version 2.0.3 (Plugin).
(*IO16Bricklet)
SetPortMonoflop
(port rune, selectionMask uint8, valueMask uint8, time uint32) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Konfiguriert einen Monoflop für die Pins, wie mittels der 8 Bit langen Bitmaske des zweiten Parameters festgelegt. Die festgelegten Pins müssen als Ausgänge konfiguriert sein. Als Eingänge konfigurierte Pins werden ignoriert.
Der dritte Parameter ist eine Bitmaske mit den gewünschten Zuständen der festgelegten Ausgangspins. Eine 1 in der Bitmaske bedeutet logisch 1 und eine 0 in der Bitmaske bedeutet logisch 0.
Der vierte Parameter stellt die Zeit dar, welche die Pins den Zustand halten sollen.
Wenn diese Funktion mit den Parametern ('a', 9, 1, 1500) bzw. ('a', 0b00001001, 0b00000001, 1500) aufgerufen wird: Pin 0 wird auf logisch 1 und Pin 3 auf logisch 0 am Port 'a' gesetzt. Nach 1,5s wird Pin 0 wieder logisch 0 und Pin 3 logisch 1 gesetzt.
Ein Monoflop kann zur Ausfallsicherung verwendet werden. Beispiel: Angenommen ein RS485 Bus und ein IO-16 Bricklet ist an ein Slave Stapel verbunden. Jetzt kann diese Funktion sekündlich, mit einem Zeitparameter von 2 Sekunden, aufgerufen werden. Der Pin wird die gesamte Zeit im Zustand logisch 1 sein. Wenn jetzt die RS485 Verbindung getrennt wird, wird der Pin nach spätestens zwei Sekunden in den Zustand logisch 0 wechseln.
(*IO16Bricklet)
GetPortMonoflop
(port rune, pin uint8) (value uint8, time uint32, timeRemaining uint32, err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt (für den angegebenen Pin) den aktuellen Zustand und die Zeit, wie von
SetPortMonoflop()
gesetzt, sowie die noch verbleibende Zeit bis zum
Zustandswechsel, zurück.
Wenn der Timer aktuell nicht läuft, ist die noch verbleibende Zeit 0.
(*IO16Bricklet)
SetSelectedValues
(port rune, selectionMask uint8, valueMask uint8) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt den Ausgangszustand (logisch 1 oder logisch 0) mittels einer Bitmaske, entsprechend der Selektionsmaske. Die Bitmaske hat eine Länge von 8 Bit und eine 1 in der Bitmaske bedeutet logisch 1 und eine 0 in der Bitmaske bedeutet logisch 0.
Beispiel: Die Parameter ('a', 192, 128) bzw. ('a', 0b11000000, 0b10000000) setzen den Pin 7 auf logisch 1 und den Pin 6 auf logisch 0 an Port A. Die Pins 0-6 bleiben unangetastet.
Laufende Monoflop Timer für die ausgewählten Pins werden abgebrochen, wenn diese Funktion aufgerufen wird.
Bemerkung
Diese Funktion bewirkt keine Änderung an Pins die als Eingang konfiguriert sind.
Pull-Up Widerstände können mit SetPortConfiguration()
zugeschaltet werden.
(*IO16Bricklet)
SetEdgeCountConfig
(pin uint8, edgeType uint8, debounce uint8) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Konfiguriert den Flankenzähler für den ausgewählten Pin von Port A. Der Flankenzähler steht für Pins 0 und 1 zur Verfügung.
Der edge type Parameter konfiguriert den zu zählenden Flankentyp. Es können steigende, fallende oder beide Flanken gezählt werden für Pins die als Eingang konfiguriert sind. Mögliche Flankentypen sind:
Durch das Konfigurieren wird der Wert des Flankenzählers auf 0 zurückgesetzt.
Falls unklar ist was dies alles bedeutet, kann diese Funktion einfach ignoriert werden. Die Standardwerte sind in fast allen Situationen OK.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für edgeType:
Neu in Version 2.0.3 (Plugin).
(*IO16Bricklet)
GetEdgeCountConfig
(pin uint8) (edgeType uint8, debounce uint8, err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt den Flankentyp sowie die Entprellzeit für den ausgewählten Pin von Port A
zurück, wie von SetEdgeCountConfig()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für edgeType:
Neu in Version 2.0.3 (Plugin).
(*IO16Bricklet)
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.
(*IO16Bricklet)
SetDebouncePeriod
(debounce uint32) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Entprellperiode der InterruptCallback
Callback.
Beispiel: Wenn dieser Wert auf 100 gesetzt wird, erhält man den Interrupt maximal alle 100ms. Dies ist notwendig falls etwas prellendes an das IO-16 Bricklet angeschlossen ist, wie z.B. eine Taste.
(*IO16Bricklet)
GetDebouncePeriod
() (debounce uint32, err error)¶Rückgabe: |
|
---|
Gibt die Entprellperiode zurück, wie von SetDebouncePeriod()
gesetzt.
(*IO16Bricklet)
SetPortInterrupt
(port rune, interruptMask uint8) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt durch eine Bitmaske die Pins für welche der Interrupt aktiv ist. Interrupts werden ausgelöst bei Änderung des Spannungspegels eines Pins, z.B. ein Wechsel von logisch 1 zu logisch 0 und logisch 0 zu logisch 1.
Beispiel: ('a', 129) bzw. ('a', 0b10000001) aktiviert den Interrupt für die Pins 0 und 7 des Ports a.
Der Interrupt wird mit dem InterruptCallback
Callback zugestellt.
(*IO16Bricklet)
GetPortInterrupt
(port rune) (interruptMask uint8, err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt die Interrupt Bitmaske für den angegebenen Port zurück, wie von
SetPortInterrupt()
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.
(*IO16Bricklet)
RegisterInterruptCallback
(func(port rune, interruptMask uint8, valueMask uint8)) (registrationId uint64)¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
Dieser Callback wird ausgelöst sobald eine Änderung des Spannungspegels
detektiert wird, an Pins für welche der Interrupt mit SetPortInterrupt()
aktiviert wurde.
Die Rückgabewerte sind der Port, eine Bitmaske der aufgetretenen Interrupts und der aktuellen Zustände des Ports.
Beispiele:
(*IO16Bricklet)
RegisterMonoflopDoneCallback
(func(port rune, selectionMask uint8, valueMask uint8)) (registrationId uint64)¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
Dieser Callback wird ausgelöst, wenn ein Monoflop Timer abläuft (0 erreicht). Parameter des Callbacks enthalten den Port, die beteiligten Pins als Bitmaske und den aktuellen Zustand als Bitmaske (der Zustand nach dem Monoflop).
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.
(*IO16Bricklet)
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.
(*IO16Bricklet)
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:
(*IO16Bricklet)
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:
(*IO16Bricklet)
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.
io16_bricklet.
DeviceIdentifier
¶Diese Konstante wird verwendet um ein IO-16 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.
io16_bricklet.
DeviceDisplayName
¶Diese Konstante stellt den Anzeigenamen eines IO-16 Bricklet dar.