Visual Basic .NET - DMX Bricklet¶

Simple¶

Download (ExampleSimple.vb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

Imports System
Imports Tinkerforge

Module ExampleSimple
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your DMX Bricklet

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim dmx As New BrickletDMX(UID, ipcon) ' Create device object

        ipcon.Connect(HOST, PORT) ' Connect to brickd
        ' Don't use device before ipcon is connected

        ' Configure Bricklet as DMX master
        dmx.SetDMXMode(BrickletDMX.DMX_MODE_MASTER)

        ' Write DMX frame with 3 channels
        dmx.WriteFrame(new Byte(){255, 128, 0})

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

Grundfunktionen¶

Class BrickletDMX(ByVal uid As String, ByVal ipcon As IPConnection)¶

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:

Dim dmx As New BrickletDMX("YOUR_DEVICE_UID", ipcon)

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

Sub BrickletDMX.SetDMXMode(ByVal dmxMode As Byte)¶

Parameter:	dmxMode – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0

Setzt den DMX Modus entweder auf Master oder Slave.

Ein Aufruf dieser Funktion setzt die Frame-Nummer auf 0.

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

Für dmxMode:

• BrickletDMX.DMX_MODE_MASTER = 0
• BrickletDMX.DMX_MODE_SLAVE = 1

Function BrickletDMX.GetDMXMode() As Byte¶

Rückgabe:	dmxMode – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 0

Gibt den DMX Modus zurück, wie von SetDMXMode() gesetzt.

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

Für dmxMode:

• BrickletDMX.DMX_MODE_MASTER = 0
• BrickletDMX.DMX_MODE_SLAVE = 1

Sub BrickletDMX.WriteFrame(ByVal frame() As Byte)¶

Parameter:	frame – Typ: Byte Array, Länge: variabel, Wertebereich: [0 bis 255]

Schreibt einen DMX Frame. Die maximale Framegröße ist 512 Byte. Jedes Byte stellt dabei einen Kanal dar.

Das nächste Frame kann geschrieben werden nachdem der FrameStartedCallback Callback aufgerufen wurde. Das Frame verfügt über einen Doublebuffer, so dass ein neues Frame geschrieben werden kann, sobald das vorherige Frame geschrieben wurde.

Die Daten werden transferiert, wenn die nächste Frame Duration abgelaufen ist, siehe see SetFrameDuration().

Genereller Ansatz:

• Setze Frame Duration auf einen Wert welcher der Anzahl der Bilder pro Sekunde entspricht die erreicht werden sollen.
• Setze alle Kanäle für den ersten Frame.
• Warte auf FrameStartedCallback Callback.
• Setze alle Kanäle für den nächsten Frame.
• Warte auf FrameStartedCallback Callback.
• Und so weiter.

Dieser Ansatz garantiert, dass DMX Daten mit einer festen Framerate gesetzt werden.

Diese Funktion kann nur im Master Modus aufgerufen werden.

Sub BrickletDMX.ReadFrame(ByRef frame() As Byte, ByRef frameNumber As Long)¶

Ausgabeparameter:	frame – Typ: Byte Array, Länge: variabel, Wertebereich: [0 bis 255] frameNumber – Typ: Long, Wertebereich: [0 bis 232 - 1]

Gibt das letzte Frame zurück, dass von dem DMX Master geschrieben wurde. Die Größe des Arrays ist identisch zu der Anzahl der Kanäle im Frame. Jedes Byte repräsentiert ein Kanal.

Das nächste Frame ist verfügbar nachdem der FrameAvailableCallback Callback aufgerufen wurde.

Genereller Ansatz:

• Aufruf von ReadFrame() um das erste Frame zu bekommen.
• Warten auf den FrameAvailableCallback Callback.
• Aufruf von ReadFrame() um das zweite Frame zu bekommen.
• Warten auf den FrameAvailableCallback Callback.
• Und so weiter.

Anstatt das diese Funktion gepollt wird, kann auch der FrameCallback Callback genutzt werden. Der Callback kann mit SetFrameCallbackConfig() aktiviert werden.

Die frame number startet mit 0 und wird für jedes empfangene Frame erhöht.

Diese Funktion kann nur im Slave Modus aufgerufen werden.

Sub BrickletDMX.SetFrameDuration(ByVal frameDuration As Integer)¶

Parameter:	frameDuration – Typ: Integer, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 100

Setzt die Dauer eines Frames.

Beispiel: Wenn 20 Frames pro Sekunde erreicht werden sollen, muss die frame duration auf 50ms gesetzt werden (50ms * 20 = 1 Sekunde).

Soll jeweils ein Frame so schnell wie möglich gesendet werden, so sollte die frame duration auf 0 gesetzt werden.

Diese Einstellung wird nur im Master Modus genutzt.

Function BrickletDMX.GetFrameDuration() As Integer¶

Rückgabe:	frameDuration – Typ: Integer, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 100

Gibt die Frame duration zurück die mittels SetFrameDuration() gesetzt wurde.

Fortgeschrittene Funktionen¶

Sub BrickletDMX.GetFrameErrorCount(ByRef overrunErrorCount As Long, ByRef framingErrorCount As Long)¶

Ausgabeparameter:	overrunErrorCount – Typ: Long, Wertebereich: [0 bis 232 - 1] framingErrorCount – Typ: Long, Wertebereich: [0 bis 232 - 1]

Gibt die aktuelle Anzahl an Overrun und Framing Fehlern zurück.

Sub BrickletDMX.SetCommunicationLEDConfig(ByVal config As Byte)¶

Parameter:	config – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 3

Setzt die Konfiguration der Kommunikations-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 Bootloadermodus befindet ist die LED aus.

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

Für config:

• BrickletDMX.COMMUNICATION_LED_CONFIG_OFF = 0
• BrickletDMX.COMMUNICATION_LED_CONFIG_ON = 1
• BrickletDMX.COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletDMX.COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION = 3

Function BrickletDMX.GetCommunicationLEDConfig() As Byte¶

Rückgabe:	config – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 3

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

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

Für config:

• BrickletDMX.COMMUNICATION_LED_CONFIG_OFF = 0
• BrickletDMX.COMMUNICATION_LED_CONFIG_ON = 1
• BrickletDMX.COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletDMX.COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION = 3

Sub BrickletDMX.SetErrorLEDConfig(ByVal config As Byte)¶

Parameter:	config – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 3

Setzt die Konfiguration der Error-LED.

Standardmäßig geht die LED an, wenn ein Error auftritt (siehe FrameErrorCountCallback Callback). Wenn diese Funktion danach nochmal mit der Show-Error-Option aufgerufen wird, geht die LED wieder aus bis der nächste Error auftritt.

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

Für config:

• BrickletDMX.ERROR_LED_CONFIG_OFF = 0
• BrickletDMX.ERROR_LED_CONFIG_ON = 1
• BrickletDMX.ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletDMX.ERROR_LED_CONFIG_SHOW_ERROR = 3

Function BrickletDMX.GetErrorLEDConfig() As Byte¶

Rückgabe:	config – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 3

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

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

Für config:

• BrickletDMX.ERROR_LED_CONFIG_OFF = 0
• BrickletDMX.ERROR_LED_CONFIG_ON = 1
• BrickletDMX.ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletDMX.ERROR_LED_CONFIG_SHOW_ERROR = 3

Sub BrickletDMX.GetSPITFPErrorCount(ByRef errorCountAckChecksum As Long, ByRef errorCountMessageChecksum As Long, ByRef errorCountFrame As Long, ByRef errorCountOverflow As Long)¶

Ausgabeparameter:	errorCountAckChecksum – Typ: Long, Wertebereich: [0 bis 232 - 1] errorCountMessageChecksum – Typ: Long, Wertebereich: [0 bis 232 - 1] errorCountFrame – Typ: Long, Wertebereich: [0 bis 232 - 1] errorCountOverflow – Typ: Long, 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.

Sub BrickletDMX.SetStatusLEDConfig(ByVal config As Byte)¶

Parameter:	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:

• BrickletDMX.STATUS_LED_CONFIG_OFF = 0
• BrickletDMX.STATUS_LED_CONFIG_ON = 1
• BrickletDMX.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletDMX.STATUS_LED_CONFIG_SHOW_STATUS = 3

Function BrickletDMX.GetStatusLEDConfig() As Byte¶

Rückgabe:	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:

• BrickletDMX.STATUS_LED_CONFIG_OFF = 0
• BrickletDMX.STATUS_LED_CONFIG_ON = 1
• BrickletDMX.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletDMX.STATUS_LED_CONFIG_SHOW_STATUS = 3

Function BrickletDMX.GetChipTemperature() As Short¶

Rückgabe:	temperature – Typ: Short, 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.

Sub BrickletDMX.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.

Sub BrickletDMX.GetIdentity(ByRef uid As String, ByRef connectedUid As String, ByRef position As Char, ByRef hardwareVersion() As Byte, ByRef firmwareVersion() As Byte, ByRef deviceIdentifier As Integer)¶

Ausgabeparameter:

uid – Typ: String, Länge: bis zu 8 connectedUid – Typ: String, Länge: bis zu 8 position – Typ: Char, Wertebereich: ["a"C bis "h"C, "z"C] hardwareVersion – Typ: Byte Array, Länge: 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 Array, Länge: 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: Integer, 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. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks¶

Sub BrickletDMX.SetFrameCallbackConfig(ByVal frameStartedCallbackEnabled As Boolean, ByVal frameAvailableCallbackEnabled As Boolean, ByVal frameCallbackEnabled As Boolean, ByVal frameErrorCountCallbackEnabled As Boolean)¶

Parameter:	frameStartedCallbackEnabled – Typ: Boolean, Standardwert: true frameAvailableCallbackEnabled – Typ: Boolean, Standardwert: true frameCallbackEnabled – Typ: Boolean, Standardwert: false frameErrorCountCallbackEnabled – Typ: Boolean, Standardwert: false

Aktiviert/Deaktiviert die verschiedenen Callback. Standardmäßig sind der FrameStartedCallback Callback und der FrameAvailableCallback Callback aktiviert, während der FrameCallback Callback und der FrameErrorCountCallback Callback deaktiviert sind.

Wenn der FrameCallback Callback aktiviert wird dann kann der FrameAvailableCallback Callback deaktiviert werden, da dieser dann redundant ist.

Sub BrickletDMX.GetFrameCallbackConfig(ByRef frameStartedCallbackEnabled As Boolean, ByRef frameAvailableCallbackEnabled As Boolean, ByRef frameCallbackEnabled As Boolean, ByRef frameErrorCountCallbackEnabled As Boolean)¶

Ausgabeparameter:	frameStartedCallbackEnabled – Typ: Boolean, Standardwert: true frameAvailableCallbackEnabled – Typ: Boolean, Standardwert: true frameCallbackEnabled – Typ: Boolean, Standardwert: false frameErrorCountCallbackEnabled – Typ: Boolean, Standardwert: false

Gibt die Frame Callback Konfiguration zurück, wie von SetFrameCallbackConfig() gesetzt.

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung erfolgt indem eine Prozedur einem Callback Property des Geräte Objektes zugewiesen wird:

Sub MyCallback(ByVal sender As BrickletDMX, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

AddHandler dmx.ExampleCallback, AddressOf MyCallback

Die verfügbaren Callback Properties und ihre Parametertypen werden weiter unten beschrieben.

Event BrickletDMX.FrameStartedCallback(ByVal sender As BrickletDMX)¶

Callback-Parameter:	sender – Typ: BrickletDMX

Dieser Callback wird ausgelöst sobald ein neuer Frame gestartet wurde. Nachdem dieser Callback empfangen wurde sollten die Daten für den nächsten Frame geschrieben werden.

Für eine Erklärung siehe die Beschreibung in der Funktion WriteFrame().

Der Callback kann mittels SetFrameCallbackConfig() aktiviert werden.

Dieser Callback wird nur im Master Modus ausgelöst.

Event BrickletDMX.FrameAvailableCallback(ByVal sender As BrickletDMX, ByVal frameNumber As Long)¶

Callback-Parameter:	sender – Typ: BrickletDMX frameNumber – Typ: Long, Wertebereich: [0 bis 232 - 1]

Dieser Callback wird im Slave Modus ausgelöst, wenn ein neuer Frame vom DMX Master empfangen wurde und nun ausgelesen werden kann. Der Frame muss ausgelesen werden, bevor der Master ein neues Frame schreibt. Siehe ReadFrame() für weitere Details.

Der Parameter ist die Frame-Nummer, diese wird für jeden empfangenen Frame um eins erhöht.

Der Callback kann mittels SetFrameCallbackConfig() aktiviert werden.

Dieser Callback kann nur im Slave Modus ausgelöst werden.

Event BrickletDMX.FrameCallback(ByVal sender As BrickletDMX, ByVal frame() As Byte, ByVal frameNumber As Long)¶

Callback-Parameter:	sender – Typ: BrickletDMX frame – Typ: Byte Array, Länge: variabel, Wertebereich: [0 bis 255] frameNumber – Typ: Long, Wertebereich: [0 bis 232 - 1]

Dieser Callback wird aufgerufen sobald ein neuer Frame verfügbar ist (vom DMX Master geschrieben).

Die Größe des Arrays ist gleichbedeutend zu der Anzahl an Kanälen in dem Frame. Jedes Byte stellt einen Kanal dar.

Der Callback kann mittels SetFrameCallbackConfig() aktiviert werden.

Dieser Callback kann nur im Slave Modus ausgelöst werden.

Bemerkung

Falls das Rekonstruieren des Wertes fehlschlägt, wird der Callback mit Nothing für frame ausgelöst.

Event BrickletDMX.FrameErrorCountCallback(ByVal sender As BrickletDMX, ByVal overrunErrorCount As Long, ByVal framingErrorCount As Long)¶

Callback-Parameter:	sender – Typ: BrickletDMX overrunErrorCount – Typ: Long, Wertebereich: [0 bis 232 - 1] framingErrorCount – Typ: Long, Wertebereich: [0 bis 232 - 1]

Dieser Callback wird aufgerufen wenn ein neuer Fehler auftritt. Er gibt die Anzahl der aufgetreten Overrun und Framing Fehler zurück.

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.

Function BrickletDMX.GetAPIVersion() As Byte()¶

Ausgabeparameter:	apiVersion – Typ: Byte Array, Länge: 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.

Function BrickletDMX.GetResponseExpected(ByVal functionId As Byte) As Boolean¶

Parameter:	functionId – Typ: Byte, Wertebereich: Siehe Konstanten
Rückgabe:	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:

• BrickletDMX.FUNCTION_SET_DMX_MODE = 1
• BrickletDMX.FUNCTION_WRITE_FRAME = 3
• BrickletDMX.FUNCTION_SET_FRAME_DURATION = 5
• BrickletDMX.FUNCTION_SET_COMMUNICATION_LED_CONFIG = 8
• BrickletDMX.FUNCTION_SET_ERROR_LED_CONFIG = 10
• BrickletDMX.FUNCTION_SET_FRAME_CALLBACK_CONFIG = 12
• BrickletDMX.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletDMX.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletDMX.FUNCTION_RESET = 243
• BrickletDMX.FUNCTION_WRITE_UID = 248

Sub BrickletDMX.SetResponseExpected(ByVal functionId As Byte, ByVal responseExpected As Boolean)¶

Parameter:	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:

• BrickletDMX.FUNCTION_SET_DMX_MODE = 1
• BrickletDMX.FUNCTION_WRITE_FRAME = 3
• BrickletDMX.FUNCTION_SET_FRAME_DURATION = 5
• BrickletDMX.FUNCTION_SET_COMMUNICATION_LED_CONFIG = 8
• BrickletDMX.FUNCTION_SET_ERROR_LED_CONFIG = 10
• BrickletDMX.FUNCTION_SET_FRAME_CALLBACK_CONFIG = 12
• BrickletDMX.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletDMX.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletDMX.FUNCTION_RESET = 243
• BrickletDMX.FUNCTION_WRITE_UID = 248

Sub BrickletDMX.SetResponseExpectedAll(ByVal responseExpected As Boolean)¶

Parameter:	responseExpected – Typ: Boolean

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

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.

Function BrickletDMX.SetBootloaderMode(ByVal mode As Byte) As Byte¶

Parameter:	mode – Typ: Byte, Wertebereich: Siehe Konstanten
Rückgabe:	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:

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

Für status:

• BrickletDMX.BOOTLOADER_STATUS_OK = 0
• BrickletDMX.BOOTLOADER_STATUS_INVALID_MODE = 1
• BrickletDMX.BOOTLOADER_STATUS_NO_CHANGE = 2
• BrickletDMX.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• BrickletDMX.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• BrickletDMX.BOOTLOADER_STATUS_CRC_MISMATCH = 5

Function BrickletDMX.GetBootloaderMode() As Byte¶

Rückgabe:	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:

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

Sub BrickletDMX.SetWriteFirmwarePointer(ByVal pointer As Long)¶

Parameter:	pointer – Typ: Long, 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.

Function BrickletDMX.WriteFirmware(ByVal data() As Byte) As Byte¶

Parameter:	data – Typ: Byte Array, Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:	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.

Sub BrickletDMX.WriteUID(ByVal uid As Long)¶

Parameter:	uid – Typ: Long, 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.

Function BrickletDMX.ReadUID() As Long¶

Rückgabe:	uid – Typ: Long, 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.

Konstanten¶

Const BrickletDMX.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein DMX Bricklet 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.

Const BrickletDMX.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines DMX Bricklet dar.