Spezifikationen / TCP/IP Protokoll / API / Bricks und Bricklets / Bricklets / One Wire Bricklet

TCP/IP - One Wire Bricklet¶

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

API¶

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

Grundfunktionen¶

BrickletOneWire.search_bus_low_level¶

Funktions-ID:	1
Anfrage:	keine Nutzdaten
Antwort:	identifier_length – Typ: uint16, Wertebereich: [0 bis 64] identifier_chunk_offset – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1] identifier_chunk_data – Typ: uint64[7], Wertebereich: [0 bis 2⁶⁴ - 1] status – Typ: uint8, Wertebereich: Siehe Bedeutungen

Gibt eine Liste mit bis zu 64 Identifiern von angeschlossenen 1-Wire Geräten zurück. Jeder Identifier ist 64-Bit und besteht aus 8-Bit Familien-Code, 48-Bit ID und 8-Bit CRC.

Um diese Liste zu erhalten führt das Bricklet den SEARCH ROM Algorithmus von Maxim aus.

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

Für status:

0 = OK
1 = Busy
2 = No Presence
3 = Timeout
4 = Error

BrickletOneWire.reset_bus¶

Funktions-ID:	2
Anfrage:	keine Nutzdaten
Antwort:	status – Typ: uint8, Wertebereich: Siehe Bedeutungen

Setzt den Bus mit einer 1-Wire Reset Operation zurück.

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

Für status:

0 = OK
1 = Busy
2 = No Presence
3 = Timeout
4 = Error

BrickletOneWire.write¶

Funktions-ID:	3
Anfrage:	data – Typ: uint8, Wertebereich: [0 bis 255]
Antwort:	status – Typ: uint8, Wertebereich: Siehe Bedeutungen

Schreibt ein Byte an Daten auf den 1-Wire Bus.

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

Für status:

0 = OK
1 = Busy
2 = No Presence
3 = Timeout
4 = Error

BrickletOneWire.read¶

Funktions-ID:	4
Anfrage:	keine Nutzdaten
Antwort:	data – Typ: uint8, Wertebereich: [0 bis 255] status – Typ: uint8, Wertebereich: Siehe Bedeutungen

Liest ein Byte an Daten vom 1-Wire Bus.

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

Für status:

0 = OK
1 = Busy
2 = No Presence
3 = Timeout
4 = Error

BrickletOneWire.write_command¶

Funktions-ID:	5
Anfrage:	identifier – Typ: uint64, Wertebereich: [0 bis 2⁶⁴ - 1] command – Typ: uint8, Wertebereich: [0 bis 255]
Antwort:	status – Typ: uint8, Wertebereich: Siehe Bedeutungen

Sendet einen Befehl an das 1-Wire Gerät mit der angegebenen Identifier. Die Liste der Identifier können mittels search_bus_low_level ermittelt werden. Die MATCH ROM Operation wird verwendet, um den Befehl zu übertragen.

Wenn nur ein Gerät angeschlossen ist, oder der Befehl an alle Geräte gesendet werden soll kann als Identifier 0 verwendet werden. Dann wird die SKIP ROM Operation verwendet, um den Befehl zu übertragen.

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

Für status:

0 = OK
1 = Busy
2 = No Presence
3 = Timeout
4 = Error

Fortgeschrittene Funktionen¶

BrickletOneWire.set_communication_led_config¶

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

Setzt die Konfiguration der Kommunikations-LED. Standardmäßig zeigt die LED die 1-Wire Kommunikation durch Aufblinken an.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootloadermodus 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 Communication

BrickletOneWire.get_communication_led_config¶

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

Gibt die Konfiguration zurück, wie von set_communication_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 Communication

BrickletOneWire.get_spitfp_error_count¶

Funktions-ID:	234
Anfrage:	keine Nutzdaten
Antwort:	error_count_ack_checksum – Typ: uint32, Wertebereich: [0 bis 2³² - 1] error_count_message_checksum – Typ: uint32, Wertebereich: [0 bis 2³² - 1] error_count_frame – Typ: uint32, Wertebereich: [0 bis 2³² - 1] error_count_overflow – Typ: uint32, Wertebereich: [0 bis 2³² - 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.

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

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

BrickletOneWire.get_chip_temperature¶

Funktions-ID:	242
Anfrage:	keine Nutzdaten
Antwort:	temperature – Typ: int16, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 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.

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

BrickletOneWire.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 2¹⁶ - 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.

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.

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

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

BrickletOneWire.set_write_firmware_pointer¶

Funktions-ID:	237
Anfrage:	pointer – Typ: uint32, Einheit: 1 B, Wertebereich: [0 bis 2³² - 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.

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

BrickletOneWire.write_uid¶

Funktions-ID:	248
Anfrage:	uid – Typ: uint32, Wertebereich: [0 bis 2³² - 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.

BrickletOneWire.read_uid¶

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

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