JavaScript - Industrial Analog Out Bricklet – Tinkerforge

- Getting Started
- Hardware
- Software
- Starter Kits
- Embedded Boards
- Specifications

# JavaScript - Industrial Analog Out Bricklet

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

## Examples

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

### SimpleCurrent (Node.js)

Download (ExampleSimpleCurrent.js)

     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

    var Tinkerforge = require('tinkerforge');

    var HOST = 'localhost';
    var PORT = 4223;
    var UID = 'XYZ'; // Change to your UID

    var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
    var ao = new Tinkerforge.BrickletIndustrialAnalogOut(UID, ipcon); // Create device object

    ipcon.connect(HOST, PORT,
        function(error) {
            console.log('Error: '+error);
        }
    ); // Connect to brickd
    // Don't use device before ipcon is connected

    ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
        function(connectReason) {
            // Set output current to 4.5mA
            ao.setCurrent(4500);
            ao.enable();
        }
    );

    console.log("Press any key to exit ...");
    process.stdin.on('data',
        function(data) {
            ipcon.disconnect();
            process.exit(0);
        }
    );

### SimpleVoltage (Node.js)

Download (ExampleSimpleVoltage.js)

     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

    var Tinkerforge = require('tinkerforge');

    var HOST = 'localhost';
    var PORT = 4223;
    var UID = 'XYZ'; // Change to your UID

    var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
    var ao = new Tinkerforge.BrickletIndustrialAnalogOut(UID, ipcon); // Create device object

    ipcon.connect(HOST, PORT,
        function(error) {
            console.log('Error: '+error);
        }
    ); // Connect to brickd
    // Don't use device before ipcon is connected

    ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
        function(connectReason) {
            // Set output voltage to 3.3V
            ao.setVoltage(3300);
            ao.enable();
        }
    );

    console.log("Press any key to exit ...");
    process.stdin.on('data',
        function(data) {
            ipcon.disconnect();
            process.exit(0);
        }
    );

### SimpleCurrent (HTML)

Download (ExampleSimpleCurrent.html), Test (ExampleSimpleCurrent.html)

     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
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52

    <!DOCTYPE html>
    <html>
        <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
        <head>
            <title>Tinkerforge | JavaScript Example</title>
        </head>
        <body>
            <div style="text-align:center;">
                <h1>Analog Out Bricklet Simple Example</h1>
                <p>
                    <input value="localhost" id="host" type="text" size="20">:
                    <input value="4280" id="port" type="text" size="5">,
                    <input value="uid" id="uid" type="text" size="5">
                    <input value="Start Example" id="start" type="button" onclick="startExample();">
                </p>
                <p>
                    <textarea id="text" cols="80" rows="24" style="resize:none;"
                              >Press "Start Example" to begin ...</textarea>
                </p>
            <div>
            <script src="./Tinkerforge.js" type='text/javascript'></script>
            <script type='text/javascript'>
                var ipcon;
                var textArea = document.getElementById("text");
                function startExample() {
                    textArea.value = "";
                    var HOST = document.getElementById("host").value;
                    var PORT = parseInt(document.getElementById("port").value);
                    var UID = document.getElementById("uid").value;
                    if(ipcon !== undefined) {
                        ipcon.disconnect();
                    }
                    ipcon = new Tinkerforge.IPConnection(); // Create IP connection
                    var ao = new Tinkerforge.BrickletIndustrialAnalogOut(UID, ipcon); // Create device object
                    ipcon.connect(HOST, PORT,
                        function(error) {
                            textArea.value += 'Error: '+error+ '\n';
                        }
                    ); // Connect to brickd
                    // Don't use device before ipcon is connected

                    ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
                        function(connectReason) {
                            //Set output current to 4.5mA
                            ao.setCurrent(4500);
                            ao.enable();
                        }
                    );
                }
            </script>
        </body>
    </html>

### SimpleVoltage (HTML)

Download (ExampleSimpleVoltage.html), Test (ExampleSimpleVoltage.html)

     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
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52

    <!DOCTYPE html>
    <html>
        <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
        <head>
            <title>Tinkerforge | JavaScript Example</title>
        </head>
        <body>
            <div style="text-align:center;">
                <h1>Analog Out Bricklet Simple Example</h1>
                <p>
                    <input value="localhost" id="host" type="text" size="20">:
                    <input value="4280" id="port" type="text" size="5">,
                    <input value="uid" id="uid" type="text" size="5">
                    <input value="Start Example" id="start" type="button" onclick="startExample();">
                </p>
                <p>
                    <textarea id="text" cols="80" rows="24" style="resize:none;"
                              >Press "Start Example" to begin ...</textarea>
                </p>
            <div>
            <script src="./Tinkerforge.js" type='text/javascript'></script>
            <script type='text/javascript'>
                var ipcon;
                var textArea = document.getElementById("text");
                function startExample() {
                    textArea.value = "";
                    var HOST = document.getElementById("host").value;
                    var PORT = parseInt(document.getElementById("port").value);
                    var UID = document.getElementById("uid").value;
                    if(ipcon !== undefined) {
                        ipcon.disconnect();
                    }
                    ipcon = new Tinkerforge.IPConnection(); // Create IP connection
                    var ao = new Tinkerforge.BrickletIndustrialAnalogOut(UID, ipcon); // Create device object
                    ipcon.connect(HOST, PORT,
                        function(error) {
                            textArea.value += 'Error: '+error+ '\n';
                        }
                    ); // Connect to brickd
                    // Don't use device before ipcon is connected

                    ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
                        function(connectReason) {
                            //Set output voltage to 3.3V
                            ao.setVoltage(3300);
                            ao.enable();
                        }
                    );
                }
            </script>
        </body>
    </html>

## API

Generally, every method of the JavaScript bindings can take two optional parameters, `returnCallback` and `errorCallback`. These are two user defined callback functions. The `returnCallback` is called with the return values as parameters, if the method returns something. The `errorCallback` is called with an error code in case of an error. The error code can be one of the following values:

- IPConnection.ERROR_ALREADY_CONNECTED = 11
- IPConnection.ERROR_NOT_CONNECTED = 12
- IPConnection.ERROR_CONNECT_FAILED = 13
- IPConnection.ERROR_INVALID_FUNCTION_ID = 21
- IPConnection.ERROR_TIMEOUT = 31
- IPConnection.ERROR_INVALID_PARAMETER = 41
- IPConnection.ERROR_FUNCTION_NOT_SUPPORTED = 42
- IPConnection.ERROR_UNKNOWN_ERROR = 43

The namespace for the JavaScript bindings is `Tinkerforge.*`.

### Basic Functions

new `BrickletIndustrialAnalogOut`(uid, ipcon)

  Parameters:

  - uid -- string
  - ipcon -- IPConnection

  Creates an object with the unique device ID `uid`:

      var industrialAnalogOut = new BrickletIndustrialAnalogOut("YOUR_DEVICE_UID", ipcon);

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

`BrickletIndustrialAnalogOut.``enable`([returnCallback][, errorCallback])

  Callback: | undefined

  Enables the output of voltage and current.

  The default is disabled.

`BrickletIndustrialAnalogOut.``disable`([returnCallback][, errorCallback])

  Callback: | undefined

  Disables the output of voltage and current.

  The default is disabled.

`BrickletIndustrialAnalogOut.``isEnabled`([returnCallback][, errorCallback])

  Callback:

  - enabled -- boolean

  Returns true if output of voltage and current is enabled, false otherwise.

`BrickletIndustrialAnalogOut.``setVoltage`(voltage[, returnCallback][, errorCallback])

  Parameters:

  - voltage -- int

  Callback: | undefined

  Sets the output voltage in mV.

`BrickletIndustrialAnalogOut.``getVoltage`([returnCallback][, errorCallback])

  Callback:

  - voltage -- int

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

`BrickletIndustrialAnalogOut.``setCurrent`(current[, returnCallback][, errorCallback])

  Parameters:

  - current -- int

  Callback: | undefined

  Sets the output current in µA.

`BrickletIndustrialAnalogOut.``getCurrent`([returnCallback][, errorCallback])

  Callback:

  - current -- int

  Returns the current as set by `setCurrent()`.

### Advanced Functions

`BrickletIndustrialAnalogOut.``setConfiguration`(voltageRange, currentRange[, returnCallback][, errorCallback])

  Parameters:

  - voltageRange -- int
  - currentRange -- int

  Callback: | undefined

  Configures the voltage and current range.

  Possible voltage ranges are:

  - 0V to 5V
  - 0V to 10V

  Possible current ranges are:

  - 4mA to 20mA
  - 0mA to 20mA
  - 0mA to 24mA

  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:

  - BrickletIndustrialAnalogOut.VOLTAGE_RANGE_0_TO_5V = 0
  - BrickletIndustrialAnalogOut.VOLTAGE_RANGE_0_TO_10V = 1
  - BrickletIndustrialAnalogOut.CURRENT_RANGE_4_TO_20MA = 0
  - BrickletIndustrialAnalogOut.CURRENT_RANGE_0_TO_20MA = 1
  - BrickletIndustrialAnalogOut.CURRENT_RANGE_0_TO_24MA = 2

`BrickletIndustrialAnalogOut.``getConfiguration`([returnCallback][, errorCallback])

  Callback:

  - voltageRange -- int
  - currentRange -- int

  Returns the configuration as set by `setConfiguration()`.

  The following constants are available for this function:

  - BrickletIndustrialAnalogOut.VOLTAGE_RANGE_0_TO_5V = 0
  - BrickletIndustrialAnalogOut.VOLTAGE_RANGE_0_TO_10V = 1
  - BrickletIndustrialAnalogOut.CURRENT_RANGE_4_TO_20MA = 0
  - BrickletIndustrialAnalogOut.CURRENT_RANGE_0_TO_20MA = 1
  - BrickletIndustrialAnalogOut.CURRENT_RANGE_0_TO_24MA = 2

`BrickletIndustrialAnalogOut.``getAPIVersion`()

  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.

`BrickletIndustrialAnalogOut.``getResponseExpected`(functionId[, errorCallback])

  Parameters:

  - functionId -- int

  Return type: | boolean

  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 `setResponseExpected()`. 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 `setResponseExpected()` for the list of function ID constants available for this function.

`BrickletIndustrialAnalogOut.``setResponseExpected`(functionId, responseExpected[, errorCallback])

  Parameters:

  - functionId -- int
  - responseExpected -- boolean

  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:

  - BrickletIndustrialAnalogOut.FUNCTION_ENABLE = 1
  - BrickletIndustrialAnalogOut.FUNCTION_DISABLE = 2
  - BrickletIndustrialAnalogOut.FUNCTION_SET_VOLTAGE = 4
  - BrickletIndustrialAnalogOut.FUNCTION_SET_CURRENT = 6
  - BrickletIndustrialAnalogOut.FUNCTION_SET_CONFIGURATION = 8

`BrickletIndustrialAnalogOut.``setResponseExpectedAll`(responseExpected)

  Parameters:

  - responseExpected -- boolean

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

`BrickletIndustrialAnalogOut.``getIdentity`([returnCallback][, errorCallback])

  Callback:

  - uid -- string
  - connectedUid -- string
  - position -- char
  - hardwareVersion -- [int, int, int]
  - firmwareVersion -- [int, int, int]
  - deviceIdentifier -- 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.

### Constants

`BrickletIndustrialAnalogOut.``DEVICE_IDENTIFIER`

  This constant is used to identify a Industrial Analog Out Bricklet.

  The `getIdentity()` 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.