Modbus - RGB LED Button Bricklet¶

Grundfunktionen¶

BrickletRGBLEDButton.set_color¶

Funktions-ID:	1
Anfrage:	red – Typ: uint8, Wertebereich: [0 bis 255], Standardwert: 0 green – Typ: uint8, Wertebereich: [0 bis 255], Standardwert: 0 blue – Typ: uint8, Wertebereich: [0 bis 255], Standardwert: 0
Antwort:	keine Antwort

Setzt die LED-Farbe.

BrickletRGBLEDButton.get_color¶

Funktions-ID:	2
Anfrage:	keine Nutzdaten
Antwort:	red – Typ: uint8, Wertebereich: [0 bis 255], Standardwert: 0 green – Typ: uint8, Wertebereich: [0 bis 255], Standardwert: 0 blue – Typ: uint8, Wertebereich: [0 bis 255], Standardwert: 0

Gibt die LED-Farbe zurück, wie von set_color gesetzt.

BrickletRGBLEDButton.get_button_state¶

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

Gibt den aktuellen Zustand des Knopfes zurück (entweder gedrückt oder nicht gedrückt).

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

Für state:

• 0 = Pressed
• 1 = Released

BrickletRGBLEDButton.get_color_calibration¶

Funktions-ID:	6
Anfrage:	keine Nutzdaten
Antwort:	red – Typ: uint8, Einheit: 1 %, Wertebereich: [0 bis 100], Standardwert: 100 green – Typ: uint8, Einheit: 1 %, Wertebereich: [0 bis 100], Standardwert: 100 blue – Typ: uint8, Einheit: 1 %, Wertebereich: [0 bis 100], Standardwert: 55

Gibt die Farbwert-Kalibrierung zurück, wie von set_color_calibration gesetzt.

Fortgeschrittene Funktionen¶

BrickletRGBLEDButton.set_color_calibration¶

Funktions-ID:	5
Anfrage:	red – Typ: uint8, Einheit: 1 %, Wertebereich: [0 bis 100], Standardwert: 100 green – Typ: uint8, Einheit: 1 %, Wertebereich: [0 bis 100], Standardwert: 100 blue – Typ: uint8, Einheit: 1 %, Wertebereich: [0 bis 100], Standardwert: 55
Antwort:	keine Antwort

Setzt die Farbwert-Kalibrierung. Einige Farben erscheinen heller als andere, daher kann eine Kalibrierung nötig sein um gleichmäßige Farben zu erzielen.

Die Kalibrierung wird im Flash des Bricklets gespeichert und muss daher nicht bei jedem Start erneut vorgenommen werden.

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

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

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

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

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

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

Callbacks¶

BrickletRGBLEDButton.CALLBACK_BUTTON_STATE_CHANGED¶

Funktions-ID:	4
Antwort:	state – Typ: uint8, Wertebereich: Siehe Bedeutungen

Dieser Callback wird jedes mal ausgelöst, wenn sich der Zustand es Knopfes ändert von gedrückt zu nicht gedrückt oder anders herum

Der Rückgabewert ist der aktuelle Zustand des Knopfes.

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

Für state:

• 0 = Pressed
• 1 = Released

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.

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

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

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

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

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

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