Struct tinkerforge::dmx_bricklet::DmxBricklet

pub struct DmxBricklet { /* private fields */ }

DMX master and slave

Implementations

impl DmxBricklet

pub const DEVICE_IDENTIFIER: u16 = 285u16

pub const DEVICE_DISPLAY_NAME: &'static str = "DMX Bricklet"

pub fn new<T: GetRequestSender>(uid: &str, req_sender: T) -> DmxBricklet

Creates an object with the unique device ID uid. This object can then be used after the IP Connection ip_connection is connected.

pub fn get_response_expected( &mut self, fun: DmxBrickletFunction ) -> Result<bool, GetResponseExpectedError>

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

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

pub fn set_response_expected( &mut self, fun: DmxBrickletFunction, response_expected: bool ) -> Result<(), SetResponseExpectedError>

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

pub fn 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 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 get_frame_started_callback_receiver( &self ) -> ConvertingCallbackReceiver<()>

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

For an explanation of the general approach see write_frame.

This receiver can be enabled via set_frame_callback_config.

This receiver can only be triggered in master mode.

pub fn get_frame_available_callback_receiver( &self ) -> ConvertingCallbackReceiver<u32>

This receiver 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 [read_frame] for more details.

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

This receiver can be enabled via [set_frame_callback_config].

This receiver can only be triggered in slave mode.

pub fn get_frame_low_level_callback_receiver( &self ) -> ConvertingCallbackReceiver<FrameLowLevelEvent>

See get_frame_callback_receiver

pub fn get_frame_callback_receiver( &self ) -> ConvertingHighLevelCallbackReceiver<u8, FrameResult, FrameLowLevelEvent>

This receiver 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 receiver can be enabled via [set_frame_callback_config].

This receiver can only be triggered in slave mode.

pub fn get_frame_error_count_callback_receiver( &self ) -> ConvertingCallbackReceiver<FrameErrorCountEvent>

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

pub fn 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.

Associated constants:

• DMX_BRICKLET_DMX_MODE_MASTER
• DMX_BRICKLET_DMX_MODE_SLAVE

pub fn get_dmx_mode(&self) -> ConvertingReceiver<u8>

Returns the DMX mode, as set by [set_dmx_mode].

Associated constants:

• DMX_BRICKLET_DMX_MODE_MASTER
• DMX_BRICKLET_DMX_MODE_SLAVE

pub fn write_frame_low_level( &self, frame_length: u16, frame_chunk_offset: u16, frame_chunk_data: [u8; 60] ) -> ConvertingReceiver<WriteFrameLowLevel>

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

The next frame can be written after the [get_frame_started_callback_receiver] receiver 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 [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 [get_frame_started_callback_receiver] receiver.
• Set channels for next frame.
• Wait for the [get_frame_started_callback_receiver] receiver.
• 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.

pub fn 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 [get_frame_started_callback_receiver] receiver 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 [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 [get_frame_started_callback_receiver] receiver.
• Set channels for next frame.
• Wait for the [get_frame_started_callback_receiver] receiver.
• 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.

pub fn read_frame_low_level(&self) -> ConvertingReceiver<ReadFrameLowLevel>

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 [get_frame_available_callback_receiver] receiver was called.

Generic approach:

• Call [read_frame] to get first frame.
• Wait for the [get_frame_available_callback_receiver] receiver.
• Call [read_frame] to get second frame.
• Wait for the [get_frame_available_callback_receiver] receiver.
• and so on.

Instead of polling this function you can also use the [get_frame_callback_receiver] receiver. You can enable it with [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 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 [get_frame_available_callback_receiver] receiver was called.

Generic approach:

• Call [read_frame] to get first frame.
• Wait for the [get_frame_available_callback_receiver] receiver.
• Call [read_frame] to get second frame.
• Wait for the [get_frame_available_callback_receiver] receiver.
• and so on.

Instead of polling this function you can also use the [get_frame_callback_receiver] receiver. You can enable it with [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 set_frame_duration(&self, frame_duration: u16) -> ConvertingReceiver<()>

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.

pub fn get_frame_duration(&self) -> ConvertingReceiver<u16>

Returns the frame duration as set by [set_frame_duration].

pub fn get_frame_error_count(&self) -> ConvertingReceiver<FrameErrorCount>

Returns the current number of overrun and framing errors.

pub fn 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.

Associated constants:

• DMX_BRICKLET_COMMUNICATION_LED_CONFIG_OFF
• DMX_BRICKLET_COMMUNICATION_LED_CONFIG_ON
• DMX_BRICKLET_COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT
• DMX_BRICKLET_COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION

pub fn get_communication_led_config(&self) -> ConvertingReceiver<u8>

Returns the configuration as set by [set_communication_led_config]

Associated constants:

• DMX_BRICKLET_COMMUNICATION_LED_CONFIG_OFF
• DMX_BRICKLET_COMMUNICATION_LED_CONFIG_ON
• DMX_BRICKLET_COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT
• DMX_BRICKLET_COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION

pub fn 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 [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.

Associated constants:

• DMX_BRICKLET_ERROR_LED_CONFIG_OFF
• DMX_BRICKLET_ERROR_LED_CONFIG_ON
• DMX_BRICKLET_ERROR_LED_CONFIG_SHOW_HEARTBEAT
• DMX_BRICKLET_ERROR_LED_CONFIG_SHOW_ERROR

pub fn get_error_led_config(&self) -> ConvertingReceiver<u8>

Returns the configuration as set by [set_error_led_config].

Associated constants:

• DMX_BRICKLET_ERROR_LED_CONFIG_OFF
• DMX_BRICKLET_ERROR_LED_CONFIG_ON
• DMX_BRICKLET_ERROR_LED_CONFIG_SHOW_HEARTBEAT
• DMX_BRICKLET_ERROR_LED_CONFIG_SHOW_ERROR

pub fn 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 receivers. By default the [get_frame_started_callback_receiver] receiver and [get_frame_available_callback_receiver] receiver are enabled while the [get_frame_callback_receiver] receiver and [get_frame_error_count_callback_receiver] receiver are disabled.

If you want to use the [get_frame_callback_receiver] receiver you can enable it and disable the [get_frame_available_callback_receiver] receiver at the same time. It becomes redundant in this case.

pub fn get_frame_callback_config( &self ) -> ConvertingReceiver<FrameCallbackConfig>

Returns the frame receiver config as set by [set_frame_callback_config].

pub fn 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 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.

Associated constants:

• DMX_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
• DMX_BRICKLET_BOOTLOADER_MODE_FIRMWARE
• DMX_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
• DMX_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
• DMX_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
• DMX_BRICKLET_BOOTLOADER_STATUS_OK
• DMX_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE
• DMX_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE
• DMX_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
• DMX_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
• DMX_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH

pub fn get_bootloader_mode(&self) -> ConvertingReceiver<u8>

Returns the current bootloader mode, see [set_bootloader_mode].

Associated constants:

• DMX_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
• DMX_BRICKLET_BOOTLOADER_MODE_FIRMWARE
• DMX_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
• DMX_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
• DMX_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT

pub fn set_write_firmware_pointer(&self, pointer: u32) -> ConvertingReceiver<()>

Sets the firmware pointer for [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 write_firmware(&self, data: [u8; 64]) -> ConvertingReceiver<u8>

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

Associated constants:

• DMX_BRICKLET_STATUS_LED_CONFIG_OFF
• DMX_BRICKLET_STATUS_LED_CONFIG_ON
• DMX_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
• DMX_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

pub fn get_status_led_config(&self) -> ConvertingReceiver<u8>

Returns the configuration as set by [set_status_led_config]

Associated constants:

• DMX_BRICKLET_STATUS_LED_CONFIG_OFF
• DMX_BRICKLET_STATUS_LED_CONFIG_ON
• DMX_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
• DMX_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

pub fn get_chip_temperature(&self) -> ConvertingReceiver<i16>

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.

pub fn 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 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 read_uid(&self) -> ConvertingReceiver<u32>

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

pub fn 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’, ‘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. |device_identifier_constant|

Trait Implementations

impl Clone for DmxBricklet

fn clone(&self) -> DmxBricklet

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.