Go - Industrial Dual 0-20mA Bricklet

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

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    id020, _ := industrial_dual_0_20ma_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 current from sensor 1.
    current, _ := id020.GetCurrent(1)
    fmt.Printf("Current (Sensor 1): %f mA\n", float64(current)/1000000.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_0_20ma_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 0-20mA Bricklet.

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

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

    id020.RegisterCurrentCallback(func(sensor uint8, current int32) {
        fmt.Printf("Sensor: %d\n", sensor)
        fmt.Printf("Current: %f mA\n", float64(current)/1000000.0)
        fmt.Println()
    })

    // Set period for current (sensor 1) receiver to 1s (1000ms).
    // Note: The current (sensor 1) callback is only called every second
    //       if the current (sensor 1) has changed since the last call!
    id020.SetCurrentCallbackPeriod(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_0_20ma_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 0-20mA Bricklet.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    id020, _ := industrial_dual_0_20ma_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).
    id020.SetDebouncePeriod(10000)

    id020.RegisterCurrentReachedCallback(func(sensor uint8, current int32) {
        fmt.Printf("Sensor: %d\n", sensor)
        fmt.Printf("Current: %f mA\n", float64(current)/1000000.0)
        fmt.Println()
    })

    // Configure threshold for current (sensor 1) "greater than 10 mA".
    id020.SetCurrentCallbackThreshold(1, '>', 10*1000000, 0)

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

API

Die API des Industrial Dual 0-20mA Bricklet ist im Package github.com/Tinkerforge/go-api-bindings/industrial_dual_0_20ma_bricklet definiert.

Fast alle Funktionen der Go Bindings können einen ipconnection.DeviceError, der das error-Interface implementiert, zurückgeben. Dieser kann folgende Werte annehmen:

  • ipconnection.DeviceErrorSuccess = 0
  • ipconnection.DeviceErrorInvalidParameter = 1
  • ipconnection.DeviceErrorFunctionNotSupported = 2
  • ipconnection.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_0_20ma_bricklet.New(uid string, ipcon *IPConnection) (device IndustrialDual020mABricklet, err error)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: *IPConnection
Rückgabe:
  • device – Typ: IndustrialDual020mABricklet
  • err – Typ: error

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

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

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

func (*IndustrialDual020mABricklet) GetCurrent(sensor uint8) (current int32, err error)
Parameter:
  • sensor – Typ: uint8, Wertebereich: [0 bis 1]
Rückgabe:
  • current – Typ: int32, Einheit: 1 nA, Wertebereich: [0 bis 22505322]
  • err – Typ: error

Gibt die gemessenen Stromstärke des angegebenen Sensors zurück.

Es ist möglich zu erkennen ob ein IEC 60381-1-kompatibler Sensor angeschlossen ist und ob er funktionsfähig ist.

Falls die zurückgegebene Stromstärke kleiner als 4mA ist, ist wahrscheinlich kein Sensor angeschlossen oder der Sensor ist defekt. Falls die zurückgegebene Stromstärke über 20mA ist, besteht entweder ein Kurzschluss oder der Sensor ist defekt. Somit ist erkennbar ob ein Sensor angeschlossen und funktionsfähig ist.

Wenn die Stromstärke periodisch abgefragt werden soll, wird empfohlen den RegisterCurrentCallback Callback zu nutzen und die Periode mit SetCurrentCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen

func (*IndustrialDual020mABricklet) SetSampleRate(rate uint8) (err error)
Parameter:
  • rate – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:
  • err – Typ: error

Setzt die Abtastrate auf 240, 60, 15 oder 4 Samples pro Sekunde. Die Auflösung für die Raten sind 12, 14, 16 und 18 Bit respektive.

Wert Beschreibung
0 240 Samples pro Sekunde, 12 Bit Auflösung
1 60 Samples pro Sekunde, 14 Bit Auflösung
2 15 Samples pro Sekunde, 16 Bit Auflösung
3 4 Samples pro Sekunde, 18 Bit Auflösung

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

Für rate:

  • industrial_dual_0_20ma_bricklet.SampleRate240SPS = 0
  • industrial_dual_0_20ma_bricklet.SampleRate60SPS = 1
  • industrial_dual_0_20ma_bricklet.SampleRate15SPS = 2
  • industrial_dual_0_20ma_bricklet.SampleRate4SPS = 3
func (*IndustrialDual020mABricklet) GetSampleRate() (rate uint8, err error)
Rückgabe:
  • rate – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
  • err – Typ: error

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

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

Für rate:

  • industrial_dual_0_20ma_bricklet.SampleRate240SPS = 0
  • industrial_dual_0_20ma_bricklet.SampleRate60SPS = 1
  • industrial_dual_0_20ma_bricklet.SampleRate15SPS = 2
  • industrial_dual_0_20ma_bricklet.SampleRate4SPS = 3
func (*IndustrialDual020mABricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)
Rückgabe:
  • uid – Typ: string, Länge: bis zu 8
  • connectedUid – Typ: string, Länge: bis zu 8
  • position – Typ: rune, Wertebereich: ['a' bis 'h', 'i', 'z']
  • hardwareVersion – Typ: [3]uint8
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: [3]uint8
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • err – Typ: 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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

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 (*IndustrialDual020mABricklet) SetCurrentCallbackPeriod(sensor uint8, period uint32) (err error)
Parameter:
  • sensor – Typ: uint8, Wertebereich: [0 bis 1]
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • err – Typ: error

Setzt die Periode mit welcher der RegisterCurrentCallback Callback für den übergebenen Sensor ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

func (*IndustrialDual020mABricklet) GetCurrentCallbackPeriod(sensor uint8) (period uint32, err error)
Parameter:
  • sensor – Typ: uint8, Wertebereich: [0 bis 1]
Rückgabe:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • err – Typ: error

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

func (*IndustrialDual020mABricklet) SetCurrentCallbackThreshold(sensor uint8, option rune, min int32, max int32) (err error)
Parameter:
  • sensor – Typ: uint8, Wertebereich: [0 bis 1]
  • option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int32, Einheit: 1 nA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int32, Einheit: 1 nA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Rückgabe:
  • err – Typ: error

Setzt den Schwellwert des RegisterCurrentReachedCallback Callbacks für den übergebenen Sensor.

Die folgenden Optionen sind möglich:

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

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

Für option:

  • industrial_dual_0_20ma_bricklet.ThresholdOptionOff = 'x'
  • industrial_dual_0_20ma_bricklet.ThresholdOptionOutside = 'o'
  • industrial_dual_0_20ma_bricklet.ThresholdOptionInside = 'i'
  • industrial_dual_0_20ma_bricklet.ThresholdOptionSmaller = '<'
  • industrial_dual_0_20ma_bricklet.ThresholdOptionGreater = '>'
func (*IndustrialDual020mABricklet) GetCurrentCallbackThreshold(sensor uint8) (option rune, min int32, max int32, err error)
Parameter:
  • sensor – Typ: uint8, Wertebereich: [0 bis 1]
Rückgabe:
  • option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int32, Einheit: 1 nA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int32, Einheit: 1 nA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • err – Typ: error

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

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

Für option:

  • industrial_dual_0_20ma_bricklet.ThresholdOptionOff = 'x'
  • industrial_dual_0_20ma_bricklet.ThresholdOptionOutside = 'o'
  • industrial_dual_0_20ma_bricklet.ThresholdOptionInside = 'i'
  • industrial_dual_0_20ma_bricklet.ThresholdOptionSmaller = '<'
  • industrial_dual_0_20ma_bricklet.ThresholdOptionGreater = '>'
func (*IndustrialDual020mABricklet) SetDebouncePeriod(debounce uint32) (err error)
Parameter:
  • debounce – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100
Rückgabe:
  • err – Typ: error

Setzt die Periode mit welcher der Schwellwert Callback

ausgelöst werden, wenn der Schwellwert

weiterhin erreicht bleibt.

func (*IndustrialDual020mABricklet) GetDebouncePeriod() (debounce uint32, err error)
Rückgabe:
  • debounce – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100
  • err – Typ: 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 (*IndustrialDual020mABricklet) RegisterCurrentCallback(func(sensor uint8, current int32)) (registrationId uint64)
Callback-Parameter:
  • sensor – Typ: uint8, Wertebereich: [0 bis 1]
  • current – Typ: int32, Einheit: 1 nA, Wertebereich: [0 bis 22505322]
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird mit der Periode, wie gesetzt mit SetCurrentCallbackPeriod(), ausgelöst. Der Parameter des Callbacks ist die Stromstärke des Sensors.

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

func (*IndustrialDual020mABricklet) RegisterCurrentReachedCallback(func(sensor uint8, current int32)) (registrationId uint64)
Callback-Parameter:
  • sensor – Typ: uint8, Wertebereich: [0 bis 1]
  • current – Typ: int32, Einheit: 1 nA, Wertebereich: [0 bis 22505322]
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetCurrentCallbackThreshold() gesetzt, erreicht wird. Der Parameter des Callbacks ist die Stromstärke des Sensors.

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

Virtuelle Funktionen

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

func (*IndustrialDual020mABricklet) GetAPIVersion() (apiVersion [3]uint8, err error)
Rückgabe:
  • apiVersion – Typ: [3]uint8
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • err – Typ: error

Gibt die Version der API Definition 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 (*IndustrialDual020mABricklet) GetResponseExpected(functionId uint8) (responseExpected bool, err error)
Parameter:
  • functionId – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • responseExpected – Typ: bool
  • err – Typ: 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:

Für functionId:

  • industrial_dual_0_20ma_bricklet.FunctionSetCurrentCallbackPeriod = 2
  • industrial_dual_0_20ma_bricklet.FunctionSetCurrentCallbackThreshold = 4
  • industrial_dual_0_20ma_bricklet.FunctionSetDebouncePeriod = 6
  • industrial_dual_0_20ma_bricklet.FunctionSetSampleRate = 8
func (*IndustrialDual020mABricklet) SetResponseExpected(functionId uint8, responseExpected bool) (err error)
Parameter:
  • functionId – Typ: uint8, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: bool
Rückgabe:
  • err – Typ: 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:

Für functionId:

  • industrial_dual_0_20ma_bricklet.FunctionSetCurrentCallbackPeriod = 2
  • industrial_dual_0_20ma_bricklet.FunctionSetCurrentCallbackThreshold = 4
  • industrial_dual_0_20ma_bricklet.FunctionSetDebouncePeriod = 6
  • industrial_dual_0_20ma_bricklet.FunctionSetSampleRate = 8
func (*IndustrialDual020mABricklet) SetResponseExpectedAll(responseExpected bool) (err error)
Parameter:
  • responseExpected – Typ: bool
Rückgabe:
  • err – Typ: error

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

Konstanten

industrial_dual_0_20ma_bricklet.DeviceIdentifier

Diese Konstante wird verwendet um ein Industrial Dual 0-20mA 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_0_20ma_bricklet.DeviceDisplayName

Diese Konstante stellt den Anzeigenamen eines Industrial Dual 0-20mA Bricklet dar.