class Tinkerforge::BrickletIndustrialAnalogOutV2

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

Public Class Methods

new(uid, ipcon) click to toggle source

Creates an object with the unique device ID uid and adds it to the IP Connection ipcon.

Calls superclass method
# File lib/tinkerforge/bricklet_industrial_analog_out_v2.rb, line 73
def initialize(uid, ipcon)
  super uid, ipcon, DEVICE_IDENTIFIER, DEVICE_DISPLAY_NAME

  @api_version = [2, 0, 0]

  @response_expected[FUNCTION_SET_ENABLED] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_ENABLED] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_VOLTAGE] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_VOLTAGE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_CURRENT] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_CURRENT] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_CONFIGURATION] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_OUT_LED_CONFIG] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_OUT_LED_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_OUT_LED_STATUS_CONFIG] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_OUT_LED_STATUS_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_SPITFP_ERROR_COUNT] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_BOOTLOADER_MODE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_BOOTLOADER_MODE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_WRITE_FIRMWARE_POINTER] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_WRITE_FIRMWARE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_STATUS_LED_CONFIG] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_STATUS_LED_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_CHIP_TEMPERATURE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_RESET] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_WRITE_UID] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_READ_UID] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE


  @ipcon.add_device self
end

Public Instance Methods

get_bootloader_mode() click to toggle source

Returns the current bootloader mode, see BrickletIndustrialAnalogOutV2#set_bootloader_mode.

# File lib/tinkerforge/bricklet_industrial_analog_out_v2.rb, line 269
def get_bootloader_mode
  check_validity

  send_request FUNCTION_GET_BOOTLOADER_MODE, [], '', 9, 'C'
end
get_chip_temperature() click to toggle source

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.

# File lib/tinkerforge/bricklet_industrial_analog_out_v2.rb, line 327
def get_chip_temperature
  check_validity

  send_request FUNCTION_GET_CHIP_TEMPERATURE, [], '', 10, 's'
end
get_configuration() click to toggle source

Returns the configuration as set by BrickletIndustrialAnalogOutV2#set_configuration.

# File lib/tinkerforge/bricklet_industrial_analog_out_v2.rb, line 177
def get_configuration
  check_validity

  send_request FUNCTION_GET_CONFIGURATION, [], '', 10, 'C C'
end
get_current() click to toggle source

Returns the current as set by BrickletIndustrialAnalogOutV2#set_current.

# File lib/tinkerforge/bricklet_industrial_analog_out_v2.rb, line 149
def get_current
  check_validity

  send_request FUNCTION_GET_CURRENT, [], '', 10, 'S'
end
get_enabled() click to toggle source

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

# File lib/tinkerforge/bricklet_industrial_analog_out_v2.rb, line 115
def get_enabled
  check_validity

  send_request FUNCTION_GET_ENABLED, [], '', 9, '?'
end
get_identity() click to toggle source

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 :ref:`Isolator Bricklet <isolator_bricklet>` is always at position 'z'.

The device identifier numbers can be found :ref:`here <device_identifier>`. |device_identifier_constant|

# File lib/tinkerforge/bricklet_industrial_analog_out_v2.rb, line 374
def get_identity
  send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S'
end
get_out_led_config() click to toggle source

Returns the Out LED configuration as set by BrickletIndustrialAnalogOutV2#set_out_led_config

# File lib/tinkerforge/bricklet_industrial_analog_out_v2.rb, line 196
def get_out_led_config
  check_validity

  send_request FUNCTION_GET_OUT_LED_CONFIG, [], '', 9, 'C'
end
get_out_led_status_config() click to toggle source

Returns the Out LED status configuration as set by BrickletIndustrialAnalogOutV2#set_out_led_status_config.

# File lib/tinkerforge/bricklet_industrial_analog_out_v2.rb, line 230
def get_out_led_status_config
  check_validity

  send_request FUNCTION_GET_OUT_LED_STATUS_CONFIG, [], '', 13, 'S S C'
end
get_spitfp_error_count() click to toggle source

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.

# File lib/tinkerforge/bricklet_industrial_analog_out_v2.rb, line 247
def get_spitfp_error_count
  check_validity

  send_request FUNCTION_GET_SPITFP_ERROR_COUNT, [], '', 24, 'L L L L'
end
get_status_led_config() click to toggle source

Returns the configuration as set by BrickletIndustrialAnalogOutV2#set_status_led_config

# File lib/tinkerforge/bricklet_industrial_analog_out_v2.rb, line 315
def get_status_led_config
  check_validity

  send_request FUNCTION_GET_STATUS_LED_CONFIG, [], '', 9, 'C'
end
get_voltage() click to toggle source

Returns the voltage as set by BrickletIndustrialAnalogOutV2#set_voltage.

# File lib/tinkerforge/bricklet_industrial_analog_out_v2.rb, line 132
def get_voltage
  check_validity

  send_request FUNCTION_GET_VOLTAGE, [], '', 10, 'S'
end
read_uid() click to toggle source

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

# File lib/tinkerforge/bricklet_industrial_analog_out_v2.rb, line 358
def read_uid
  check_validity

  send_request FUNCTION_READ_UID, [], '', 12, 'L'
end
reset() click to toggle source

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!

# File lib/tinkerforge/bricklet_industrial_analog_out_v2.rb, line 339
def reset
  check_validity

  send_request FUNCTION_RESET, [], '', 8, ''
end
set_bootloader_mode(mode) click to toggle source

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.

# File lib/tinkerforge/bricklet_industrial_analog_out_v2.rb, line 262
def set_bootloader_mode(mode)
  check_validity

  send_request FUNCTION_SET_BOOTLOADER_MODE, [mode], 'C', 9, 'C'
end
set_configuration(voltage_range, current_range) click to toggle source

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.

# File lib/tinkerforge/bricklet_industrial_analog_out_v2.rb, line 170
def set_configuration(voltage_range, current_range)
  check_validity

  send_request FUNCTION_SET_CONFIGURATION, [voltage_range, current_range], 'C C', 8, ''
end
set_current(current) click to toggle source

Sets the output current.

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

# File lib/tinkerforge/bricklet_industrial_analog_out_v2.rb, line 142
def set_current(current)
  check_validity

  send_request FUNCTION_SET_CURRENT, [current], 'S', 8, ''
end
set_enabled(enabled) click to toggle source

Enables/disables the output of voltage and current.

# File lib/tinkerforge/bricklet_industrial_analog_out_v2.rb, line 108
def set_enabled(enabled)
  check_validity

  send_request FUNCTION_SET_ENABLED, [enabled], '?', 8, ''
end
set_out_led_config(config) click to toggle source

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 BrickletIndustrialAnalogOutV2#set_out_led_status_config.

# File lib/tinkerforge/bricklet_industrial_analog_out_v2.rb, line 189
def set_out_led_config(config)
  check_validity

  send_request FUNCTION_SET_OUT_LED_CONFIG, [config], 'C', 8, ''
end
set_out_led_status_config(min, max, config) click to toggle source

Sets the Out LED status config. This config is used if the Out LED is configured as “Out Status”, see BrickletIndustrialAnalogOutV2#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.

# File lib/tinkerforge/bricklet_industrial_analog_out_v2.rb, line 223
def set_out_led_status_config(min, max, config)
  check_validity

  send_request FUNCTION_SET_OUT_LED_STATUS_CONFIG, [min, max, config], 'S S C', 8, ''
end
set_status_led_config(config) click to toggle source

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.

# File lib/tinkerforge/bricklet_industrial_analog_out_v2.rb, line 308
def set_status_led_config(config)
  check_validity

  send_request FUNCTION_SET_STATUS_LED_CONFIG, [config], 'C', 8, ''
end
set_voltage(voltage) click to toggle source

Sets the output voltage.

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

# File lib/tinkerforge/bricklet_industrial_analog_out_v2.rb, line 125
def set_voltage(voltage)
  check_validity

  send_request FUNCTION_SET_VOLTAGE, [voltage], 'S', 8, ''
end
set_write_firmware_pointer(pointer) click to toggle source

Sets the firmware pointer for BrickletIndustrialAnalogOutV2#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.

# File lib/tinkerforge/bricklet_industrial_analog_out_v2.rb, line 281
def set_write_firmware_pointer(pointer)
  check_validity

  send_request FUNCTION_SET_WRITE_FIRMWARE_POINTER, [pointer], 'L', 8, ''
end
write_firmware(data) click to toggle source

Writes 64 Bytes of firmware at the position as written by BrickletIndustrialAnalogOutV2#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.

# File lib/tinkerforge/bricklet_industrial_analog_out_v2.rb, line 295
def write_firmware(data)
  check_validity

  send_request FUNCTION_WRITE_FIRMWARE, [data], 'C64', 9, 'C'
end
write_uid(uid) click to toggle source

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.

# File lib/tinkerforge/bricklet_industrial_analog_out_v2.rb, line 350
def write_uid(uid)
  check_validity

  send_request FUNCTION_WRITE_UID, [uid], 'L', 8, ''
end