Go - Industrial Dual Relay Bricklet

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

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    idr, _ := industrial_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)
        idr.SetValue(true, false)
        time.Sleep(1000 * time.Millisecond)
        idr.SetValue(false, true)
    }

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

API

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

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

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

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

func (*IndustrialDualRelayBricklet) SetValue(channel0 bool, channel1 bool) (err error)

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

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

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

Der Standardwert ist (false, false).

func (*IndustrialDualRelayBricklet) GetValue() (channel0 bool, channel1 bool, err error)

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

Fortgeschrittene Funktionen

func (*IndustrialDualRelayBricklet) SetMonoflop(channel uint8, value bool, time uint32) (err error)

Der erste Parameter kann 0 oder 1 sein (Relais 0 oder Relais 1). 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 Industrial 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 (*IndustrialDualRelayBricklet) GetMonoflop(channel uint8) (value 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 (*IndustrialDualRelayBricklet) SetSelectedValue(channel uint8, value bool) (err error)

Setzt den Zustand des ausgewählten Relais (0 oder 1), 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 unverändert.

func (*IndustrialDualRelayBricklet) 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 (*IndustrialDualRelayBricklet) 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_dual_relay_bricklet.FunctionSetValue = 1
  • industrial_dual_relay_bricklet.FunctionSetMonoflop = 3
  • industrial_dual_relay_bricklet.FunctionSetSelectedValue = 6
  • industrial_dual_relay_bricklet.FunctionSetWriteFirmwarePointer = 237
  • industrial_dual_relay_bricklet.FunctionSetStatusLEDConfig = 239
  • industrial_dual_relay_bricklet.FunctionReset = 243
  • industrial_dual_relay_bricklet.FunctionWriteUID = 248
func (*IndustrialDualRelayBricklet) 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_dual_relay_bricklet.FunctionSetValue = 1
  • industrial_dual_relay_bricklet.FunctionSetMonoflop = 3
  • industrial_dual_relay_bricklet.FunctionSetSelectedValue = 6
  • industrial_dual_relay_bricklet.FunctionSetWriteFirmwarePointer = 237
  • industrial_dual_relay_bricklet.FunctionSetStatusLEDConfig = 239
  • industrial_dual_relay_bricklet.FunctionReset = 243
  • industrial_dual_relay_bricklet.FunctionWriteUID = 248
func (*IndustrialDualRelayBricklet) SetResponseExpectedAll(responseExpected bool) (err error)

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

func (*IndustrialDualRelayBricklet) GetSPITFPErrorCount() (errorCountAckChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err error)

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

func (*IndustrialDualRelayBricklet) SetBootloaderMode(mode BootloaderMode) (status BootloaderStatus, err error)

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootlodaer- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

  • industrial_dual_relay_bricklet.BootloaderModeBootloader = 0
  • industrial_dual_relay_bricklet.BootloaderModeFirmware = 1
  • industrial_dual_relay_bricklet.BootloaderModeBootloaderWaitForReboot = 2
  • industrial_dual_relay_bricklet.BootloaderModeFirmwareWaitForReboot = 3
  • industrial_dual_relay_bricklet.BootloaderModeFirmwareWaitForEraseAndReboot = 4
  • industrial_dual_relay_bricklet.BootloaderStatusOK = 0
  • industrial_dual_relay_bricklet.BootloaderStatusInvalidMode = 1
  • industrial_dual_relay_bricklet.BootloaderStatusNoChange = 2
  • industrial_dual_relay_bricklet.BootloaderStatusEntryFunctionNotPresent = 3
  • industrial_dual_relay_bricklet.BootloaderStatusDeviceIdentifierIncorrect = 4
  • industrial_dual_relay_bricklet.BootloaderStatusCRCMismatch = 5
func (*IndustrialDualRelayBricklet) GetBootloaderMode() (mode BootloaderMode, err error)

Gibt den aktuellen Bootloader-Modus zurück, siehe SetBootloaderMode().

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

  • industrial_dual_relay_bricklet.BootloaderModeBootloader = 0
  • industrial_dual_relay_bricklet.BootloaderModeFirmware = 1
  • industrial_dual_relay_bricklet.BootloaderModeBootloaderWaitForReboot = 2
  • industrial_dual_relay_bricklet.BootloaderModeFirmwareWaitForReboot = 3
  • industrial_dual_relay_bricklet.BootloaderModeFirmwareWaitForEraseAndReboot = 4
func (*IndustrialDualRelayBricklet) SetWriteFirmwarePointer(pointer uint32) (err error)

Setzt den Firmware-Pointer für WriteFirmware(). Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

func (*IndustrialDualRelayBricklet) WriteFirmware(data [64]uint8) (status uint8, err error)

Schreibt 64 Bytes Firmware an die Position die vorher von SetWriteFirmwarePointer() gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

func (*IndustrialDualRelayBricklet) SetStatusLEDConfig(config StatusLEDConfig) (err error)

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

  • industrial_dual_relay_bricklet.StatusLEDConfigOff = 0
  • industrial_dual_relay_bricklet.StatusLEDConfigOn = 1
  • industrial_dual_relay_bricklet.StatusLEDConfigShowHeartbeat = 2
  • industrial_dual_relay_bricklet.StatusLEDConfigShowStatus = 3
func (*IndustrialDualRelayBricklet) GetStatusLEDConfig() (config StatusLEDConfig, err error)

Gibt die Konfiguration zurück, wie von SetStatusLEDConfig() gesetzt.

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

  • industrial_dual_relay_bricklet.StatusLEDConfigOff = 0
  • industrial_dual_relay_bricklet.StatusLEDConfigOn = 1
  • industrial_dual_relay_bricklet.StatusLEDConfigShowHeartbeat = 2
  • industrial_dual_relay_bricklet.StatusLEDConfigShowStatus = 3
func (*IndustrialDualRelayBricklet) GetChipTemperature() (temperature int16, err error)

Gibt die Temperatur in °C, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

func (*IndustrialDualRelayBricklet) Reset() (err error)

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

func (*IndustrialDualRelayBricklet) WriteUID(uid uint32) (err error)

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

func (*IndustrialDualRelayBricklet) ReadUID() (uid uint32, err error)

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

func (*IndustrialDualRelayBricklet) 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 (*IndustrialDualRelayBricklet) RegisterMonoflopDoneCallback(func(channel uint8, value 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 (0 oder 1) und den aktuellen Zustand des Relais (der Zustand nach dem Monoflop).

Konstanten

industrial_dual_relay_bricklet.DeviceIdentifier

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

industrial_dual_relay_bricklet.DeviceDisplayName

Diese Konstante stellt den Anzeigenamen eines Industrial Dual Relay Bricklet dar.