TCP/IP - PTC Bricklet

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

API

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

Grundfunktionen

BrickletPTC.get_temperature
Funktions-ID:
  • 1
Anfrage:
  • keine Nutzdaten
Antwort:
  • temperature – Typ: int32, Einheit: 1/100 °C, Wertebereich: [-24600 bis 84900]

Gibt die Temperatur des verbundenen Sensors zurück.

Wenn die Temperatur periodisch abgefragt werden soll, wird empfohlen den CALLBACK_TEMPERATURE Callback zu nutzen und die Periode mit set_temperature_callback_period vorzugeben.

BrickletPTC.is_sensor_connected
Funktions-ID:
  • 19
Anfrage:
  • keine Nutzdaten
Antwort:
  • connected – Typ: bool

Gibt true zurück wenn ein Sensor korrekt verbunden ist.

Falls diese Funktion false zurück gibt, ist entweder kein Pt100 oder Pt1000 Sensor verbunden, der Sensor ist inkorrekt verbunden oder der Sensor selbst ist fehlerhaft.

BrickletPTC.set_wire_mode
Funktions-ID:
  • 20
Anfrage:
  • mode – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 2
Antwort:
  • keine Antwort

Stellt die Leiter-Konfiguration des Sensors ein. Mögliche Werte sind 2, 3 und 4, dies entspricht 2-, 3- und 4-Leiter-Sensoren. Der Wert muss er Jumper-Konfiguration am Bricklet entsprechen.

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

Für mode:

  • 2 = 2
  • 3 = 3
  • 4 = 4
BrickletPTC.get_wire_mode
Funktions-ID:
  • 21
Anfrage:
  • keine Nutzdaten
Antwort:
  • mode – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 2

Gibt die Leiter-Konfiguration zurück, wie von set_wire_mode gesetzt.

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

Für mode:

  • 2 = 2
  • 3 = 3
  • 4 = 4

Fortgeschrittene Funktionen

BrickletPTC.get_resistance
Funktions-ID:
  • 2
Anfrage:
  • keine Nutzdaten
Antwort:
  • resistance – Typ: int32, Einheit: ? Ω, Wertebereich: [-231 bis 231 - 1]

Gibt den Wert zurück, wie vom "MAX31865 Präzisions Delta-Sigma ADC" berechnet.

Der Wert kann mit den folgenden Formeln in einen Widerstand konvertiert werden:

  • Pt100: Widerstand = (Wert * 390) / 32768
  • Pt1000: Widerstand = (Wert * 3900) / 32768

Wenn der Widerstand periodisch abgefragt werden soll, wird empfohlen den CALLBACK_RESISTANCE Callback zu nutzen und die Periode mit set_resistance_callback_period vorzugeben.

BrickletPTC.set_noise_rejection_filter
Funktions-ID:
  • 17
Anfrage:
  • filter – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0
Antwort:
  • keine Antwort

Setzt den Entstörfilter auf 50Hz (0) oder 60Hz (1). Störungen von 50Hz oder 60Hz Stromquellen (inklusive Oberwellen der Stromquellen-Grundfrequenz) werden um 82dB abgeschwächt.

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

Für filter:

  • 0 = 50Hz
  • 1 = 60Hz
BrickletPTC.get_noise_rejection_filter
Funktions-ID:
  • 18
Anfrage:
  • keine Nutzdaten
Antwort:
  • filter – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0

Gibt die Einstellung des Entstörfilters zurück, wie von set_noise_rejection_filter gesetzt.

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

Für filter:

  • 0 = 50Hz
  • 1 = 60Hz
BrickletPTC.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

BrickletPTC.set_temperature_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_TEMPERATURE Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

BrickletPTC.get_temperature_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_temperature_callback_period gesetzt.

BrickletPTC.set_resistance_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_RESISTANCE Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

BrickletPTC.get_resistance_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_resistance_callback_period gesetzt.

BrickletPTC.set_temperature_callback_threshold
Funktions-ID:
  • 7
Anfrage:
  • option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x'
  • min – Typ: int32, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int32, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Antwort:
  • keine Antwort

Setzt den Schwellwert für den CALLBACK_TEMPERATURE_REACHED Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Temperatur außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn die Temperatur innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn die Temperatur kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Temperatur 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
BrickletPTC.get_temperature_callback_threshold
Funktions-ID:
  • 8
Anfrage:
  • keine Nutzdaten
Antwort:
  • option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x'
  • min – Typ: int32, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int32, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von set_temperature_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
BrickletPTC.set_resistance_callback_threshold
Funktions-ID:
  • 9
Anfrage:
  • option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x'
  • min – Typ: int32, Einheit: ? Ω, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int32, Einheit: ? Ω, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Antwort:
  • keine Antwort

Setzt den Schwellwert für den CALLBACK_RESISTANCE_REACHED Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Temperatur außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn die Temperatur innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn die Temperatur kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Temperatur 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
BrickletPTC.get_resistance_callback_threshold
Funktions-ID:
  • 10
Anfrage:
  • keine Nutzdaten
Antwort:
  • option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x'
  • min – Typ: int32, Einheit: ? Ω, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int32, Einheit: ? Ω, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von set_resistance_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
BrickletPTC.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 Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

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

BrickletPTC.set_sensor_connected_callback_configuration
Funktions-ID:
  • 22
Anfrage:
  • enabled – Typ: bool, Standardwert: false
Antwort:
  • keine Antwort

Wenn dieser Callback aktiviert ist, wird der CALLBACK_SENSOR_CONNECTED Callback jedes mal ausgelöst, wenn ein Pt-Sensor verbunden/getrennt wird.

Neu in Version 2.0.2 (Plugin).

BrickletPTC.get_sensor_connected_callback_configuration
Funktions-ID:
  • 23
Anfrage:
  • keine Nutzdaten
Antwort:
  • enabled – Typ: bool, Standardwert: false

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

Neu in Version 2.0.2 (Plugin).

Callbacks

BrickletPTC.CALLBACK_TEMPERATURE
Funktions-ID:
  • 13
Antwort:
  • temperature – Typ: int32, Einheit: 1/100 °C, Wertebereich: [-24600 bis 84900]

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

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

BrickletPTC.CALLBACK_TEMPERATURE_REACHED
Funktions-ID:
  • 14
Antwort:
  • temperature – Typ: int32, Einheit: 1/100 °C, Wertebereich: [-24600 bis 84900]

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

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

BrickletPTC.CALLBACK_RESISTANCE
Funktions-ID:
  • 15
Antwort:
  • resistance – Typ: int32, Einheit: ? Ω, Wertebereich: [-231 bis 231 - 1]

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

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

BrickletPTC.CALLBACK_RESISTANCE_REACHED
Funktions-ID:
  • 16
Antwort:
  • resistance – Typ: int32, Einheit: ? Ω, Wertebereich: [-231 bis 231 - 1]

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

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

BrickletPTC.CALLBACK_SENSOR_CONNECTED
Funktions-ID:
  • 24
Antwort:
  • connected – Typ: bool

Dieser Callback wird periodisch ausgelöst abhängig von der mittels set_sensor_connected_callback_configuration gesetzten Konfiguration

Der Rückgabewert ist der gleiche wie bei is_sensor_connected.

Neu in Version 2.0.2 (Plugin).