Note
This Bricklet is currently in the prototype stage and the software/hardware as well as the documentation is in an incomplete state.
This is the description of the Ruby API bindings for the Industrial Analog Out Bricklet. General information and technical specifications for the Industrial Analog Out 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).
Download (example_simple_current.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 | #!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-
require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_industrial_analog_out'
include Tinkerforge
HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change to your UID
ipcon = IPConnection.new # Create IP connection
ao = BrickletIndustrialAnalogOut.new UID, ipcon # Create device object
ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected
# Set output current to 4.5mA
ao.set_current 4500
ao.enable
puts 'Press key to exit'
$stdin.gets
ipcon.disconnect
|
Download (example_simple_voltage.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 | #!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-
require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_industrial_analog_out'
include Tinkerforge
HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change to your UID
ipcon = IPConnection.new # Create IP connection
ao = BrickletIndustrialAnalogOut.new UID, ipcon # Create device object
ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected
# Set output voltage to 3.3V
ao.set_voltage 3300
ao.enable
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:
industrial_analog_out = BrickletIndustrialAnalogOut.new 'YOUR_DEVICE_UID', ipcon
This object can then be used after the IP Connection is connected (see examples above).
Enables the output of voltage and current.
The default is disabled.
Disables the output of voltage and current.
The default is disabled.
Returns true if output of voltage and current is enabled, false otherwise.
Parameters: | voltage -- int |
---|
Sets the output voltage in mV.
Returns the voltage as set by #set_voltage.
Parameters: | current -- int |
---|
Sets the output current in µA.
Returns the current as set by #set_current.
Parameters: |
|
---|
Configures the voltage and current range.
Possible voltage ranges are:
Possible current ranges are:
The resolution will always be 12 bit. This means, that the precision is higher with a smaller range.
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 voltage_range and current_range.
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.
This constant is used to identify a Industrial Analog Out 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.