Struct tinkerforge::io4_bricklet::Io4Bricklet
source · pub struct Io4Bricklet { /* private fields */ }
Expand description
4-channel digital input/output
Implementations
sourceimpl Io4Bricklet
impl Io4Bricklet
pub const DEVICE_IDENTIFIER: u16 = 29u16
pub const DEVICE_DISPLAY_NAME: &'static str = "IO-4 Bricklet"
sourcepub fn new(uid: &str, ip_connection: &IpConnection) -> Io4Bricklet
pub fn new(uid: &str, ip_connection: &IpConnection) -> Io4Bricklet
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: Io4BrickletFunction
) -> Result<bool, GetResponseExpectedError>
pub fn get_response_expected(
&mut self,
fun: Io4BrickletFunction
) -> 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.
sourcepub fn set_response_expected(
&mut self,
fun: Io4BrickletFunction,
response_expected: bool
) -> Result<(), SetResponseExpectedError>
pub fn set_response_expected(
&mut self,
fun: Io4BrickletFunction,
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.
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_interrupt_callback_receiver(
&self
) -> ConvertingCallbackReceiver<InterruptEvent>
pub fn get_interrupt_callback_receiver(
&self
) -> ConvertingCallbackReceiver<InterruptEvent>
This receiver is triggered whenever a change of the voltage level is detected
on pins where the interrupt was activated with Set Interrupt
.
The values are a bitmask that specifies which interrupts occurred and the current value bitmask.
For example:
- (1, 1) or (0b0001, 0b0001) means that an interrupt on pin 0 occurred and currently pin 0 is high and pins 1-3 are low.
- (9, 14) or (0b1001, 0b1110) means that interrupts on pins 0 and 3 occurred and currently pin 0 is low and pins 1-3 are high.
sourcepub fn get_monoflop_done_callback_receiver(
&self
) -> ConvertingCallbackReceiver<MonoflopDoneEvent>
pub fn get_monoflop_done_callback_receiver(
&self
) -> ConvertingCallbackReceiver<MonoflopDoneEvent>
This receiver is triggered whenever a monoflop timer reaches 0. The parameters contain the involved pins and the current value of the pins (the value after the monoflop).
sourcepub fn set_value(&self, value_mask: u8) -> ConvertingReceiver<()>
pub fn set_value(&self, value_mask: u8) -> ConvertingReceiver<()>
Sets the output value (high or low) with a bitmask (4bit). A 1 in the bitmask means high and a 0 in the bitmask means low.
For example: The value 3 or 0b0011 will turn the pins 0-1 high and the pins 2-3 low.
Note
This function does nothing for pins that are configured as input.
Pull-up resistors can be switched on with Set Configuration
.
sourcepub fn get_value(&self) -> ConvertingReceiver<u8>
pub fn get_value(&self) -> ConvertingReceiver<u8>
Returns a bitmask of the values that are currently measured. This function works if the pin is configured to input as well as if it is configured to output.
sourcepub fn set_configuration(
&self,
selection_mask: u8,
direction: char,
value: bool
) -> ConvertingReceiver<()>
pub fn set_configuration(
&self,
selection_mask: u8,
direction: char,
value: bool
) -> ConvertingReceiver<()>
Configures the value and direction of the specified pins. Possible directions are ‘i’ and ‘o’ for input and output.
If the direction is configured as output, the value is either high or low (set as true or false).
If the direction is configured as input, the value is either pull-up or default (set as true or false).
For example:
- (15, ‘i’, true) or (0b1111, ‘i’, true) will set all pins of as input pull-up.
- (8, ‘i’, false) or (0b1000, ‘i’, false) will set pin 3 of as input default (floating if nothing is connected).
- (3, ‘o’, false) or (0b0011, ‘o’, false) will set pins 0 and 1 as output low.
- (4, ‘o’, true) or (0b0100, ‘o’, true) will set pin 2 of as output high.
The default configuration is input with pull-up.
Associated constants:
- IO4BRICKLET_DIRECTION_IN
- IO4BRICKLET_DIRECTION_OUT
sourcepub fn get_configuration(&self) -> ConvertingReceiver<Configuration>
pub fn get_configuration(&self) -> ConvertingReceiver<Configuration>
Returns a value bitmask and a direction bitmask. A 1 in the direction bitmask means input and a 0 in the bitmask means output.
For example: A return value of (3, 5) or (0b0011, 0b0101) for direction and value means that:
- pin 0 is configured as input pull-up,
- pin 1 is configured as input default,
- pin 2 is configured as output high and
- pin 3 is are configured as output low.
sourcepub fn set_debounce_period(&self, debounce: u32) -> ConvertingReceiver<()>
pub fn set_debounce_period(&self, debounce: u32) -> ConvertingReceiver<()>
Sets the debounce period of the get_interrupt_callback_receiver
receiver in ms.
For example: If you set this value to 100, you will get the interrupt maximal every 100ms. This is necessary if something that bounces is connected to the IO-4 Bricklet, such as a button.
The default value is 100.
sourcepub fn get_debounce_period(&self) -> ConvertingReceiver<u32>
pub fn get_debounce_period(&self) -> ConvertingReceiver<u32>
Returns the debounce period as set by Set Debounce Period
.
sourcepub fn set_interrupt(&self, interrupt_mask: u8) -> ConvertingReceiver<()>
pub fn set_interrupt(&self, interrupt_mask: u8) -> ConvertingReceiver<()>
Sets the pins on which an interrupt is activated with a bitmask. Interrupts are triggered on changes of the voltage level of the pin, i.e. changes from high to low and low to high.
For example: An interrupt bitmask of 10 or 0b1010 will enable the interrupt for pins 1 and 3.
The interrupt is delivered with the get_interrupt_callback_receiver
receiver.
sourcepub fn get_interrupt(&self) -> ConvertingReceiver<u8>
pub fn get_interrupt(&self) -> ConvertingReceiver<u8>
Returns the interrupt bitmask as set by Set Interrupt
.
sourcepub fn set_monoflop(
&self,
selection_mask: u8,
value_mask: u8,
time: u32
) -> ConvertingReceiver<()>
pub fn set_monoflop(
&self,
selection_mask: u8,
value_mask: u8,
time: u32
) -> ConvertingReceiver<()>
Configures a monoflop of the pins specified by the first parameter as 4 bit long bitmask. The specified pins must be configured for output. Non-output pins will be ignored.
The second parameter is a bitmask with the desired value of the specified output pins. A 1 in the bitmask means high and a 0 in the bitmask means low.
The third parameter indicates the time (in ms) that the pins should hold the value.
If this function is called with the parameters (9, 1, 1500) or (0b1001, 0b0001, 1500): Pin 0 will get high and pin 3 will get low. In 1.5s pin 0 will get low and pin 3 will get high again.
A monoflop can be used as a fail-safe mechanism. For example: Lets assume you have a RS485 bus and an IO-4 Bricklet connected to one of the slave stacks. You can now call this function every second, with a time parameter of two seconds and pin 0 set to high. Pin 0 will be high all the time. If now the RS485 connection is lost, then pin 0 will get low in at most two seconds.
sourcepub fn get_monoflop(&self, pin: u8) -> ConvertingReceiver<Monoflop>
pub fn get_monoflop(&self, pin: u8) -> ConvertingReceiver<Monoflop>
Returns (for the given pin) the current value and the time as set by
Set Monoflop
as well as the remaining time until the value flips.
If the timer is not running currently, the remaining time will be returned as 0.
sourcepub fn set_selected_values(
&self,
selection_mask: u8,
value_mask: u8
) -> ConvertingReceiver<()>
pub fn set_selected_values(
&self,
selection_mask: u8,
value_mask: u8
) -> ConvertingReceiver<()>
Sets the output value (high or low) with a bitmask, according to the selection mask. The bitmask is 4 bit long, true refers to high and false refers to low.
For example: The parameters (9, 4) or (0b0110, 0b0100) will turn pin 1 low and pin 2 high, pin 0 and 3 will remain untouched.
Note
This function does nothing for pins that are configured as input.
Pull-up resistors can be switched on with Set Configuration
.
sourcepub fn get_edge_count(
&self,
pin: u8,
reset_counter: bool
) -> ConvertingReceiver<u32>
pub fn get_edge_count(
&self,
pin: u8,
reset_counter: bool
) -> ConvertingReceiver<u32>
Returns the current value of the edge counter for the selected pin. You can
configure the edges that are counted with Set Edge Count Config
.
If you set the reset counter to true, the count is set back to 0 directly after it is read.
.. versionadded:: 2.0.1$nbsp;(Plugin)
sourcepub fn set_edge_count_config(
&self,
selection_mask: u8,
edge_type: u8,
debounce: u8
) -> ConvertingReceiver<()>
pub fn set_edge_count_config(
&self,
selection_mask: u8,
edge_type: u8,
debounce: u8
) -> ConvertingReceiver<()>
Configures the edge counter for the selected pins.
The edge type parameter configures if rising edges, falling edges or both are counted if the pin is configured for input. Possible edge types are:
- 0 = rising (default)
- 1 = falling
- 2 = both
The debounce time is given in ms.
Configuring an edge counter resets its value to 0.
If you don’t know what any of this means, just leave it at default. The default configuration is very likely OK for you.
Default values: 0 (edge type) and 100ms (debounce time)
.. versionadded:: 2.0.1$nbsp;(Plugin)
Associated constants:
- IO4BRICKLET_EDGE_TYPE_RISING
- IO4BRICKLET_EDGE_TYPE_FALLING
- IO4BRICKLET_EDGE_TYPE_BOTH
sourcepub fn get_edge_count_config(
&self,
pin: u8
) -> ConvertingReceiver<EdgeCountConfig>
pub fn get_edge_count_config(
&self,
pin: u8
) -> ConvertingReceiver<EdgeCountConfig>
Returns the edge type and debounce time for the selected pin as set by
Set Edge Count Config
.
.. versionadded:: 2.0.1$nbsp;(Plugin)
Associated constants:
- IO4BRICKLET_EDGE_TYPE_RISING
- IO4BRICKLET_EDGE_TYPE_FALLING
- IO4BRICKLET_EDGE_TYPE_BOTH
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’ or ‘d’.
The device identifier numbers can be found here. |device_identifier_constant|
Trait Implementations
sourceimpl Clone for Io4Bricklet
impl Clone for Io4Bricklet
sourcefn clone(&self) -> Io4Bricklet
fn clone(&self) -> Io4Bricklet
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more