Go - Industrial Analog Out Bricklet

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

Download (example_simple_current.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
package main

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

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

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    iao, _ := industrial_analog_out_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 output current to 4.5mA
    iao.SetCurrent(4500)
    iao.Enable()

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

Simple Voltage

Download (example_simple_voltage.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
package main

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

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

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    iao, _ := industrial_analog_out_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 output voltage to 3.3V
    iao.SetVoltage(3300)
    iao.Enable()

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

API

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

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

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

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

func (*IndustrialAnalogOutBricklet) Enable() (err error)

Aktiviert die Ausgabe von Spannung und Strom.

Der Standardwert ist deaktiviert.

func (*IndustrialAnalogOutBricklet) Disable() (err error)

Deaktiviert die Ausgabe von Spannung und Strom.

Der Standardwert ist deaktiviert.

func (*IndustrialAnalogOutBricklet) IsEnabled() (enabled bool, err error)

Gibt true zurück falls die Ausgabe von Spannung und Strom aktiviert ist, false sonst.

func (*IndustrialAnalogOutBricklet) SetVoltage(voltage uint16) (err error)

Setzt die Ausgangsspannung in mV.

Die Ausgangsspannung und der Ausgangsstrom sind gekoppelt. Eine Änderung der Ausgangsspannung führt auch zu einer Änderung des Ausgangsstroms.

func (*IndustrialAnalogOutBricklet) GetVoltage() (voltage uint16, err error)

Gibt die Spannung zurück, wie von SetVoltage() gesetzt.

func (*IndustrialAnalogOutBricklet) SetCurrent(current uint16) (err error)

Setzt den Ausgangsstrom in µA.

Der Ausgangsstrom und die Ausgangsspannung sind gekoppelt. Eine Änderung des Ausgangsstroms führt auch zu einer Änderung der Ausgangsspannung.

func (*IndustrialAnalogOutBricklet) GetCurrent() (current uint16, err error)

Gibt die Spannung zurück, wie von SetCurrent() gesetzt.

Fortgeschrittene Funktionen

func (*IndustrialAnalogOutBricklet) SetConfiguration(voltageRange VoltageRange, currentRange CurrentRange) (err error)

Konfiguriert die Spannungs- und Stromwertebereiche.

Einstellbare Spannungswertebereiche sind:

  • 0V bis 5V
  • 0V bis 10V (Standard)

Einstellbare Stromwertebereiche sind:

  • 4mA bis 20mA (Standard)
  • 0mA bis 20mA
  • 0mA bis 24mA

Die Auflösung ist immer 12 Bit. Dass heißt, die Genauigkeit erhöht sich bei kleineren Wertebereichen.

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

  • industrial_analog_out_bricklet.VoltageRange0To5V = 0
  • industrial_analog_out_bricklet.VoltageRange0To10V = 1
  • industrial_analog_out_bricklet.CurrentRange4To20mA = 0
  • industrial_analog_out_bricklet.CurrentRange0To20mA = 1
  • industrial_analog_out_bricklet.CurrentRange0To24mA = 2
func (*IndustrialAnalogOutBricklet) GetConfiguration() (voltageRange VoltageRange, currentRange CurrentRange, err error)

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

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

  • industrial_analog_out_bricklet.VoltageRange0To5V = 0
  • industrial_analog_out_bricklet.VoltageRange0To10V = 1
  • industrial_analog_out_bricklet.CurrentRange4To20mA = 0
  • industrial_analog_out_bricklet.CurrentRange0To20mA = 1
  • industrial_analog_out_bricklet.CurrentRange0To24mA = 2
func (*IndustrialAnalogOutBricklet) 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 (*IndustrialAnalogOutBricklet) 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_analog_out_bricklet.FunctionEnable = 1
  • industrial_analog_out_bricklet.FunctionDisable = 2
  • industrial_analog_out_bricklet.FunctionSetVoltage = 4
  • industrial_analog_out_bricklet.FunctionSetCurrent = 6
  • industrial_analog_out_bricklet.FunctionSetConfiguration = 8
func (*IndustrialAnalogOutBricklet) 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_analog_out_bricklet.FunctionEnable = 1
  • industrial_analog_out_bricklet.FunctionDisable = 2
  • industrial_analog_out_bricklet.FunctionSetVoltage = 4
  • industrial_analog_out_bricklet.FunctionSetCurrent = 6
  • industrial_analog_out_bricklet.FunctionSetConfiguration = 8
func (*IndustrialAnalogOutBricklet) SetResponseExpectedAll(responseExpected bool) (err error)

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

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

Konstanten

industrial_analog_out_bricklet.DeviceIdentifier

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

Diese Konstante stellt den Anzeigenamen eines Industrial Analog Out Bricklet dar.