TCP/IP - Industrial PTC Bricklet¶

Grundfunktionen¶

BrickletIndustrialPTC.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 der Wert periodisch benötigt wird, kann auch der CALLBACK_TEMPERATURE Callback verwendet werden. Der Callback wird mit der Funktion set_temperature_callback_configuration konfiguriert.

BrickletIndustrialPTC.get_resistance¶

Funktions-ID:	5
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 Wert periodisch benötigt wird, kann auch der CALLBACK_RESISTANCE Callback verwendet werden. Der Callback wird mit der Funktion set_resistance_callback_configuration konfiguriert.

BrickletIndustrialPTC.is_sensor_connected¶

Funktions-ID:	11
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.

Zum automatischen übertragen des Status kann auch der CALLBACK_SENSOR_CONNECTED Callback verwendet werden. Der Callback wird mit der Funktion set_sensor_connected_callback_configuration konfiguriert.

BrickletIndustrialPTC.set_wire_mode¶

Funktions-ID:	12
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

BrickletIndustrialPTC.get_wire_mode¶

Funktions-ID:	13
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

BrickletIndustrialPTC.set_moving_average_configuration¶

Funktions-ID:	14
Anfrage:	moving_average_length_resistance – Typ: uint16, Wertebereich: [1 bis 1000], Standardwert: 1 moving_average_length_temperature – Typ: uint16, Wertebereich: [1 bis 1000], Standardwert: 40
Antwort:	keine Antwort

Setzt die Länge eines gleitenden Mittelwerts für den Widerstand und die Temperatur.

Wenn die Länge auf 1 gesetzt wird, ist die Mittelwertbildung deaktiviert. Je kürzer die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

Einer neue Wert wird alle 20ms gemessen. Mit einer Mittelwerts-Länge von 1000 hat das resultierende gleitende Fenster eine Zeitspanne von 20s. Bei Langzeitmessungen gibt ein langer Mittelwert die saubersten Resultate.

Die Standardwerte entsprechen den nicht-änderbaren Mittelwert-Einstellungen des alten PTC Bricklet 1.0.

BrickletIndustrialPTC.get_moving_average_configuration¶

Funktions-ID:	15
Anfrage:	keine Nutzdaten
Antwort:	moving_average_length_resistance – Typ: uint16, Wertebereich: [1 bis 1000], Standardwert: 1 moving_average_length_temperature – Typ: uint16, Wertebereich: [1 bis 1000], Standardwert: 40

Gibt die Moving Average-Konfiguration zurück, wie von set_moving_average_configuration gesetzt.

Fortgeschrittene Funktionen¶

BrickletIndustrialPTC.set_noise_rejection_filter¶

Funktions-ID:	9
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

BrickletIndustrialPTC.get_noise_rejection_filter¶

Funktions-ID:	10
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

BrickletIndustrialPTC.get_spitfp_error_count¶

Funktions-ID:	234
Anfrage:	keine Nutzdaten
Antwort:	error_count_ack_checksum – Typ: uint32, Wertebereich: [0 bis 232 - 1] error_count_message_checksum – Typ: uint32, Wertebereich: [0 bis 232 - 1] error_count_frame – Typ: uint32, Wertebereich: [0 bis 232 - 1] error_count_overflow – Typ: uint32, Wertebereich: [0 bis 232 - 1]

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.

BrickletIndustrialPTC.set_status_led_config¶

Funktions-ID:	239
Anfrage:	config – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3
Antwort:	keine Antwort

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

Für config:

• 0 = Off
• 1 = On
• 2 = Show Heartbeat
• 3 = Show Status

BrickletIndustrialPTC.get_status_led_config¶

Funktions-ID:	240
Anfrage:	keine Nutzdaten
Antwort:	config – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3

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

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

Für config:

• 0 = Off
• 1 = On
• 2 = Show Heartbeat
• 3 = Show Status

BrickletIndustrialPTC.get_chip_temperature¶

Funktions-ID:	242
Anfrage:	keine Nutzdaten
Antwort:	temperature – Typ: int16, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur, 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.

BrickletIndustrialPTC.reset¶

Funktions-ID:	243
Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

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.

BrickletIndustrialPTC.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', '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 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. 

Konfigurationsfunktionen für Callbacks¶

BrickletIndustrialPTC.set_temperature_callback_configuration¶

Funktions-ID:	2
Anfrage:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false 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

Die Periode ist die Periode mit der der CALLBACK_TEMPERATURE 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 CALLBACK_TEMPERATURE 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.

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

Für option:

• 'x' = Off
• 'o' = Outside
• 'i' = Inside
• '<' = Smaller
• '>' = Greater

BrickletIndustrialPTC.get_temperature_callback_configuration¶

Funktions-ID:	3
Anfrage:	keine Nutzdaten
Antwort:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false 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 die Callback-Konfiguration zurück, wie mittels set_temperature_callback_configuration gesetzt.

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

Für option:

• 'x' = Off
• 'o' = Outside
• 'i' = Inside
• '<' = Smaller
• '>' = Greater

BrickletIndustrialPTC.set_resistance_callback_configuration¶

Funktions-ID:	6
Anfrage:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false 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

Die Periode ist die Periode mit der der CALLBACK_RESISTANCE 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 CALLBACK_RESISTANCE 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.

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

Für option:

• 'x' = Off
• 'o' = Outside
• 'i' = Inside
• '<' = Smaller
• '>' = Greater

BrickletIndustrialPTC.get_resistance_callback_configuration¶

Funktions-ID:	7
Anfrage:	keine Nutzdaten
Antwort:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false 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 die Callback-Konfiguration zurück, wie mittels set_resistance_callback_configuration gesetzt.

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

Für option:

• 'x' = Off
• 'o' = Outside
• 'i' = Inside
• '<' = Smaller
• '>' = Greater

BrickletIndustrialPTC.set_sensor_connected_callback_configuration¶

Funktions-ID:	16
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.

BrickletIndustrialPTC.get_sensor_connected_callback_configuration¶

Funktions-ID:	17
Anfrage:	keine Nutzdaten
Antwort:	enabled – Typ: bool, Standardwert: false

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

Callbacks¶

BrickletIndustrialPTC.CALLBACK_TEMPERATURE¶

Funktions-ID:	4
Antwort:	temperature – Typ: int32, Einheit: 1/100 °C, Wertebereich: [-24600 bis 84900]

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

Der Rückgabewert ist der gleiche wie get_temperature.

BrickletIndustrialPTC.CALLBACK_RESISTANCE¶

Funktions-ID:	8
Antwort:	resistance – Typ: int32, Einheit: ? Ω, Wertebereich: [-231 bis 231 - 1]

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

Der Rückgabewert ist der gleiche wie get_resistance.

BrickletIndustrialPTC.CALLBACK_SENSOR_CONNECTED¶

Funktions-ID:	18
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.

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

BrickletIndustrialPTC.set_bootloader_mode¶

Funktions-ID:	235
Anfrage:	mode – Typ: uint8, Wertebereich: Siehe Bedeutungen
Antwort:	status – Typ: uint8, Wertebereich: Siehe Bedeutungen

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

Für mode:

• 0 = Bootloader
• 1 = Firmware
• 2 = Bootloader Wait For Reboot
• 3 = Firmware Wait For Reboot
• 4 = Firmware Wait For Erase And Reboot

Für status:

• 0 = OK
• 1 = Invalid Mode
• 2 = No Change
• 3 = Entry Function Not Present
• 4 = Device Identifier Incorrect
• 5 = CRC Mismatch

BrickletIndustrialPTC.get_bootloader_mode¶

Funktions-ID:	236
Anfrage:	keine Nutzdaten
Antwort:	mode – Typ: uint8, Wertebereich: Siehe Bedeutungen

Gibt den aktuellen Bootloader-Modus zurück, siehe set_bootloader_mode.

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

Für mode:

• 0 = Bootloader
• 1 = Firmware
• 2 = Bootloader Wait For Reboot
• 3 = Firmware Wait For Reboot
• 4 = Firmware Wait For Erase And Reboot

BrickletIndustrialPTC.set_write_firmware_pointer¶

Funktions-ID:	237
Anfrage:	pointer – Typ: uint32, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Antwort:	keine Antwort

Setzt den Firmware-Pointer für write_firmware. 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.

BrickletIndustrialPTC.write_firmware¶

Funktions-ID:	238
Anfrage:	data – Typ: uint8[64], Wertebereich: [0 bis 255]
Antwort:	status – Typ: uint8, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von set_write_firmware_pointer 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.

BrickletIndustrialPTC.write_uid¶

Funktions-ID:	248
Anfrage:	uid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
Antwort:	keine Antwort

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.

BrickletIndustrialPTC.read_uid¶

Funktions-ID:	249
Anfrage:	keine Nutzdaten
Antwort:	uid – Typ: uint32, Wertebereich: [0 bis 232 - 1]

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.