Perl - Analog Out Bricklet – Tinkerforge

- Getting Started
  - Primer
  - Tutorials
  - FAQ
- Hardware
  - Bricks
  - Bricklets
  - Master Extensions
  - Power Supplies
  - Accessories
  - Timeline
- Software
  - Brick Daemon (brickd)
  - Brick Viewer (brickv)
  - API Bindings
    - C/C++
    - C/C++ (iOS)
    - C#
    - C# (Windows Phone)
    - Delphi/Lazarus
    - Java
    - Java (Android)
    - JavaScript
    - LabVIEW
    - Mathematica
    - MATLAB/Octave
    - Perl
      - Requirements
      - Installation
      - Testing an Example
      - Known Problems
      - API Reference and Examples
        - IP Connection
        - Bricks
        - Bricklets
          - Ambient Light Bricklet
          - Analog In Bricklet
          - Analog Out Bricklet
            - Examples
              - Simple
            - API
              - Basic Functions
              - Advanced Functions
              - Constants
          - Barometer Bricklet
          - Color Bricklet
          - Current12 Bricklet
          - Current25 Bricklet
          - Distance IR Bricklet
          - Distance US Bricklet
          - Dual Button Bricklet
          - Dual Relay Bricklet
          - GPS Bricklet
          - Hall Effect Bricklet
          - Humidity Bricklet
          - Industrial Digital In 4 Bricklet
          - Industrial Digital Out 4 Bricklet
          - Industrial Dual 0-20mA Bricklet
          - Industrial Quad Relay Bricklet
          - IO-16 Bricklet
          - IO-4 Bricklet
          - Joystick Bricklet
          - LCD 16x2 Bricklet
          - LCD 20x4 Bricklet
          - LED Strip Bricklet
          - Line Bricklet
          - Linear Poti Bricklet
          - Moisture Bricklet
          - Motion Detector Bricklet
          - Multi Touch Bricklet
          - NFC/RFID Bricklet
          - Piezo Buzzer Bricklet
          - Piezo Speaker Bricklet
          - PTC Bricklet
          - Remote Switch Bricklet
          - Rotary Encoder Bricklet
          - Rotary Poti Bricklet
          - Segment Display 4x7 Bricklet
          - Solid State Relay Bricklet
          - Sound Intensity Bricklet
          - Temperature Bricklet
          - Temperature IR Bricklet
          - Tilt Bricklet
          - Voltage Bricklet
          - Voltage/Current Bricklet
    - PHP
    - Python
    - Ruby
    - Shell
    - Visual Basic .NET
  - Firmwares and Plugins
  - Device Identifier
  - Source Code and Bug Tracking
  - Programming Interface
- Starter Kits
  - Weather Station
  - Hardware Hacking
  - Server Room Monitoring
  - Blinkenlights
  - Internet of Things
  - Camera Slider
- Embedded Boards
  - Raspberry Pi
- Specifications
  - Technical Data
  - TCP/IP Protocol
  - Modbus Protocol
  - Wireshark Dissector

# Perl - Analog Out Bricklet

This is the description of the Perl 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 Perl API bindings is part of their general description.

## Examples

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

### Simple

Download (example_simple.pl)

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21

    #!/usr/bin/perl

    use Tinkerforge::IPConnection;
    use Tinkerforge::BrickletAnalogOut;

    use constant HOST => 'localhost';
    use constant PORT => 4223;
    use constant UID => 'ikE'; # Change to your UID

    my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
    my $ao = Tinkerforge::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);

    print "Press any key to exit...\n";
    <STDIN>;
    $ipcon->disconnect();

## API

Generally, every subroutine of the Perl bindings can report an error as `Tinkerforge::Error` object via `croak()`. The object has a `get_code()` and a `get_message()` subroutine. There are different error code:

- Error->ALREADY_CONNECTED = 11
- Error->NOT_CONNECTED = 12
- Error->CONNECT_FAILED = 13
- Error->INVALID_FUNCTION_ID = 21
- Error->TIMEOUT = 31
- Error->INVALID_PARAMETER = 41
- Error->FUNCTION_NOT_SUPPORTED = 42
- Error->UNKNOWN_ERROR = 43

All methods listed below are thread-safe.

### Basic Functions

`BrickletAnalogOut``->``new`($uid, $ipcon)

  Parameters:

  - $uid -- string
  - $ipcon -- IPConnection

  Return 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)

  Parameters: | $voltage -- int
  Return type: | undef

  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`()

  Return type: | int

  Returns the voltage as set by `set_voltage()`.

`BrickletAnalogOut``->``set_mode`($mode)

  Parameters: | $mode -- int
  Return type: | undef

  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:

  - 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`()

  Return type: | int

  Returns the mode as set by `set_mode()`.

  The following constants are available for this function:

  - 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`()

  Return type: | [int, int, int]

  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)

  Parameters: | $function_id -- int
  Return 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.

  See `set_response_expected()` for the list of function ID constants available for this function.

`BrickletAnalogOut``->``set_response_expected`($function_id, $response_expected)

  Parameters:

  - $function_id -- int
  - $response_expected -- bool

  Return type: | undef

  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:

  - BrickletAnalogOut->FUNCTION_SET_VOLTAGE = 1
  - BrickletAnalogOut->FUNCTION_SET_MODE = 3

`BrickletAnalogOut``->``set_response_expected_all`($response_expected)

  Parameters: | $response_expected -- bool
  Return type: | undef

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

`BrickletAnalogOut``->``get_identity`()

  Return type: | [string, string, char, [int, int, int], [int, int, int], int]

  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 contains the elements `uid`, `connected_uid`, `position`, `hardware_version`, `firmware_version` and `device_identifier`.

### Constants

`BrickletAnalogOut``->``DEVICE_IDENTIFIER`

  This constant is used to identify a 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.

The content of this page is licensed under Creative Commons Attribution 3.0 Unported License.