Go - Voltage/Current Bricklet 2.0

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

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
package main

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

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Voltage/Current Bricklet 2.0.

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

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

    vc.RegisterCurrentCallback(func(current int32) {
        fmt.Printf("Current: %f A\n", float64(current)/1000.0)
    })

    // Set period for current callback to 1s (1000ms) without a threshold.
    vc.SetCurrentCallbackConfiguration(1000, false, 'x', 0, 0)

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

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
package main

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

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Voltage/Current Bricklet 2.0.

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

    // Get current current.
    current, _ := vc.GetCurrent()
    fmt.Printf("Current: %f A\n", float64(current)/1000.0)

    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
package main

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

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Voltage/Current Bricklet 2.0.

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

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

    vc.RegisterPowerCallback(func(power int32) {
        fmt.Printf("power: %f W\n", float64(power)/1000.0)
    })

    // Configure threshold for power "greater than 10 W"
    // with a debounce period of 1s (1000ms).
    vc.SetPowerCallbackConfiguration(1000, false, '>', 10*1000, 0)

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

API

Die API des Voltage/Current Bricklet 2.0 ist im Package github.com/Tinkerforge/go-api-bindings/voltage_current_v2_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 NewVoltageCurrentV2Bricklet(uid string, ipcon *IPConnection) (device VoltageCurrentV2Bricklet, err error)

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

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

func (*VoltageCurrentV2Bricklet) GetCurrent() (current int32, err error)

Gibt die gemessenen Stromstärke zurück. Der Wert ist in mA und im Bereich von -20000mA bis 20000mA.

Wenn der Wert periodisch benötigt wird, kann auch der RegisterCurrentCallback Callback verwendet werden. Der Callback wird mit der Funktion SetCurrentCallbackConfiguration() konfiguriert.

func (*VoltageCurrentV2Bricklet) GetVoltage() (voltage int32, err error)

Gibt die gemessenen Spannung zurück. Der Wert ist in mV und im Bereich von 0mV bis 36000mV.

Wenn der Wert periodisch benötigt wird, kann auch der RegisterVoltageCallback Callback verwendet werden. Der Callback wird mit der Funktion SetVoltageCallbackConfiguration() konfiguriert.

func (*VoltageCurrentV2Bricklet) GetPower() (power int32, err error)

Gibt die gemessenen Leistung zurück. Der Wert ist in mW und im Bereich von 0mW bis 720000mW.

Wenn der Wert periodisch benötigt wird, kann auch der RegisterPowerCallback Callback verwendet werden. Der Callback wird mit der Funktion SetPowerCallbackConfiguration() konfiguriert.

func (*VoltageCurrentV2Bricklet) SetConfiguration(averaging Averaging, voltageConversionTime ConversionTime, currentConversionTime ConversionTime) (err error)

Setzt die Konfiguration des Voltage/Current Bricklet 2.0. Es ist möglich die Anzahl für die Durchschnittsbildung, und die Wandlungszeit für Spannung und Stromstärke zu definieren.

Durchschnittsbildung:

Wert Anzahl
0 1
1 4
2 16
3 64
4 128
5 256
6 512
>=7 1024

Wandlungszeit für Spannung/Stromstärke:

Wert Wandlungszeit
0 140µs
1 204µs
2 332µs
3 588µs
4 1.1ms
5 2.116ms
6 4.156ms
>=7 8.244ms

Die Standardwerte sind 3, 4 und 4 (64, 1.1ms, 1.1ms) für die Durchschnittsbildung und die Spannungs/Stromstärkenwandlungszeit.

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

  • Averaging1 = 0
  • Averaging4 = 1
  • Averaging16 = 2
  • Averaging64 = 3
  • Averaging128 = 4
  • Averaging256 = 5
  • Averaging512 = 6
  • Averaging1024 = 7
  • ConversionTime140us = 0
  • ConversionTime204us = 1
  • ConversionTime332us = 2
  • ConversionTime588us = 3
  • ConversionTime11ms = 4
  • ConversionTime2116ms = 5
  • ConversionTime4156ms = 6
  • ConversionTime8244ms = 7
func (*VoltageCurrentV2Bricklet) GetConfiguration() (averaging Averaging, voltageConversionTime uint8, currentConversionTime uint8, err error)

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

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

  • Averaging1 = 0
  • Averaging4 = 1
  • Averaging16 = 2
  • Averaging64 = 3
  • Averaging128 = 4
  • Averaging256 = 5
  • Averaging512 = 6
  • Averaging1024 = 7

Fortgeschrittene Funktionen

func (*VoltageCurrentV2Bricklet) SetCalibration(voltageMultiplier uint16, voltageDivisor uint16, currentMultiplier uint16, currentDivisor uint16) (err error)

Da der ADC und der Shunt-Widerstand für die Messungen verwendet werden nicht perfekt sind, ist es nötig einen Multiplikator und einen Divisor zu setzen falls sehr genaue Messwerte nötig sind.

Zum Beispiel: Wenn eine Messung von 1000mA erwartet wird, das Voltage/Current Bricklet 2.0 aber 1023mA zurück gibt, sollte der Multiplikator auf 1000 und der Divisor auf 1023 gesetzt werden. Das gleiches gilt für die Spannung.

Die Kalibrierung wird in den EEPROM des Voltage/Current Bricklet gespeichert und muss nur einmal gesetzt werden.

func (*VoltageCurrentV2Bricklet) GetCalibration() (voltageMultiplier uint16, voltageDivisor uint16, currentMultiplier uint16, currentDivisor uint16, err error)

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

func (*VoltageCurrentV2Bricklet) 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 (*VoltageCurrentV2Bricklet) GetResponseExpected(functionId uint8) (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.

Siehe SetResponseExpected() für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

func (*VoltageCurrentV2Bricklet) SetResponseExpected(functionId uint8, 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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • FunctionSetCurrentCallbackConfiguration = 2
  • FunctionSetVoltageCallbackConfiguration = 6
  • FunctionSetPowerCallbackConfiguration = 10
  • FunctionSetConfiguration = 13
  • FunctionSetCalibration = 15
  • FunctionSetWriteFirmwarePointer = 237
  • FunctionSetStatusLEDConfig = 239
  • FunctionReset = 243
  • FunctionWriteUID = 248
func (*VoltageCurrentV2Bricklet) SetResponseExpectedAll(responseExpected bool) (err error)

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

func (*VoltageCurrentV2Bricklet) 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 (*VoltageCurrentV2Bricklet) 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:

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

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

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

  • BootloaderModeBootloader = 0
  • BootloaderModeFirmware = 1
  • BootloaderModeBootloaderWaitForReboot = 2
  • BootloaderModeFirmwareWaitForReboot = 3
  • BootloaderModeFirmwareWaitForEraseAndReboot = 4
func (*VoltageCurrentV2Bricklet) 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 (*VoltageCurrentV2Bricklet) 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 (*VoltageCurrentV2Bricklet) 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:

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

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

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

  • StatusLEDConfigOff = 0
  • StatusLEDConfigOn = 1
  • StatusLEDConfigShowHeartbeat = 2
  • StatusLEDConfigShowStatus = 3
func (*VoltageCurrentV2Bricklet) 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 (*VoltageCurrentV2Bricklet) 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 (*VoltageCurrentV2Bricklet) 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 (*VoltageCurrentV2Bricklet) 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 (*VoltageCurrentV2Bricklet) 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 (*VoltageCurrentV2Bricklet) SetCurrentCallbackConfiguration(period uint32, valueHasToChange bool, option ThresholdOption, min int32, max int32) (err error)

Die Periode in ms ist die Periode mit der der RegisterCurrentCallback Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter`zusammen mit min/max setzt einen Threshold für den RegisterCurrentCallback Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

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

  • ThresholdOptionOff = 'x'
  • ThresholdOptionOutside = 'o'
  • ThresholdOptionInside = 'i'
  • ThresholdOptionSmaller = '<'
  • ThresholdOptionGreater = '>'
func (*VoltageCurrentV2Bricklet) GetCurrentCallbackConfiguration() (period uint32, valueHasToChange bool, option ThresholdOption, min int32, max int32, err error)

Gibt die Callback-Konfiguration zurück, wie mittels SetCurrentCallbackConfiguration() gesetzt.

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

  • ThresholdOptionOff = 'x'
  • ThresholdOptionOutside = 'o'
  • ThresholdOptionInside = 'i'
  • ThresholdOptionSmaller = '<'
  • ThresholdOptionGreater = '>'
func (*VoltageCurrentV2Bricklet) SetVoltageCallbackConfiguration(period uint32, valueHasToChange bool, option ThresholdOption, min int32, max int32) (err error)

Die Periode in ms ist die Periode mit der der RegisterVoltageCallback Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter`zusammen mit min/max setzt einen Threshold für den RegisterVoltageCallback Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

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

  • ThresholdOptionOff = 'x'
  • ThresholdOptionOutside = 'o'
  • ThresholdOptionInside = 'i'
  • ThresholdOptionSmaller = '<'
  • ThresholdOptionGreater = '>'
func (*VoltageCurrentV2Bricklet) GetVoltageCallbackConfiguration() (period uint32, valueHasToChange bool, option ThresholdOption, min int32, max int32, err error)

Gibt die Callback-Konfiguration zurück, wie mittels SetVoltageCallbackConfiguration() gesetzt.

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

  • ThresholdOptionOff = 'x'
  • ThresholdOptionOutside = 'o'
  • ThresholdOptionInside = 'i'
  • ThresholdOptionSmaller = '<'
  • ThresholdOptionGreater = '>'
func (*VoltageCurrentV2Bricklet) SetPowerCallbackConfiguration(period uint32, valueHasToChange bool, option ThresholdOption, min int32, max int32) (err error)

Die Periode in ms ist die Periode mit der der RegisterPowerCallback Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter`zusammen mit min/max setzt einen Threshold für den RegisterPowerCallback Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

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

  • ThresholdOptionOff = 'x'
  • ThresholdOptionOutside = 'o'
  • ThresholdOptionInside = 'i'
  • ThresholdOptionSmaller = '<'
  • ThresholdOptionGreater = '>'
func (*VoltageCurrentV2Bricklet) GetPowerCallbackConfiguration() (period uint32, valueHasToChange bool, option ThresholdOption, min int32, max int32, err error)

Gibt die Callback-Konfiguration zurück, wie mittels SetPowerCallbackConfiguration() gesetzt.

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

  • ThresholdOptionOff = 'x'
  • ThresholdOptionOutside = 'o'
  • ThresholdOptionInside = 'i'
  • ThresholdOptionSmaller = '<'
  • ThresholdOptionGreater = '>'

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 (*VoltageCurrentV2Bricklet) RegisterCurrentCallback(func(current int32)) (registrationId uint64)

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

Dieser Callback wird periodisch ausgelöst abhängig von der mittels SetCurrentCallbackConfiguration() gesetzten Konfiguration

Der Parameter des Callbacks ist der gleiche wie GetCurrent().

func (*VoltageCurrentV2Bricklet) RegisterVoltageCallback(func(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 periodisch ausgelöst abhängig von der mittels SetVoltageCallbackConfiguration() gesetzten Konfiguration

Der Parameter des Callbacks ist der gleiche wie GetVoltage().

func (*VoltageCurrentV2Bricklet) RegisterPowerCallback(func(power int32)) (registrationId uint64)

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

Dieser Callback wird periodisch ausgelöst abhängig von der mittels SetPowerCallbackConfiguration() gesetzten Konfiguration

Der Parameter des Callbacks ist der gleiche wie GetPower().

Konstanten

voltage_current_v2_bricklet.DeviceIdentifier

Diese Konstante wird verwendet um ein Voltage/Current Bricklet 2.0 zu identifizieren.

Die GetIdentity() Funktion und der (*IPConnection) RegisterEnumerateCallback Callback der IPConnection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

voltage_current_v2_bricklet.DeviceDisplayName

Diese Konstante stellt den Anzeigenamen eines Voltage/Current Bricklet 2.0 dar.