LabVIEW - Segment Display 4x7 Bricklet 2.0

Dies ist die Beschreibung der LabVIEW API Bindings für das Segment Display 4x7 Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Segment Display 4x7 Bricklet 2.0 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

BrickletSegmentDisplay4x7V2(uid, ipcon) → segmentDisplay4x7V2
Eingabe:
  • uid – Typ: String
  • ipcon – Typ: .NET Refnum (IPConnection)
Ausgabe:
  • segmentDisplay4x7V2 – Typ: .NET Refnum (BrickletSegmentDisplay4x7V2)

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

BrickletSegmentDisplay4x7V2.SetSegments(digit0, digit1, digit2, digit3, colon, tick)
Eingabe:
  • digit0 – Typ: Boolean[8]
  • digit1 – Typ: Boolean[8]
  • digit2 – Typ: Boolean[8]
  • digit3 – Typ: Boolean[8]
  • colon – Typ: Boolean[2]
  • tick – Typ: Boolean

Setzt die einzelnen Segmente des Segment Display 4x7 Bricklet 2.0 Segment für Segment.

Die Daten sind aufgeteilt in die vier Ziffern (digit0-3), dem Doppelpunkt (colon) und dem Hochkomma (tick).

Die Indizes der Segmente in den Ziffern und dem Doppelpunkt sind wie folgt aufgeteilt:

Indizes der Segmente
BrickletSegmentDisplay4x7V2.GetSegments() → digit0, digit1, digit2, digit3, colon, tick
Ausgabe:
  • digit0 – Typ: Boolean[8]
  • digit1 – Typ: Boolean[8]
  • digit2 – Typ: Boolean[8]
  • digit3 – Typ: Boolean[8]
  • colon – Typ: Boolean[2]
  • tick – Typ: Boolean

Gibt die Segmentdaten zurück, wie von SetSegments() gesetzt.

BrickletSegmentDisplay4x7V2.SetBrightness(brightness)
Eingabe:
  • brightness – Typ: Byte, Wertebereich: [0 bis 7], Standardwert: 7

Die Helligkeit kann zwischen 0 (dunkel) und 7 (hell) gesetzt werden.

BrickletSegmentDisplay4x7V2.GetBrightness() → brightness
Ausgabe:
  • brightness – Typ: Byte, Wertebereich: [0 bis 7], Standardwert: 7

Gibt die Helligkeit zurück, wie von SetBrightness() gesetzt.

BrickletSegmentDisplay4x7V2.SetNumericValue(value)
Eingabe:
  • value – Typ: Int16[4], Wertebereich: [-2 bis 15]

Setzt einen numerischen Wert für jede Ziffer. Die Werte repräsentieren:

  • -2: Minuszeichen
  • -1: Leerstelle
  • 0-9: 0-9
  • 10: A
  • 11: b
  • 12: C
  • 13: d
  • 14: E
  • 15: F

Beispiel: Ein Aufruf mit [-2, -1, 4, 2] erzeugt eine Anzeige auf dem Display von "- 42".

BrickletSegmentDisplay4x7V2.SetSelectedSegment(segment, value)
Eingabe:
  • segment – Typ: Byte, Wertebereich: [0 bis 31]
  • value – Typ: Boolean

Aktiviert/deaktiviert ein selektiertes Segment.

Die Indizes sind wie folgt aufgeteilt:

Indizes für einzeln selektierte Segmente
BrickletSegmentDisplay4x7V2.GetSelectedSegment(segment) → value
Eingabe:
  • segment – Typ: Byte, Wertebereich: [0 bis 31]
Ausgabe:
  • value – Typ: Boolean

Gibt den Wert eines einzelnen Segments zurück.

Fortgeschrittene Funktionen

BrickletSegmentDisplay4x7V2.StartCounter(valueFrom, valueTo, increment, length)
Eingabe:
  • valueFrom – Typ: Int16, Wertebereich: [-999 bis 9999]
  • valueTo – Typ: Int16, Wertebereich: [-999 bis 9999]
  • increment – Typ: Int16, Wertebereich: [-999 bis 9999]
  • length – Typ: Int64, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]

Starter einen Zähler mit dem from Wert der bis zum to Wert zählt mit einer Schrittweite von increment. Das Argument length ist die Länge der Pause zwischen zwei Inkrements.

Beispiel: Wenn from auf 0, to auf 100, increment auf 1 und length auf 1000 gesetzt wird, wird ein Zähler gestartet der von 0 bis 100 zählt mit Rate von einer Sekunde zwischen jeder Erhöhung.

Wenn increment negativ ist läuft der Zähler rückwärts.

Der Zähler kann jederzeit durch einen Aufruf von SetSegments() oder SetNumericValue() gestoppt werden.

BrickletSegmentDisplay4x7V2.GetCounterValue() → value
Ausgabe:
  • value – Typ: Int32, Wertebereich: [-999 bis 9999]

Gibt den aktuellen Zählerstand zurück der auf der Anzeige angezeigt wird.

Wenn kein Zähler läuft wird eine 0 zurückgegeben.

BrickletSegmentDisplay4x7V2.GetSPITFPErrorCount() → errorCountAckChecksum, errorCountMessageChecksum, errorCountFrame, errorCountOverflow
Ausgabe:
  • errorCountAckChecksum – Typ: Int64, Wertebereich: [0 bis 232 - 1]
  • errorCountMessageChecksum – Typ: Int64, Wertebereich: [0 bis 232 - 1]
  • errorCountFrame – Typ: Int64, Wertebereich: [0 bis 232 - 1]
  • errorCountOverflow – Typ: Int64, 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.

BrickletSegmentDisplay4x7V2.SetBootloaderMode(mode) → status
Eingabe:
  • mode – Typ: Byte, Wertebereich: Siehe Konstanten
Ausgabe:
  • status – Typ: Byte, Wertebereich: Siehe Konstanten

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

Für mode:

  • BrickletSegmentDisplay4x7V2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletSegmentDisplay4x7V2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletSegmentDisplay4x7V2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletSegmentDisplay4x7V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletSegmentDisplay4x7V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

  • BrickletSegmentDisplay4x7V2.BOOTLOADER_STATUS_OK = 0
  • BrickletSegmentDisplay4x7V2.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletSegmentDisplay4x7V2.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletSegmentDisplay4x7V2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletSegmentDisplay4x7V2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletSegmentDisplay4x7V2.BOOTLOADER_STATUS_CRC_MISMATCH = 5
BrickletSegmentDisplay4x7V2.GetBootloaderMode() → mode
Ausgabe:
  • mode – Typ: Byte, Wertebereich: Siehe Konstanten

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

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

Für mode:

  • BrickletSegmentDisplay4x7V2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletSegmentDisplay4x7V2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletSegmentDisplay4x7V2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletSegmentDisplay4x7V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletSegmentDisplay4x7V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
BrickletSegmentDisplay4x7V2.SetWriteFirmwarePointer(pointer)
Eingabe:
  • pointer – Typ: Int64, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]

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.

BrickletSegmentDisplay4x7V2.WriteFirmware(data) → status
Eingabe:
  • data – Typ: Byte[64], Wertebereich: [0 bis 255]
Ausgabe:
  • status – Typ: Byte, Wertebereich: [0 bis 255]

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.

BrickletSegmentDisplay4x7V2.SetStatusLEDConfig(config)
Eingabe:
  • config – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 3

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:

Für config:

  • BrickletSegmentDisplay4x7V2.STATUS_LED_CONFIG_OFF = 0
  • BrickletSegmentDisplay4x7V2.STATUS_LED_CONFIG_ON = 1
  • BrickletSegmentDisplay4x7V2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletSegmentDisplay4x7V2.STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletSegmentDisplay4x7V2.GetStatusLEDConfig() → config
Ausgabe:
  • config – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 3

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

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

Für config:

  • BrickletSegmentDisplay4x7V2.STATUS_LED_CONFIG_OFF = 0
  • BrickletSegmentDisplay4x7V2.STATUS_LED_CONFIG_ON = 1
  • BrickletSegmentDisplay4x7V2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletSegmentDisplay4x7V2.STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletSegmentDisplay4x7V2.GetChipTemperature() → temperature
Ausgabe:
  • 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.

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

BrickletSegmentDisplay4x7V2.WriteUID(uid)
Eingabe:
  • uid – Typ: Int64, Wertebereich: [0 bis 232 - 1]

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.

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

BrickletSegmentDisplay4x7V2.GetIdentity() → uid, connectedUid, position, hardwareVersion, firmwareVersion, deviceIdentifier
Ausgabe:
  • uid – Typ: String, Länge: bis zu 8
  • connectedUid – Typ: String, Länge: bis zu 8
  • position – Typ: Char, Wertebereich: ["a" bis "h", "i", "z"]
  • hardwareVersion – Typ: Byte[3]
    • 0: major – Typ: Byte, Wertebereich: [0 bis 255]
    • 1: minor – Typ: Byte, Wertebereich: [0 bis 255]
    • 2: revision – Typ: Byte, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: Byte[3]
    • 0: major – Typ: Byte, Wertebereich: [0 bis 255]
    • 1: minor – Typ: Byte, Wertebereich: [0 bis 255]
    • 2: revision – Typ: Byte, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: Int32, 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. 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 BrickletSegmentDisplay4x7V2.CounterFinishedCallback → sender
Callback-Ausgabe:
  • sender – Typ: .NET Refnum (BrickletSegmentDisplay4x7V2)

Diese Callback wird ausgelöst, wenn der Zähler (siehe StartCounter()) fertig ist.

Virtuelle Funktionen

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

BrickletSegmentDisplay4x7V2.GetAPIVersion() → apiVersion
Ausgabe:
  • apiVersion – Typ: Byte[3]
    • 0: major – Typ: Byte, Wertebereich: [0 bis 255]
    • 1: minor – Typ: Byte, Wertebereich: [0 bis 255]
    • 2: revision – Typ: Byte, Wertebereich: [0 bis 255]

Gibt die Version der API Definition 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.

BrickletSegmentDisplay4x7V2.GetResponseExpected(functionId) → responseExpected
Eingabe:
  • functionId – Typ: Byte, Wertebereich: Siehe Konstanten
Ausgabe:
  • responseExpected – Typ: 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.

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

Für functionId:

  • BrickletSegmentDisplay4x7V2.FUNCTION_SET_SEGMENTS = 1
  • BrickletSegmentDisplay4x7V2.FUNCTION_SET_BRIGHTNESS = 3
  • BrickletSegmentDisplay4x7V2.FUNCTION_SET_NUMERIC_VALUE = 5
  • BrickletSegmentDisplay4x7V2.FUNCTION_SET_SELECTED_SEGMENT = 6
  • BrickletSegmentDisplay4x7V2.FUNCTION_START_COUNTER = 8
  • BrickletSegmentDisplay4x7V2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletSegmentDisplay4x7V2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletSegmentDisplay4x7V2.FUNCTION_RESET = 243
  • BrickletSegmentDisplay4x7V2.FUNCTION_WRITE_UID = 248
BrickletSegmentDisplay4x7V2.SetResponseExpected(functionId, responseExpected)
Eingabe:
  • functionId – Typ: Byte, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: 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 Konstanten sind für diese Funktion verfügbar:

Für functionId:

  • BrickletSegmentDisplay4x7V2.FUNCTION_SET_SEGMENTS = 1
  • BrickletSegmentDisplay4x7V2.FUNCTION_SET_BRIGHTNESS = 3
  • BrickletSegmentDisplay4x7V2.FUNCTION_SET_NUMERIC_VALUE = 5
  • BrickletSegmentDisplay4x7V2.FUNCTION_SET_SELECTED_SEGMENT = 6
  • BrickletSegmentDisplay4x7V2.FUNCTION_START_COUNTER = 8
  • BrickletSegmentDisplay4x7V2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletSegmentDisplay4x7V2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletSegmentDisplay4x7V2.FUNCTION_RESET = 243
  • BrickletSegmentDisplay4x7V2.FUNCTION_WRITE_UID = 248
BrickletSegmentDisplay4x7V2.SetResponseExpectedAll(responseExpected)
Eingabe:
  • responseExpected – Typ: Boolean

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

Konstanten

BrickletSegmentDisplay4x7V2.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Segment Display 4x7 Bricklet 2.0 zu identifizieren.

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

BrickletSegmentDisplay4x7V2.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Segment Display 4x7 Bricklet 2.0 dar.