TCP/IP - Voltage/Current Bricklet

Dies ist die Beschreibung des TCP/IP Protokolls für das Voltage/Current Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Voltage/Current Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

API

Eine allgemeine Beschreibung der TCP/IP Protokollstruktur findet sich hier.

Grundfunktionen

BrickletVoltageCurrent.get_current
Funktions-ID:
  • 1
Anfrage:
  • keine Nutzdaten
Antwort:
  • current – Typ: int32, Einheit: 1 mA, Wertebereich: [-20000 bis 20000]

Gibt die gemessenen Stromstärke zurück.

Wenn die Stromstärke periodisch abgefragt werden soll, wird empfohlen den CALLBACK_CURRENT Callback zu nutzen und die Periode mit set_current_callback_period vorzugeben.

BrickletVoltageCurrent.get_voltage
Funktions-ID:
  • 2
Anfrage:
  • keine Nutzdaten
Antwort:
  • voltage – Typ: int32, Einheit: 1 mV, Wertebereich: [0 bis 36000]

Gibt die gemessenen Spannung zurück.

Wenn die Spannung periodisch abgefragt werden soll, wird empfohlen den CALLBACK_VOLTAGE Callback zu nutzen und die Periode mit set_voltage_callback_period vorzugeben.

BrickletVoltageCurrent.get_power
Funktions-ID:
  • 3
Anfrage:
  • keine Nutzdaten
Antwort:
  • power – Typ: int32, Einheit: 1 mW, Wertebereich: [0 bis 720000]

Gibt die gemessenen Leistung zurück.

Wenn die Leistung periodisch abgefragt werden soll, wird empfohlen den CALLBACK_POWER Callback zu nutzen und die Periode mit set_power_callback_period vorzugeben.

BrickletVoltageCurrent.set_configuration
Funktions-ID:
  • 4
Anfrage:
  • averaging – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3
  • voltage_conversion_time – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 4
  • current_conversion_time – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 4
Antwort:
  • keine Antwort

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 Bedeutungen sind für die Elemente dieser Funktion definiert:

Für averaging:

  • 0 = 1
  • 1 = 4
  • 2 = 16
  • 3 = 64
  • 4 = 128
  • 5 = 256
  • 6 = 512
  • 7 = 1024

Für voltage_conversion_time:

  • 0 = 140us
  • 1 = 204us
  • 2 = 332us
  • 3 = 588us
  • 4 = 1,1ms
  • 5 = 2,116ms
  • 6 = 4,156ms
  • 7 = 8,244ms

Für current_conversion_time:

  • 0 = 140us
  • 1 = 204us
  • 2 = 332us
  • 3 = 588us
  • 4 = 1,1ms
  • 5 = 2,116ms
  • 6 = 4,156ms
  • 7 = 8,244ms
BrickletVoltageCurrent.get_configuration
Funktions-ID:
  • 5
Anfrage:
  • keine Nutzdaten
Antwort:
  • averaging – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3
  • voltage_conversion_time – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 4
  • current_conversion_time – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 4

Gibt die Konfiguration zurück, wie von set_configuration gesetzt.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für averaging:

  • 0 = 1
  • 1 = 4
  • 2 = 16
  • 3 = 64
  • 4 = 128
  • 5 = 256
  • 6 = 512
  • 7 = 1024

Für voltage_conversion_time:

  • 0 = 140us
  • 1 = 204us
  • 2 = 332us
  • 3 = 588us
  • 4 = 1,1ms
  • 5 = 2,116ms
  • 6 = 4,156ms
  • 7 = 8,244ms

Für current_conversion_time:

  • 0 = 140us
  • 1 = 204us
  • 2 = 332us
  • 3 = 588us
  • 4 = 1,1ms
  • 5 = 2,116ms
  • 6 = 4,156ms
  • 7 = 8,244ms

Fortgeschrittene Funktionen

BrickletVoltageCurrent.set_calibration
Funktions-ID:
  • 6
Anfrage:
  • gain_multiplier – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • gain_divisor – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • keine Antwort

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.

BrickletVoltageCurrent.get_calibration
Funktions-ID:
  • 7
Anfrage:
  • keine Nutzdaten
Antwort:
  • gain_multiplier – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • gain_divisor – Typ: uint16, Wertebereich: [0 bis 216 - 1]

Gibt die Kalibrierung zurück, wie von set_calibration gesetzt.

BrickletVoltageCurrent.get_identity
Funktions-ID:
  • 255
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: char[8]
  • connected_uid – Typ: char[8]
  • position – Typ: char, Wertebereich: ['a' bis 'h', 'i', 'z']
  • hardware_version – Typ: uint8[3]
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • firmware_version – Typ: uint8[3]
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • device_identifier – Typ: uint16, Wertebereich: [0 bis 216 - 1]

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. 

Konfigurationsfunktionen für Callbacks

BrickletVoltageCurrent.set_current_callback_period
Funktions-ID:
  • 8
Anfrage:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Antwort:
  • keine Antwort

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

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

BrickletVoltageCurrent.get_current_callback_period
Funktions-ID:
  • 9
Anfrage:
  • keine Nutzdaten
Antwort:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von set_current_callback_period gesetzt

BrickletVoltageCurrent.set_voltage_callback_period
Funktions-ID:
  • 10
Anfrage:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Antwort:
  • keine Antwort

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

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

BrickletVoltageCurrent.get_voltage_callback_period
Funktions-ID:
  • 11
Anfrage:
  • keine Nutzdaten
Antwort:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von set_voltage_callback_period gesetzt

BrickletVoltageCurrent.set_power_callback_period
Funktions-ID:
  • 12
Anfrage:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Antwort:
  • keine Antwort

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

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

BrickletVoltageCurrent.get_power_callback_period
Funktions-ID:
  • 13
Anfrage:
  • keine Nutzdaten
Antwort:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von get_power_callback_period gesetzt

BrickletVoltageCurrent.set_current_callback_threshold
Funktions-ID:
  • 14
Anfrage:
  • option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x'
  • min – Typ: int32, Einheit: 1 mA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int32, Einheit: 1 mA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Antwort:
  • keine Antwort

Setzt den Schwellwert für den CALLBACK_CURRENT_REACHED 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 Bedeutungen sind für die Elemente dieser Funktion definiert:

Für option:

  • 'x' = Off
  • 'o' = Outside
  • 'i' = Inside
  • '<' = Smaller
  • '>' = Greater
BrickletVoltageCurrent.get_current_callback_threshold
Funktions-ID:
  • 15
Anfrage:
  • keine Nutzdaten
Antwort:
  • option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x'
  • min – Typ: int32, Einheit: 1 mA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int32, Einheit: 1 mA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von set_current_callback_threshold gesetzt.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für option:

  • 'x' = Off
  • 'o' = Outside
  • 'i' = Inside
  • '<' = Smaller
  • '>' = Greater
BrickletVoltageCurrent.set_voltage_callback_threshold
Funktions-ID:
  • 16
Anfrage:
  • option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x'
  • min – Typ: int32, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int32, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Antwort:
  • keine Antwort

Setzt den Schwellwert für den CALLBACK_VOLTAGE_REACHED 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 Bedeutungen sind für die Elemente dieser Funktion definiert:

Für option:

  • 'x' = Off
  • 'o' = Outside
  • 'i' = Inside
  • '<' = Smaller
  • '>' = Greater
BrickletVoltageCurrent.get_voltage_callback_threshold
Funktions-ID:
  • 17
Anfrage:
  • keine Nutzdaten
Antwort:
  • option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x'
  • min – Typ: int32, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int32, Einheit: 1 mV, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von set_voltage_callback_threshold gesetzt.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für option:

  • 'x' = Off
  • 'o' = Outside
  • 'i' = Inside
  • '<' = Smaller
  • '>' = Greater
BrickletVoltageCurrent.set_power_callback_threshold
Funktions-ID:
  • 18
Anfrage:
  • option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x'
  • min – Typ: int32, Einheit: 1 mW, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int32, Einheit: 1 mW, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Antwort:
  • keine Antwort

Setzt den Schwellwert für den CALLBACK_POWER_REACHED 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 Bedeutungen sind für die Elemente dieser Funktion definiert:

Für option:

  • 'x' = Off
  • 'o' = Outside
  • 'i' = Inside
  • '<' = Smaller
  • '>' = Greater
BrickletVoltageCurrent.get_power_callback_threshold
Funktions-ID:
  • 19
Anfrage:
  • keine Nutzdaten
Antwort:
  • option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x'
  • min – Typ: int32, Einheit: 1 mW, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int32, Einheit: 1 mW, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von set_power_callback_threshold gesetzt.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für option:

  • 'x' = Off
  • 'o' = Outside
  • 'i' = Inside
  • '<' = Smaller
  • '>' = Greater
BrickletVoltageCurrent.set_debounce_period
Funktions-ID:
  • 20
Anfrage:
  • debounce – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100
Antwort:
  • keine Antwort

Setzt die Periode mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

BrickletVoltageCurrent.get_debounce_period
Funktions-ID:
  • 21
Anfrage:
  • keine Nutzdaten
Antwort:
  • debounce – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von set_debounce_period gesetzt.

Callbacks

BrickletVoltageCurrent.CALLBACK_CURRENT
Funktions-ID:
  • 22
Antwort:
  • current – Typ: int32, Einheit: 1 mA, Wertebereich: [-20000 bis 20000]

Dieser Callback wird mit der Periode, wie gesetzt mit set_current_callback_period, ausgelöst. Der Rückgabewert ist die Stromstärke des Sensors.

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

BrickletVoltageCurrent.CALLBACK_VOLTAGE
Funktions-ID:
  • 23
Antwort:
  • voltage – Typ: int32, Einheit: 1 mV, Wertebereich: [0 bis 36000]

Dieser Callback wird mit der Periode, wie gesetzt mit set_voltage_callback_period, ausgelöst. Der Rückgabewert ist die Spannung des Sensors.

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

BrickletVoltageCurrent.CALLBACK_POWER
Funktions-ID:
  • 24
Antwort:
  • power – Typ: int32, Einheit: 1 mW, Wertebereich: [0 bis 720000]

Dieser Callback wird mit der Periode, wie gesetzt mit set_power_callback_period, ausgelöst. Der Rückgabewert ist die Leistung des Sensors.

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

BrickletVoltageCurrent.CALLBACK_CURRENT_REACHED
Funktions-ID:
  • 25
Antwort:
  • current – Typ: int32, Einheit: 1 mA, Wertebereich: [-20000 bis 20000]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von set_current_callback_threshold gesetzt, erreicht wird. Der Rückgabewert ist die Stromstärke des Sensors.

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

BrickletVoltageCurrent.CALLBACK_VOLTAGE_REACHED
Funktions-ID:
  • 26
Antwort:
  • voltage – Typ: int32, Einheit: 1 mV, Wertebereich: [0 bis 36000]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von set_voltage_callback_threshold gesetzt, erreicht wird. Der Rückgabewert ist die Spannung des Sensors.

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

BrickletVoltageCurrent.CALLBACK_POWER_REACHED
Funktions-ID:
  • 27
Antwort:
  • power – Typ: int32, Einheit: 1 mA, Wertebereich: [-20000 bis 20000]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von set_power_callback_threshold gesetzt, erreicht wird. Der Rückgabewert ist die Spannung des Sensors.

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