Rust - DMX Bricklet

This is the description of the Rust API bindings for the DMX Bricklet. General information and technical specifications for the DMX Bricklet are summarized in its hardware description.

An installation guide for the Rust API bindings is part of their general description. Additional documentation can be found on docs.rs.

Examples

The example code below is Public Domain (CC0 1.0).

Simple

Download (example_simple.rs)

 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
use std::{error::Error, io};

use tinkerforge::{dmx_bricklet::*, ip_connection::IpConnection};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your DMX Bricklet.

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let dmx = DmxBricklet::new(UID, &ipcon); // Create device object.

    ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
                                          // Don't use device before ipcon is connected.

    // Configure Bricklet as DMX master
    dmx.set_dmx_mode(DMX_BRICKLET_DMX_MODE_MASTER);

    // Write DMX frame with 3 channels
    dmx.write_frame(&[255, 128, 0]);

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    ipcon.disconnect();
    Ok(())
}

API

To allow non-blocking usage, nearly every function of the Rust bindings returns a wrapper around a mpsc::Receiver. To block until the function has finished and get your result, call one of the receiver's recv variants. Those return either the result sent by the device, or any error occured.

Functions returning a result directly will block until the device has finished processing the request.

All functions listed below are thread-safe, those which return a receiver are lock-free.

Basic Functions

pub fn DmxBricklet::new(uid: &str, ip_connection: &IpConnection) → DmxBricklet

Creates a new DmxBricklet object with the unique device ID uid and adds it to the IPConnection ipcon:

This device object can be used after the IP connection has been connected (see examples above).

pub fn DmxBricklet::set_dmx_mode(&self, dmx_mode: u8) → ConvertingReceiver<()>

Sets the DMX mode to either master or slave.

Calling this function sets frame number to 0.

The default value is 0 (master).

The following constants are available for this function:

  • DMX_BRICKLET_DMX_MODE_MASTER = 0
  • DMX_BRICKLET_DMX_MODE_SLAVE = 1
pub fn DmxBricklet::get_dmx_mode(&self) → ConvertingReceiver<u8>

Returns the DMX mode, as set by DmxBricklet::set_dmx_mode.

The following constants are available for this function:

  • DMX_BRICKLET_DMX_MODE_MASTER = 0
  • DMX_BRICKLET_DMX_MODE_SLAVE = 1
pub fn DmxBricklet::write_frame(&self, frame: u8) → Result<(), BrickletRecvTimeoutError>

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

The next frame can be written after the DmxBricklet::get_frame_started_callback_receiver 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 DmxBricklet::set_frame_duration.

Generic approach:

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

This function can only be called in master mode.

pub fn DmxBricklet::read_frame(&self) → Result<(Vec<u8>, u32), BrickletRecvTimeoutError>

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 DmxBricklet::get_frame_available_callback_receiver callback was called.

Generic approach:

Instead of polling this function you can also use the DmxBricklet::get_frame_callback_receiver callback. You can enable it with DmxBricklet::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.

pub fn DmxBricklet::set_frame_duration(&self, frame_duration: u16) → ConvertingReceiver<()>

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

pub fn DmxBricklet::get_frame_duration(&self) → ConvertingReceiver<u16>

Returns the frame duration as set by DmxBricklet::set_frame_duration.

Advanced Functions

pub fn DmxBricklet::get_frame_error_count(&self) → ConvertingReceiver<FrameErrorCount>

Returns the current number of overrun and framing errors.

pub fn DmxBricklet::set_communication_led_config(&self, config: u8) → ConvertingReceiver<()>

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:

  • DMX_BRICKLET_COMMUNICATION_LED_CONFIG_OFF = 0
  • DMX_BRICKLET_COMMUNICATION_LED_CONFIG_ON = 1
  • DMX_BRICKLET_COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT = 2
  • DMX_BRICKLET_COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION = 3
pub fn DmxBricklet::get_communication_led_config(&self) → ConvertingReceiver<u8>

Returns the configuration as set by DmxBricklet::set_communication_led_config

The following constants are available for this function:

  • DMX_BRICKLET_COMMUNICATION_LED_CONFIG_OFF = 0
  • DMX_BRICKLET_COMMUNICATION_LED_CONFIG_ON = 1
  • DMX_BRICKLET_COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT = 2
  • DMX_BRICKLET_COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION = 3
pub fn DmxBricklet::set_error_led_config(&self, config: u8) → ConvertingReceiver<()>

Sets the error LED configuration.

By default the error LED turns on if there is any error (see DmxBricklet::get_frame_error_count_callback_receiver 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:

  • DMX_BRICKLET_ERROR_LED_CONFIG_OFF = 0
  • DMX_BRICKLET_ERROR_LED_CONFIG_ON = 1
  • DMX_BRICKLET_ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
  • DMX_BRICKLET_ERROR_LED_CONFIG_SHOW_ERROR = 3
pub fn DmxBricklet::get_error_led_config(&self) → ConvertingReceiver<u8>

Returns the configuration as set by DmxBricklet::set_error_led_config.

The following constants are available for this function:

  • DMX_BRICKLET_ERROR_LED_CONFIG_OFF = 0
  • DMX_BRICKLET_ERROR_LED_CONFIG_ON = 1
  • DMX_BRICKLET_ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
  • DMX_BRICKLET_ERROR_LED_CONFIG_SHOW_ERROR = 3
pub fn DmxBricklet::get_api_version(&self) → [u8; 3]

Returns the version of the API definition (major, minor, revision) 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.

pub fn DmxBricklet::get_response_expected(&mut self, function_id: u8) → bool

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 callback configuration functions it is enabled by default too, but can be disabled by DmxBricklet::set_response_expected. 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 send and errors are silently ignored, because they cannot be detected.

See DmxBricklet::set_response_expected for the list of function ID constants available for this function.

pub fn DmxBricklet::set_response_expected(&mut self, function_id: u8, response_expected: bool) → ()

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 callback 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 send and errors are silently ignored, because they cannot be detected.

The following function ID constants are available for this function:

  • DMX_BRICKLET_FUNCTION_SET_DMX_MODE = 1
  • DMX_BRICKLET_FUNCTION_WRITE_FRAME = 3
  • DMX_BRICKLET_FUNCTION_SET_FRAME_DURATION = 5
  • DMX_BRICKLET_FUNCTION_SET_COMMUNICATION_LED_CONFIG = 8
  • DMX_BRICKLET_FUNCTION_SET_ERROR_LED_CONFIG = 10
  • DMX_BRICKLET_FUNCTION_SET_FRAME_CALLBACK_CONFIG = 12
  • DMX_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • DMX_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • DMX_BRICKLET_FUNCTION_RESET = 243
  • DMX_BRICKLET_FUNCTION_WRITE_UID = 248
pub fn DmxBricklet::set_response_expected_all(&mut self, response_expected: bool) → ()

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

pub fn DmxBricklet::get_spitfp_error_count(&self) → ConvertingReceiver<SpitfpErrorCount>

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.

pub fn DmxBricklet::set_bootloader_mode(&self, mode: u8) → ConvertingReceiver<u8>

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:

  • DMX_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • DMX_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • DMX_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • DMX_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • DMX_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • DMX_BRICKLET_BOOTLOADER_STATUS_OK = 0
  • DMX_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE = 1
  • DMX_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE = 2
  • DMX_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • DMX_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • DMX_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH = 5
pub fn DmxBricklet::get_bootloader_mode(&self) → ConvertingReceiver<u8>

Returns the current bootloader mode, see DmxBricklet::set_bootloader_mode.

The following constants are available for this function:

  • DMX_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • DMX_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • DMX_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • DMX_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • DMX_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
pub fn DmxBricklet::set_write_firmware_pointer(&self, pointer: u32) → ConvertingReceiver<()>

Sets the firmware pointer for DmxBricklet::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.

pub fn DmxBricklet::write_firmware(&self, data: [u8; 64]) → ConvertingReceiver<u8>

Writes 64 Bytes of firmware at the position as written by DmxBricklet::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.

pub fn DmxBricklet::set_status_led_config(&self, config: u8) → ConvertingReceiver<()>

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:

  • DMX_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • DMX_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • DMX_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • DMX_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn DmxBricklet::get_status_led_config(&self) → ConvertingReceiver<u8>

Returns the configuration as set by DmxBricklet::set_status_led_config

The following constants are available for this function:

  • DMX_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • DMX_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • DMX_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • DMX_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn DmxBricklet::get_chip_temperature(&self) → ConvertingReceiver<i16>

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.

pub fn DmxBricklet::reset(&self) → ConvertingReceiver<()>

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!

pub fn DmxBricklet::write_uid(&self, uid: u32) → ConvertingReceiver<()>

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.

pub fn DmxBricklet::read_uid(&self) → ConvertingReceiver<u32>

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

pub fn DmxBricklet::get_identity(&self) → ConvertingReceiver<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 here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions

pub fn DmxBricklet::set_frame_callback_config(&self, frame_started_callback_enabled: bool, frame_available_callback_enabled: bool, frame_callback_enabled: bool, frame_error_count_callback_enabled: bool) → ConvertingReceiver<()>

Enables/Disables the different callbacks. By default the DmxBricklet::get_frame_started_callback_receiver callback and DmxBricklet::get_frame_available_callback_receiver callback are enabled while the DmxBricklet::get_frame_callback_receiver callback and DmxBricklet::get_frame_error_count_callback_receiver callback are disabled.

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

pub fn DmxBricklet::get_frame_callback_config(&self) → ConvertingReceiver<FrameCallbackConfig>

Returns the frame callback config as set by DmxBricklet::set_frame_callback_config.

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the corresponding get_*_callback_receiver function, which returns a receiver for callback events.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

pub fn DmxBricklet::get_frame_started_callback_receiver(&self) → ConvertingCallbackReceiver<()>

Receivers created with this function receive Frame Started events.

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

For an explanation of the general approach see DmxBricklet::write_frame.

This callback can be enabled via DmxBricklet::set_frame_callback_config.

This callback can only be triggered in master mode.

pub fn DmxBricklet::get_frame_available_callback_receiver(&self) → ConvertingCallbackReceiver<u32>

Receivers created with this function receive Frame Available events.

This callback 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 DmxBricklet::read_frame for more details.

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

This callback can be enabled via DmxBricklet::set_frame_callback_config.

This callback can only be triggered in slave mode.

pub fn DmxBricklet::get_frame_callback_receiver(&self) → ConvertingHighLevelCallbackReceiver<u8, FrameResult, FrameLowLevelEvent>

Receivers created with this function receive Frame events.

This callback 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 callback can be enabled via DmxBricklet::set_frame_callback_config.

This callback can only be triggered in slave mode.

pub fn DmxBricklet::get_frame_error_count_callback_receiver(&self) → ConvertingCallbackReceiver<FrameErrorCountEvent>

Receivers created with this function receive Frame Error Count events.

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

Constants

DmxBricklet::DEVICE_IDENTIFIER

This constant is used to identify a DMX Bricklet.

The DmxBricklet::get_identity function and the IpConnection::get_enumerate_callback_receiver callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

DmxBricklet::DEVICE_DISPLAY_NAME

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