Ruby - Analog Out Bricklet

This is the description of the Ruby API bindings for the Analog Out Bricklet. General information and technical specifications for the Analog Out Bricklet are summarized in its hardware description.

An installation guide for the Ruby API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

Simple

Download (example_simple.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
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_analog_out'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Analog Out Bricklet

ipcon = IPConnection.new # Create IP connection
ao = BrickletAnalogOut.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

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

API

All methods listed below are thread-safe.

Basic Functions

BrickletAnalogOut::new(uid, ipcon) → analog_out
Parameters:
  • uid – Type: str
  • ipcon – Type: IPConnection
Returns:
  • analog_out – Type: BrickletAnalogOut

Creates an object with the unique device ID uid:

analog_out = BrickletAnalogOut.new 'YOUR_DEVICE_UID', ipcon

This object can then be used after the IP Connection is connected (see examples above).

BrickletAnalogOut#set_voltage(voltage) → nil
Parameters:
  • voltage – Type: int, Range: [0 to 216 - 1]

Sets the voltage in mV. The possible range is 0V to 5V (0-5000). Calling this function will set the mode to 0 (see #set_mode).

The default value is 0 (with mode 1).

BrickletAnalogOut#get_voltage → int
Returns:
  • voltage – Type: int, Range: [0 to 216 - 1]

Returns the voltage as set by #set_voltage.

BrickletAnalogOut#set_mode(mode) → nil
Parameters:
  • mode – Type: int, Range: See constants

Sets the mode of the analog value. Possible modes:

  • 0: Normal Mode (Analog value as set by #set_voltage is applied)
  • 1: 1k Ohm resistor to ground
  • 2: 100k Ohm resistor to ground
  • 3: 500k Ohm resistor to ground

Setting the mode to 0 will result in an output voltage of 0. You can jump to a higher output voltage directly by calling #set_voltage.

The default mode is 1.

The following constants are available for this function:

For mode:

  • BrickletAnalogOut::MODE_ANALOG_VALUE = 0
  • BrickletAnalogOut::MODE_1K_TO_GROUND = 1
  • BrickletAnalogOut::MODE_100K_TO_GROUND = 2
  • BrickletAnalogOut::MODE_500K_TO_GROUND = 3
BrickletAnalogOut#get_mode → int
Returns:
  • mode – Type: int, Range: See constants

Returns the mode as set by #set_mode.

The following constants are available for this function:

For mode:

  • BrickletAnalogOut::MODE_ANALOG_VALUE = 0
  • BrickletAnalogOut::MODE_1K_TO_GROUND = 1
  • BrickletAnalogOut::MODE_100K_TO_GROUND = 2
  • BrickletAnalogOut::MODE_500K_TO_GROUND = 3

Advanced Functions

BrickletAnalogOut#get_api_version → [int, ...]
Returns:
  • api_version – Type: [int, ...], Length: 3, Range: [0 to 255]

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.

BrickletAnalogOut#get_response_expected(function_id) → bool
Parameters:
  • function_id – Type: int, Range: See constants
Returns:
  • response_expected – Type: bool

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.

The following constants are available for this function:

For function_id:

  • BrickletAnalogOut::FUNCTION_SET_VOLTAGE = 1
  • BrickletAnalogOut::FUNCTION_SET_MODE = 3
BrickletAnalogOut#set_response_expected(function_id, response_expected) → nil
Parameters:
  • function_id – Type: int, Range: See constants
  • response_expected – Type: bool

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.

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 constants are available for this function:

For function_id:

  • BrickletAnalogOut::FUNCTION_SET_VOLTAGE = 1
  • BrickletAnalogOut::FUNCTION_SET_MODE = 3
BrickletAnalogOut#set_response_expected_all(response_expected) → nil
Parameters:
  • response_expected – Type: bool

Changes the response expected flag for all setter and callback configuration functions of this device at once.

BrickletAnalogOut#get_identity → [str, str, chr, [int, ...], [int, ...], int]
Return Array:
  • 0: uid – Type: str, Length: up to 8
  • 1: connected_uid – Type: str, Length: up to 8
  • 2: position – Type: chr
  • 3: hardware_version – Type: [int, ...], Length: 3, Range: [0 to 255]
  • 4: firmware_version – Type: [int, ...], Length: 3, Range: [0 to 255]
  • 5: device_identifier – Type: int, Range: [0 to 216 - 1]

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.

Constants

BrickletAnalogOut::DEVICE_IDENTIFIER

This constant is used to identify a Analog Out Bricklet.

The #get_identity() function and the IPConnection::CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

BrickletAnalogOut::DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Analog Out Bricklet.