Dies ist die Beschreibung der Go API Bindings für das Analog In Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des 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.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
1package main
2
3import (
4 "fmt"
5 "github.com/Tinkerforge/go-api-bindings/analog_in_bricklet"
6 "github.com/Tinkerforge/go-api-bindings/ipconnection"
7)
8
9const ADDR string = "localhost:4223"
10const UID string = "XYZ" // Change XYZ to the UID of your Analog In Bricklet.
11
12func main() {
13 ipcon := ipconnection.New()
14 defer ipcon.Close()
15 ai, _ := analog_in_bricklet.New(UID, &ipcon) // Create device object.
16
17 ipcon.Connect(ADDR) // Connect to brickd.
18 defer ipcon.Disconnect()
19 // Don't use device before ipcon is connected.
20
21 // Get current voltage.
22 voltage, _ := ai.GetVoltage()
23 fmt.Printf("Voltage: %f V\n", float64(voltage)/1000.0)
24
25 fmt.Print("Press enter to exit.")
26 fmt.Scanln()
27}
Download (example_callback.go)
1package main
2
3import (
4 "fmt"
5 "github.com/Tinkerforge/go-api-bindings/analog_in_bricklet"
6 "github.com/Tinkerforge/go-api-bindings/ipconnection"
7)
8
9const ADDR string = "localhost:4223"
10const UID string = "XYZ" // Change XYZ to the UID of your Analog In Bricklet.
11
12func main() {
13 ipcon := ipconnection.New()
14 defer ipcon.Close()
15 ai, _ := analog_in_bricklet.New(UID, &ipcon) // Create device object.
16
17 ipcon.Connect(ADDR) // Connect to brickd.
18 defer ipcon.Disconnect()
19 // Don't use device before ipcon is connected.
20
21 ai.RegisterVoltageCallback(func(voltage uint16) {
22 fmt.Printf("Voltage: %f V\n", float64(voltage)/1000.0)
23 })
24
25 // Set period for voltage receiver to 1s (1000ms).
26 // Note: The voltage callback is only called every second
27 // if the voltage has changed since the last call!
28 ai.SetVoltageCallbackPeriod(1000)
29
30 fmt.Print("Press enter to exit.")
31 fmt.Scanln()
32}
Download (example_threshold.go)
1package main
2
3import (
4 "fmt"
5 "github.com/Tinkerforge/go-api-bindings/analog_in_bricklet"
6 "github.com/Tinkerforge/go-api-bindings/ipconnection"
7)
8
9const ADDR string = "localhost:4223"
10const UID string = "XYZ" // Change XYZ to the UID of your Analog In Bricklet.
11
12func main() {
13 ipcon := ipconnection.New()
14 defer ipcon.Close()
15 ai, _ := analog_in_bricklet.New(UID, &ipcon) // Create device object.
16
17 ipcon.Connect(ADDR) // Connect to brickd.
18 defer ipcon.Disconnect()
19 // Don't use device before ipcon is connected.
20
21 // Get threshold receivers with a debounce time of 10 seconds (10000ms).
22 ai.SetDebouncePeriod(10000)
23
24 ai.RegisterVoltageReachedCallback(func(voltage uint16) {
25 fmt.Printf("Voltage: %f V\n", float64(voltage)/1000.0)
26 })
27
28 // Configure threshold for voltage "smaller than 5 V".
29 ai.SetVoltageCallbackThreshold('<', 5*1000, 0)
30
31 fmt.Print("Press enter to exit.")
32 fmt.Scanln()
33}
Die API des Analog In Bricklet ist im Package github.com/Tinkerforge/go-api-bindings/analog_in_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.
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Erzeugt ein neues AnalogInBricklet-Objekt mit der eindeutigen Geräte ID uid und
fügt es der IPConnection ipcon hinzu:
device, err := analog_in_bricklet.New("YOUR_DEVICE_UID", &ipcon)
Dieses Geräteobjekt kann benutzt werden, nachdem die IPConnection verbunden.
| Rückgabe: |
|
|---|
Gibt die gemessene Spannung des Sensors zurück. Die Auflösung im Bereich 0 bis 6V beträgt rund 2mV. Zwischen 6 und 45V ist die Auflösung rund 10mV.
Wenn die Spannung periodisch abgefragt werden soll, wird empfohlen
den VoltageCallback Callback zu nutzen und die Periode mit
SetVoltageCallbackPeriod() vorzugeben.
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Setzt den Messbereich. Mögliche Bereiche:
0: Automatisch geschaltet
1: 0V - 6,05V, ~1,48mV Auflösung
2: 0V - 10,32V, ~2,52mV Auflösung
3: 0V - 36,30V, ~8,86mV Auflösung
4: 0V - 45,00V, ~11,25mV Auflösung
5: 0V - 3,3V, ~0,81mV Auflösung, neu in Version 2.0.3$nbsp;(Plugin)
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für range:
analog_in_bricklet.RangeAutomatic = 0
analog_in_bricklet.RangeUpTo6V = 1
analog_in_bricklet.RangeUpTo10V = 2
analog_in_bricklet.RangeUpTo36V = 3
analog_in_bricklet.RangeUpTo45V = 4
analog_in_bricklet.RangeUpTo3V = 5
Added in version 2.0.1$nbsp;(Plugin).
| Rückgabe: |
|
|---|
Gibt den Messbereich zurück, wie von SetRange() gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für range:
analog_in_bricklet.RangeAutomatic = 0
analog_in_bricklet.RangeUpTo6V = 1
analog_in_bricklet.RangeUpTo10V = 2
analog_in_bricklet.RangeUpTo36V = 3
analog_in_bricklet.RangeUpTo45V = 4
analog_in_bricklet.RangeUpTo3V = 5
Added in version 2.0.1$nbsp;(Plugin).
| Rückgabe: |
|
|---|
Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück.
Bemerkung
Der von GetVoltage() zurückgegebene Wert ist über mehrere
Messwerte gemittelt um das Rauschen zu vermindern, während GetAnalogValue()
unverarbeitete Analogwerte zurück gibt. Der einzige Grund GetAnalogValue()
zu nutzen, ist die volle Auflösung des Analog-Digital-Wandlers zu erhalten.
Wenn der Analogwert periodisch abgefragt werden soll, wird empfohlen
den AnalogValueCallback Callback zu nutzen und die Periode mit
SetAnalogValueCallbackPeriod() vorzugeben.
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Setzt die Länge des Mittelwerts für die Spannung.
Wenn die Länge auf 0 gesetzt wird, ist das Averaging komplett aus. In diesem Fall gibt es mehr Rauschen auf den Daten, allerdings sind die Daten dann ohne Verzögerung.
Added in version 2.0.3$nbsp;(Plugin).
| Rückgabe: |
|
|---|
Gibt die Averaging-Konfiguration zurück, wie von SetAveraging() gesetzt.
Added in version 2.0.3$nbsp;(Plugin).
| Rückgabe: |
|
|---|
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 ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein 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.
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Setzt die Periode mit welcher der VoltageCallback Callback ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
Der VoltageCallback Callback wird nur ausgelöst, wenn sich die Spannung seit der
letzten Auslösung geändert hat.
| Rückgabe: |
|
|---|
Gibt die Periode zurück, wie von SetVoltageCallbackPeriod() gesetzt.
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Setzt die Periode mit welcher der AnalogValueCallback Callback ausgelöst
wird. Ein Wert von 0 deaktiviert den Callback.
Der AnalogValueCallback Callback wird nur ausgelöst, wenn sich der Analogwert
seit der letzten Auslösung geändert hat.
| Rückgabe: |
|
|---|
Gibt die Periode zurück, wie von SetAnalogValueCallbackPeriod() gesetzt.
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Setzt den Schwellwert für den VoltageReachedCallback Callback.
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) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
analog_in_bricklet.ThresholdOptionOff = 'x'
analog_in_bricklet.ThresholdOptionOutside = 'o'
analog_in_bricklet.ThresholdOptionInside = 'i'
analog_in_bricklet.ThresholdOptionSmaller = '<'
analog_in_bricklet.ThresholdOptionGreater = '>'
| Rückgabe: |
|
|---|
Gibt den Schwellwert zurück, wie von SetVoltageCallbackThreshold() gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
analog_in_bricklet.ThresholdOptionOff = 'x'
analog_in_bricklet.ThresholdOptionOutside = 'o'
analog_in_bricklet.ThresholdOptionInside = 'i'
analog_in_bricklet.ThresholdOptionSmaller = '<'
analog_in_bricklet.ThresholdOptionGreater = '>'
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Setzt den Schwellwert für den AnalogValueReachedCallback Callback.
Die folgenden Optionen sind möglich:
Option |
Beschreibung |
|---|---|
'x' |
Callback ist inaktiv |
'o' |
Callback wird ausgelöst, wenn der Analogwert außerhalb des min und max Wertes ist |
'i' |
Callback wird ausgelöst, wenn der Analogwert innerhalb des min und max Wertes ist |
'<' |
Callback wird ausgelöst, wenn der Analogwert kleiner als der min Wert ist (max wird ignoriert) |
'>' |
Callback wird ausgelöst, wenn der Analogwert größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
analog_in_bricklet.ThresholdOptionOff = 'x'
analog_in_bricklet.ThresholdOptionOutside = 'o'
analog_in_bricklet.ThresholdOptionInside = 'i'
analog_in_bricklet.ThresholdOptionSmaller = '<'
analog_in_bricklet.ThresholdOptionGreater = '>'
| Rückgabe: |
|
|---|
Gibt den Schwellwert zurück, wie von SetAnalogValueCallbackThreshold() gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
analog_in_bricklet.ThresholdOptionOff = 'x'
analog_in_bricklet.ThresholdOptionOutside = 'o'
analog_in_bricklet.ThresholdOptionInside = 'i'
analog_in_bricklet.ThresholdOptionSmaller = '<'
analog_in_bricklet.ThresholdOptionGreater = '>'
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Setzt die Periode mit welcher die Schwellwert Callbacks
ausgelöst werden, wenn die Schwellwerte
weiterhin erreicht bleiben.
| Rückgabe: |
|
|---|
Gibt die Entprellperiode zurück, wie von SetDebouncePeriod() gesetzt.
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.
| Callback-Parameter: |
|
|---|---|
| Rückgabe: |
|
Dieser Callback wird mit der Periode, wie gesetzt mit
SetVoltageCallbackPeriod(), ausgelöst. Der Parameter des Callbacks ist die
gemessene Spannung des Sensors.
Der VoltageCallback Callback wird nur ausgelöst, wenn sich die Spannung seit der
letzten Auslösung geändert hat.
| Callback-Parameter: |
|
|---|---|
| Rückgabe: |
|
Dieser Callback wird mit der Periode, wie gesetzt mit
SetAnalogValueCallbackPeriod(), ausgelöst. Der Parameter des Callbacks
ist der Analogwert des Sensors.
Der AnalogValueCallback Callback wird nur ausgelöst, wenn sich der Analogwert
seit der letzten Auslösung geändert hat.
| Callback-Parameter: |
|
|---|---|
| Rückgabe: |
|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
SetVoltageCallbackThreshold() gesetzt, erreicht wird.
Der Parameter des Callbacks ist die gemessene Spannung des Sensors.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit SetDebouncePeriod() gesetzt, ausgelöst.
| Callback-Parameter: |
|
|---|---|
| Rückgabe: |
|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
SetAnalogValueCallbackThreshold() gesetzt, erreicht wird.
Der Parameter des Callbacks ist der Analogwert des Sensors.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit SetDebouncePeriod() gesetzt, ausgelöst.
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.
| Rückgabe: |
|
|---|
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.
| Parameter: |
|
|---|---|
| Rückgabe: |
|
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:
analog_in_bricklet.FunctionSetVoltageCallbackPeriod = 3
analog_in_bricklet.FunctionSetAnalogValueCallbackPeriod = 5
analog_in_bricklet.FunctionSetVoltageCallbackThreshold = 7
analog_in_bricklet.FunctionSetAnalogValueCallbackThreshold = 9
analog_in_bricklet.FunctionSetDebouncePeriod = 11
analog_in_bricklet.FunctionSetRange = 17
analog_in_bricklet.FunctionSetAveraging = 19
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Ä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:
analog_in_bricklet.FunctionSetVoltageCallbackPeriod = 3
analog_in_bricklet.FunctionSetAnalogValueCallbackPeriod = 5
analog_in_bricklet.FunctionSetVoltageCallbackThreshold = 7
analog_in_bricklet.FunctionSetAnalogValueCallbackThreshold = 9
analog_in_bricklet.FunctionSetDebouncePeriod = 11
analog_in_bricklet.FunctionSetRange = 17
analog_in_bricklet.FunctionSetAveraging = 19
| Parameter: |
|
|---|---|
| Rückgabe: |
|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
Diese Konstante wird verwendet um ein 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.
Diese Konstante stellt den Anzeigenamen eines Analog In Bricklet dar.