class Tinkerforge::BrickletCurrent12

Measures AC/DC current between -12.5A and +12.5A

Constants

CALLBACK_ANALOG_VALUE

This callback is triggered periodically with the period that is set by BrickletCurrent12#set_analog_value_callback_period. The parameter is the analog value of the sensor.

The CALLBACK_ANALOG_VALUE callback is only triggered if the current has changed since the last triggering.

CALLBACK_ANALOG_VALUE_REACHED

This callback is triggered when the threshold as set by BrickletCurrent12#set_analog_value_callback_threshold is reached. The parameter is the analog value of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by BrickletCurrent12#set_debounce_period.

CALLBACK_CURRENT

This callback is triggered periodically with the period that is set by BrickletCurrent12#set_current_callback_period. The parameter is the current of the sensor.

The CALLBACK_CURRENT callback is only triggered if the current has changed since the last triggering.

CALLBACK_CURRENT_REACHED

This callback is triggered when the threshold as set by BrickletCurrent12#set_current_callback_threshold is reached. The parameter is the current of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by BrickletCurrent12#set_debounce_period.

CALLBACK_OVER_CURRENT

This callback is triggered when an over current is measured (see BrickletCurrent12#is_over_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_current12.rb, line 79
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_CALIBRATE] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_IS_OVER_CURRENT] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_ANALOG_VALUE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_CURRENT_CALLBACK_PERIOD] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_CURRENT_CALLBACK_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_ANALOG_VALUE_CALLBACK_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_CURRENT_CALLBACK_THRESHOLD] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_ANALOG_VALUE_CALLBACK_THRESHOLD] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_DEBOUNCE_PERIOD] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_DEBOUNCE_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE

  @callback_formats[CALLBACK_CURRENT] = [10, 's']
  @callback_formats[CALLBACK_ANALOG_VALUE] = [10, 'S']
  @callback_formats[CALLBACK_CURRENT_REACHED] = [10, 's']
  @callback_formats[CALLBACK_ANALOG_VALUE_REACHED] = [10, 'S']
  @callback_formats[CALLBACK_OVER_CURRENT] = [8, '']

  @ipcon.add_device self
end

Public Instance Methods

calibrate() click to toggle source

Calibrates the 0 value of the sensor. You have to call this function when there is no current present.

The zero point of the current sensor is depending on the exact properties of the analog-to-digital converter, the length of the Bricklet cable and the temperature. Thus, if you change the Brick or the environment in which the Bricklet is used, you might have to recalibrate.

The resulting calibration will be saved on the EEPROM of the Current Bricklet.

# File lib/tinkerforge/bricklet_current12.rb, line 131
def calibrate
  check_validity

  send_request FUNCTION_CALIBRATE, [], '', 8, ''
end
get_analog_value() click to toggle source

Returns the value as read by a 12-bit analog-to-digital converter.

.. note

The value returned by BrickletCurrent12#get_current is averaged over several samples to yield less noise, while BrickletCurrent12#get_analog_value gives back raw unfiltered analog values. The only reason to use BrickletCurrent12#get_analog_value is, if you need the full resolution of the analog-to-digital converter.

If you want the analog value periodically, it is recommended to use the CALLBACK_ANALOG_VALUE callback and set the period with BrickletCurrent12#set_analog_value_callback_period.

# File lib/tinkerforge/bricklet_current12.rb, line 158
def get_analog_value
  check_validity

  send_request FUNCTION_GET_ANALOG_VALUE, [], '', 10, 'S'
end
get_analog_value_callback_period() click to toggle source

Returns the period as set by BrickletCurrent12#set_analog_value_callback_period.

# File lib/tinkerforge/bricklet_current12.rb, line 194
def get_analog_value_callback_period
  check_validity

  send_request FUNCTION_GET_ANALOG_VALUE_CALLBACK_PERIOD, [], '', 12, 'L'
end
get_analog_value_callback_threshold() click to toggle source

Returns the threshold as set by BrickletCurrent12#set_analog_value_callback_threshold.

# File lib/tinkerforge/bricklet_current12.rb, line 242
def get_analog_value_callback_threshold
  check_validity

  send_request FUNCTION_GET_ANALOG_VALUE_CALLBACK_THRESHOLD, [], '', 13, 'k S S'
end
get_current() click to toggle source

Returns the current of the sensor.

If you want to get the current periodically, it is recommended to use the CALLBACK_CURRENT callback and set the period with BrickletCurrent12#set_current_callback_period.

# File lib/tinkerforge/bricklet_current12.rb, line 114
def get_current
  check_validity

  send_request FUNCTION_GET_CURRENT, [], '', 10, 's'
end
get_current_callback_period() click to toggle source

Returns the period as set by BrickletCurrent12#set_current_callback_period.

# File lib/tinkerforge/bricklet_current12.rb, line 176
def get_current_callback_period
  check_validity

  send_request FUNCTION_GET_CURRENT_CALLBACK_PERIOD, [], '', 12, 'L'
end
get_current_callback_threshold() click to toggle source

Returns the threshold as set by BrickletCurrent12#set_current_callback_threshold.

# File lib/tinkerforge/bricklet_current12.rb, line 218
def get_current_callback_threshold
  check_validity

  send_request FUNCTION_GET_CURRENT_CALLBACK_THRESHOLD, [], '', 13, 'k s s'
end
get_debounce_period() click to toggle source

Returns the debounce period as set by BrickletCurrent12#set_debounce_period.

# File lib/tinkerforge/bricklet_current12.rb, line 266
def get_debounce_period
  check_validity

  send_request FUNCTION_GET_DEBOUNCE_PERIOD, [], '', 12, 'L'
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_current12.rb, line 282
def get_identity
  send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S'
end
is_over_current() click to toggle source

Returns true if more than 12.5A were measured.

.. note

To reset this value you have to power cycle the Bricklet.

# File lib/tinkerforge/bricklet_current12.rb, line 141
def is_over_current
  check_validity

  send_request FUNCTION_IS_OVER_CURRENT, [], '', 9, '?'
end
register_callback(id, &block) click to toggle source

Registers a callback with ID id to the block block.

# File lib/tinkerforge/bricklet_current12.rb, line 287
def register_callback(id, &block)
  callback = block
  @registered_callbacks[id] = callback
end
set_analog_value_callback_period(period) click to toggle source

Sets the period with which the CALLBACK_ANALOG_VALUE callback is triggered periodically. A value of 0 turns the callback off.

The CALLBACK_ANALOG_VALUE callback is only triggered if the analog value has changed since the last triggering.

# File lib/tinkerforge/bricklet_current12.rb, line 187
def set_analog_value_callback_period(period)
  check_validity

  send_request FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD, [period], 'L', 8, ''
end
set_analog_value_callback_threshold(option, min, max) click to toggle source

Sets the thresholds for the CALLBACK_ANALOG_VALUE_REACHED callback.

The following options are possible:

"Option", "Description"

"'x'",    "Callback is turned off"
"'o'",    "Callback is triggered when the analog value is *outside* the min and max values"
"'i'",    "Callback is triggered when the analog value is *inside* the min and max values"
"'<'",    "Callback is triggered when the analog value is smaller than the min value (max is ignored)"
"'>'",    "Callback is triggered when the analog value is greater than the min value (max is ignored)"
# File lib/tinkerforge/bricklet_current12.rb, line 235
def set_analog_value_callback_threshold(option, min, max)
  check_validity

  send_request FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD, [option, min, max], 'k S S', 8, ''
end
set_current_callback_period(period) click to toggle source

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

The CALLBACK_CURRENT callback is only triggered if the current has changed since the last triggering.

# File lib/tinkerforge/bricklet_current12.rb, line 169
def set_current_callback_period(period)
  check_validity

  send_request FUNCTION_SET_CURRENT_CALLBACK_PERIOD, [period], 'L', 8, ''
end
set_current_callback_threshold(option, min, max) click to toggle source

Sets the thresholds for the CALLBACK_CURRENT_REACHED callback.

The following options are possible:

"Option", "Description"

"'x'",    "Callback is turned off"
"'o'",    "Callback is triggered when the current is *outside* the min and max values"
"'i'",    "Callback is triggered when the current is *inside* the min and max values"
"'<'",    "Callback is triggered when the current is smaller than the min value (max is ignored)"
"'>'",    "Callback is triggered when the current is greater than the min value (max is ignored)"
# File lib/tinkerforge/bricklet_current12.rb, line 211
def set_current_callback_threshold(option, min, max)
  check_validity

  send_request FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD, [option, min, max], 'k s s', 8, ''
end
set_debounce_period(debounce) click to toggle source

Sets the period with which the threshold callbacks

are triggered, if the thresholds

keep being reached.

# File lib/tinkerforge/bricklet_current12.rb, line 259
def set_debounce_period(debounce)
  check_validity

  send_request FUNCTION_SET_DEBOUNCE_PERIOD, [debounce], 'L', 8, ''
end