pub struct AnalogOutBricklet { /* private fields */ }
Expand description
Generates configurable DC voltage between 0V and 5V
Implementations
sourceimpl AnalogOutBricklet
impl AnalogOutBricklet
pub const DEVICE_IDENTIFIER: u16 = 220u16
pub const DEVICE_DISPLAY_NAME: &'static str = "Analog Out Bricklet"
sourcepub fn new(uid: &str, ip_connection: &IpConnection) -> AnalogOutBricklet
pub fn new(uid: &str, ip_connection: &IpConnection) -> AnalogOutBricklet
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: AnalogOutBrickletFunction
) -> Result<bool, GetResponseExpectedError>
pub fn get_response_expected(
&mut self,
fun: AnalogOutBrickletFunction
) -> 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: AnalogOutBrickletFunction,
response_expected: bool
) -> Result<(), SetResponseExpectedError>
pub fn set_response_expected(
&mut self,
fun: AnalogOutBrickletFunction,
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 set_voltage(&self, voltage: u16) -> ConvertingReceiver<()>
pub fn set_voltage(&self, voltage: u16) -> ConvertingReceiver<()>
Sets the voltage in mV. The possible range is 0V to 5V (0-5000).
Calling this function will set the mode to 0 (see Set Mode
).
The default value is 0 (with mode 1).
sourcepub fn get_voltage(&self) -> ConvertingReceiver<u16>
pub fn get_voltage(&self) -> ConvertingReceiver<u16>
Returns the voltage as set by Set Voltage
.
sourcepub fn set_mode(&self, mode: u8) -> ConvertingReceiver<()>
pub fn set_mode(&self, mode: u8) -> ConvertingReceiver<()>
Sets the mode of the analog value. Possible modes:
- 0: Normal Mode (Analog value as set by
Set Voltage
is applied) - 1: 1k Ohm resistor to ground
- 2: 100k Ohm resistor to ground
- 3: 500k Ohm resistor to ground
Setting the mode to 0 will result in an output voltage of 0. You can jump
to a higher output voltage directly by calling Set Voltage
.
The default mode is 1.
Associated constants:
- ANALOG_OUTBRICKLET_MODE_ANALOG_VALUE
- ANALOG_OUTBRICKLET_MODE_1K_TO_GROUND
- ANALOG_OUTBRICKLET_MODE_100K_TO_GROUND
- ANALOG_OUTBRICKLET_MODE_500K_TO_GROUND
sourcepub fn get_mode(&self) -> ConvertingReceiver<u8>
pub fn get_mode(&self) -> ConvertingReceiver<u8>
Returns the mode as set by Set Mode
.
Associated constants:
- ANALOG_OUTBRICKLET_MODE_ANALOG_VALUE
- ANALOG_OUTBRICKLET_MODE_1K_TO_GROUND
- ANALOG_OUTBRICKLET_MODE_100K_TO_GROUND
- ANALOG_OUTBRICKLET_MODE_500K_TO_GROUND
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 AnalogOutBricklet
impl Clone for AnalogOutBricklet
sourcefn clone(&self) -> AnalogOutBricklet
fn clone(&self) -> AnalogOutBricklet
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more