JavaScript - Color 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
      - Requirements
      - Installation
      - Testing an Example
      - API Reference and Examples
        - IP Connection
        - Bricks
        - Bricklets
          - Ambient Light Bricklet
          - Analog In Bricklet
          - Analog Out Bricklet
          - Barometer Bricklet
          - Color Bricklet
            - Examples
              - Simple (Node.js)
              - Callback (Node.js)
              - Threshold (Node.js)
              - Simple (HTML)
              - Callback (HTML)
              - Threshold (HTML)
            - API
              - Basic Functions
              - Advanced Functions
              - Callback Configuration Functions
              - Callbacks
              - Constants
          - 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
    - LabVIEW
    - Mathematica
    - MATLAB/Octave
    - Perl
    - 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

# JavaScript - Color Bricklet

This is the description of the JavaScript API bindings for the Color Bricklet. General information and technical specifications for the Color 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 (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
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41

    var Tinkerforge = require('tinkerforge');

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

    var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
    var c = new Tinkerforge.BrickletColor(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) {
            // Get current color
            c.getColor(
                function(r, g, b, cl) {
                    console.log('Color(R): '+r);
                    console.log('Color(G): '+g);
                    console.log('Color(B): '+b);
                    console.log('Color(C): '+cl);
                    console.log();
                },
                function(error) {
                    console.log('Error: '+error);
                }
            );
        }
    );

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

### Callback (Node.js)

Download (ExampleCallback.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
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44

    var Tinkerforge = require('tinkerforge');

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

    var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
    var c = new Tinkerforge.BrickletColor(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 Period for color callback to 1s (1000ms)
            // Note: The callback is only called every second if the
            // color has changed since the last call!
            c.setColorCallbackPeriod(1000);
        }
    );

    // Register temperature callback
    c.on(Tinkerforge.BrickletColor.CALLBACK_COLOR,
        // Callback function for color callback
        function(r, g, b, cl) {
            console.log('Color(R): '+r);
            console.log('Color(G): '+g);
            console.log('Color(B): '+b);
            console.log('Color(C): '+cl);
            console.log();
        }
    );

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

### Threshold (Node.js)

Download (ExampleThreshold.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
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48

    var Tinkerforge = require('tinkerforge');

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

    var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
    var c = new Tinkerforge.BrickletColor(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 threshold callbacks with a debounce time of 10 seconds (10000ms)
            c.setDebouncePeriod(10000);
            // Configure threshold for color values,
            // RED   greater than 100
            // GREEN greater than 200
            // BLUE  greater than 300
            // CLEAR greater than 400
            c.setColorCallbackThreshold('>', 100, 0, 200, 0, 300, 0, 400, 0);
        }
    );

    // Register threshold reached callback
    c.on(Tinkerforge.BrickletColor.CALLBACK_COLOR_REACHED,
        // Callback for color threshold reached
        function(r, g, b, cl) {
            console.log('Color(R): '+r);
            console.log('Color(G): '+g);
            console.log('Color(B): '+b);
            console.log('Color(C): '+cl);
            console.log();
        }
    );

    console.log("Press any 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
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63

    <!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>Color 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 c = new Tinkerforge.BrickletColor(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) {
                            // Get current color
                            c.getColor(
                                function(r, g, b, cl) {
                                    textArea.value += 'Color(R): '+r+'\n';
                                    textArea.value += 'Color(G): '+g+'\n';
                                    textArea.value += 'Color(B): '+b+'\n';
                                    textArea.value += 'Color(C): '+cl+'\n';
                                    textArea.value += '\n';
                                    textArea.scrollTop = textArea.scrollHeight;
                                },
                                function(error) {
                                    textArea.value += 'Error: '+error+'\n';
                                }
                            );
                        }
                    );
                }
            </script>
        </body>
    </html>

### Callback (HTML)

Download (ExampleCallback.html), Test (ExampleCallback.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
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65

    <!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>Color Bricklet Callback 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 c = new Tinkerforge.BrickletColor(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 Period for color callback to 1s (1000ms)
                            // Note: The callback is only called every second if the
                            // color has changed since the last call!
                            c.setColorCallbackPeriod(1000);
                        }
                    );
                    // Register color callback
                    c.on(Tinkerforge.BrickletColor.CALLBACK_COLOR,
                        // Callback function for color callback
                        function(r, g, b, cl) {
                            textArea.value += 'Color(R): '+r+'\n';
                            textArea.value += 'Color(G): '+g+'\n';
                            textArea.value += 'Color(B): '+b+'\n';
                            textArea.value += 'Color(C): '+cl+'\n';
                            textArea.value += '\n';
                            textArea.scrollTop = textArea.scrollHeight;
                        }
                    );
                }
            </script>
        </body>
    </html>

### Threshold (HTML)

Download (ExampleThreshold.html), Test (ExampleThreshold.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
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69

    <!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>Color Bricklet Threshold 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 c = new Tinkerforge.BrickletColor(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 threshold callbacks with a debounce time of 10 seconds (10000ms)
                            c.setDebouncePeriod(10000);
                            // Configure threshold for color values,
                            // RED   greater than 100
                            // GREEN greater than 200
                            // BLUE  greater than 300
                            // CLEAR greater than 400
                            c.setColorCallbackThreshold('>', 100, 0, 200, 0, 300, 0, 400, 0);
                        }
                    );
                    // Register threshold reached callback
                    c.on(Tinkerforge.BrickletColor.CALLBACK_COLOR_REACHED,
                        // Callback for color threshold reached
                        function(r, g, b, cl) {
                            textArea.value += 'Color(R): '+r+'\n';
                            textArea.value += 'Color(G): '+g+'\n';
                            textArea.value += 'Color(B): '+b+'\n';
                            textArea.value += 'Color(C): '+cl+'\n';
                            textArea.value += '\n';
                            textArea.scrollTop = textArea.scrollHeight;
                        }
                    );
                }
            </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 `BrickletColor`(uid, ipcon)

  Parameters:

  - uid -- string
  - ipcon -- IPConnection

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

      var color = new BrickletColor("YOUR_DEVICE_UID", ipcon);

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

`BrickletColor.``getColor`([returnCallback][, errorCallback])

  Callback:

  - r -- int
  - g -- int
  - b -- int
  - c -- int

  Returns the measured color of the sensor. The values have a range of 0 to 65535.

  The red (r), green (g), blue (b) and clear (c) colors are measured with four different photodiodes that are responsive at different wavelengths:

  If you want to get the color periodically, it is recommended to use the callback `CALLBACK_COLOR` and set the period with `setColorCallbackPeriod()`.

`BrickletColor.``lightOn`([returnCallback][, errorCallback])

  Callback: | undefined

  Turns the LED on.

`BrickletColor.``lightOff`([returnCallback][, errorCallback])

  Callback: | undefined

  Turns the LED off.

`BrickletColor.``isLightOn`([returnCallback][, errorCallback])

  Callback:

  - light -- int

  Returns the state of the LED. Possible values are:

  - 0: On
  - 1: Off

  The following constants are available for this function:

  - BrickletColor.LIGHT_ON = 0
  - BrickletColor.LIGHT_OFF = 1

`BrickletColor.``setConfig`(gain, integrationTime[, returnCallback][, errorCallback])

  Parameters:

  - gain -- int
  - integrationTime -- int

  Callback: | undefined

  Sets the configuration of the sensor. Gain and integration time can be configured in this way.

  For configuring the gain:

  - 0: 1x Gain
  - 1: 4x Gain
  - 2: 16x Gain
  - 3: 60x Gain

  For configuring the integration time:

  - 0: 2.4ms
  - 1: 24ms
  - 2: 101ms
  - 3: 154ms
  - 4: 700ms

  Increasing the gain enables the sensor to detect a color from a higher distance.

  The integration time provides a trade-off between conversion time and accuracy. With a longer integration time the values read will be more accurate but it will take longer time to get the conversion results.

  The default values are 60x gain and 154ms integration time.

  The following constants are available for this function:

  - BrickletColor.GAIN_1X = 0
  - BrickletColor.GAIN_4X = 1
  - BrickletColor.GAIN_16X = 2
  - BrickletColor.GAIN_60X = 3
  - BrickletColor.INTEGRATION_TIME_2MS = 0
  - BrickletColor.INTEGRATION_TIME_24MS = 1
  - BrickletColor.INTEGRATION_TIME_101MS = 2
  - BrickletColor.INTEGRATION_TIME_154MS = 3
  - BrickletColor.INTEGRATION_TIME_700MS = 4

`BrickletColor.``getConfig`([returnCallback][, errorCallback])

  Callback:

  - gain -- int
  - integrationTime -- int

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

  The following constants are available for this function:

  - BrickletColor.GAIN_1X = 0
  - BrickletColor.GAIN_4X = 1
  - BrickletColor.GAIN_16X = 2
  - BrickletColor.GAIN_60X = 3
  - BrickletColor.INTEGRATION_TIME_2MS = 0
  - BrickletColor.INTEGRATION_TIME_24MS = 1
  - BrickletColor.INTEGRATION_TIME_101MS = 2
  - BrickletColor.INTEGRATION_TIME_154MS = 3
  - BrickletColor.INTEGRATION_TIME_700MS = 4

`BrickletColor.``getIlluminance`([returnCallback][, errorCallback])

  Callback:

  - illuminance -- int

  Returns the illuminance affected by the gain and integration time as set by `setConfig()`. To get the illuminance in Lux apply this formula:

      lux = illuminance * 700 / gain / integration_time

  To get a correct illuminance measurement make sure that the color values themself are not saturated. The color value (R, G or B) is saturated if it is equal to the maximum value of 65535. In that case you have to reduce the gain, see `setConfig()`.

`BrickletColor.``getColorTemperature`([returnCallback][, errorCallback])

  Callback:

  - colorTemperature -- int

  Returns the color temperature in Kelvin.

  To get a correct color temperature measurement make sure that the color values themself are not saturated. The color value (R, G or B) is saturated if it is equal to the maximum value of 65535. In that case you have to reduce the gain, see `setConfig()`.

### Advanced Functions

`BrickletColor.``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.

`BrickletColor.``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.

`BrickletColor.``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:

  - BrickletColor.FUNCTION_SET_COLOR_CALLBACK_PERIOD = 2
  - BrickletColor.FUNCTION_SET_COLOR_CALLBACK_THRESHOLD = 4
  - BrickletColor.FUNCTION_SET_DEBOUNCE_PERIOD = 6
  - BrickletColor.FUNCTION_LIGHT_ON = 10
  - BrickletColor.FUNCTION_LIGHT_OFF = 11
  - BrickletColor.FUNCTION_SET_CONFIG = 13
  - BrickletColor.FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 17
  - BrickletColor.FUNCTION_SET_COLOR_TEMPERATURE_CALLBACK_PERIOD = 19

`BrickletColor.``setResponseExpectedAll`(responseExpected)

  Parameters:

  - responseExpected -- boolean

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

`BrickletColor.``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.

### Callback Configuration Functions

`BrickletColor.``on`(id, callback)

  Parameters:

  - id -- int
  - callback -- function

  Registers a callback with ID id to the function callback. The available IDs with corresponding function signatures are listed below.

`BrickletColor.``setColorCallbackPeriod`(period[, returnCallback][, errorCallback])

  Parameters:

  - period -- int

  Callback: | undefined

  Sets the period in ms with which the `CALLBACK_COLOR` callback is triggered periodically. A value of 0 turns the callback off.

  `CALLBACK_COLOR` is only triggered if the color has changed since the last triggering.

  The default value is 0.

`BrickletColor.``getColorCallbackPeriod`([returnCallback][, errorCallback])

  Callback:

  - period -- int

  Returns the period as set by `setColorCallbackPeriod()`.

`BrickletColor.``setColorCallbackThreshold`(option, minR, maxR, minG, maxG, minB, maxB, minC, maxC[, returnCallback][, errorCallback])

  Parameters:

  - option -- char
  - minR -- int
  - maxR -- int
  - minG -- int
  - maxG -- int
  - minB -- int
  - maxB -- int
  - minC -- int
  - maxC -- int

  Callback: | undefined

  Sets the thresholds for the `CALLBACK_COLOR_REACHED` callback.

  The following options are possible:

  Option | Description
  --- | ---
  'x' | Callback is turned off
  'o' | Callback is triggered when the temperature is outside the min and max values
  'i' | Callback is triggered when the temperature is inside the min and max values
  '<' | Callback is triggered when the temperature is smaller than the min value (max is ignored)
  '>' | Callback is triggered when the temperature is greater than the min value (max is ignored)

  The default value is ('x', 0, 0, 0, 0, 0, 0, 0, 0).

  The following constants are available for this function:

  - BrickletColor.THRESHOLD_OPTION_OFF = 'x'
  - BrickletColor.THRESHOLD_OPTION_OUTSIDE = 'o'
  - BrickletColor.THRESHOLD_OPTION_INSIDE = 'i'
  - BrickletColor.THRESHOLD_OPTION_SMALLER = '<'
  - BrickletColor.THRESHOLD_OPTION_GREATER = '>'

`BrickletColor.``getColorCallbackThreshold`([returnCallback][, errorCallback])

  Callback:

  - option -- char
  - minR -- int
  - maxR -- int
  - minG -- int
  - maxG -- int
  - minB -- int
  - maxB -- int
  - minC -- int
  - maxC -- int

  Returns the threshold as set by `setColorCallbackThreshold()`.

  The following constants are available for this function:

  - BrickletColor.THRESHOLD_OPTION_OFF = 'x'
  - BrickletColor.THRESHOLD_OPTION_OUTSIDE = 'o'
  - BrickletColor.THRESHOLD_OPTION_INSIDE = 'i'
  - BrickletColor.THRESHOLD_OPTION_SMALLER = '<'
  - BrickletColor.THRESHOLD_OPTION_GREATER = '>'

`BrickletColor.``setDebouncePeriod`(debounce[, returnCallback][, errorCallback])

  Parameters:

  - debounce -- int

  Callback: | undefined

  Sets the period in ms with which the threshold callback

  - `CALLBACK_COLOR_REACHED`

  is triggered, if the threshold

  - `setColorCallbackThreshold()`

  keeps being reached.

  The default value is 100.

`BrickletColor.``getDebouncePeriod`([returnCallback][, errorCallback])

  Callback:

  - debounce -- int

  Returns the debounce period as set by `setDebouncePeriod()`.

`BrickletColor.``setIlluminanceCallbackPeriod`(period[, returnCallback][, errorCallback])

  Parameters:

  - period -- int

  Callback: | undefined

  Sets the period in ms with which the `CALLBACK_ILLUMINANCE` callback is triggered periodically. A value of 0 turns the callback off.

  `CALLBACK_ILLUMINANCE` is only triggered if the illuminance has changed since the last triggering.

  The default value is 0.

`BrickletColor.``getIlluminanceCallbackPeriod`([returnCallback][, errorCallback])

  Callback:

  - period -- int

  Returns the period as set by `setIlluminanceCallbackPeriod()`.

`BrickletColor.``setColorTemperatureCallbackPeriod`(period[, returnCallback][, errorCallback])

  Parameters:

  - period -- int

  Callback: | undefined

  Sets the period in ms with which the `CALLBACK_COLOR_TEMPERATURE` callback is triggered periodically. A value of 0 turns the callback off.

  `CALLBACK_COLOR_TEMPERATURE` is only triggered if the color temperature has changed since the last triggering.

  The default value is 0.

`BrickletColor.``getColorTemperatureCallbackPeriod`([returnCallback][, errorCallback])

  Callback:

  - period -- int

  Returns the period as set by `setColorTemperatureCallbackPeriod()`.

### Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the `on()` function of the device object. The first parameter is the callback ID and the second parameter the callback function:

    color.on(BrickletColor.CALLBACK_EXAMPLE,
        function (param) {
            console.log(param);
        }
    );

The available constants with inherent number and type of parameters are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

`BrickletColor.``CALLBACK_COLOR`

  Parameters:

  - r -- int
  - g -- int
  - b -- int
  - c -- int

  This callback is triggered periodically with the period that is set by `setColorCallbackPeriod()`. The parameter is the color of the sensor as RGBC.

  `CALLBACK_COLOR` is only triggered if the color has changed since the last triggering.

`BrickletColor.``CALLBACK_COLOR_REACHED`

  Parameters:

  - r -- int
  - g -- int
  - b -- int
  - c -- int

  This callback is triggered when the threshold as set by `setColorCallbackThreshold()` is reached. The parameter is the color of the sensor as RGBC.

  If the threshold keeps being reached, the callback is triggered periodically with the period as set by `setDebouncePeriod()`.

`BrickletColor.``CALLBACK_ILLUMINANCE`

  Parameters:

  - illuminance -- int

  This callback is triggered periodically with the period that is set by `setIlluminanceCallbackPeriod()`. The parameter is the illuminance. See `getIlluminance()` for how to interpret this value.

  `CALLBACK_ILLUMINANCE` is only triggered if the illuminance has changed since the last triggering.

`BrickletColor.``CALLBACK_COLOR_TEMPERATURE`

  Parameters:

  - colorTemperature -- int

  This callback is triggered periodically with the period that is set by `setColorTemperatureCallbackPeriod()`. The parameter is the color temperature in Kelvin.

  `CALLBACK_COLOR_TEMPERATURE` is only triggered if the color temperature has changed since the last triggering.

### Constants

`BrickletColor.``DEVICE_IDENTIFIER`

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