openHAB - DMX Bricklet¶

Master¶

Download (ExampleMaster.rules)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

// For this example configure your DMX Bricklet to Master Mode in Paper UI.

rule "send"
when
    System started // Replace with trigger of your choice
then
    // Change XYZ to the UID of your DMX Bricklet
    val dmxActions = getActions("tinkerforge", "tinkerforge:brickletdmx:XYZ")
    // Write DMX frame with 3 channels
    dmxActions.brickletDMXWriteFrame(newArrayList(255, 128, 0))
end

Slave¶

Download (ExampleSlave.rules)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

// For this example configure your DMX Bricklet to Slave Mode in Paper UI.

import java.util.Arrays

rule "receive"
when
    // Change XYZ to the UID of your DMX Bricklet
    Channel "tinkerforge:brickletdmx:XYZ:BrickletDMXFrameAvailable" triggered
then
    // Change XYZ to the UID of your DMX Bricklet
    val dmxActions = getActions("tinkerforge", "tinkerforge:brickletdmx:XYZ")
    val frame = dmxActions.brickletDMXReadFrame()

    logInfo("Example", "Frame Number:" + frame.get("frameNumber"))
    logInfo("Example", "Frame:" + Arrays.toString(frame.get("frame") as int[]))
end

Basic Actions¶

brickletDMXWriteFrame(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 Frame Started channel 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 the thing configuration.

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 Frame Started channel.
• Set channels for next frame.
• Wait for the Frame Started channel.
• 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.

brickletDMXGetDMXMode()¶

Return Map:	dmxMode – Type: int, Range: See constants, Default: 0

Returns the DMX mode, as set by the thing configuration.

The following constants are available for this function:

For dmxMode:

• val DMX_MODE_MASTER = 0
• val DMX_MODE_SLAVE = 1

brickletDMXReadFrame()¶

Return Map:	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 Frame Available channel was called.

Generic approach:

• Call ReadFrame() to get first frame.
• Wait for the Frame Available channel.
• Call ReadFrame() to get second frame.
• Wait for the Frame Available channel.
• and so on.

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.

brickletDMXGetFrameDuration()¶

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

Returns the frame duration as set by the thing configuration.

Advanced Actions¶

brickletDMXGetFrameErrorCount()¶

Return Map:	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.

brickletDMXGetCommunicationLEDConfig()¶

Return Map:	config – Type: int, Range: See constants, Default: 3

Returns the configuration as set by the thing configuration

The following constants are available for this function:

For config:

• val COMMUNICATION_LED_CONFIG_OFF = 0
• val COMMUNICATION_LED_CONFIG_ON = 1
• val COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT = 2
• val COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION = 3

brickletDMXGetErrorLEDConfig()¶

Return Map:	config – Type: int, Range: See constants, Default: 3

Returns the configuration as set by Clear Error LED.

The following constants are available for this function:

For config:

• val ERROR_LED_CONFIG_OFF = 0
• val ERROR_LED_CONFIG_ON = 1
• val ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
• val ERROR_LED_CONFIG_SHOW_ERROR = 3

brickletDMXGetChipTemperature()¶

Return Map:	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.

brickletDMXGetStatusLEDConfig()¶

Return Map:	config – Type: int, Range: See constants, Default: 3

Returns the configuration as set by the thing configuration

The following constants are available for this function:

For config:

• val STATUS_LED_CONFIG_OFF = 0
• val STATUS_LED_CONFIG_ON = 1
• val STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• val STATUS_LED_CONFIG_SHOW_STATUS = 3

brickletDMXGetSPITFPErrorCount()¶

Return Map:	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.

brickletDMXReset()¶

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!

brickletDMXGetIdentity()¶

Return Map:

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. 

Internal Actions¶

brickletDMXReadUID()¶

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

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