Struct tinkerforge::rgb_led_bricklet::RgbLedBricklet

pub struct RgbLedBricklet { /* private fields */ }

Controls one RGB LED

Implementations

impl RgbLedBricklet

pub const DEVICE_IDENTIFIER: u16 = 271u16

pub const DEVICE_DISPLAY_NAME: &'static str = "RGB LED Bricklet"

pub fn new(uid: &str, ip_connection: &IpConnection) -> RgbLedBricklet

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: RgbLedBrickletFunction
) -> 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 send 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: RgbLedBrickletFunction,
    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 send 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 set_rgb_value(&self, r: u8, g: u8, b: u8) -> ConvertingReceiver<()>

Sets the rgb value for the LED. The value can be between 0 and 255.

pub fn get_rgb_value(&self) -> ConvertingReceiver<RgbValue>

Returns the rgb value of the LED as set by set_rgb_value.

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’ or ‘d’.

The device identifier numbers can be found here. |device_identifier_constant|

Trait Implementations

impl Clone for RgbLedBricklet

fn clone(&self) -> RgbLedBricklet

Returns a copy of the value.

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

Performs copy-assignment from source.