Software / API Bindings / Go / API Referenz und Beispiele / Bricklets (Abgekündigt) / Voltage/Current Bricklet

Go - Voltage/Current Bricklet¶

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

package main

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

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

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    vc, _ := voltage_current_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()
}

Callback¶

Download (example_callback.go)

package main

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

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

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    vc, _ := voltage_current_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 receiver to 1s (1000ms).
    // Note: The current callback is only called every second
    //       if the current has changed since the last call!
    vc.SetCurrentCallbackPeriod(1000)

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

Threshold¶

Download (example_threshold.go)

package main

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

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

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

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

    // Configure threshold for power "greater than 10 W".
    vc.SetPowerCallbackThreshold('>', 10*1000, 0)

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

API¶

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

Parameter:	uid – Typ: string ipcon – Typ: *IPConnection
Rückgabe:	device – Typ: VoltageCurrentBricklet err – Typ: error

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

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

Dieses Geräteobjekt kann benutzt werden, nachdem die IPConnection verbunden.

func (*VoltageCurrentBricklet) GetCurrent() (current int32, err error)¶

Rückgabe:	current – Typ: int32, Einheit: 1 mA, Wertebereich: [-20000 bis 20000] err – Typ: error

Gibt die gemessenen Stromstärke zurück.

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

func (*VoltageCurrentBricklet) GetVoltage() (voltage int32, err error)¶

Rückgabe:	voltage – Typ: int32, Einheit: 1 mV, Wertebereich: [0 bis 36000] err – Typ: error

Gibt die gemessenen Spannung zurück.

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

func (*VoltageCurrentBricklet) GetPower() (power int32, err error)¶

Rückgabe:	power – Typ: int32, Einheit: 1 mW, Wertebereich: [0 bis 720000] err – Typ: error

Gibt die gemessenen Leistung zurück.

Wenn die Leistung periodisch abgefragt werden soll, wird empfohlen den PowerCallback Callback zu nutzen und die Periode mit SetPowerCallbackPeriod() vorzugeben.

func (*VoltageCurrentBricklet) SetConfiguration(averaging uint8, voltageConversionTime uint8, currentConversionTime uint8) (err error)¶

Parameter:	averaging – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3 voltageConversionTime – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 4 currentConversionTime – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 4
Rückgabe:	err – Typ: error

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

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

Für averaging:

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

Für voltageConversionTime:

voltage_current_bricklet.ConversionTime140us = 0
voltage_current_bricklet.ConversionTime204us = 1
voltage_current_bricklet.ConversionTime332us = 2
voltage_current_bricklet.ConversionTime588us = 3
voltage_current_bricklet.ConversionTime1_1ms = 4
voltage_current_bricklet.ConversionTime2_116ms = 5
voltage_current_bricklet.ConversionTime4_156ms = 6
voltage_current_bricklet.ConversionTime8_244ms = 7

Für currentConversionTime:

voltage_current_bricklet.ConversionTime140us = 0
voltage_current_bricklet.ConversionTime204us = 1
voltage_current_bricklet.ConversionTime332us = 2
voltage_current_bricklet.ConversionTime588us = 3
voltage_current_bricklet.ConversionTime1_1ms = 4
voltage_current_bricklet.ConversionTime2_116ms = 5
voltage_current_bricklet.ConversionTime4_156ms = 6
voltage_current_bricklet.ConversionTime8_244ms = 7

func (*VoltageCurrentBricklet) GetConfiguration() (averaging uint8, voltageConversionTime uint8, currentConversionTime uint8, err error)¶

Rückgabe:	averaging – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3 voltageConversionTime – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 4 currentConversionTime – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 4 err – Typ: error

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

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

Für averaging:

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

Für voltageConversionTime:

voltage_current_bricklet.ConversionTime140us = 0
voltage_current_bricklet.ConversionTime204us = 1
voltage_current_bricklet.ConversionTime332us = 2
voltage_current_bricklet.ConversionTime588us = 3
voltage_current_bricklet.ConversionTime1_1ms = 4
voltage_current_bricklet.ConversionTime2_116ms = 5
voltage_current_bricklet.ConversionTime4_156ms = 6
voltage_current_bricklet.ConversionTime8_244ms = 7

Für currentConversionTime:

voltage_current_bricklet.ConversionTime140us = 0
voltage_current_bricklet.ConversionTime204us = 1
voltage_current_bricklet.ConversionTime332us = 2
voltage_current_bricklet.ConversionTime588us = 3
voltage_current_bricklet.ConversionTime1_1ms = 4
voltage_current_bricklet.ConversionTime2_116ms = 5
voltage_current_bricklet.ConversionTime4_156ms = 6
voltage_current_bricklet.ConversionTime8_244ms = 7

Fortgeschrittene Funktionen¶

func (*VoltageCurrentBricklet) SetCalibration(gainMultiplier uint16, gainDivisor uint16) (err error)¶

Parameter:	gainMultiplier – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1] gainDivisor – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	err – Typ: error

Da der Shunt-Widerstand über den die Stromstärke gemessen wird keine perfekte Genauigkeit hat, 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 aber 1023mA zurück gibt, sollte der Multiplikator auf 1000 und der Divisor auf 1023 gesetzt werden.

func (*VoltageCurrentBricklet) GetCalibration() (gainMultiplier uint16, gainDivisor uint16, err error)¶

Rückgabe:	gainMultiplier – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1] gainDivisor – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1] err – Typ: error

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

func (*VoltageCurrentBricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)¶

Rückgabe:

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', '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 2¹⁶ - 1] err – Typ: error

uid – Typ: string, Länge: bis zu 8
connectedUid – Typ: string, Länge: bis zu 8
position – Typ: rune, Wertebereich: ['a' bis 'h', '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 2¹⁶ - 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 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.

Konfigurationsfunktionen für Callbacks¶

func (*VoltageCurrentBricklet) SetCurrentCallbackPeriod(period uint32) (err error)¶

Parameter:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	err – Typ: error

Setzt die Periode mit welcher der CurrentCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

func (*VoltageCurrentBricklet) GetCurrentCallbackPeriod() (period uint32, err error)¶

Rückgabe:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 err – Typ: error

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

func (*VoltageCurrentBricklet) SetVoltageCallbackPeriod(period uint32) (err error)¶

Parameter:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	err – Typ: error

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.

func (*VoltageCurrentBricklet) GetVoltageCallbackPeriod() (period uint32, err error)¶

Rückgabe:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 err – Typ: error

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

func (*VoltageCurrentBricklet) SetPowerCallbackPeriod(period uint32) (err error)¶

Parameter:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	err – Typ: error

Setzt die Periode mit welcher der PowerCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

func (*VoltageCurrentBricklet) GetPowerCallbackPeriod() (period uint32, err error)¶

Rückgabe:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 err – Typ: error

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

func (*VoltageCurrentBricklet) SetCurrentCallbackThreshold(option rune, min int32, max int32) (err error)¶

Parameter:	option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int32, Einheit: 1 mA, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: int32, Einheit: 1 mA, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0
Rückgabe:	err – Typ: error

Setzt den Schwellwert für den CurrentReachedCallback Callback.

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:

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

func (*VoltageCurrentBricklet) GetCurrentCallbackThreshold() (option rune, min int32, max int32, err error)¶

Rückgabe:	option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int32, Einheit: 1 mA, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: int32, Einheit: 1 mA, Wertebereich: [-2³¹ bis 2³¹ - 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:

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

func (*VoltageCurrentBricklet) SetVoltageCallbackThreshold(option rune, min int32, max int32) (err error)¶

Parameter:	option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int32, Einheit: 1 mV, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: int32, Einheit: 1 mV, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0
Rückgabe:	err – Typ: error

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:

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

func (*VoltageCurrentBricklet) GetVoltageCallbackThreshold() (option rune, min int32, max int32, err error)¶

Rückgabe:	option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int32, Einheit: 1 mV, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: int32, Einheit: 1 mV, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 err – Typ: error

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

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

Für option:

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

func (*VoltageCurrentBricklet) SetPowerCallbackThreshold(option rune, min int32, max int32) (err error)¶

Parameter:	option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int32, Einheit: 1 mW, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: int32, Einheit: 1 mW, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0
Rückgabe:	err – Typ: error

Setzt den Schwellwert für den PowerReachedCallback Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

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

func (*VoltageCurrentBricklet) GetPowerCallbackThreshold() (option rune, min int32, max int32, err error)¶

Rückgabe:	option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int32, Einheit: 1 mW, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: int32, Einheit: 1 mW, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 err – Typ: error

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

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

Für option:

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

func (*VoltageCurrentBricklet) SetDebouncePeriod(debounce uint32) (err error)¶

Parameter:	debounce – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 100
Rückgabe:	err – Typ: error

Setzt die Periode mit welcher die Schwellwert Callbacks

CurrentReachedCallback,
VoltageReachedCallback,
PowerReachedCallback

ausgelöst werden, wenn die Schwellwerte

SetCurrentCallbackThreshold(),
SetVoltageCallbackThreshold(),
SetPowerCallbackThreshold()

weiterhin erreicht bleiben.

func (*VoltageCurrentBricklet) GetDebouncePeriod() (debounce uint32, err error)¶

Rückgabe:	debounce – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 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 (*VoltageCurrentBricklet) RegisterCurrentCallback(func(current int32)) (registrationId uint64)¶

Callback-Parameter:	current – Typ: int32, Einheit: 1 mA, Wertebereich: [-20000 bis 20000]
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 CurrentCallback Callback wird nur ausgelöst, wenn sich die Stromstärke seit der letzten Auslösung geändert hat.

func (*VoltageCurrentBricklet) RegisterVoltageCallback(func(voltage int32)) (registrationId uint64)¶

Callback-Parameter:	voltage – Typ: int32, Einheit: 1 mV, Wertebereich: [0 bis 36000]
Rückgabe:	registrationId – Typ: uint64

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

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

func (*VoltageCurrentBricklet) RegisterPowerCallback(func(power int32)) (registrationId uint64)¶

Callback-Parameter:	power – Typ: int32, Einheit: 1 mW, Wertebereich: [0 bis 720000]
Rückgabe:	registrationId – Typ: uint64

Dieser Callback wird mit der Periode, wie gesetzt mit SetPowerCallbackPeriod(), ausgelöst. Der Parameter des Callbacks ist die Leistung des Sensors.

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

func (*VoltageCurrentBricklet) RegisterCurrentReachedCallback(func(current int32)) (registrationId uint64)¶

Callback-Parameter:	current – Typ: int32, Einheit: 1 mA, Wertebereich: [-20000 bis 20000]
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.

func (*VoltageCurrentBricklet) RegisterVoltageReachedCallback(func(voltage int32)) (registrationId uint64)¶

Callback-Parameter:	voltage – Typ: int32, Einheit: 1 mV, Wertebereich: [0 bis 36000]
Rückgabe:	registrationId – Typ: uint64

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

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

func (*VoltageCurrentBricklet) RegisterPowerReachedCallback(func(power int32)) (registrationId uint64)¶

Callback-Parameter:	power – Typ: int32, Einheit: 1 mA, Wertebereich: [-20000 bis 20000]
Rückgabe:	registrationId – Typ: uint64

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetPowerCallbackThreshold() gesetzt, erreicht wird. Der Parameter des Callbacks ist die Spannung 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 (*VoltageCurrentBricklet) 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 (*VoltageCurrentBricklet) 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:

voltage_current_bricklet.FunctionSetConfiguration = 4
voltage_current_bricklet.FunctionSetCalibration = 6
voltage_current_bricklet.FunctionSetCurrentCallbackPeriod = 8
voltage_current_bricklet.FunctionSetVoltageCallbackPeriod = 10
voltage_current_bricklet.FunctionSetPowerCallbackPeriod = 12
voltage_current_bricklet.FunctionSetCurrentCallbackThreshold = 14
voltage_current_bricklet.FunctionSetVoltageCallbackThreshold = 16
voltage_current_bricklet.FunctionSetPowerCallbackThreshold = 18
voltage_current_bricklet.FunctionSetDebouncePeriod = 20

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

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

Für functionId:

voltage_current_bricklet.FunctionSetConfiguration = 4
voltage_current_bricklet.FunctionSetCalibration = 6
voltage_current_bricklet.FunctionSetCurrentCallbackPeriod = 8
voltage_current_bricklet.FunctionSetVoltageCallbackPeriod = 10
voltage_current_bricklet.FunctionSetPowerCallbackPeriod = 12
voltage_current_bricklet.FunctionSetCurrentCallbackThreshold = 14
voltage_current_bricklet.FunctionSetVoltageCallbackThreshold = 16
voltage_current_bricklet.FunctionSetPowerCallbackThreshold = 18
voltage_current_bricklet.FunctionSetDebouncePeriod = 20

func (*VoltageCurrentBricklet) 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¶

voltage_current_bricklet.DeviceIdentifier¶

Diese Konstante wird verwendet um ein Voltage/Current 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.

voltage_current_bricklet.DeviceDisplayName¶: Diese Konstante stellt den Anzeigenamen eines Voltage/Current Bricklet dar.