class Tinkerforge::BrickletIndustrialDual020mAV2

Measures two DC currents between 0mA and 20mA (IEC 60381-1)

Constants

CALLBACK_CURRENT

This callback is triggered periodically according to the configuration set by BrickletIndustrialDual020mAV2#set_current_callback_configuration.

The parameter is the same as BrickletIndustrialDual020mAV2#get_current.

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_dual_0_20ma_v2.rb, line 86
def initialize(uid, ipcon)
  super uid, ipcon, DEVICE_IDENTIFIER, DEVICE_DISPLAY_NAME

  @api_version = [2, 0, 0]

  @response_expected[FUNCTION_GET_CURRENT] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_CURRENT_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_CURRENT_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_SAMPLE_RATE] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_SAMPLE_RATE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_GAIN] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_GAIN] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_CHANNEL_LED_CONFIG] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_CHANNEL_LED_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_CHANNEL_LED_STATUS_CONFIG] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_CHANNEL_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

  @callback_formats[CALLBACK_CURRENT] = [13, 'C l']

  @ipcon.add_device self
end

Public Instance Methods

get_bootloader_mode() click to toggle source

Returns the current bootloader mode, see BrickletIndustrialDual020mAV2#set_bootloader_mode.

# File lib/tinkerforge/bricklet_industrial_dual_0_20ma_v2.rb, line 303
def get_bootloader_mode
  check_validity

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

Returns the channel LED configuration as set by BrickletIndustrialDual020mAV2#set_channel_led_config

# File lib/tinkerforge/bricklet_industrial_dual_0_20ma_v2.rb, line 230
def get_channel_led_config(channel)
  check_validity

  send_request FUNCTION_GET_CHANNEL_LED_CONFIG, [channel], 'C', 9, 'C'
end
get_channel_led_status_config(channel) click to toggle source

Returns the channel LED status configuration as set by BrickletIndustrialDual020mAV2#set_channel_led_status_config.

# File lib/tinkerforge/bricklet_industrial_dual_0_20ma_v2.rb, line 264
def get_channel_led_status_config(channel)
  check_validity

  send_request FUNCTION_GET_CHANNEL_LED_STATUS_CONFIG, [channel], 'C', 17, 'l l 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_dual_0_20ma_v2.rb, line 361
def get_chip_temperature
  check_validity

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

Returns the current of the specified channel.

It is possible to detect if an IEC 60381-1 compatible sensor is connected and if it works probably.

If the returned current is below 4mA, there is likely no sensor connected or the connected sensor is defective. If the returned current is over 20mA, there might be a short circuit or the sensor is defective.

If you want to get the value periodically, it is recommended to use the CALLBACK_CURRENT callback. You can set the callback configuration with BrickletIndustrialDual020mAV2#set_current_callback_configuration.

# File lib/tinkerforge/bricklet_industrial_dual_0_20ma_v2.rb, line 133
def get_current(channel)
  check_validity

  send_request FUNCTION_GET_CURRENT, [channel], 'C', 12, 'l'
end
get_current_callback_configuration(channel) click to toggle source

Returns the callback configuration as set by BrickletIndustrialDual020mAV2#set_current_callback_configuration.

# File lib/tinkerforge/bricklet_industrial_dual_0_20ma_v2.rb, line 171
def get_current_callback_configuration(channel)
  check_validity

  send_request FUNCTION_GET_CURRENT_CALLBACK_CONFIGURATION, [channel], 'C', 22, 'L ? k l l'
end
get_gain() click to toggle source

Returns the gain as set by BrickletIndustrialDual020mAV2#set_gain.

# File lib/tinkerforge/bricklet_industrial_dual_0_20ma_v2.rb, line 211
def get_gain
  check_validity

  send_request FUNCTION_GET_GAIN, [], '', 9, 'C'
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_dual_0_20ma_v2.rb, line 408
def get_identity
  send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S'
end
get_sample_rate() click to toggle source

Returns the sample rate as set by BrickletIndustrialDual020mAV2#set_sample_rate.

# File lib/tinkerforge/bricklet_industrial_dual_0_20ma_v2.rb, line 193
def get_sample_rate
  check_validity

  send_request FUNCTION_GET_SAMPLE_RATE, [], '', 9, '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_dual_0_20ma_v2.rb, line 281
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 BrickletIndustrialDual020mAV2#set_status_led_config

# File lib/tinkerforge/bricklet_industrial_dual_0_20ma_v2.rb, line 349
def get_status_led_config
  check_validity

  send_request FUNCTION_GET_STATUS_LED_CONFIG, [], '', 9, 'C'
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_dual_0_20ma_v2.rb, line 392
def read_uid
  check_validity

  send_request FUNCTION_READ_UID, [], '', 12, 'L'
end
register_callback(id, &block) click to toggle source

Registers a callback with ID id to the block block.

# File lib/tinkerforge/bricklet_industrial_dual_0_20ma_v2.rb, line 413
def register_callback(id, &block)
  callback = block
  @registered_callbacks[id] = callback
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_dual_0_20ma_v2.rb, line 373
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_dual_0_20ma_v2.rb, line 296
def set_bootloader_mode(mode)
  check_validity

  send_request FUNCTION_SET_BOOTLOADER_MODE, [mode], 'C', 9, 'C'
end
set_channel_led_config(channel, config) click to toggle source

Each channel has a corresponding LED. You can turn the LED off, on or show a heartbeat. You can also set the LED to “Channel 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 measured value.

You can configure the channel status behavior with BrickletIndustrialDual020mAV2#set_channel_led_status_config.

# File lib/tinkerforge/bricklet_industrial_dual_0_20ma_v2.rb, line 223
def set_channel_led_config(channel, config)
  check_validity

  send_request FUNCTION_SET_CHANNEL_LED_CONFIG, [channel, config], 'C C', 8, ''
end
set_channel_led_status_config(channel, min, max, config) click to toggle source

Sets the channel LED status config. This config is used if the channel LED is configured as “Channel Status”, see BrickletIndustrialDual020mAV2#set_channel_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 nA above which the LED should turn on and set the “max” parameter to 0. Example: If you set a positive threshold of 10mA, the LED will turn on as soon as the current exceeds 10mA and turn off again if it goes below 10mA. For a negative threshold set the “max” parameter to the threshold value in nA below which the LED should turn on and set the “min” parameter to 0. Example: If you set a negative threshold of 10mA, the LED will turn on as soon as the current goes below 10mA and the LED will turn off when the current exceeds 10mA.

In intensity mode you can define a range in nA that is used to scale the brightness of the LED. Example with min=4mA and max=20mA: The LED is off at 4mA and below, on at 20mA and above and the brightness is linearly scaled between the values 4mA and 20mA. If the min value is greater than the max value, the LED brightness is scaled the other way around.

# File lib/tinkerforge/bricklet_industrial_dual_0_20ma_v2.rb, line 256
def set_channel_led_status_config(channel, min, max, config)
  check_validity

  send_request FUNCTION_SET_CHANNEL_LED_STATUS_CONFIG, [channel, min, max, config], 'C l l C', 8, ''
end
set_current_callback_configuration(channel, period, value_has_to_change, option, min, max) click to toggle source

The period is the period with which the CALLBACK_CURRENT callback is triggered periodically. A value of 0 turns the callback off.

If the `value has to change`-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The `option`-parameter together with min/max sets a threshold for the CALLBACK_CURRENT callback.

The following options are possible:

"Option", "Description"

"'x'",    "Threshold is turned off"
"'o'",    "Threshold is triggered when the value is *outside* the min and max values"
"'i'",    "Threshold is triggered when the value is *inside* or equal to the min and max values"
"'<'",    "Threshold is triggered when the value is smaller than the min value (max is ignored)"
"'>'",    "Threshold is triggered when the value is greater than the min value (max is ignored)"

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

# File lib/tinkerforge/bricklet_industrial_dual_0_20ma_v2.rb, line 164
def set_current_callback_configuration(channel, period, value_has_to_change, option, min, max)
  check_validity

  send_request FUNCTION_SET_CURRENT_CALLBACK_CONFIGURATION, [channel, period, value_has_to_change, option, min, max], 'C L ? k l l', 8, ''
end
set_gain(gain) click to toggle source

Sets a gain between 1x and 8x. If you want to measure a very small current, you can increase the gain to get some more resolution.

Example: If you measure 0.5mA with a gain of 8x the return value will be 4mA.

# File lib/tinkerforge/bricklet_industrial_dual_0_20ma_v2.rb, line 204
def set_gain(gain)
  check_validity

  send_request FUNCTION_SET_GAIN, [gain], 'C', 8, ''
end
set_sample_rate(rate) click to toggle source

Sets the sample rate to either 240, 60, 15 or 4 samples per second. The resolution for the rates is 12, 14, 16 and 18 bit respectively.

"Value", "Description"

"0",    "240 samples per second, 12 bit resolution"
"1",    "60 samples per second, 14 bit resolution"
"2",    "15 samples per second, 16 bit resolution"
"3",    "4 samples per second, 18 bit resolution"
# File lib/tinkerforge/bricklet_industrial_dual_0_20ma_v2.rb, line 186
def set_sample_rate(rate)
  check_validity

  send_request FUNCTION_SET_SAMPLE_RATE, [rate], '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_dual_0_20ma_v2.rb, line 342
def set_status_led_config(config)
  check_validity

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

Sets the firmware pointer for BrickletIndustrialDual020mAV2#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_dual_0_20ma_v2.rb, line 315
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 BrickletIndustrialDual020mAV2#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_dual_0_20ma_v2.rb, line 329
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_dual_0_20ma_v2.rb, line 384
def write_uid(uid)
  check_validity

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