pub struct IndustrialAnalogOutV2Bricklet { /* private fields */ }
Expand description
Generates configurable DC voltage and current, 0V to 10V and 4mA to 20mA
Implementations§
source§impl IndustrialAnalogOutV2Bricklet
impl IndustrialAnalogOutV2Bricklet
pub const DEVICE_IDENTIFIER: u16 = 2_116u16
pub const DEVICE_DISPLAY_NAME: &'static str = "Industrial Analog Out Bricklet 2.0"
sourcepub fn new<T: GetRequestSender>(
uid: &str,
req_sender: T
) -> IndustrialAnalogOutV2Bricklet
pub fn new<T: GetRequestSender>( uid: &str, req_sender: T ) -> IndustrialAnalogOutV2Bricklet
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: IndustrialAnalogOutV2BrickletFunction
) -> Result<bool, GetResponseExpectedError>
pub fn get_response_expected( &mut self, fun: IndustrialAnalogOutV2BrickletFunction ) -> 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: IndustrialAnalogOutV2BrickletFunction,
response_expected: bool
) -> Result<(), SetResponseExpectedError>
pub fn set_response_expected( &mut self, fun: IndustrialAnalogOutV2BrickletFunction, 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_enabled(&self, enabled: bool) -> ConvertingReceiver<()>
pub fn set_enabled(&self, enabled: bool) -> ConvertingReceiver<()>
Enables/disables the output of voltage and current.
sourcepub fn get_enabled(&self) -> ConvertingReceiver<bool>
pub fn get_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.
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.
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
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_V2_BRICKLET_VOLTAGE_RANGE_0_TO_5V
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_VOLTAGE_RANGE_0_TO_10V
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_CURRENT_RANGE_4_TO_20MA
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_CURRENT_RANGE_0_TO_20MA
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_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_OUT_V2_BRICKLET_VOLTAGE_RANGE_0_TO_5V
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_VOLTAGE_RANGE_0_TO_10V
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_CURRENT_RANGE_4_TO_20MA
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_CURRENT_RANGE_0_TO_20MA
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_CURRENT_RANGE_0_TO_24MA
sourcepub fn set_out_led_config(&self, config: u8) -> ConvertingReceiver<()>
pub fn set_out_led_config(&self, config: u8) -> ConvertingReceiver<()>
You can turn the Out LED off, on or show a heartbeat. You can also set the LED to Out Status. In this mode the LED can either be turned on with a pre-defined threshold or the intensity of the LED can change with the output value (voltage or current).
You can configure the channel status behavior with [set_out_led_status_config
].
Associated constants:
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_OUT_LED_CONFIG_OFF
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_OUT_LED_CONFIG_ON
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_OUT_LED_CONFIG_SHOW_HEARTBEAT
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_OUT_LED_CONFIG_SHOW_OUT_STATUS
sourcepub fn get_out_led_config(&self) -> ConvertingReceiver<u8>
pub fn get_out_led_config(&self) -> ConvertingReceiver<u8>
Returns the Out LED configuration as set by [set_out_led_config
]
Associated constants:
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_OUT_LED_CONFIG_OFF
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_OUT_LED_CONFIG_ON
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_OUT_LED_CONFIG_SHOW_HEARTBEAT
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_OUT_LED_CONFIG_SHOW_OUT_STATUS
sourcepub fn set_out_led_status_config(
&self,
min: u16,
max: u16,
config: u8
) -> ConvertingReceiver<()>
pub fn set_out_led_status_config( &self, min: u16, max: u16, config: u8 ) -> ConvertingReceiver<()>
Sets the Out LED status config. This config is used if the Out LED is
configured as Out Status, see [set_out_led_config
].
For each channel you can choose between threshold and intensity mode.
In threshold mode you can define a positive or a negative threshold. For a positive threshold set the min parameter to the threshold value in mV or µA above which the LED should turn on and set the max parameter to 0. Example: If you set a positive threshold of 5V, the LED will turn on as soon as the output value exceeds 5V and turn off again if it goes below 5V. For a negative threshold set the max parameter to the threshold value in mV or µA below which the LED should turn on and set the min parameter to 0. Example: If you set a negative threshold of 5V, the LED will turn on as soon as the output value goes below 5V and the LED will turn off when the output value exceeds 5V.
In intensity mode you can define a range mV or µA that is used to scale the brightness of the LED. Example with min=2V, max=8V: The LED is off at 2V and below, on at 8V and above and the brightness is linearly scaled between the values 2V and 8V. If the min value is greater than the max value, the LED brightness is scaled the other way around.
Associated constants:
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_OUT_LED_STATUS_CONFIG_THRESHOLD
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_OUT_LED_STATUS_CONFIG_INTENSITY
sourcepub fn get_out_led_status_config(
&self
) -> ConvertingReceiver<OutLedStatusConfig>
pub fn get_out_led_status_config( &self ) -> ConvertingReceiver<OutLedStatusConfig>
Returns the Out LED status configuration as set by [set_out_led_status_config
].
Associated constants:
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_OUT_LED_STATUS_CONFIG_THRESHOLD
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_OUT_LED_STATUS_CONFIG_INTENSITY
sourcepub fn get_spitfp_error_count(&self) -> ConvertingReceiver<SpitfpErrorCount>
pub fn get_spitfp_error_count(&self) -> ConvertingReceiver<SpitfpErrorCount>
Returns the error count for the communication between Brick and Bricklet.
The errors are divided into
- ACK checksum errors,
- message checksum errors,
- framing errors and
- overflow errors.
The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.
sourcepub fn set_bootloader_mode(&self, mode: u8) -> ConvertingReceiver<u8>
pub fn set_bootloader_mode(&self, mode: u8) -> ConvertingReceiver<u8>
Sets the bootloader mode and returns the status after the requested mode change was instigated.
You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.
This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.
Associated constants:
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_BOOTLOADER_STATUS_OK
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH
sourcepub fn get_bootloader_mode(&self) -> ConvertingReceiver<u8>
pub fn get_bootloader_mode(&self) -> ConvertingReceiver<u8>
Returns the current bootloader mode, see [set_bootloader_mode
].
Associated constants:
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
sourcepub fn set_write_firmware_pointer(&self, pointer: u32) -> ConvertingReceiver<()>
pub fn set_write_firmware_pointer(&self, pointer: u32) -> ConvertingReceiver<()>
Sets the firmware pointer for [write_firmware
]. The pointer has
to be increased by chunks of size 64. The data is written to flash
every 4 chunks (which equals to one page of size 256).
This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.
sourcepub fn write_firmware(&self, data: [u8; 64]) -> ConvertingReceiver<u8>
pub fn write_firmware(&self, data: [u8; 64]) -> ConvertingReceiver<u8>
Writes 64 Bytes of firmware at the position as written by
[set_write_firmware_pointer
] before. The firmware is written
to flash every 4 chunks.
You can only write firmware in bootloader mode.
This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.
sourcepub fn set_status_led_config(&self, config: u8) -> ConvertingReceiver<()>
pub fn set_status_led_config(&self, config: u8) -> ConvertingReceiver<()>
Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.
You can also turn the LED permanently on/off or show a heartbeat.
If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.
Associated constants:
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_STATUS_LED_CONFIG_OFF
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_STATUS_LED_CONFIG_ON
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS
sourcepub fn get_status_led_config(&self) -> ConvertingReceiver<u8>
pub fn get_status_led_config(&self) -> ConvertingReceiver<u8>
Returns the configuration as set by [set_status_led_config
]
Associated constants:
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_STATUS_LED_CONFIG_OFF
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_STATUS_LED_CONFIG_ON
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
- INDUSTRIAL_ANALOG_OUT_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS
sourcepub fn get_chip_temperature(&self) -> ConvertingReceiver<i16>
pub fn get_chip_temperature(&self) -> ConvertingReceiver<i16>
Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!
The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.
sourcepub fn reset(&self) -> ConvertingReceiver<()>
pub fn reset(&self) -> ConvertingReceiver<()>
Calling this function will reset the Bricklet. All configurations will be lost.
After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!
sourcepub fn write_uid(&self, uid: u32) -> ConvertingReceiver<()>
pub fn write_uid(&self, uid: u32) -> ConvertingReceiver<()>
Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.
We recommend that you use Brick Viewer to change the UID.
sourcepub fn read_uid(&self) -> ConvertingReceiver<u32>
pub fn read_uid(&self) -> ConvertingReceiver<u32>
Returns the current UID as an integer. Encode as Base58 to get the usual string version.
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 IndustrialAnalogOutV2Bricklet
impl Clone for IndustrialAnalogOutV2Bricklet
source§fn clone(&self) -> IndustrialAnalogOutV2Bricklet
fn clone(&self) -> IndustrialAnalogOutV2Bricklet
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more