/ 
Tinkerforge-2.1.16
River stage zero No dependents
/ Tinkerforge::BrickletDMX

NAME

Tinkerforge::BrickletDMX - DMX master and slave

CONSTANTS

DEVICE_IDENTIFIER

This constant is used to identify a DMX Bricklet.

The get_identity() subroutine and the CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

DEVICE_DISPLAY_NAME

This constant represents the display name of a DMX Bricklet.

CALLBACK_FRAME_STARTED

This constant is used with the register_callback() subroutine to specify the CALLBACK_FRAME_STARTED callback.

CALLBACK_FRAME_AVAILABLE

This constant is used with the register_callback() subroutine to specify the CALLBACK_FRAME_AVAILABLE callback.

CALLBACK_FRAME_LOW_LEVEL

This constant is used with the register_callback() subroutine to specify the CALLBACK_FRAME_LOW_LEVEL callback.

CALLBACK_FRAME_ERROR_COUNT

This constant is used with the register_callback() subroutine to specify the CALLBACK_FRAME_ERROR_COUNT callback.

CALLBACK_FRAME

This constant is used with the register_callback() subroutine to specify the CALLBACK_FRAME callback.

FUNCTION_SET_DMX_MODE

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_DMX_MODE

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_WRITE_FRAME_LOW_LEVEL

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_READ_FRAME_LOW_LEVEL

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_FRAME_DURATION

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_FRAME_DURATION

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_FRAME_ERROR_COUNT

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_COMMUNICATION_LED_CONFIG

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_COMMUNICATION_LED_CONFIG

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_ERROR_LED_CONFIG

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_ERROR_LED_CONFIG

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_FRAME_CALLBACK_CONFIG

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_FRAME_CALLBACK_CONFIG

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_SPITFP_ERROR_COUNT

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_BOOTLOADER_MODE

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_BOOTLOADER_MODE

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_WRITE_FIRMWARE_POINTER

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_WRITE_FIRMWARE

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_STATUS_LED_CONFIG

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_STATUS_LED_CONFIG

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_CHIP_TEMPERATURE

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_RESET

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_WRITE_UID

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_READ_UID

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_IDENTITY

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTIONS

new()

Creates an object with the unique device ID *uid* and adds it to the IP Connection *ipcon*.

set_dmx_mode()

Sets the DMX mode to either master or slave.

Calling this function sets frame number to 0.

get_dmx_mode()

Returns the DMX mode, as set by func:`Set DMX Mode`.

write_frame_low_level()

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

The next frame can be written after the :cb:`Frame Started` callback 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 :func:`Set Frame Duration`.

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 :cb:`Frame Started` callback. * Set channels for next frame. * Wait for the :cb:`Frame Started` callback. * 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.

read_frame_low_level()

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 :cb:`Frame Available` callback was called.

Generic approach:

* Call :func:`Read Frame` to get first frame. * Wait for the :cb:`Frame Available` callback. * Call :func:`Read Frame` to get second frame. * Wait for the :cb:`Frame Available` callback. * and so on.

Instead of polling this function you can also use the :cb:`Frame` callback. You can enable it with :func:`Set Frame Callback Config`.

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.

set_frame_duration()

Sets the duration of a frame in ms.

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.

Default value: 100ms (10 frames per second).

get_frame_duration()

Returns the frame duration as set by :func:`Set Frame Duration`.

get_frame_error_count()

Returns the current number of overrun and framing errors.

set_communication_led_config()

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.

get_communication_led_config()

Returns the configuration as set by :func:`Set Communication LED Config`

set_error_led_config()

Sets the error LED configuration.

By default the error LED turns on if there is any error (see :cb:`Frame Error Count` 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.

get_error_led_config()

Returns the configuration as set by :func:`Set Error LED Config`.

set_frame_callback_config()

Enables/Disables the different callbacks. By default the :cb:`Frame Started` callback and :cb:`Frame Available` callback are enabled while the :cb:`Frame` callback and :cb:`Frame Error Count` callback are disabled.

If you want to use the :cb:`Frame` callback you can enable it and disable the cb:`Frame Available` callback at the same time. It becomes redundant in this case.

get_frame_callback_config()

Returns the frame callback config as set by :func:`Set Frame Callback Config`.

get_spitfp_error_count()

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

The errors are divided into

* ack checksum errors, * message checksum errors, * frameing 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.

set_bootloader_mode()

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 und 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.

get_bootloader_mode()

Returns the current bootloader mode, see :func:`Set Bootloader Mode`.

set_write_firmware_pointer()

Sets the firmware pointer for :func:`Write Firmware`. 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.

write_firmware()

Writes 64 Bytes of firmware at the position as written by :func:`Set Write Firmware Pointer` 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.

set_status_led_config()

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.

get_status_led_config()

Returns the configuration as set by :func:`Set Status LED Config`

get_chip_temperature()

Returns the temperature in °C 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.

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!

write_uid()

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.

read_uid()

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

get_identity()

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' or 'd'.

The device identifier numbers can be found :ref:`here <device_identifier>`. |device_identifier_constant|

write_frame()

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

The next frame can be written after the :cb:`Frame Started` callback 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 :func:`Set Frame Duration`.

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 :cb:`Frame Started` callback. * Set channels for next frame. * Wait for the :cb:`Frame Started` callback. * 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.

read_frame()

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 :cb:`Frame Available` callback was called.

Generic approach:

* Call :func:`Read Frame` to get first frame. * Wait for the :cb:`Frame Available` callback. * Call :func:`Read Frame` to get second frame. * Wait for the :cb:`Frame Available` callback. * and so on.

Instead of polling this function you can also use the :cb:`Frame` callback. You can enable it with :func:`Set Frame Callback Config`.

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.