This is the description of the Ruby API bindings for the Voltage/Current Bricklet. General information and technical specifications for the Voltage/Current Bricklet are summarized in its hardware description.
An installation guide for the Ruby API bindings is part of their general description.
The example code below is Public Domain (CC0 1.0).
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 | #!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-
require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_voltage_current'
include Tinkerforge
HOST = 'localhost'
PORT = 4223
UID = 'ABC' # Change to your UID
ipcon = IPConnection.new # Create IP connection
vc = BrickletVoltageCurrent.new UID, ipcon # Create device object
ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected
# Get current current and voltage (unit is mA and mV)
current = vc.get_current / 1000.0
voltage = vc.get_voltage / 1000.0
puts "Current: #{current} A"
puts "Voltage: #{voltage} V"
puts 'Press key to exit'
$stdin.gets
ipcon.disconnect
|
Download (example_callback.rb)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 | #!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-
require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_voltage_current'
include Tinkerforge
HOST = 'localhost'
PORT = 4223
UID = 'ABC' # Change to your UID
ipcon = IPConnection.new # Create IP connection
vc = BrickletVoltageCurrent.new UID, ipcon # Create device object
ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected
# Set Period for current callback to 1s (1000ms)
# Note: The callback is only called every second if the
# current has changed since the last call!
vc.set_current_callback_period 1000
# Register current callback (parameter has unit mA)
vc.register_callback(BrickletVoltageCurrent::CALLBACK_CURRENT) do |current|
puts "Current: #{current/1000.0} A"
end
puts 'Press key to exit'
$stdin.gets
ipcon.disconnect
|
Download (example_threshold.rb)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 | #!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-
require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_voltage_current'
include Tinkerforge
HOST = 'localhost'
PORT = 4223
UID = 'ABC' # Change to your UID
ipcon = IPConnection.new # Create IP connection
vc = BrickletVoltageCurrent.new UID, ipcon # Create device object
ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected
# Get threshold callbacks with a debounce time of 10 seconds (10000ms)
vc.set_debounce_period 10000
# Register threshold reached callback for "greater than 1A" (unit is mA)
vc.register_callback(BrickletVoltageCurrent::CALLBACK_CURRENT_REACHED) do |current|
puts "Current is greater than 1A: #{current/1000.0}"
end
# Configure threshold for "greater than 1A" (unit is mA)
vc.set_current_callback_threshold '>', 1*1000, 0
puts 'Press key to exit'
$stdin.gets
ipcon.disconnect
|
All methods listed below are thread-safe.
Parameters: |
|
---|
Creates an object with the unique device ID uid:
voltage_current = BrickletVoltageCurrent.new 'YOUR_DEVICE_UID', ipcon
This object can then be used after the IP Connection is connected (see examples above).
Returns the current. The value is in mA and between -20000mA and 20000mA.
If you want to get the current periodically, it is recommended to use the callback ::CALLBACK_CURRENT and set the period with #set_current_callback_period.
Returns the voltage. The value is in mV and between 0mV and 36000mV.
If you want to get the voltage periodically, it is recommended to use the callback ::CALLBACK_VOLTAGE and set the period with #set_voltage_callback_period.
Returns the power. The value is in mW and between 0mV and 720000mW.
If you want to get the power periodically, it is recommended to use the callback ::CALLBACK_POWER and set the period with #set_power_callback_period.
Parameters: |
|
---|
Sets the configuration of the Voltage/Current Bricklet. It is possible to configure number of averages as well as voltage and current conversion time.
Averaging:
Value | Number of Averages |
---|---|
0 | 1 |
1 | 4 |
2 | 16 |
3 | 64 |
4 | 128 |
5 | 256 |
6 | 512 |
>=7 | 1024 |
Voltage/Current conversion:
Value | Conversion time |
---|---|
0 | 140µs |
1 | 204µs |
2 | 332µs |
3 | 588µs |
4 | 1.1ms |
5 | 2.116ms |
6 | 4.156ms |
>=7 | 8.244ms |
The default values are 3, 4 and 4 (64, 1.1ms, 1.1ms) for averaging, voltage conversion and current conversion.
The following constants are available for this function:
Returns the configuration as set by #set_configuration.
The following constants are available for this function:
The returned array has the values averaging, voltage_conversion_time and current_conversion_time.
Parameters: |
|
---|
Since the shunt resistor that is used to measure the current is not perfectly precise, it needs to be calibrated by a multiplier and divisor if a very precise reading is needed.
For example, if you are expecting a measurement of 1000mA and you are measuring 1023mA, you can calibrate the Voltage/Current Bricklet by setting the multiplier to 1000 and the divisor to 1023.
Returns the calibration as set by #set_calibration.
The returned array has the values gain_multiplier and gain_divisor.
Returns the version of the API definition (major, minor, revision) 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.
Parameters: | function_id -- int |
---|
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.
See #set_response_expected for the list of function ID constants available for this function.
Parameters: |
|
---|
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 and callbacks it is always disabled.
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 function ID constants are available for this function:
Parameters: | response_expected -- bool |
---|
Changes the response expected flag for all setter and callback configuration functions of this device at once.
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. There is also a constant for the device identifier of this Bricklet.
The returned array has the values uid, connected_uid, position, hardware_version, firmware_version and device_identifier.
Parameters: | id -- int |
---|
Registers a callback with ID id to the given block. The available IDs with corresponding function signatures are listed below.
Parameters: | period -- int |
---|
Sets the period in ms with which the ::CALLBACK_CURRENT callback is triggered periodically. A value of 0 turns the callback off.
::CALLBACK_CURRENT is only triggered if the current has changed since the last triggering.
The default value is 0.
Returns the period as set by #set_current_callback_period.
Parameters: | period -- int |
---|
Sets the period in ms with which the ::CALLBACK_VOLTAGE callback is triggered periodically. A value of 0 turns the callback off.
::CALLBACK_VOLTAGE is only triggered if the voltage has changed since the last triggering.
The default value is 0.
Returns the period as set by #set_voltage_callback_period.
Parameters: | period -- int |
---|
Sets the period in ms with which the ::CALLBACK_POWER callback is triggered periodically. A value of 0 turns the callback off.
::CALLBACK_POWER is only triggered if the power has changed since the last triggering.
The default value is 0.
Returns the period as set by #get_power_callback_period.
Parameters: |
|
---|
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) |
The default value is ('x', 0, 0).
The following constants are available for this function:
Returns the threshold as set by #set_current_callback_threshold.
The following constants are available for this function:
The returned array has the values option, min and max.
Parameters: |
|
---|
Sets the thresholds for the ::CALLBACK_VOLTAGE_REACHED callback.
The following options are possible:
Option | Description |
---|---|
'x' | Callback is turned off |
'o' | Callback is triggered when the voltage is outside the min and max values |
'i' | Callback is triggered when the voltage is inside the min and max values |
'<' | Callback is triggered when the voltage is smaller than the min value (max is ignored) |
'>' | Callback is triggered when the voltage is greater than the min value (max is ignored) |
The default value is ('x', 0, 0).
The following constants are available for this function:
Returns the threshold as set by #set_voltage_callback_threshold.
The following constants are available for this function:
The returned array has the values option, min and max.
Parameters: |
|
---|
Sets the thresholds for the ::CALLBACK_POWER_REACHED callback.
The following options are possible:
Option | Description |
---|---|
'x' | Callback is turned off |
'o' | Callback is triggered when the power is outside the min and max values |
'i' | Callback is triggered when the power is inside the min and max values |
'<' | Callback is triggered when the power is smaller than the min value (max is ignored) |
'>' | Callback is triggered when the power is greater than the min value (max is ignored) |
The default value is ('x', 0, 0).
The following constants are available for this function:
Returns the threshold as set by #set_power_callback_threshold.
The following constants are available for this function:
The returned array has the values option, min and max.
Parameters: | debounce -- int |
---|
Sets the period in ms with which the threshold callbacks
are triggered, if the thresholds
keep being reached.
The default value is 100.
Returns the debounce period as set by #set_debounce_period.
Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the #register_callback function of the device object. The first parameter is the callback ID and the second parameter is a block:
voltage_current.register_callback BrickletVoltageCurrent::CALLBACK_EXAMPLE, do |param|
puts "#{param}"
end
The available constants with inherent number and type of parameters are described below.
Note
Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.
Parameters: | current -- int |
---|
This callback is triggered periodically with the period that is set by #set_current_callback_period. The parameter is the current of the sensor.
::CALLBACK_CURRENT is only triggered if the current has changed since the last triggering.
Parameters: | voltage -- int |
---|
This callback is triggered periodically with the period that is set by #set_voltage_callback_period. The parameter is the voltage of the sensor.
::CALLBACK_VOLTAGE is only triggered if the voltage has changed since the last triggering.
Parameters: | power -- int |
---|
This callback is triggered periodically with the period that is set by #set_power_callback_period. The parameter is the power of the sensor.
::CALLBACK_POWER is only triggered if the power has changed since the last triggering.
Parameters: | current -- int |
---|
This callback is triggered when the threshold as set by #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 #set_debounce_period.
Parameters: | voltage -- int |
---|
This callback is triggered when the threshold as set by #set_voltage_callback_threshold is reached. The parameter is the voltage of the sensor.
If the threshold keeps being reached, the callback is triggered periodically with the period as set by #set_debounce_period.
Parameters: | power -- int |
---|
This callback is triggered when the threshold as set by #set_power_callback_threshold is reached. The parameter is the power of the sensor.
If the threshold keeps being reached, the callback is triggered periodically with the period as set by #set_debounce_period.
This constant is used to identify a Voltage/Current Bricklet.
The #get_identity() function and the ::CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.