pub struct IndustrialAnalogOutBricklet { /* private fields */ }
Expand description
Generates configurable DC voltage and current, 0V to 10V and 4mA to 20mA
Implementations
sourceimpl IndustrialAnalogOutBricklet
impl IndustrialAnalogOutBricklet
pub const DEVICE_IDENTIFIER: u16 = 258u16
pub const DEVICE_DISPLAY_NAME: &'static str = "Industrial Analog Out Bricklet"
sourcepub fn new(
uid: &str,
ip_connection: &IpConnection
) -> IndustrialAnalogOutBricklet
pub fn new(
uid: &str,
ip_connection: &IpConnection
) -> IndustrialAnalogOutBricklet
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: IndustrialAnalogOutBrickletFunction
) -> Result<bool, GetResponseExpectedError>
pub fn get_response_expected(
&mut self,
fun: IndustrialAnalogOutBrickletFunction
) -> 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: IndustrialAnalogOutBrickletFunction,
response_expected: bool
) -> Result<(), SetResponseExpectedError>
pub fn set_response_expected(
&mut self,
fun: IndustrialAnalogOutBrickletFunction,
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 enable(&self) -> ConvertingReceiver<()>
pub fn enable(&self) -> ConvertingReceiver<()>
Enables the output of voltage and current.
The default is disabled.
sourcepub fn disable(&self) -> ConvertingReceiver<()>
pub fn disable(&self) -> ConvertingReceiver<()>
Disables the output of voltage and current.
The default is disabled.
sourcepub fn is_enabled(&self) -> ConvertingReceiver<bool>
pub fn is_enabled(&self) -> ConvertingReceiver<bool>
Returns true if output of voltage and current is enabled, false otherwise.
sourcepub fn set_voltage(&self, voltage: u16) -> ConvertingReceiver<()>
pub fn set_voltage(&self, voltage: u16) -> ConvertingReceiver<()>
Sets the output voltage in mV.
The output voltage and output current are linked. Changing the output voltage also changes the output current.
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_current(&self, current: u16) -> ConvertingReceiver<()>
pub fn set_current(&self, current: u16) -> ConvertingReceiver<()>
Sets the output current in µA.
The output current and output voltage are linked. Changing the output current also changes the output voltage.
sourcepub fn get_current(&self) -> ConvertingReceiver<u16>
pub fn get_current(&self) -> ConvertingReceiver<u16>
Returns the current as set by Set Current
.
sourcepub fn set_configuration(
&self,
voltage_range: u8,
current_range: u8
) -> ConvertingReceiver<()>
pub fn set_configuration(
&self,
voltage_range: u8,
current_range: u8
) -> ConvertingReceiver<()>
Configures the voltage and current range.
Possible voltage ranges are:
- 0V to 5V
- 0V to 10V (default)
Possible current ranges are:
- 4mA to 20mA (default)
- 0mA to 20mA
- 0mA to 24mA
The resolution will always be 12 bit. This means, that the precision is higher with a smaller range.
Associated constants:
- INDUSTRIAL_ANALOG_OUTBRICKLET_VOLTAGE_RANGE_0_TO_5V
- INDUSTRIAL_ANALOG_OUTBRICKLET_VOLTAGE_RANGE_0_TO_10V
- INDUSTRIAL_ANALOG_OUTBRICKLET_CURRENT_RANGE_4_TO_20MA
- INDUSTRIAL_ANALOG_OUTBRICKLET_CURRENT_RANGE_0_TO_20MA
- INDUSTRIAL_ANALOG_OUTBRICKLET_CURRENT_RANGE_0_TO_24MA
sourcepub fn get_configuration(&self) -> ConvertingReceiver<Configuration>
pub fn get_configuration(&self) -> ConvertingReceiver<Configuration>
Returns the configuration as set by Set Configuration
.
Associated constants:
- INDUSTRIAL_ANALOG_OUTBRICKLET_VOLTAGE_RANGE_0_TO_5V
- INDUSTRIAL_ANALOG_OUTBRICKLET_VOLTAGE_RANGE_0_TO_10V
- INDUSTRIAL_ANALOG_OUTBRICKLET_CURRENT_RANGE_4_TO_20MA
- INDUSTRIAL_ANALOG_OUTBRICKLET_CURRENT_RANGE_0_TO_20MA
- INDUSTRIAL_ANALOG_OUTBRICKLET_CURRENT_RANGE_0_TO_24MA
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 IndustrialAnalogOutBricklet
impl Clone for IndustrialAnalogOutBricklet
sourcefn clone(&self) -> IndustrialAnalogOutBricklet
fn clone(&self) -> IndustrialAnalogOutBricklet
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more