Struct IndustrialAnalogOutBricklet

pub struct IndustrialAnalogOutBricklet { /* private fields */ }

Generates configurable DC voltage and current, 0V to 10V and 4mA to 20mA

Implementations

impl IndustrialAnalogOutBricklet

pub const DEVICE_IDENTIFIER: u16 = 258u16

pub const DEVICE_DISPLAY_NAME: &'static str = "Industrial Analog Out Bricklet"

pub fn new( uid: Uid, connection: AsyncIpConnection, ) -> IndustrialAnalogOutBricklet

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: 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 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.

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 sent 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 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.

pub async fn enable(&mut self) -> Result<(), TinkerforgeError>

Enables the output of voltage and current.

The default is disabled.

pub async fn disable(&mut self) -> Result<(), TinkerforgeError>

Disables the output of voltage and current.

The default is disabled.

pub async fn is_enabled(&mut self) -> Result<bool, TinkerforgeError>

Returns true if output of voltage and current is enabled, false otherwise.

pub async fn set_voltage( &mut self, voltage: u16, ) -> Result<(), TinkerforgeError>

Sets the output voltage.

The output voltage and output current are linked. Changing the output voltage also changes the output current.

pub async fn get_voltage(&mut self) -> Result<u16, TinkerforgeError>

Returns the voltage as set by [set_voltage].

pub async fn set_current( &mut self, current: u16, ) -> Result<(), TinkerforgeError>

Sets the output current.

The output current and output voltage are linked. Changing the output current also changes the output voltage.

pub async fn get_current(&mut self) -> Result<u16, TinkerforgeError>

Returns the current as set by [set_current].

pub async fn set_configuration( &mut self, voltage_range: u8, current_range: u8, ) -> Result<(), TinkerforgeError>

Configures the voltage and current range.

Possible voltage ranges are:

• 0V to 5V
• 0V to 10V

Possible current ranges are:

• 4mA to 20mA
• 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_OUT_BRICKLET_VOLTAGE_RANGE_0_TO_5V
• INDUSTRIAL_ANALOG_OUT_BRICKLET_VOLTAGE_RANGE_0_TO_10V
• INDUSTRIAL_ANALOG_OUT_BRICKLET_CURRENT_RANGE_4_TO_20MA
• INDUSTRIAL_ANALOG_OUT_BRICKLET_CURRENT_RANGE_0_TO_20MA
• INDUSTRIAL_ANALOG_OUT_BRICKLET_CURRENT_RANGE_0_TO_24MA

pub async fn get_configuration( &mut self, ) -> Result<Configuration, TinkerforgeError>

Returns the configuration as set by [set_configuration].

Associated constants:

• INDUSTRIAL_ANALOG_OUT_BRICKLET_VOLTAGE_RANGE_0_TO_5V
• INDUSTRIAL_ANALOG_OUT_BRICKLET_VOLTAGE_RANGE_0_TO_10V
• INDUSTRIAL_ANALOG_OUT_BRICKLET_CURRENT_RANGE_4_TO_20MA
• INDUSTRIAL_ANALOG_OUT_BRICKLET_CURRENT_RANGE_0_TO_20MA
• INDUSTRIAL_ANALOG_OUT_BRICKLET_CURRENT_RANGE_0_TO_24MA

pub async fn get_identity(&mut self) -> Result<Identity, TinkerforgeError>

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

impl Clone for IndustrialAnalogOutBricklet

fn clone(&self) -> IndustrialAnalogOutBricklet

Returns a duplicate of the value.

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

Performs copy-assignment from source.