Python - Industrial Analog Out Bricklet

This is the description of the Python API bindings for the Industrial Analog Out Bricklet. General information and technical specifications for the Industrial Analog Out Bricklet are summarized in its hardware description.

An installation guide for the Python API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

Simple Current

Download (example_simple_current.py)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
#!/usr/bin/env python
# -*- coding: utf-8 -*-

HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your Industrial Analog Out Bricklet

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_industrial_analog_out import BrickletIndustrialAnalogOut

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    iao = BrickletIndustrialAnalogOut(UID, ipcon) # Create device object

    ipcon.connect(HOST, PORT) # Connect to brickd
    # Don't use device before ipcon is connected

    # Set output current to 4.5mA
    iao.set_current(4500)
    iao.enable()

    raw_input("Press key to exit\n") # Use input() in Python 3
    iao.disable()
    ipcon.disconnect()

Simple Voltage

Download (example_simple_voltage.py)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
#!/usr/bin/env python
# -*- coding: utf-8 -*-

HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your Industrial Analog Out Bricklet

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_industrial_analog_out import BrickletIndustrialAnalogOut

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    iao = BrickletIndustrialAnalogOut(UID, ipcon) # Create device object

    ipcon.connect(HOST, PORT) # Connect to brickd
    # Don't use device before ipcon is connected

    # Set output voltage to 3.3V
    iao.set_voltage(3300)
    iao.enable()

    raw_input("Press key to exit\n") # Use input() in Python 3
    iao.disable()
    ipcon.disconnect()

API

Generally, every function of the Python bindings can throw an tinkerforge.ip_connection.Error exception that has a value and a description property. value can have different values:

  • Error.TIMEOUT = -1
  • Error.NOT_ADDED = -6 (unused since Python bindings version 2.0.0)
  • Error.ALREADY_CONNECTED = -7
  • Error.NOT_CONNECTED = -8
  • Error.INVALID_PARAMETER = -9
  • Error.NOT_SUPPORTED = -10
  • Error.UNKNOWN_ERROR_CODE = -11
  • Error.STREAM_OUT_OF_SYNC = -12
  • Error.INVALID_UID = -13
  • Error.NON_ASCII_CHAR_IN_SECRET = -14

All functions listed below are thread-safe.

Basic Functions

BrickletIndustrialAnalogOut(uid, ipcon)
Parameters:
  • uid – Type: str
  • ipcon – Type: IPConnection
Returns:
  • industrial_analog_out – Type: BrickletIndustrialAnalogOut

Creates an object with the unique device ID uid:

industrial_analog_out = BrickletIndustrialAnalogOut("YOUR_DEVICE_UID", ipcon)

This object can then be used after the IP Connection is connected (see examples above).

BrickletIndustrialAnalogOut.enable()
Returns:
  • None

Enables the output of voltage and current.

The default is disabled.

BrickletIndustrialAnalogOut.disable()
Returns:
  • None

Disables the output of voltage and current.

The default is disabled.

BrickletIndustrialAnalogOut.is_enabled()
Returns:
  • enabled – Type: bool, Default: False

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

BrickletIndustrialAnalogOut.set_voltage(voltage)
Parameters:
  • voltage – Type: int, Unit: 1 mV, Range: [0 to 10000]
Returns:
  • None

Sets the output voltage.

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

BrickletIndustrialAnalogOut.get_voltage()
Returns:
  • voltage – Type: int, Unit: 1 mV, Range: [0 to 10000]

Returns the voltage as set by set_voltage().

BrickletIndustrialAnalogOut.set_current(current)
Parameters:
  • current – Type: int, Unit: 1 µA, Range: [0 to 24000]
Returns:
  • None

Sets the output current.

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

BrickletIndustrialAnalogOut.get_current()
Returns:
  • current – Type: int, Unit: 1 µA, Range: [0 to 24000]

Returns the current as set by set_current().

Advanced Functions

BrickletIndustrialAnalogOut.set_configuration(voltage_range, current_range)
Parameters:
  • voltage_range – Type: int, Range: See constants, Default: 1
  • current_range – Type: int, Range: See constants, Default: 0
Returns:
  • None

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.

The following constants are available for this function:

For voltage_range:

  • BrickletIndustrialAnalogOut.VOLTAGE_RANGE_0_TO_5V = 0
  • BrickletIndustrialAnalogOut.VOLTAGE_RANGE_0_TO_10V = 1

For current_range:

  • BrickletIndustrialAnalogOut.CURRENT_RANGE_4_TO_20MA = 0
  • BrickletIndustrialAnalogOut.CURRENT_RANGE_0_TO_20MA = 1
  • BrickletIndustrialAnalogOut.CURRENT_RANGE_0_TO_24MA = 2
BrickletIndustrialAnalogOut.get_configuration()
Return Object:
  • voltage_range – Type: int, Range: See constants, Default: 1
  • current_range – Type: int, Range: See constants, Default: 0

Returns the configuration as set by set_configuration().

The following constants are available for this function:

For voltage_range:

  • BrickletIndustrialAnalogOut.VOLTAGE_RANGE_0_TO_5V = 0
  • BrickletIndustrialAnalogOut.VOLTAGE_RANGE_0_TO_10V = 1

For current_range:

  • BrickletIndustrialAnalogOut.CURRENT_RANGE_4_TO_20MA = 0
  • BrickletIndustrialAnalogOut.CURRENT_RANGE_0_TO_20MA = 1
  • BrickletIndustrialAnalogOut.CURRENT_RANGE_0_TO_24MA = 2
BrickletIndustrialAnalogOut.get_identity()
Return Object:
  • uid – Type: str, Length: up to 8
  • connected_uid – Type: str, Length: up to 8
  • position – Type: chr, Range: ["a" to "h", "i", "z"]
  • hardware_version – Type: [int, ...], Length: 3
    • 0: major – Type: int, Range: [0 to 255]
    • 1: minor – Type: int, Range: [0 to 255]
    • 2: revision – Type: int, Range: [0 to 255]
  • firmware_version – Type: [int, ...], Length: 3
    • 0: major – Type: int, Range: [0 to 255]
    • 1: minor – Type: int, Range: [0 to 255]
    • 2: revision – Type: int, Range: [0 to 255]
  • device_identifier – Type: int, Range: [0 to 216 - 1]

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). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an Isolator Bricklet is always as position 'z'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Virtual Functions

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

BrickletIndustrialAnalogOut.get_api_version()
Return Object:
  • api_version – Type: [int, ...], Length: 3
    • 0: major – Type: int, Range: [0 to 255]
    • 1: minor – Type: int, Range: [0 to 255]
    • 2: revision – Type: int, Range: [0 to 255]

Returns the version of the API definition 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.

BrickletIndustrialAnalogOut.get_response_expected(function_id)
Parameters:
  • function_id – Type: int, Range: See constants
Returns:
  • response_expected – Type: bool

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.

The following constants are available for this function:

For function_id:

  • BrickletIndustrialAnalogOut.FUNCTION_ENABLE = 1
  • BrickletIndustrialAnalogOut.FUNCTION_DISABLE = 2
  • BrickletIndustrialAnalogOut.FUNCTION_SET_VOLTAGE = 4
  • BrickletIndustrialAnalogOut.FUNCTION_SET_CURRENT = 6
  • BrickletIndustrialAnalogOut.FUNCTION_SET_CONFIGURATION = 8
BrickletIndustrialAnalogOut.set_response_expected(function_id, response_expected)
Parameters:
  • function_id – Type: int, Range: See constants
  • response_expected – Type: bool
Returns:
  • None

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.

The following constants are available for this function:

For function_id:

  • BrickletIndustrialAnalogOut.FUNCTION_ENABLE = 1
  • BrickletIndustrialAnalogOut.FUNCTION_DISABLE = 2
  • BrickletIndustrialAnalogOut.FUNCTION_SET_VOLTAGE = 4
  • BrickletIndustrialAnalogOut.FUNCTION_SET_CURRENT = 6
  • BrickletIndustrialAnalogOut.FUNCTION_SET_CONFIGURATION = 8
BrickletIndustrialAnalogOut.set_response_expected_all(response_expected)
Parameters:
  • response_expected – Type: bool
Returns:
  • None

Changes the response expected flag for all setter and callback configuration functions of this device at once.

Constants

BrickletIndustrialAnalogOut.DEVICE_IDENTIFIER

This constant is used to identify a Industrial Analog Out Bricklet.

The get_identity() function and the IPConnection.CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

BrickletIndustrialAnalogOut.DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Industrial Analog Out Bricklet.