Java - DMX Bricklet¶

Simple¶

Download (ExampleSimple.java)

 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

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletDMX;

public class ExampleSimple {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your DMX Bricklet
    private static final String UID = "XYZ";

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletDMX dmx = 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 int[]{255, 128, 0});

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

Basic Functions¶

class BrickletDMX(String uid, IPConnection ipcon)¶

Parameters:	uid – Type: String ipcon – Type: IPConnection
Returns:	dmx – Type: BrickletDMX

Creates an object with the unique device ID uid:

BrickletDMX dmx = new BrickletDMX("YOUR_DEVICE_UID", ipcon);

This object can then be used after the IP Connection is connected.

void BrickletDMX.setDMXMode(int dmxMode)¶

Parameters:	dmxMode – Type: int, Range: See constants, Default: 0

Sets the DMX mode to either master or slave.

Calling this function sets frame number to 0.

The following constants are available for this function:

For dmxMode:

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

int BrickletDMX.getDMXMode()¶

Returns:	dmxMode – Type: int, Range: See constants, Default: 0

Returns the DMX mode, as set by setDMXMode().

The following constants are available for this function:

For dmxMode:

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

void BrickletDMX.writeFrame(int[] frame)¶

Parameters:	frame – Type: int[], Length: variable, Range: [0 to 255]

Writes a DMX frame. The maximum frame size is 512 byte. Each byte represents one channel.

The next frame can be written after the FrameStartedListener listener was called. The frame is double buffered, so a new frame can be written as soon as the writing of the prior frame starts.

The data will be transfered when the next frame duration ends, see setFrameDuration().

Generic approach:

• Set the frame duration to a value that represents the number of frames per second you want to achieve.
• Set channels for first frame.
• Wait for the FrameStartedListener listener.
• Set channels for next frame.
• Wait for the FrameStartedListener listener.
• and so on.

This approach ensures that you can set new DMX data with a fixed frame rate.

This function can only be called in master mode.

BrickletDMX.ReadFrame BrickletDMX.readFrame()¶

Return Object:	frame – Type: int[], Length: variable, Range: [0 to 255] frameNumber – Type: long, Range: [0 to 232 - 1]

Returns the last frame that was written by the DMX master. The size of the array is equivalent to the number of channels in the frame. Each byte represents one channel.

The next frame is available after the FrameAvailableListener listener was called.

Generic approach:

• Call readFrame() to get first frame.
• Wait for the FrameAvailableListener listener.
• Call readFrame() to get second frame.
• Wait for the FrameAvailableListener listener.
• and so on.

Instead of polling this function you can also use the FrameListener listener. You can enable it with setFrameCallbackConfig().

The frame number starts at 0 and it is increased by one with each received frame.

This function can only be called in slave mode.

void BrickletDMX.setFrameDuration(int frameDuration)¶

Parameters:	frameDuration – Type: int, Unit: 1 ms, Range: [0 to 216 - 1], Default: 100

Sets the duration of a frame.

Example: If you want to achieve 20 frames per second, you should set the frame duration to 50ms (50ms * 20 = 1 second).

If you always want to send a frame as fast as possible you can set this value to 0.

This setting is only used in master mode.

int BrickletDMX.getFrameDuration()¶

Returns:	frameDuration – Type: int, Unit: 1 ms, Range: [0 to 216 - 1], Default: 100

Returns the frame duration as set by setFrameDuration().

Advanced Functions¶

BrickletDMX.FrameErrorCount BrickletDMX.getFrameErrorCount()¶

Return Object:	overrunErrorCount – Type: long, Range: [0 to 232 - 1] framingErrorCount – Type: long, Range: [0 to 232 - 1]

Returns the current number of overrun and framing errors.

void BrickletDMX.setCommunicationLEDConfig(int config)¶

Parameters:	config – Type: int, Range: See constants, Default: 3

Sets the communication LED configuration. By default the LED shows communication traffic, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is off.

The following constants are available for this function:

For 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

int BrickletDMX.getCommunicationLEDConfig()¶

Returns:	config – Type: int, Range: See constants, Default: 3

Returns the configuration as set by setCommunicationLEDConfig()

The following constants are available for this function:

For 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

void BrickletDMX.setErrorLEDConfig(int config)¶

Parameters:	config – Type: int, Range: See constants, Default: 3

Sets the error LED configuration.

By default the error LED turns on if there is any error (see FrameErrorCountListener callback). If you call this function with the Show-Error option again, the LED will turn off until the next error occurs.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is off.

The following constants are available for this function:

For 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

int BrickletDMX.getErrorLEDConfig()¶

Returns:	config – Type: int, Range: See constants, Default: 3

Returns the configuration as set by setErrorLEDConfig().

The following constants are available for this function:

For 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

BrickletDMX.SPITFPErrorCount BrickletDMX.getSPITFPErrorCount()¶

Return Object:	errorCountAckChecksum – Type: long, Range: [0 to 232 - 1] errorCountMessageChecksum – Type: long, Range: [0 to 232 - 1] errorCountFrame – Type: long, Range: [0 to 232 - 1] errorCountOverflow – Type: long, Range: [0 to 232 - 1]

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

• ACK checksum errors,
• message checksum errors,
• framing errors and
• overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

void BrickletDMX.setStatusLEDConfig(int config)¶

Parameters:	config – Type: int, Range: See constants, Default: 3

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following constants are available for this function:

For 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

int BrickletDMX.getStatusLEDConfig()¶

Returns:	config – Type: int, Range: See constants, Default: 3

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

For 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

int BrickletDMX.getChipTemperature()¶

Returns:	temperature – Type: int, Unit: 1 °C, Range: [-215 to 215 - 1]

Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

void BrickletDMX.reset()¶

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

BrickletDMX.Identity BrickletDMX.getIdentity()¶

Return Object:

uid – Type: String, Length: up to 8 connectedUid – Type: String, Length: up to 8 position – Type: char, Range: ['a' to 'h', 'z'] hardwareVersion – Type: short[], Length: 3 0: major – Type: short, Range: [0 to 255] 1: minor – Type: short, Range: [0 to 255] 2: revision – Type: short, Range: [0 to 255] firmwareVersion – Type: short[], Length: 3 0: major – Type: short, Range: [0 to 255] 1: minor – Type: short, Range: [0 to 255] 2: revision – Type: short, Range: [0 to 255] deviceIdentifier – Type: int, Range: [0 to 216 - 1]

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Listener Configuration Functions¶

void BrickletDMX.setFrameCallbackConfig(boolean frameStartedCallbackEnabled, boolean frameAvailableCallbackEnabled, boolean frameCallbackEnabled, boolean frameErrorCountCallbackEnabled)¶

Parameters:	frameStartedCallbackEnabled – Type: boolean, Default: true frameAvailableCallbackEnabled – Type: boolean, Default: true frameCallbackEnabled – Type: boolean, Default: false frameErrorCountCallbackEnabled – Type: boolean, Default: false

Enables/Disables the different listeners. By default the FrameStartedListener listener and FrameAvailableListener listener are enabled while the FrameListener listener and FrameErrorCountListener listener are disabled.

If you want to use the FrameListener listener you can enable it and disable the FrameAvailableListener listener at the same time. It becomes redundant in this case.

BrickletDMX.FrameCallbackConfig BrickletDMX.getFrameCallbackConfig()¶

Return Object:	frameStartedCallbackEnabled – Type: boolean, Default: true frameAvailableCallbackEnabled – Type: boolean, Default: true frameCallbackEnabled – Type: boolean, Default: false frameErrorCountCallbackEnabled – Type: boolean, Default: false

Returns the frame listener config as set by setFrameCallbackConfig().

Listeners¶

Listeners can be registered to receive time critical or recurring data from the device. The registration is done with add*Listener() functions of the device object.

The parameter is a listener class object, for example:

device.addExampleListener(new BrickletDMX.ExampleListener() {
    public void property(int value) {
        System.out.println("Value: " + value);
    }
});

The available listener classes with inherent methods to be overwritten are described below. It is possible to add several listeners and to remove them with the corresponding remove*Listener() function.

class BrickletDMX.FrameStartedListener()¶

This listener can be added with the addFrameStartedListener() function. An added listener can be removed with the removeFrameStartedListener() function.

void frameStarted()

This listener is triggered as soon as a new frame write is started. You should send the data for the next frame directly after this listener was triggered.

For an explanation of the general approach see writeFrame().

This listener can be enabled via setFrameCallbackConfig().

This listener can only be triggered in master mode.

class BrickletDMX.FrameAvailableListener()¶

This listener can be added with the addFrameAvailableListener() function. An added listener can be removed with the removeFrameAvailableListener() function.

void frameAvailable(long frameNumber)

Parameters:	frameNumber – Type: long, Range: [0 to 232 - 1]

This listener is triggered in slave mode when a new frame was received from the DMX master and it can be read out. You have to read the frame before the master has written the next frame, see readFrame() for more details.

The parameter is the frame number, it is increased by one with each received frame.

This listener can be enabled via setFrameCallbackConfig().

This listener can only be triggered in slave mode.

class BrickletDMX.FrameListener()¶

This listener can be added with the addFrameListener() function. An added listener can be removed with the removeFrameListener() function.

void frame(int[] frame, long frameNumber)

Parameters:	frame – Type: int[], Length: variable, Range: [0 to 255] frameNumber – Type: long, Range: [0 to 232 - 1]

This listener is called as soon as a new frame is available (written by the DMX master).

The size of the array is equivalent to the number of channels in the frame. Each byte represents one channel.

This listener can be enabled via setFrameCallbackConfig().

This listener can only be triggered in slave mode.

Note

If reconstructing the value fails, the listener is triggered with null for frame.

class BrickletDMX.FrameErrorCountListener()¶

This listener can be added with the addFrameErrorCountListener() function. An added listener can be removed with the removeFrameErrorCountListener() function.

void frameErrorCount(long overrunErrorCount, long framingErrorCount)

Parameters:	overrunErrorCount – Type: long, Range: [0 to 232 - 1] framingErrorCount – Type: long, Range: [0 to 232 - 1]

This listener is called if a new error occurs. It returns the current overrun and framing error count.

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

short[] BrickletDMX.getAPIVersion()¶

Return Object:	apiVersion – Type: short[], Length: 3 0: major – Type: short, Range: [0 to 255] 1: minor – Type: short, Range: [0 to 255] 2: revision – Type: short, Range: [0 to 255]

Returns the version of the API definition implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

boolean BrickletDMX.getResponseExpected(byte functionId)¶

Parameters:	functionId – Type: byte, Range: See constants
Returns:	responseExpected – Type: boolean

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For listener configuration functions it is enabled by default too, but can be disabled by setResponseExpected(). For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For 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

void BrickletDMX.setResponseExpected(byte functionId, boolean responseExpected)¶

Parameters:	functionId – Type: byte, Range: See constants responseExpected – Type: boolean

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and listener configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For 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

void BrickletDMX.setResponseExpectedAll(boolean responseExpected)¶

Parameters:	responseExpected – Type: boolean

Changes the response expected flag for all setter and listener configuration functions of this device at once.

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

int BrickletDMX.setBootloaderMode(int mode)¶

Parameters:	mode – Type: int, Range: See constants
Returns:	status – Type: int, Range: See constants

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following constants are available for this function:

For 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

For 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

int BrickletDMX.getBootloaderMode()¶

Returns:	mode – Type: int, Range: See constants

Returns the current bootloader mode, see setBootloaderMode().

The following constants are available for this function:

For 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

void BrickletDMX.setWriteFirmwarePointer(long pointer)¶

Parameters:	pointer – Type: long, Unit: 1 B, Range: [0 to 232 - 1]

Sets the firmware pointer for writeFirmware(). The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

int BrickletDMX.writeFirmware(int[] data)¶

Parameters:	data – Type: int[], Length: 64, Range: [0 to 255]
Returns:	status – Type: int, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by setWriteFirmwarePointer() before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

void BrickletDMX.writeUID(long uid)¶

Parameters:	uid – Type: long, Range: [0 to 232 - 1]

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

long BrickletDMX.readUID()¶

Returns:	uid – Type: long, Range: [0 to 232 - 1]

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

Constants¶

int BrickletDMX.DEVICE_IDENTIFIER¶

This constant is used to identify a DMX Bricklet.

The getIdentity() function and the IPConnection.EnumerateListener listener of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

String BrickletDMX.DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a DMX Bricklet.