Shell - Industrial Analog Out Bricklet 2.0

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

An installation guide for the Shell 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.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Industrial Analog Out Bricklet 2.0

# Set output current to 4.5mA
tinkerforge call industrial-analog-out-v2-bricklet $uid set-current 4500
tinkerforge call industrial-analog-out-v2-bricklet $uid set-enabled true

echo "Press key to exit"; read dummy

tinkerforge call industrial-analog-out-v2-bricklet $uid set-enabled false

Simple Voltage

Download (example-simple-voltage.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Industrial Analog Out Bricklet 2.0

# Set output voltage to 3.3V
tinkerforge call industrial-analog-out-v2-bricklet $uid set-voltage 3300
tinkerforge call industrial-analog-out-v2-bricklet $uid set-enabled true

echo "Press key to exit"; read dummy

tinkerforge call industrial-analog-out-v2-bricklet $uid set-enabled false

API

Possible exit codes for all tinkerforge commands are:

  • 1: interrupted (ctrl+c)
  • 2: syntax error
  • 21: Python 2.5 or newer is required
  • 22: Python argparse module is missing
  • 23: socket error
  • 24: other exception
  • 25: invalid placeholder in format string
  • 26: authentication error
  • 201: timeout occurred
  • 209: invalid argument value
  • 210: function is not supported
  • 211: unknown error

Command Structure

The common options of the call and dispatch commands are documented here. The specific command structure is shown below.

tinkerforge call industrial-analog-out-v2-bricklet [<option>..] <uid> <function> [<argument>..]
Parameters:
  • <uid> -- string
  • <function> -- string

The call command is used to call a function of the Industrial Analog Out Bricklet 2.0. It can take several options:

  • --help shows help for the specific call command and exits
  • --list-functions shows a list of known functions of the Industrial Analog Out Bricklet 2.0 and exits
tinkerforge dispatch industrial-analog-out-v2-bricklet [<option>..] <uid> <callback>
Parameters:
  • <uid> -- string
  • <callback> -- string

The dispatch command is used to dispatch a callback of the Industrial Analog Out Bricklet 2.0. It can take several options:

  • --help shows help for the specific dispatch command and exits
  • --list-callbacks shows a list of known callbacks of the Industrial Analog Out Bricklet 2.0 and exits
tinkerforge call industrial-analog-out-v2-bricklet <uid> <function> [<option>..] [<argument>..]
Parameters:
  • <uid> -- string
  • <function> -- string

The <function> to be called can take different options depending of its kind. All functions can take the following options:

  • --help shows help for the specific function and exits

Getter functions can take the following options:

  • --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Setter functions can take the following options:

  • --expect-response requests response and waits for it

The --expect-response option for setter functions allows to detect timeouts and other error conditions calls of setters as well. The device will then send a response for this purpose. If this option is not given for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

tinkerforge dispatch industrial-analog-out-v2-bricklet <uid> <callback> [<option>..]
Parameters:
  • <uid> -- string
  • <callback> -- string

The <callback> to be dispatched can take several options:

  • --help shows help for the specific callback and exits
  • --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Basic Functions

tinkerforge call industrial-analog-out-v2-bricklet <uid> set-enabled <enabled>
Parameters:
  • <enabled> -- bool
Output:

no output

Enables/disables the output of voltage and current.

The default is disabled.

tinkerforge call industrial-analog-out-v2-bricklet <uid> get-enabled
Output:
  • enabled -- bool

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

tinkerforge call industrial-analog-out-v2-bricklet <uid> set-voltage <voltage>
Parameters:
  • <voltage> -- int
Output:

no output

Sets the output voltage in mV.

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

tinkerforge call industrial-analog-out-v2-bricklet <uid> get-voltage
Output:
  • voltage -- int

Returns the voltage as set by set-voltage.

tinkerforge call industrial-analog-out-v2-bricklet <uid> set-current <current>
Parameters:
  • <current> -- int
Output:

no output

Sets the output current in µA.

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

tinkerforge call industrial-analog-out-v2-bricklet <uid> get-current
Output:
  • current -- int

Returns the current as set by set-current.

tinkerforge call industrial-analog-out-v2-bricklet <uid> set-out-led-config <config>
Parameters:
  • <config> -- int (has symbols)
Output:

no output

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.

By default the LED is configured as "Out Status"

The following symbols are available for this function:

  • out-led-config-off = 0, for <config>
  • out-led-config-on = 1, for <config>
  • out-led-config-show-heartbeat = 2, for <config>
  • out-led-config-show-out-status = 3, for <config>
tinkerforge call industrial-analog-out-v2-bricklet <uid> get-out-led-config
Output:
  • config -- int (has symbols)

Returns the Out LED configuration as set by set-out-led-config

The following symbols are available for this function:

  • out-led-config-off = 0, for config
  • out-led-config-on = 1, for config
  • out-led-config-show-heartbeat = 2, for config
  • out-led-config-show-out-status = 3, for config
tinkerforge call industrial-analog-out-v2-bricklet <uid> set-out-led-status-config <min> <max> <config>
Parameters:
  • <min> -- int
  • <max> -- int
  • <config> -- int (has symbols)
Output:

no output

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.

By default the channel LED status config is set to intensity with min=0V and max=10V.

The following symbols are available for this function:

  • out-led-status-config-threshold = 0, for <config>
  • out-led-status-config-intensity = 1, for <config>
tinkerforge call industrial-analog-out-v2-bricklet <uid> get-out-led-status-config
Output:
  • min -- int
  • max -- int
  • config -- int (has symbols)

Returns the Out LED status configuration as set by set-out-led-status-config.

The following symbols are available for this function:

  • out-led-status-config-threshold = 0, for config
  • out-led-status-config-intensity = 1, for config

Advanced Functions

tinkerforge call industrial-analog-out-v2-bricklet <uid> set-configuration <voltage-range> <current-range>
Parameters:
  • <voltage-range> -- int (has symbols)
  • <current-range> -- int (has symbols)
Output:

no output

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.

The following symbols are available for this function:

  • voltage-range-0-to-5v = 0, for <voltage-range>
  • voltage-range-0-to-10v = 1, for <voltage-range>
  • current-range-4-to-20ma = 0, for <current-range>
  • current-range-0-to-20ma = 1, for <current-range>
  • current-range-0-to-24ma = 2, for <current-range>
tinkerforge call industrial-analog-out-v2-bricklet <uid> get-configuration
Output:
  • voltage-range -- int (has symbols)
  • current-range -- int (has symbols)

Returns the configuration as set by set-configuration.

The following symbols are available for this function:

  • voltage-range-0-to-5v = 0, for voltage-range
  • voltage-range-0-to-10v = 1, for voltage-range
  • current-range-4-to-20ma = 0, for current-range
  • current-range-0-to-20ma = 1, for current-range
  • current-range-0-to-24ma = 2, for current-range
tinkerforge call industrial-analog-out-v2-bricklet <uid> get-spitfp-error-count
Output:
  • error-count-ack-checksum -- int
  • error-count-message-checksum -- int
  • error-count-frame -- int
  • error-count-overflow -- int

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.

tinkerforge call industrial-analog-out-v2-bricklet <uid> set-bootloader-mode <mode>
Parameters:
  • <mode> -- int (has symbols)
Output:
  • status -- int (has symbols)

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.

The following symbols are available for this function:

  • bootloader-mode-bootloader = 0, for <mode>
  • bootloader-mode-firmware = 1, for <mode>
  • bootloader-mode-bootloader-wait-for-reboot = 2, for <mode>
  • bootloader-mode-firmware-wait-for-reboot = 3, for <mode>
  • bootloader-mode-firmware-wait-for-erase-and-reboot = 4, for <mode>
  • bootloader-status-ok = 0, for status
  • bootloader-status-invalid-mode = 1, for status
  • bootloader-status-no-change = 2, for status
  • bootloader-status-entry-function-not-present = 3, for status
  • bootloader-status-device-identifier-incorrect = 4, for status
  • bootloader-status-crc-mismatch = 5, for status
tinkerforge call industrial-analog-out-v2-bricklet <uid> get-bootloader-mode
Output:
  • mode -- int (has symbols)

Returns the current bootloader mode, see set-bootloader-mode.

The following symbols are available for this function:

  • bootloader-mode-bootloader = 0, for mode
  • bootloader-mode-firmware = 1, for mode
  • bootloader-mode-bootloader-wait-for-reboot = 2, for mode
  • bootloader-mode-firmware-wait-for-reboot = 3, for mode
  • bootloader-mode-firmware-wait-for-erase-and-reboot = 4, for mode
tinkerforge call industrial-analog-out-v2-bricklet <uid> set-write-firmware-pointer <pointer>
Parameters:
  • <pointer> -- int
Output:

no output

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.

tinkerforge call industrial-analog-out-v2-bricklet <uid> write-firmware <data>
Parameters:
  • <data> -- int,int,..61x..,int
Output:
  • status -- int

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.

tinkerforge call industrial-analog-out-v2-bricklet <uid> set-status-led-config <config>
Parameters:
  • <config> -- int (has symbols)
Output:

no output

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.

The following symbols are available for this function:

  • status-led-config-off = 0, for <config>
  • status-led-config-on = 1, for <config>
  • status-led-config-show-heartbeat = 2, for <config>
  • status-led-config-show-status = 3, for <config>
tinkerforge call industrial-analog-out-v2-bricklet <uid> get-status-led-config
Output:
  • config -- int (has symbols)

Returns the configuration as set by set-status-led-config

The following symbols are available for this function:

  • status-led-config-off = 0, for config
  • status-led-config-on = 1, for config
  • status-led-config-show-heartbeat = 2, for config
  • status-led-config-show-status = 3, for config
tinkerforge call industrial-analog-out-v2-bricklet <uid> get-chip-temperature
Output:
  • temperature -- int

Returns the temperature in °C 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.

tinkerforge call industrial-analog-out-v2-bricklet <uid> reset
Output:no output

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!

tinkerforge call industrial-analog-out-v2-bricklet <uid> write-uid <uid>
Parameters:
  • <uid> -- int
Output:

no output

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.

tinkerforge call industrial-analog-out-v2-bricklet <uid> read-uid
Output:
  • uid -- int

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

tinkerforge call industrial-analog-out-v2-bricklet <uid> get-identity
Output:
  • uid -- string
  • connected-uid -- string
  • position -- char
  • hardware-version -- int,int,int
  • firmware-version -- int,int,int
  • device-identifier -- int (has symbols)

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