TCP/IP - Analog In Bricklet

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

API

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

Grundfunktionen

BrickletAnalogIn.get_voltage
Funktions-ID:
  • 1
Anfrage:
  • keine Nutzdaten
Antwort:
  • voltage – Typ: uint16, Einheit: 1 mV, Wertebereich: [0 bis 45000]

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 CALLBACK_VOLTAGE Callback zu nutzen und die Periode mit set_voltage_callback_period vorzugeben.

BrickletAnalogIn.set_range
Funktions-ID:
  • 17
Anfrage:
  • range – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0
Antwort:
  • keine Antwort

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 (Plugin)

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

Für range:

  • 0 = Automatic
  • 1 = Up To 6V
  • 2 = Up To 10V
  • 3 = Up To 36V
  • 4 = Up To 45V
  • 5 = Up To 3V

Neu in Version 2.0.1 (Plugin).

BrickletAnalogIn.get_range
Funktions-ID:
  • 18
Anfrage:
  • keine Nutzdaten
Antwort:
  • range – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0

Gibt den Messbereich zurück, wie von set_range gesetzt.

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

Für range:

  • 0 = Automatic
  • 1 = Up To 6V
  • 2 = Up To 10V
  • 3 = Up To 36V
  • 4 = Up To 45V
  • 5 = Up To 3V

Neu in Version 2.0.1 (Plugin).

Fortgeschrittene Funktionen

BrickletAnalogIn.get_analog_value
Funktions-ID:
  • 2
Anfrage:
  • keine Nutzdaten
Antwort:
  • value – Typ: uint16, Wertebereich: [0 bis 212 - 1]

Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück.

Bemerkung

Der von get_voltage zurückgegebene Wert ist über mehrere Messwerte gemittelt um das Rauschen zu vermindern, während get_analog_value unverarbeitete Analogwerte zurück gibt. Der einzige Grund get_analog_value zu nutzen, ist die volle Auflösung des Analog-Digital-Wandlers zu erhalten.

Wenn der Analogwert periodisch abgefragt werden soll, wird empfohlen den CALLBACK_ANALOG_VALUE Callback zu nutzen und die Periode mit set_analog_value_callback_period vorzugeben.

BrickletAnalogIn.set_averaging
Funktions-ID:
  • 19
Anfrage:
  • average – Typ: uint8, Wertebereich: [0 bis 255], Standardwert: 50
Antwort:
  • keine Antwort

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.

Neu in Version 2.0.3 (Plugin).

BrickletAnalogIn.get_averaging
Funktions-ID:
  • 20
Anfrage:
  • keine Nutzdaten
Antwort:
  • average – Typ: uint8, Wertebereich: [0 bis 255], Standardwert: 50

Gibt die Averaging-Konfiguration zurück, wie von set_averaging gesetzt.

Neu in Version 2.0.3 (Plugin).

BrickletAnalogIn.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

BrickletAnalogIn.set_voltage_callback_period
Funktions-ID:
  • 3
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.

BrickletAnalogIn.get_voltage_callback_period
Funktions-ID:
  • 4
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.

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

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

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

BrickletAnalogIn.get_analog_value_callback_period
Funktions-ID:
  • 6
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_analog_value_callback_period gesetzt.

BrickletAnalogIn.set_voltage_callback_threshold
Funktions-ID:
  • 7
Anfrage:
  • option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x'
  • min – Typ: uint16, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: uint16, Einheit: 1 mV, Wertebereich: [0 bis 216 - 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
BrickletAnalogIn.get_voltage_callback_threshold
Funktions-ID:
  • 8
Anfrage:
  • keine Nutzdaten
Antwort:
  • option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x'
  • min – Typ: uint16, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: uint16, Einheit: 1 mV, Wertebereich: [0 bis 216 - 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
BrickletAnalogIn.set_analog_value_callback_threshold
Funktions-ID:
  • 9
Anfrage:
  • option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x'
  • min – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
Antwort:
  • keine Antwort

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

Für option:

  • 'x' = Off
  • 'o' = Outside
  • 'i' = Inside
  • '<' = Smaller
  • '>' = Greater
BrickletAnalogIn.get_analog_value_callback_threshold
Funktions-ID:
  • 10
Anfrage:
  • keine Nutzdaten
Antwort:
  • option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x'
  • min – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von set_analog_value_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
BrickletAnalogIn.set_debounce_period
Funktions-ID:
  • 11
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.

BrickletAnalogIn.get_debounce_period
Funktions-ID:
  • 12
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

BrickletAnalogIn.CALLBACK_VOLTAGE
Funktions-ID:
  • 13
Antwort:
  • voltage – Typ: uint16, Einheit: 1 mV, Wertebereich: [0 bis 45000]

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

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

BrickletAnalogIn.CALLBACK_ANALOG_VALUE
Funktions-ID:
  • 14
Antwort:
  • value – Typ: uint16, Wertebereich: [0 bis 212 - 1]

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

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

BrickletAnalogIn.CALLBACK_VOLTAGE_REACHED
Funktions-ID:
  • 15
Antwort:
  • voltage – Typ: uint16, Einheit: 1 mV, Wertebereich: [0 bis 45000]

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

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

BrickletAnalogIn.CALLBACK_ANALOG_VALUE_REACHED
Funktions-ID:
  • 16
Antwort:
  • value – Typ: uint16, Wertebereich: [0 bis 212 - 1]

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

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