Software / API Bindings / JavaScript / API Reference and Examples / Bricklets (Discontinued) / Industrial Analog Out Bricklet

JavaScript - Industrial Analog Out Bricklet¶

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

Simple Current (Node.js)¶

Download (ExampleSimpleCurrent.js)

var Tinkerforge = require('tinkerforge');

var HOST = 'localhost';
var PORT = 4223;
var UID = 'XYZ'; // Change XYZ to the UID of your Industrial Analog Out Bricklet

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var iao = 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
        iao.setCurrent(4500);
        iao.enable();
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        iao.disable();

        ipcon.disconnect();
        process.exit(0);
    }
);

Simple Voltage (Node.js)¶

Download (ExampleSimpleVoltage.js)

var Tinkerforge = require('tinkerforge');

var HOST = 'localhost';
var PORT = 4223;
var UID = 'XYZ'; // Change XYZ to the UID of your Industrial Analog Out Bricklet

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var iao = 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
        iao.setVoltage(3300);
        iao.enable();
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        iao.disable();

        ipcon.disconnect();
        process.exit(0);
    }
);

Simple Current (HTML)¶

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

<!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>Industrial Analog Out Bricklet Simple Current 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 readonly 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 iao = 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
                        iao.setCurrent(4500);
                        iao.enable();
                    }
                );
            }
        </script>
    </body>
</html>

Simple Voltage (HTML)¶

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

<!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>Industrial Analog Out Bricklet Simple Voltage 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 readonly 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 iao = 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
                        iao.setVoltage(3300);
                        iao.enable();
                    }
                );
            }
        </script>
    </body>
</html>

API¶

Generally, every function of the JavaScript bindings can take two optional parameters, returnCallback and errorCallback. These are two user defined callback functions. The returnCallback function is called with the results as arguments, if the function returns its results asynchronously. 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
IPConnection.ERROR_STREAM_OUT_OF_SYNC = 51
IPConnection.ERROR_NON_ASCII_CHAR_IN_SECRET = 71
IPConnection.ERROR_WRONG_DEVICE_TYPE = 81
IPConnection.ERROR_DEVICE_REPLACED = 82
IPConnection.ERROR_WRONG_RESPONSE_LENGTH = 83
IPConnection.ERROR_INT64_NOT_SUPPORTED = 91

The namespace for the JavaScript bindings is Tinkerforge.*.

Basic Functions¶

new BrickletIndustrialAnalogOut(uid, ipcon)¶

Parameters:	uid – Type: string ipcon – Type: IPConnection
Returns:	industrialAnalogOut – Type: BrickletIndustrialAnalogOut

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.

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

Callback Parameters:	undefined
Returns:	undefined

Enables the output of voltage and current.

The default is disabled.

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

Callback Parameters:	undefined
Returns:	undefined

Disables the output of voltage and current.

The default is disabled.

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

Callback Parameters:	enabled – Type: boolean, Default: false
Returns:	undefined

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

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

Parameters:	voltage – Type: int, Unit: 1 mV, Range: [0 to 10000]
Callback Parameters:	undefined
Returns:	undefined

Sets the output voltage.

The output voltage and output current are linked. Changing the output voltage also changes the output current.

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

Callback Parameters:	voltage – Type: int, Unit: 1 mV, Range: [0 to 10000]
Returns:	undefined

Returns the voltage as set by setVoltage().

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

Parameters:	current – Type: int, Unit: 1 µA, Range: [0 to 24000]
Callback Parameters:	undefined
Returns:	undefined

Sets the output current.

The output current and output voltage are linked. Changing the output current also changes the output voltage.

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

Callback Parameters:	current – Type: int, Unit: 1 µA, Range: [0 to 24000]
Returns:	undefined

Returns the current as set by setCurrent().

Advanced Functions¶

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

Parameters:	voltageRange – Type: int, Range: See constants, Default: 1 currentRange – Type: int, Range: See constants, Default: 0
Callback Parameters:	undefined
Returns:	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:

For voltage_range:

BrickletIndustrialAnalogOut.VOLTAGE_RANGE_0_TO_5V = 0
BrickletIndustrialAnalogOut.VOLTAGE_RANGE_0_TO_10V = 1

For current_range:

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 Parameters:	voltageRange – Type: int, Range: See constants, Default: 1 currentRange – Type: int, Range: See constants, Default: 0
Returns:	undefined

Returns the configuration as set by setConfiguration().

The following constants are available for this function:

For voltage_range:

BrickletIndustrialAnalogOut.VOLTAGE_RANGE_0_TO_5V = 0
BrickletIndustrialAnalogOut.VOLTAGE_RANGE_0_TO_10V = 1

For current_range:

BrickletIndustrialAnalogOut.CURRENT_RANGE_4_TO_20MA = 0
BrickletIndustrialAnalogOut.CURRENT_RANGE_0_TO_20MA = 1
BrickletIndustrialAnalogOut.CURRENT_RANGE_0_TO_24MA = 2

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

Callback Parameters:

Callback Parameters:	uid – Type: string, Length: up to 8 connectedUid – Type: string, Length: up to 8 position – Type: char, Range: ['a' to 'h', 'z'] hardwareVersion – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] firmwareVersion – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] deviceIdentifier – Type: int, Range: [0 to 2¹⁶ - 1]
Returns:	undefined

uid – Type: string, Length: up to 8
connectedUid – Type: string, Length: up to 8
position – Type: char, Range: ['a' to 'h', 'z']
hardwareVersion – Type: [int, ...], Length: 3

0: major – Type: int, Range: [0 to 255]
1: minor – Type: int, Range: [0 to 255]
2: revision – Type: int, Range: [0 to 255]

firmwareVersion – Type: [int, ...], Length: 3

0: major – Type: int, Range: [0 to 255]
1: minor – Type: int, Range: [0 to 255]
2: revision – Type: int, Range: [0 to 255]

deviceIdentifier – Type: int, Range: [0 to 2¹⁶ - 1]

Returns:

undefined

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', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

BrickletIndustrialAnalogOut.getAPIVersion()¶

Returns:	apiVersion – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255]

Returns the version of the API definition 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 – Type: int, Range: See constants
Returns:	responseExpected – 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 sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For function_id:

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

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

Parameters:	functionId – Type: int, Range: See constants responseExpected – Type: boolean
Returns:	undefined

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.

The following constants are available for this function:

For function_id:

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 – Type: boolean
Returns:	undefined

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

Constants¶

BrickletIndustrialAnalogOut.DEVICE_IDENTIFIER¶

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

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

BrickletIndustrialAnalogOut.DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Industrial Analog Out Bricklet.