Ruby - DMX Bricklet

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

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (example_simple.rb)

 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
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_dmx'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your DMX Bricklet

ipcon = IPConnection.new # Create IP connection
dmx = BrickletDMX.new 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.set_dmx_mode BrickletDMX::DMX_MODE_MASTER

# Write DMX frame with 3 channels
dmx.write_frame [255, 128, 0]

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

API

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen

BrickletDMX::new(uid, ipcon) → dmx
Parameter:
  • uid -- str
  • ipcon -- IPConnection

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

dmx = BrickletDMX.new 'YOUR_DEVICE_UID', ipcon

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

BrickletDMX#set_dmx_mode(dmx_mode) → nil
Parameter:dmx_mode -- int

Setzt den DMX Modus entweder auf Master oder Slave.

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

Der Standardwert ist 0 (Master).

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

  • BrickletDMX::DMX_MODE_MASTER = 0
  • BrickletDMX::DMX_MODE_SLAVE = 1
BrickletDMX#get_dmx_mode → int

Gibt den DMX Modus zurück, wie von #set_dmx_mode gesetzt.

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

  • BrickletDMX::DMX_MODE_MASTER = 0
  • BrickletDMX::DMX_MODE_SLAVE = 1
BrickletDMX#write_frame(frame) → nil
Parameter:frame -- [int, int, ...]

Schreibt ein 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 ::CALLBACK_FRAME_STARTED 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 #set_frame_duration.

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 ::CALLBACK_FRAME_STARTED Callback.
  • Setze alle Kanäle für den nächsten Frame.
  • Warte auf ::CALLBACK_FRAME_STARTED 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.

BrickletDMX#read_frame → [[int, int, ...], int]

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 ::CALLBACK_FRAME_AVAILABLE Callback aufgerufen wurde.

Genereller Ansatz:

Anstatt das diese Funktion gepollt wird, kann auch der ::CALLBACK_FRAME Callback genutzt werden. Der Callback kann mit #set_frame_callback_config 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.

Das zurückgegebene Array enthält die Werte frame und frame_number.

BrickletDMX#set_frame_duration(frame_duration) → nil
Parameter:frame_duration -- int

Setzt die Dauer eines Frames in ms.

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.

Standardwert: 100ms (10 Frames pro Sekunde)

BrickletDMX#get_frame_duration → int

Gibt die Frame duration zurück die mittels #set_frame_duration gesetzt wurde.

Fortgeschrittene Funktionen

BrickletDMX#get_frame_error_count → [int, int]

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

Das zurückgegebene Array enthält die Werte overrun_error_count und framing_error_count.

BrickletDMX#set_communication_led_config(config) → nil
Parameter:config -- int

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 Bootlodermodus befindet ist die LED aus.

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

  • 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
BrickletDMX#get_communication_led_config → int

Gibt die Konfiguration zurück, wie von #set_communication_led_config gesetzt.

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

  • 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
BrickletDMX#set_error_led_config(config) → nil
Parameter:config -- int

Setzt die Konfiguration der Error-LED.

Standardmäßig geht die LED an, wenn ein Error auftritt (siehe ::CALLBACK_FRAME_ERROR_COUNT 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 Bootlodermodus befindet ist die LED aus.

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

  • 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
BrickletDMX#get_error_led_config → int

Gibt die Konfiguration zurück, wie von #set_error_led_config gesetzt.

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

  • 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
BrickletDMX#get_api_version → [int, int, int]

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.

BrickletDMX#get_response_expected(function_id) → bool
Parameter:function_id -- int

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 #set_response_expected. 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 #set_response_expected für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

BrickletDMX#set_response_expected(function_id, response_expected) → nil
Parameter:
  • function_id -- int
  • response_expected -- bool

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

  • 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
BrickletDMX#set_response_expected_all(response_expected) → nil
Parameter:response_expected -- bool

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

BrickletDMX#get_spitfp_error_count → [int, int, int, int]

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.

Das zurückgegebene Array enthält die Werte error_count_ack_checksum, error_count_message_checksum, error_count_frame und error_count_overflow.

BrickletDMX#set_bootloader_mode(mode) → int
Parameter:mode -- int

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:

  • 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
  • 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
BrickletDMX#get_bootloader_mode → int

Gibt den aktuellen Bootloader-Modus zurück, siehe #set_bootloader_mode.

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

  • 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
BrickletDMX#set_write_firmware_pointer(pointer) → nil
Parameter:pointer -- int

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.

BrickletDMX#write_firmware(data) → int
Parameter:data -- [int, int, ..61x.., int]

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.

BrickletDMX#set_status_led_config(config) → nil
Parameter:config -- int

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:

  • 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
BrickletDMX#get_status_led_config → int

Gibt die Konfiguration zurück, wie von #set_status_led_config gesetzt.

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

  • 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
BrickletDMX#get_chip_temperature → int

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.

BrickletDMX#reset → nil

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.

BrickletDMX#write_uid(uid) → nil
Parameter:uid -- int

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.

BrickletDMX#read_uid → int

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

BrickletDMX#get_identity → [str, str, str, [int, int, int], [int, int, int], int]

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.

Das zurückgegebene Array enthält die Werte uid, connected_uid, position, hardware_version, firmware_version und device_identifier.

Konfigurationsfunktionen für Callbacks

BrickletDMX#register_callback(callback_id) { |param [, ...]| block } → nil
Parameter:callback_id -- int

Registriert den block für die gegebene callback_id.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

BrickletDMX#set_frame_callback_config(frame_started_callback_enabled, frame_available_callback_enabled, frame_callback_enabled, frame_error_count_callback_enabled) → nil
Parameter:
  • frame_started_callback_enabled -- bool
  • frame_available_callback_enabled -- bool
  • frame_callback_enabled -- bool
  • frame_error_count_callback_enabled -- bool

Aktiviert/Deaktiviert die verschiedenen Callback. Standardmäßig sind der ::CALLBACK_FRAME_STARTED Callback und der ::CALLBACK_FRAME_AVAILABLE Callback aktiviert, während der ::CALLBACK_FRAME Callback und der ::CALLBACK_FRAME_ERROR_COUNT Callback deaktiviert sind.

Wenn der ::CALLBACK_FRAME Callback aktiviert wird dann kann der ::CALLBACK_FRAME_AVAILABLE Callback deaktiviert werden, da dieser dann redundant ist.

BrickletDMX#get_frame_callback_config → [bool, bool, bool, bool]

Gibt die Frame Callback Konfiguration zurück, wie von #set_frame_callback_config gesetzt.

Das zurückgegebene Array enthält die Werte frame_started_callback_enabled, frame_available_callback_enabled, frame_callback_enabled und frame_error_count_callback_enabled.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der Funktion #register_callback des Geräte Objektes durchgeführt werden. Der erste Parameter ist der Callback ID und der zweite Parameter der Block:

dmx.register_callback BrickletDMX::CALLBACK_EXAMPLE, do |param|
  puts "#{param}"
end

Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen 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.

BrickletDMX::CALLBACK_FRAME_STARTED

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 #write_frame.

Der Callback kann mittels #set_frame_callback_config aktiviert werden.

Dieser Callback wird nur im Master Modus ausgelöst.

BrickletDMX::CALLBACK_FRAME_AVAILABLE
Parameter:frame_number -- int

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 #read_frame 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 #set_frame_callback_config aktiviert werden.

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

BrickletDMX::CALLBACK_FRAME
Parameter:
  • frame -- [int, int, ...]
  • frame_number -- int

Dieser Callback wird aufgerufen sobald ein neuer Frame verfügbar ist (vim 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 #set_frame_callback_config aktiviert werden.

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

BrickletDMX::CALLBACK_FRAME_ERROR_COUNT
Parameter:
  • overrun_error_count -- int
  • framing_error_count -- int

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

Konstanten

BrickletDMX::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein DMX Bricklet zu identifizieren.

Die #get_identity() Funktion und der IPConnection::CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

BrickletDMX::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines DMX Bricklet dar.