LabVIEW - RGB LED Button Bricklet

Dies ist die Beschreibung der LabVIEW API Bindings für das RGB LED Button Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des RGB LED Button Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die LabVIEW API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

API

Prinzipiell kann jede Funktion der LabVIEW Bindings, welche einen Wert ausgibt eine Tinkerforge.TimeoutException melden. Dieser Fehler wird gemeldet wenn das Gerät nicht antwortet. Wenn eine Kabelverbindung genutzt wird, ist es unwahrscheinlich, dass die Exception geworfen wird (unter der Annahme, dass das Gerät nicht abgesteckt wird). Bei einer drahtlosen Verbindung können Zeitüberschreitungen auftreten, sobald die Entfernung zum Gerät zu groß wird.

Der Namensraum für alle Brick/Bricklet Bindings und die IPConnection ist Tinkerforge.*.

Grundfunktionen

BrickletRGBLEDButton(uid, ipcon) → rgbLEDButton
Eingabe:
  • uid -- String
  • ipcon -- .NET Refnum (IPConnection)
Ausgabe:
  • rgbLEDButton -- .NET Refnum (BrickletRGBLEDButton)

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid. Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

BrickletRGBLEDButton.SetColor(red, green, blue)
Eingabe:
  • red -- Byte
  • green -- Byte
  • blue -- Byte

Setzt die LED-Farbe.

Standardmäßig ist die LED aus (0, 0, 0).

BrickletRGBLEDButton.GetColor() → red, green, blue
Ausgabe:
  • red -- Byte
  • green -- Byte
  • blue -- Byte

Gibt die LED-Farbe zurück, wie von SetColor() gesetzt.

BrickletRGBLEDButton.GetButtonState() → state
Ausgabe:
  • state -- Byte

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

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • BrickletRGBLEDButton.BUTTON_STATE_PRESSED = 0
  • BrickletRGBLEDButton.BUTTON_STATE_RELEASED = 1
BrickletRGBLEDButton.GetColorCalibration() → red, green, blue
Ausgabe:
  • red -- Byte
  • green -- Byte
  • blue -- Byte

Gibt die Farbwert-Kalibrierung zurück, wie von SetColorCalibration() gesetzt.

Fortgeschrittene Funktionen

BrickletRGBLEDButton.SetColorCalibration(red, green, blue)
Eingabe:
  • red -- Byte
  • green -- Byte
  • blue -- Byte

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

Der Wertebereich ist 0% bis 100%

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

Standardwert ist (100, 100, 55).

BrickletRGBLEDButton.GetAPIVersion() → apiVersion
Ausgabe:
  • apiVersion -- Byte[3]

Gibt die Version der API Definition (Major, Minor, Revision) zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

BrickletRGBLEDButton.GetResponseExpected(functionId) → responseExpected
Eingabe:
  • functionId -- Byte
Ausgabe:
  • responseExpected -- Boolean

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels SetResponseExpected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Siehe SetResponseExpected() für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

BrickletRGBLEDButton.SetResponseExpected(functionId, responseExpected)
Eingabe:
  • functionId -- Byte
  • responseExpected -- Boolean

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Funktions ID Konstanten sind für diese Funktion verfügbar:

  • BrickletRGBLEDButton.FUNCTION_SET_COLOR = 1
  • BrickletRGBLEDButton.FUNCTION_SET_COLOR_CALIBRATION = 5
  • BrickletRGBLEDButton.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletRGBLEDButton.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletRGBLEDButton.FUNCTION_RESET = 243
  • BrickletRGBLEDButton.FUNCTION_WRITE_UID = 248
BrickletRGBLEDButton.SetResponseExpectedAll(responseExpected)
Eingabe:
  • responseExpected -- Boolean

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

BrickletRGBLEDButton.GetSPITFPErrorCount() → errorCountAckChecksum, errorCountMessageChecksum, errorCountFrame, errorCountOverflow
Ausgabe:
  • errorCountAckChecksum -- Int64
  • errorCountMessageChecksum -- Int64
  • errorCountFrame -- Int64
  • errorCountOverflow -- Int64

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.SetBootloaderMode(mode) → status
Eingabe:
  • mode -- Byte
Ausgabe:
  • status -- Byte

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 Bootlodaer- 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 Konstanten sind für diese Funktion verfügbar:

  • BrickletRGBLEDButton.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletRGBLEDButton.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletRGBLEDButton.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletRGBLEDButton.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletRGBLEDButton.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BrickletRGBLEDButton.BOOTLOADER_STATUS_OK = 0
  • BrickletRGBLEDButton.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletRGBLEDButton.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletRGBLEDButton.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletRGBLEDButton.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletRGBLEDButton.BOOTLOADER_STATUS_CRC_MISMATCH = 5
BrickletRGBLEDButton.GetBootloaderMode() → mode
Ausgabe:
  • mode -- Byte

Gibt den aktuellen Bootloader-Modus zurück, siehe SetBootloaderMode().

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • BrickletRGBLEDButton.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletRGBLEDButton.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletRGBLEDButton.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletRGBLEDButton.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletRGBLEDButton.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
BrickletRGBLEDButton.SetWriteFirmwarePointer(pointer)
Eingabe:
  • pointer -- Int64

Setzt den Firmware-Pointer für WriteFirmware(). 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.WriteFirmware(data) → status
Eingabe:
  • data -- Byte[64]
Ausgabe:
  • status -- Byte

Schreibt 64 Bytes Firmware an die Position die vorher von SetWriteFirmwarePointer() 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.SetStatusLEDConfig(config)
Eingabe:
  • config -- Byte

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 Konstanten sind für diese Funktion verfügbar:

  • BrickletRGBLEDButton.STATUS_LED_CONFIG_OFF = 0
  • BrickletRGBLEDButton.STATUS_LED_CONFIG_ON = 1
  • BrickletRGBLEDButton.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletRGBLEDButton.STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletRGBLEDButton.GetStatusLEDConfig() → config
Ausgabe:
  • config -- Byte

Gibt die Konfiguration zurück, wie von SetStatusLEDConfig() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • BrickletRGBLEDButton.STATUS_LED_CONFIG_OFF = 0
  • BrickletRGBLEDButton.STATUS_LED_CONFIG_ON = 1
  • BrickletRGBLEDButton.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletRGBLEDButton.STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletRGBLEDButton.GetChipTemperature() → temperature
Ausgabe:
  • temperature -- Int16

Gibt die Temperatur in °C, 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()

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.WriteUID(uid)
Eingabe:
  • uid -- Int64

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.ReadUID() → uid
Ausgabe:
  • uid -- Int64

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

BrickletRGBLEDButton.GetIdentity() → uid, connectedUid, position, hardwareVersion, firmwareVersion, deviceIdentifier
Ausgabe:
  • uid -- String
  • connectedUid -- String
  • position -- Char
  • hardwareVersion -- Byte[3]
  • firmwareVersion -- Byte[3]
  • deviceIdentifier -- Int32

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 kann 'a', 'b', 'c' oder 'd' sein.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung erfolgt indem eine Funktion einem Callback Property des Geräte Objektes zugewiesen wird. Die verfügbaren Callback Properties und ihre Parametertypen werden weiter unten beschrieben.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

event BrickletRGBLEDButton.ButtonStateChangedCallback(sender, state)
Eingabe:
  • sender -- .NET Refnum (BrickletRGBLEDButton)
  • state -- Byte

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

Das Parameter ist der aktuelle Zustand des Knopfes.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • BrickletRGBLEDButton.BUTTON_STATE_PRESSED = 0
  • BrickletRGBLEDButton.BUTTON_STATE_RELEASED = 1

Konstanten

BrickletRGBLEDButton.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein RGB LED Button Bricklet zu identifizieren.

Die GetIdentity() Funktion und der EnumerateCallback Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

BrickletRGBLEDButton.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines RGB LED Button Bricklet dar.