Go - Industrial Digital Out 4 Bricklet

Dies ist die Beschreibung der Go API Bindings für das Industrial Digital Out 4 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Industrial Digital Out 4 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
28
29
30
31
32
33
34
35
36
package main

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

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Industrial Digital Out 4 Bricklet.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    ido4, _ := industrial_digital_out_4_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 pins alternating high/low 10 times with 100ms delay
    for i := 0; i < 10; i++ {
        time.Sleep(100 * time.Millisecond)
        ido4.SetValue(1 << 0)
        time.Sleep(100 * time.Millisecond)
        ido4.SetValue(1 << 1)
        time.Sleep(100 * time.Millisecond)
        ido4.SetValue(1 << 2)
        time.Sleep(100 * time.Millisecond)
        ido4.SetValue(1 << 3)
    }

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

API

Die API des Industrial Digital Out 4 Bricklet ist im Package github.com/Tinkerforge/go-api-bindings/industrial_digital_out_4_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 industrial_digital_out_4_bricklet.New(uid string, ipcon *IPConnection) (device IndustrialDigitalOut4Bricklet, err error)

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

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

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

func (*IndustrialDigitalOut4Bricklet) SetValue(valueMask uint16) (err error)

Setzt die Ausgabewerte mit einer Bitmaske (16Bit). Eine 1 in der Bitmaske bedeutet logisch 1 und eine 0 in der Bitmaske bedeutet logisch 0.

Zum Beispiel: Der Wert 3 bzw. 0b0011 wird die Pins 0-1 auf logisch 1 und alle anderen auf logisch 0 setzen.

Falls keine Gruppen verwendet werden (siehe SetGroup()), entsprechen die Pins der Beschriftung auf dem Industrial Digital Out 4 Bricklet.

Falls Gruppen verwendet werden, entsprechen die Pins den Elementen der Gruppe. Element 1 in der Gruppe bekommt Pins 0-3, Element 2 Pins 4-7, Element 3 Pins 8-11 und Element 4 Pins 12-15.

Alle laufenden Monoflop Timer werden abgebrochen, wenn diese Funktion aufgerufen wird.

func (*IndustrialDigitalOut4Bricklet) GetValue() (valueMask uint16, err error)

Gibt die Bitmaske zurück, wie von SetValue() gesetzt.

func (*IndustrialDigitalOut4Bricklet) SetSelectedValues(selectionMask uint16, valueMask uint16) (err error)

Setzt die Ausgabewerte mit einer Bitmaske, entsprechend der Selektionsmaske. Die Bitmaske ist 16 Bit lang. true bedeutet logisch 1 und false logisch 0.

Zum Beispiel: Die Werte (3, 1) bzw. (0b0011, 0b0001) werden den Pin 0 auf logisch 1 und den Pin 1 auf logisch 0 setzen. Alle anderen Pins bleiben unangetastet.

Falls keine Gruppen verwendet werden (siehe SetGroup()), entsprechen die Pins der Beschriftung auf dem Industrial Digital Out 4 Bricklet.

Falls Gruppen verwendet werden, entsprechen die Pins den Elementen der Gruppe. Element 1 in der Gruppe bekommt Pins 0-3, Element 2 Pins 4-7, Element 3 Pins 8-11 und Element 4 Pins 12-15.

Laufende Monoflop Timer für die ausgewählten Pins werden abgebrochen, wenn diese Funktion aufgerufen wird.

Fortgeschrittene Funktionen

func (*IndustrialDigitalOut4Bricklet) SetMonoflop(selectionMask uint16, valueMask uint16, time uint32) (err error)

Konfiguriert einen Monoflop für die Pins, wie mittels der Bitmaske des ersten Parameters festgelegt.

Der zweite Parameter ist eine Bitmaske mit den gewünschten Zuständen der festgelegten Pins. Eine 1 in der Bitmaske bedeutet logisch 1 und eine 0 in der Bitmaske bedeutet logisch 0.

Der dritte Parameter stellt die Zeit (in ms) dar, welche die Pins den Zustand halten sollen.

Wenn diese Funktion mit den Parametern (9, 1, 1500) bzw. (0b1001, 0b0001, 1500) aufgerufen wird: Pin 0 wird auf logisch 1 und Pin 3 auf logisch 0 gesetzt. Nach 1,5s wird Pin 0 wieder auf logisch 0 und Pin 3 auf logisch 1 gesetzt.

Ein Monoflop kann zur Ausfallsicherung verwendet werden. Beispiel: Angenommen ein RS485 Bus und ein Digital Out 4 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.

func (*IndustrialDigitalOut4Bricklet) GetMonoflop(pin uint8) (value uint16, time uint32, timeRemaining uint32, err error)

Gibt (für den angegebenen Pin) den aktuellen Zustand und die Zeit, wie von SetMonoflop() gesetzt, sowie die noch verbleibende Zeit bis zum Zustandswechsel, zurück.

Wenn der Timer aktuell nicht läuft, ist die noch verbleibende Zeit 0.

func (*IndustrialDigitalOut4Bricklet) SetGroup(group [4]rune) (err error)

Setzt eine Gruppe von Digital Out 4 Bricklets die zusammenarbeiten sollen. Mögliche Gruppierungen können mit der Funktion GetAvailableForGroup() gefunden werden.

Eine Gruppe besteht aus 4 Element. Element 1 in der Gruppe bekommt Pins 0-3, Element 2 Pins 4-7, Element 3 Pins 8-11 und Element 4 Pins 12-15.

Jedes Element kann entweder auf einen der Ports ('a' bis 'd') gesetzt werden oder falls nicht genutzt 'n' gesetzt werden.

Zum Beispiel: Falls zwei Digital Out 4 Bricklets mit Port A und Port B verbunden sind, könnte diese Funktion mit ['a', 'b', 'n', 'n'] aufgerufen werden.

In diesem Fall wären die Pins von Port A den Werten 0-3 zugewiesen und die Pins von Port B den Werten 4-7. Es ist jetzt möglich mit der Funktion SetValue() beide Bricklets gleichzeitig zu kontrollieren.

func (*IndustrialDigitalOut4Bricklet) GetGroup() (group [4]rune, err error)

Gibt die Gruppierung zurück, wie von SetGroup() gesetzt.

func (*IndustrialDigitalOut4Bricklet) GetAvailableForGroup() (available uint8, err error)

Gibt eine Bitmaske von Ports zurück die für die Gruppierung zur Verfügung stehen. Zum Beispiel bedeutet der Wert 5 bzw. 0b0101: Port A und Port C sind mit Bricklets verbunden die zusammen gruppiert werden können.

func (*IndustrialDigitalOut4Bricklet) 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 (*IndustrialDigitalOut4Bricklet) GetResponseExpected(functionId Function) (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.

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

  • industrial_digital_out_4_bricklet.FunctionSetValue = 1
  • industrial_digital_out_4_bricklet.FunctionSetMonoflop = 3
  • industrial_digital_out_4_bricklet.FunctionSetGroup = 5
  • industrial_digital_out_4_bricklet.FunctionSetSelectedValues = 9
func (*IndustrialDigitalOut4Bricklet) SetResponseExpected(functionId Function, 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 Konstanten sind für diese Funktion verfügbar:

  • industrial_digital_out_4_bricklet.FunctionSetValue = 1
  • industrial_digital_out_4_bricklet.FunctionSetMonoflop = 3
  • industrial_digital_out_4_bricklet.FunctionSetGroup = 5
  • industrial_digital_out_4_bricklet.FunctionSetSelectedValues = 9
func (*IndustrialDigitalOut4Bricklet) SetResponseExpectedAll(responseExpected bool) (err error)

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

func (*IndustrialDigitalOut4Bricklet) 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.

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 (*IndustrialDigitalOut4Bricklet) RegisterMonoflopDoneCallback(func(selectionMask uint16, valueMask uint16)) (registrationId uint64)

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

Dieser Callback wird ausgelöst, wenn ein Monoflop Timer abläuft (0 erreicht). Parameter des Callbacks enthalten die beteiligten Pins als Bitmaske und den aktuellen Zustand als Bitmaske (der Zustand nach dem Monoflop).

Konstanten

industrial_digital_out_4_bricklet.DeviceIdentifier

Diese Konstante wird verwendet um ein Industrial Digital Out 4 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.

industrial_digital_out_4_bricklet.DeviceDisplayName

Diese Konstante stellt den Anzeigenamen eines Industrial Digital Out 4 Bricklet dar.