Go - Industrial Dual Analog In Bricklet

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

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

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    idai, _ := industrial_dual_analog_in_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 voltage from channel 1.
    voltage, _ := idai.GetVoltage(1)
    fmt.Printf("Voltage (Channel 1): %f V\n", float64(voltage)/1000.0)

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

Callback

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

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

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

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

    idai.RegisterVoltageCallback(func(channel uint8, voltage int32) {
        fmt.Printf("Channel: %d\n", channel)
        fmt.Printf("Voltage: %f V\n", float64(voltage)/1000.0)
        fmt.Println()
    })

    // Set period for voltage (channel 1) receiver to 1s (1000ms).
    // Note: The voltage (channel 1) callback is only called every second
    //       if the voltage (channel 1) has changed since the last call!
    idai.SetVoltageCallbackPeriod(1, 1000)

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

Threshold

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

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

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    idai, _ := industrial_dual_analog_in_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 threshold receivers with a debounce time of 10 seconds (10000ms).
    idai.SetDebouncePeriod(10000)

    idai.RegisterVoltageReachedCallback(func(channel uint8, voltage int32) {
        fmt.Printf("Channel: %d\n", channel)
        fmt.Printf("Voltage: %f V\n", float64(voltage)/1000.0)
        fmt.Println()
    })

    // Configure threshold for voltage (channel 1) "greater than 10 V".
    idai.SetVoltageCallbackThreshold(1, '>', 10*1000, 0)

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

API

Die API des Industrial Dual Analog In Bricklet ist im Package github.com/Tinkerforge/go-api-bindings/industrial_dual_analog_in_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.

Das Bricklet hat zwei Eingangskanäle. Funktionen die sich direkt auf einen der Kanäle beziehen haben einen channel Parameter, um den Kanal anzugeben. Gültige Werte für das channel Parameter sind 0 und 1.

Grundfunktionen

func industrial_dual_analog_in_bricklet.New(uid string, ipcon *IPConnection) (device IndustrialDualAnalogInBricklet, err error)

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

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

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

func (*IndustrialDualAnalogInBricklet) GetVoltage(channel uint8) (voltage int32, err error)

Gibt die Spannung für den übergebenen Kanal in mV zurück.

Wenn die Spannung periodisch abgefragt werden soll, wird empfohlen den RegisterVoltageCallback Callback zu nutzen und die Periode mit SetVoltageCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen

func (*IndustrialDualAnalogInBricklet) SetSampleRate(rate SampleRate) (err error)

Setzt die Abtastrate. Der Wertebereich der verfügbare Abtastraten liegt zwischen 1 Wert pro Sekunde und 976 Werte pro Sekunde. Ein Verringern der Abtastrate wird auch das Rauschen auf den Daten verringern.

Der Standardwert ist 6 (2 Werte pro Sekunde).

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

  • industrial_dual_analog_in_bricklet.SampleRate976SPS = 0
  • industrial_dual_analog_in_bricklet.SampleRate488SPS = 1
  • industrial_dual_analog_in_bricklet.SampleRate244SPS = 2
  • industrial_dual_analog_in_bricklet.SampleRate122SPS = 3
  • industrial_dual_analog_in_bricklet.SampleRate61SPS = 4
  • industrial_dual_analog_in_bricklet.SampleRate4SPS = 5
  • industrial_dual_analog_in_bricklet.SampleRate2SPS = 6
  • industrial_dual_analog_in_bricklet.SampleRate1SPS = 7
func (*IndustrialDualAnalogInBricklet) GetSampleRate() (rate SampleRate, err error)

Gibt die Abtastrate zurück, wie von SetSampleRate() gesetzt.

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

  • industrial_dual_analog_in_bricklet.SampleRate976SPS = 0
  • industrial_dual_analog_in_bricklet.SampleRate488SPS = 1
  • industrial_dual_analog_in_bricklet.SampleRate244SPS = 2
  • industrial_dual_analog_in_bricklet.SampleRate122SPS = 3
  • industrial_dual_analog_in_bricklet.SampleRate61SPS = 4
  • industrial_dual_analog_in_bricklet.SampleRate4SPS = 5
  • industrial_dual_analog_in_bricklet.SampleRate2SPS = 6
  • industrial_dual_analog_in_bricklet.SampleRate1SPS = 7
func (*IndustrialDualAnalogInBricklet) SetCalibration(offset [2]int32, gain [2]int32) (err error)

Setzt Offset und Gain der MCP3911 internen Kalibrierungsregister.

Siehe MCP3911 Datenblatt 7.7 und 7.8. Das Industrial Dual Analog In Bricklet wird von Tinkerforge werkskalibriert. Ein Aufruf dieser Funktion sollte nicht notwendig sein.

func (*IndustrialDualAnalogInBricklet) GetCalibration() (offset [2]int32, gain [2]int32, err error)

Gibt die Kalibrierung zurück, wie von SetCalibration() gesetzt.

func (*IndustrialDualAnalogInBricklet) GetADCValues() (value [2]int32, err error)

Gibt die ADC-Werte des MCP3911 ICs zurück. Diese Funktion wird für die Kalibrierung benötigt, siehe SetCalibration().

func (*IndustrialDualAnalogInBricklet) 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 (*IndustrialDualAnalogInBricklet) 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_analog_in_bricklet.FunctionSetVoltageCallbackPeriod = 2
  • industrial_dual_analog_in_bricklet.FunctionSetVoltageCallbackThreshold = 4
  • industrial_dual_analog_in_bricklet.FunctionSetDebouncePeriod = 6
  • industrial_dual_analog_in_bricklet.FunctionSetSampleRate = 8
  • industrial_dual_analog_in_bricklet.FunctionSetCalibration = 10
func (*IndustrialDualAnalogInBricklet) 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_analog_in_bricklet.FunctionSetVoltageCallbackPeriod = 2
  • industrial_dual_analog_in_bricklet.FunctionSetVoltageCallbackThreshold = 4
  • industrial_dual_analog_in_bricklet.FunctionSetDebouncePeriod = 6
  • industrial_dual_analog_in_bricklet.FunctionSetSampleRate = 8
  • industrial_dual_analog_in_bricklet.FunctionSetCalibration = 10
func (*IndustrialDualAnalogInBricklet) SetResponseExpectedAll(responseExpected bool) (err error)

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

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

Konfigurationsfunktionen für Callbacks

func (*IndustrialDualAnalogInBricklet) SetVoltageCallbackPeriod(channel uint8, period uint32) (err error)

Setzt die Periode in ms mit welcher der RegisterVoltageCallback Callback für den übergebenen Kanal ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der RegisterVoltageCallback Callback wird nur ausgelöst, wenn sich die Spannung seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

func (*IndustrialDualAnalogInBricklet) GetVoltageCallbackPeriod(channel uint8) (period uint32, err error)

Gibt die Periode zurück, wie von SetVoltageCallbackPeriod() gesetzt.

func (*IndustrialDualAnalogInBricklet) SetVoltageCallbackThreshold(channel uint8, option ThresholdOption, min int32, max int32) (err error)

Setzt den Schwellwert des RegisterVoltageReachedCallback Callbacks für den übergebenen Kanal.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Spannung außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn die Spannung innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn die Spannung kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Spannung größer als der min Wert ist (max wird ignoriert)

Der Standardwert ist ('x', 0, 0).

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

  • industrial_dual_analog_in_bricklet.ThresholdOptionOff = 'x'
  • industrial_dual_analog_in_bricklet.ThresholdOptionOutside = 'o'
  • industrial_dual_analog_in_bricklet.ThresholdOptionInside = 'i'
  • industrial_dual_analog_in_bricklet.ThresholdOptionSmaller = '<'
  • industrial_dual_analog_in_bricklet.ThresholdOptionGreater = '>'
func (*IndustrialDualAnalogInBricklet) GetVoltageCallbackThreshold(channel uint8) (option ThresholdOption, min int32, max int32, err error)

Gibt den Schwellwert zurück, wie von SetVoltageCallbackThreshold() gesetzt.

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

  • industrial_dual_analog_in_bricklet.ThresholdOptionOff = 'x'
  • industrial_dual_analog_in_bricklet.ThresholdOptionOutside = 'o'
  • industrial_dual_analog_in_bricklet.ThresholdOptionInside = 'i'
  • industrial_dual_analog_in_bricklet.ThresholdOptionSmaller = '<'
  • industrial_dual_analog_in_bricklet.ThresholdOptionGreater = '>'
func (*IndustrialDualAnalogInBricklet) SetDebouncePeriod(debounce uint32) (err error)

Setzt die Periode in ms mit welcher der Schwellwert Callback

ausgelöst werden, wenn der Schwellwert

weiterhin erreicht bleibt.

Der Standardwert ist 100.

func (*IndustrialDualAnalogInBricklet) GetDebouncePeriod() (debounce uint32, err error)

Gibt die Entprellperiode zurück, wie von SetDebouncePeriod() gesetzt.

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 (*IndustrialDualAnalogInBricklet) RegisterVoltageCallback(func(channel uint8, voltage int32)) (registrationId uint64)

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

Dieser Callback wird mit der Periode, wie gesetzt mit SetVoltageCallbackPeriod(), ausgelöst. Der Parameter des Callbacks ist die Spannung des Kanals.

Der RegisterVoltageCallback Callback wird nur ausgelöst, wenn sich die Spannung seit der letzten Auslösung geändert hat.

func (*IndustrialDualAnalogInBricklet) RegisterVoltageReachedCallback(func(channel uint8, voltage int32)) (registrationId uint64)

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetVoltageCallbackThreshold() gesetzt, erreicht wird. Der Parameter des Callbacks ist die Spannung des Kanals.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit SetDebouncePeriod() gesetzt, ausgelöst.

Konstanten

industrial_dual_analog_in_bricklet.DeviceIdentifier

Diese Konstante wird verwendet um ein Industrial Dual Analog In 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_analog_in_bricklet.DeviceDisplayName

Diese Konstante stellt den Anzeigenamen eines Industrial Dual Analog In Bricklet dar.