Delphi/Lazarus - DMX Bricklet¶

Simple¶

Download (ExampleSimple.pas)

 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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

program ExampleSimple;

{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}

uses
  SysUtils, IPConnection, BrickletDMX;

type
  TExample = class
  private
    ipcon: TIPConnection;
    dmx: TBrickletDMX;
  public
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your DMX Bricklet }

var
  e: TExample;

procedure TExample.Execute;
begin
  { Create IP connection }
  ipcon := TIPConnection.Create;

  { Create device object }
  dmx := TBrickletDMX.Create(UID, ipcon);

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

  { Configure Bricklet as DMX master }
  dmx.SetDMXMode(BRICKLET_DMX_DMX_MODE_MASTER);

  { Write DMX frame with 3 channels }
  dmx.WriteFrame([255, 128, 0]);

  WriteLn('Press key to exit');
  ReadLn;
  ipcon.Destroy; { Calls ipcon.Disconnect internally }
end;

begin
  e := TExample.Create;
  e.Execute;
  e.Destroy;
end.

Grundfunktionen¶

constructor TBrickletDMX.Create(const uid: string; ipcon: TIPConnection)¶

Parameter:	uid – Typ: string ipcon – Typ: TIPConnection
Rückgabe:	dmx – Typ: TBrickletDMX

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

dmx := TBrickletDMX.Create('YOUR_DEVICE_UID', ipcon);

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

procedure TBrickletDMX.SetDMXMode(const dmxMode: 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:

• BRICKLET_DMX_DMX_MODE_MASTER = 0
• BRICKLET_DMX_DMX_MODE_SLAVE = 1

function TBrickletDMX.GetDMXMode: 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:

• BRICKLET_DMX_DMX_MODE_MASTER = 0
• BRICKLET_DMX_DMX_MODE_SLAVE = 1

procedure TBrickletDMX.WriteFrame(const frame: array of byte)¶

Parameter:	frame – Typ: array of byte, 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 OnFrameStarted 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 OnFrameStarted Callback.
• Setze alle Kanäle für den nächsten Frame.
• Warte auf OnFrameStarted 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.

procedure TBrickletDMX.ReadFrame(out frame: array of byte; out frameNumber: longword)¶

Ausgabeparameter:	frame – Typ: array of byte, Wertebereich: [0 bis 255] frameNumber – Typ: longword, 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 OnFrameAvailable Callback aufgerufen wurde.

Genereller Ansatz:

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

Anstatt das diese Funktion gepollt wird, kann auch der OnFrame 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.

procedure TBrickletDMX.SetFrameDuration(const frameDuration: word)¶

Parameter:	frameDuration – Typ: word, 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 TBrickletDMX.GetFrameDuration: word¶

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

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

Fortgeschrittene Funktionen¶

procedure TBrickletDMX.GetFrameErrorCount(out overrunErrorCount: longword; out framingErrorCount: longword)¶

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

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

procedure TBrickletDMX.SetCommunicationLEDConfig(const config: 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:

• BRICKLET_DMX_COMMUNICATION_LED_CONFIG_OFF = 0
• BRICKLET_DMX_COMMUNICATION_LED_CONFIG_ON = 1
• BRICKLET_DMX_COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT = 2
• BRICKLET_DMX_COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION = 3

function TBrickletDMX.GetCommunicationLEDConfig: 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:

• BRICKLET_DMX_COMMUNICATION_LED_CONFIG_OFF = 0
• BRICKLET_DMX_COMMUNICATION_LED_CONFIG_ON = 1
• BRICKLET_DMX_COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT = 2
• BRICKLET_DMX_COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION = 3

procedure TBrickletDMX.SetErrorLEDConfig(const config: 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 OnFrameErrorCount 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:

• BRICKLET_DMX_ERROR_LED_CONFIG_OFF = 0
• BRICKLET_DMX_ERROR_LED_CONFIG_ON = 1
• BRICKLET_DMX_ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
• BRICKLET_DMX_ERROR_LED_CONFIG_SHOW_ERROR = 3

function TBrickletDMX.GetErrorLEDConfig: 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:

• BRICKLET_DMX_ERROR_LED_CONFIG_OFF = 0
• BRICKLET_DMX_ERROR_LED_CONFIG_ON = 1
• BRICKLET_DMX_ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
• BRICKLET_DMX_ERROR_LED_CONFIG_SHOW_ERROR = 3

procedure TBrickletDMX.GetSPITFPErrorCount(out errorCountAckChecksum: longword; out errorCountMessageChecksum: longword; out errorCountFrame: longword; out errorCountOverflow: longword)¶

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

procedure TBrickletDMX.SetStatusLEDConfig(const config: 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:

• BRICKLET_DMX_STATUS_LED_CONFIG_OFF = 0
• BRICKLET_DMX_STATUS_LED_CONFIG_ON = 1
• BRICKLET_DMX_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BRICKLET_DMX_STATUS_LED_CONFIG_SHOW_STATUS = 3

function TBrickletDMX.GetStatusLEDConfig: 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:

• BRICKLET_DMX_STATUS_LED_CONFIG_OFF = 0
• BRICKLET_DMX_STATUS_LED_CONFIG_ON = 1
• BRICKLET_DMX_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BRICKLET_DMX_STATUS_LED_CONFIG_SHOW_STATUS = 3

function TBrickletDMX.GetChipTemperature: smallint¶

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

procedure TBrickletDMX.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.

procedure TBrickletDMX.GetIdentity(out uid: string; out connectedUid: string; out position: char; out hardwareVersion: array [0..2] of byte; out firmwareVersion: array [0..2] of byte; out deviceIdentifier: word)¶

Ausgabeparameter:

uid – Typ: string, Länge: bis zu 8 connectedUid – Typ: string, Länge: bis zu 8 position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] hardwareVersion – Typ: array [0..2] of byte 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: array [0..2] of byte 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: word, 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¶

procedure TBrickletDMX.SetFrameCallbackConfig(const frameStartedCallbackEnabled: boolean; const frameAvailableCallbackEnabled: boolean; const frameCallbackEnabled: boolean; const frameErrorCountCallbackEnabled: 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 OnFrameStarted Callback und der OnFrameAvailable Callback aktiviert, während der OnFrame Callback und der OnFrameErrorCount Callback deaktiviert sind.

Wenn der OnFrame Callback aktiviert wird dann kann der OnFrameAvailable Callback deaktiviert werden, da dieser dann redundant ist.

procedure TBrickletDMX.GetFrameCallbackConfig(out frameStartedCallbackEnabled: boolean; out frameAvailableCallbackEnabled: boolean; out frameCallbackEnabled: boolean; out frameErrorCountCallbackEnabled: 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:

procedure TExample.MyCallback(sender: TBrickletDMX; const value: longint);
begin
  WriteLn(Format('Value: %d', [value]));
end;

dmx.OnExample := {$ifdef FPC}@{$endif}example.MyCallback;

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

property TBrickletDMX.OnFrameStarted¶

procedure(sender: TBrickletDMX) of object;

Callback-Parameter:	sender – Typ: TBrickletDMX

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.

property TBrickletDMX.OnFrameAvailable¶

procedure(sender: TBrickletDMX; const frameNumber: longword) of object;

Callback-Parameter:	sender – Typ: TBrickletDMX frameNumber – Typ: longword, 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.

property TBrickletDMX.OnFrame¶

procedure(sender: TBrickletDMX; const frame: array of byte; const frameNumber: longword) of object;

Callback-Parameter:	sender – Typ: TBrickletDMX frame – Typ: array of byte, Wertebereich: [0 bis 255] frameNumber – Typ: longword, 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 nil für frame ausgelöst.

property TBrickletDMX.OnFrameErrorCount¶

procedure(sender: TBrickletDMX; const overrunErrorCount: longword; const framingErrorCount: longword) of object;

Callback-Parameter:	sender – Typ: TBrickletDMX overrunErrorCount – Typ: longword, Wertebereich: [0 bis 232 - 1] framingErrorCount – Typ: longword, 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 TBrickletDMX.GetAPIVersion: array [0..2] of byte¶

Ausgabeparameter:	apiVersion – Typ: array [0..2] of byte 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 TBrickletDMX.GetResponseExpected(const functionId: byte): 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:

• BRICKLET_DMX_FUNCTION_SET_DMX_MODE = 1
• BRICKLET_DMX_FUNCTION_WRITE_FRAME = 3
• BRICKLET_DMX_FUNCTION_SET_FRAME_DURATION = 5
• BRICKLET_DMX_FUNCTION_SET_COMMUNICATION_LED_CONFIG = 8
• BRICKLET_DMX_FUNCTION_SET_ERROR_LED_CONFIG = 10
• BRICKLET_DMX_FUNCTION_SET_FRAME_CALLBACK_CONFIG = 12
• BRICKLET_DMX_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BRICKLET_DMX_FUNCTION_SET_STATUS_LED_CONFIG = 239
• BRICKLET_DMX_FUNCTION_RESET = 243
• BRICKLET_DMX_FUNCTION_WRITE_UID = 248

procedure TBrickletDMX.SetResponseExpected(const functionId: byte; const responseExpected: 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:

• BRICKLET_DMX_FUNCTION_SET_DMX_MODE = 1
• BRICKLET_DMX_FUNCTION_WRITE_FRAME = 3
• BRICKLET_DMX_FUNCTION_SET_FRAME_DURATION = 5
• BRICKLET_DMX_FUNCTION_SET_COMMUNICATION_LED_CONFIG = 8
• BRICKLET_DMX_FUNCTION_SET_ERROR_LED_CONFIG = 10
• BRICKLET_DMX_FUNCTION_SET_FRAME_CALLBACK_CONFIG = 12
• BRICKLET_DMX_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BRICKLET_DMX_FUNCTION_SET_STATUS_LED_CONFIG = 239
• BRICKLET_DMX_FUNCTION_RESET = 243
• BRICKLET_DMX_FUNCTION_WRITE_UID = 248

procedure TBrickletDMX.SetResponseExpectedAll(const responseExpected: 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 TBrickletDMX.SetBootloaderMode(const mode: byte): 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:

• BRICKLET_DMX_BOOTLOADER_MODE_BOOTLOADER = 0
• BRICKLET_DMX_BOOTLOADER_MODE_FIRMWARE = 1
• BRICKLET_DMX_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BRICKLET_DMX_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BRICKLET_DMX_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

• BRICKLET_DMX_BOOTLOADER_STATUS_OK = 0
• BRICKLET_DMX_BOOTLOADER_STATUS_INVALID_MODE = 1
• BRICKLET_DMX_BOOTLOADER_STATUS_NO_CHANGE = 2
• BRICKLET_DMX_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• BRICKLET_DMX_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• BRICKLET_DMX_BOOTLOADER_STATUS_CRC_MISMATCH = 5

function TBrickletDMX.GetBootloaderMode: 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:

• BRICKLET_DMX_BOOTLOADER_MODE_BOOTLOADER = 0
• BRICKLET_DMX_BOOTLOADER_MODE_FIRMWARE = 1
• BRICKLET_DMX_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BRICKLET_DMX_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BRICKLET_DMX_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

procedure TBrickletDMX.SetWriteFirmwarePointer(const pointer: longword)¶

Parameter:	pointer – Typ: longword, 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 TBrickletDMX.WriteFirmware(const data: array [0..63] of byte): byte¶

Parameter:	data – Typ: array [0..63] of byte, 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.

procedure TBrickletDMX.WriteUID(const uid: longword)¶

Parameter:	uid – Typ: longword, 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 TBrickletDMX.ReadUID: longword¶

Rückgabe:	uid – Typ: longword, 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 BRICKLET_DMX_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein DMX Bricklet zu identifizieren.

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

const BRICKLET_DMX_DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines DMX Bricklet dar.