JavaScript - Analog Out Bricklet 3.0

This is the description of the JavaScript API bindings for the Analog Out Bricklet 3.0. General information and technical specifications for the Analog Out Bricklet 3.0 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 (Node.js)

Download (ExampleSimple.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
var Tinkerforge = require('tinkerforge');

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

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

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

Simple (HTML)

Download (ExampleSimple.html), Test (ExampleSimple.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
<!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 3.0 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 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 ao = new Tinkerforge.BrickletAnalogOutV3(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.setOutputVoltage(3300);
                    }
                );
            }
        </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 BrickletAnalogOutV3(uid, ipcon)
Parameters:
  • uid -- string
  • ipcon -- IPConnection

Creates an object with the unique device ID uid:

var analogOutV3 = new BrickletAnalogOutV3("YOUR_DEVICE_UID", ipcon);

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

BrickletAnalogOutV3.setOutputVoltage(voltage[, returnCallback][, errorCallback])
Parameters:
  • voltage -- int
Callback:

undefined

Sets the voltage in mV. The possible range is 0V to 12V (0-12000).

BrickletAnalogOutV3.getOutputVoltage([returnCallback][, errorCallback])
Callback:
  • voltage -- int

Returns the voltage as set by setOutputVoltage().

Advanced Functions

BrickletAnalogOutV3.getInputVoltage([returnCallback][, errorCallback])
Callback:
  • voltage -- int

Returns the input voltage in mV.

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

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

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

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:

  • BrickletAnalogOutV3.FUNCTION_SET_OUTPUT_VOLTAGE = 1
  • BrickletAnalogOutV3.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletAnalogOutV3.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletAnalogOutV3.FUNCTION_RESET = 243
  • BrickletAnalogOutV3.FUNCTION_WRITE_UID = 248
BrickletAnalogOutV3.setResponseExpectedAll(responseExpected)
Parameters:
  • responseExpected -- boolean

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

BrickletAnalogOutV3.getSPITFPErrorCount([returnCallback][, errorCallback])
Callback:
  • errorCountAckChecksum -- int
  • errorCountMessageChecksum -- int
  • errorCountFrame -- int
  • errorCountOverflow -- int

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

  • ACK checksum errors,
  • message checksum errors,
  • framing errors and
  • overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

BrickletAnalogOutV3.setBootloaderMode(mode[, returnCallback][, errorCallback])
Parameters:
  • mode -- int
Callback:
  • status -- int

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following constants are available for this function:

  • BrickletAnalogOutV3.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletAnalogOutV3.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletAnalogOutV3.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletAnalogOutV3.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletAnalogOutV3.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BrickletAnalogOutV3.BOOTLOADER_STATUS_OK = 0
  • BrickletAnalogOutV3.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletAnalogOutV3.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletAnalogOutV3.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletAnalogOutV3.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletAnalogOutV3.BOOTLOADER_STATUS_CRC_MISMATCH = 5
BrickletAnalogOutV3.getBootloaderMode([returnCallback][, errorCallback])
Callback:
  • mode -- int

Returns the current bootloader mode, see setBootloaderMode().

The following constants are available for this function:

  • BrickletAnalogOutV3.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletAnalogOutV3.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletAnalogOutV3.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletAnalogOutV3.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletAnalogOutV3.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
BrickletAnalogOutV3.setWriteFirmwarePointer(pointer[, returnCallback][, errorCallback])
Parameters:
  • pointer -- int
Callback:

undefined

Sets the firmware pointer for writeFirmware(). The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

BrickletAnalogOutV3.writeFirmware(data[, returnCallback][, errorCallback])
Parameters:
  • data -- [int, int, ..61x.., int]
Callback:
  • status -- int

Writes 64 Bytes of firmware at the position as written by setWriteFirmwarePointer() before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

BrickletAnalogOutV3.setStatusLEDConfig(config[, returnCallback][, errorCallback])
Parameters:
  • config -- int
Callback:

undefined

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following constants are available for this function:

  • BrickletAnalogOutV3.STATUS_LED_CONFIG_OFF = 0
  • BrickletAnalogOutV3.STATUS_LED_CONFIG_ON = 1
  • BrickletAnalogOutV3.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletAnalogOutV3.STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletAnalogOutV3.getStatusLEDConfig([returnCallback][, errorCallback])
Callback:
  • config -- int

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

  • BrickletAnalogOutV3.STATUS_LED_CONFIG_OFF = 0
  • BrickletAnalogOutV3.STATUS_LED_CONFIG_ON = 1
  • BrickletAnalogOutV3.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletAnalogOutV3.STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletAnalogOutV3.getChipTemperature([returnCallback][, errorCallback])
Callback:
  • temperature -- int

Returns the temperature in °C as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

BrickletAnalogOutV3.reset([returnCallback][, errorCallback])
Callback:undefined

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

BrickletAnalogOutV3.writeUID(uid[, returnCallback][, errorCallback])
Parameters:
  • uid -- int
Callback:

undefined

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

BrickletAnalogOutV3.readUID([returnCallback][, errorCallback])
Callback:
  • uid -- int

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

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

BrickletAnalogOutV3.DEVICE_IDENTIFIER

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

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.

BrickletAnalogOutV3.DEVICE_DISPLAY_NAME

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