Struct tinkerforge::rgb_led_bricklet::RgbLedBricklet
source · pub struct RgbLedBricklet { /* private fields */ }
Expand description
Controls one RGB LED
Implementations§
source§impl RgbLedBricklet
impl RgbLedBricklet
pub const DEVICE_IDENTIFIER: u16 = 271u16
pub const DEVICE_DISPLAY_NAME: &'static str = "RGB LED Bricklet"
sourcepub fn new<T: GetRequestSender>(uid: &str, req_sender: T) -> RgbLedBricklet
pub fn new<T: GetRequestSender>(uid: &str, req_sender: T) -> RgbLedBricklet
Creates an object with the unique device ID uid
. This object can then be used after the IP Connection ip_connection
is connected.
sourcepub fn get_response_expected(
&mut self,
fun: RgbLedBrickletFunction
) -> Result<bool, GetResponseExpectedError>
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 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.
sourcepub fn set_response_expected(
&mut self,
fun: RgbLedBrickletFunction,
response_expected: bool
) -> Result<(), SetResponseExpectedError>
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 sent and errors are silently ignored, because they cannot be detected.
sourcepub fn set_response_expected_all(&mut self, response_expected: bool)
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.
sourcepub fn get_api_version(&self) -> [u8; 3]
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.
sourcepub fn set_rgb_value(&self, r: u8, g: u8, b: u8) -> ConvertingReceiver<()>
pub fn set_rgb_value(&self, r: u8, g: u8, b: u8) -> ConvertingReceiver<()>
Sets the r, g and b values for the LED.
sourcepub fn get_rgb_value(&self) -> ConvertingReceiver<RgbValue>
pub fn get_rgb_value(&self) -> ConvertingReceiver<RgbValue>
Returns the r, g and b values of the LED as set by [set_rgb_value
].
sourcepub fn get_identity(&self) -> ConvertingReceiver<Identity>
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§
source§impl Clone for RgbLedBricklet
impl Clone for RgbLedBricklet
source§fn clone(&self) -> RgbLedBricklet
fn clone(&self) -> RgbLedBricklet
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more