Go - Dual Relay Bricklet

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

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/dual_relay_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 Dual Relay Bricklet.

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

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

    // Turn relays alternating on/off 10 times with 1 second delay
    for i := 0; i < 5; i++ {
        time.Sleep(1000 * time.Millisecond)
        dr.SetState(true, false)
        time.Sleep(1000 * time.Millisecond)
        dr.SetState(false, true)
    }

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

API

Die API des Dual Relay Bricklet ist im Package github.com/Tinkerforge/go-api-bindings/dual_relay_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 NewDualRelayBricklet(uid string, ipcon *IPConnection) (device DualRelayBricklet, err error)

Erzeugt ein neues DualRelayBricklet-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 (*DualRelayBricklet) SetState(relay1 bool, relay2 bool) (err error)

Setzt den Zustand der Relais, true bedeutet ein und false aus. Beispiel: (true, false) schaltet Relais 1 ein und Relais 2 aus.

Wenn nur eines der Relais gesetzt werden soll und der aktuelle Zustand des anderen Relais nicht bekannt ist, dann kann der Zustand mit GetState() ausgelesen werden oder es kann SetSelectedState() genutzt werden.

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

Der Standardwert ist (false, false).

func (*DualRelayBricklet) GetState() (relay1 bool, relay2 bool, err error)

Gibt den Zustand der Relais zurück, true bedeutet ein und false aus.

Fortgeschrittene Funktionen

func (*DualRelayBricklet) SetMonoflop(relay uint8, state bool, time uint32) (err error)

Der erste Parameter kann 1 oder 2 sein (Relais 1 oder Relais 2). Der zweite Parameter ist der gewünschte Zustand des Relais (true bedeutet ein und false aus). Der dritte Parameter stellt die Zeit (in ms) dar, welche das Relais den Zustand halten soll.

Wenn diese Funktion mit den Parametern (1, true, 1500) aufgerufen wird: Relais 1 wird angeschaltet und nach 1,5s wieder ausgeschaltet.

Ein Monoflop kann als Ausfallsicherung verwendet werden. Beispiel: Angenommen ein RS485 Bus und ein Dual Relay Bricklet ist an ein Slave Stapel verbunden. Jetzt kann diese Funktion sekündlich, mit einem Zeitparameter von 2 Sekunden, aufgerufen werden. Das Relais wird die gesamte Zeit ein sein. Wenn jetzt die RS485 Verbindung getrennt wird, wird das Relais nach spätestens zwei Sekunden ausschalten.

func (*DualRelayBricklet) GetMonoflop(relay uint8) (state bool, time uint32, timeRemaining uint32, err error)

Gibt (für das angegebene Relais) 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 (*DualRelayBricklet) SetSelectedState(relay uint8, state bool) (err error)

Setzt den Zustand des ausgewählte Relais (1 oder 2), true bedeutet ein und false aus.

Ein laufender Monoflop Timer für das ausgewählte Relais wird abgebrochen, wenn diese Funktion aufgerufen wird.

Das andere Relais bleibt unangetastet.

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

  • FunctionSetState = 1
  • FunctionSetMonoflop = 3
  • FunctionSetSelectedState = 6
func (*DualRelayBricklet) SetResponseExpectedAll(responseExpected bool) (err error)

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

func (*DualRelayBricklet) 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 (*DualRelayBricklet) RegisterMonoflopDoneCallback(func(relay uint8, state bool)) (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). Die Parameter enthalten das auslösende Relais (1 oder 2) und den aktuellen Zustand des Relais (der Zustand nach dem Monoflop).

Konstanten

dual_relay_bricklet.DeviceIdentifier

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

Diese Konstante stellt den Anzeigenamen eines Dual Relay Bricklet dar.