Visual Basic .NET - 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
    - LabVIEW
    - Mathematica
    - MATLAB/Octave
    - Perl
    - PHP
    - Python
    - Ruby
    - Shell
    - Visual Basic .NET
      - 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
              - Callback
              - Threshold
            - 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
  - 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

# Visual Basic .NET - Color Bricklet

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

## Examples

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

### Simple

Download (ExampleSimple.vb)

     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

    Imports Tinkerforge

    Module ExampleSimple
        Const HOST As String = "localhost"
        Const PORT As Integer = 4223
        Const UID As String = "abc" ' Change to your UID

        Sub Main()
            Dim ipcon As New IPConnection() ' Create IP connection
            Dim c As New BrickletColor(UID, ipcon) ' Create device object

            ipcon.Connect(HOST, PORT) ' Connect to brickd
            ' Don't use device before ipcon is connected

            ' Get current color
            Dim r As Integer
            Dim g As Integer
            Dim b As Integer
            Dim cl As Integer

            c.GetColor(r, g, b, cl)

            System.Console.WriteLine("Color(R): " + r.ToString())
            System.Console.WriteLine("Color(G): " + g.ToString())
            System.Console.WriteLine("Color(B): " + b.ToString())
            System.Console.WriteLine("Color(C): " + cl.ToString())

            System.Console.WriteLine("Press key to exit")
            System.Console.ReadLine()
            ipcon.Disconnect()
        End Sub
    End Module

### Callback

Download (ExampleCallback.vb)

     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

    Imports Tinkerforge

    Module ExampleCallback
        Const HOST As String = "localhost"
        Const PORT As Integer = 4223
        Const UID As String = "abc" ' Change to your UID

        ' Callback function for color callback
        Sub ColorCB(ByVal sender As BrickletColor, ByVal r As Integer, _
                    ByVal g As Integer, ByVal b As Integer, ByVal cl As Integer)
            System.Console.WriteLine("Color(R): " + r.ToString())
            System.Console.WriteLine("Color(G): " + g.ToString())
            System.Console.WriteLine("Color(B): " + b.ToString())
            System.Console.WriteLine("Color(C): " + cl.ToString())
            System.Console.WriteLine("")
        End Sub

        Sub Main()
            Dim ipcon As New IPConnection() ' Create IP connection
            Dim c As New BrickletColor(UID, ipcon) ' Create device object

            ipcon.Connect(HOST, PORT) ' Connect to brickd
            ' Don't use device before ipcon is connected

            ' Set Period for color callback to 1s (1000ms)
            ' Note: The color callback is only called every second if the
            '       color has changed since the last call!
            c.SetColorCallbackPeriod(1000)

            ' Register color callback to function ColorCB
            AddHandler c.Color, AddressOf ColorCB

            System.Console.WriteLine("Press key to exit")
            System.Console.ReadLine()
            ipcon.Disconnect()
        End Sub
    End Module

### Threshold

Download (ExampleThreshold.vb)

     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

    Imports Tinkerforge

    Module ExampleThreshold
        Const HOST As String = "localhost"
        Const PORT As Integer = 4223
        Const UID As String = "abc" ' Change to your UID

        ' Callback for color threshold reached
        Sub ReachedCB(ByVal sender As BrickletColor, ByVal r As Integer, _
                      ByVal g As Integer, ByVal b As Integer, ByVal cl As Integer)
            System.Console.WriteLine("Color(R): " + r.ToString())
            System.Console.WriteLine("Color(G): " + g.ToString())
            System.Console.WriteLine("Color(B): " + b.ToString())
            System.Console.WriteLine("Color(C): " + cl.ToString())
            System.Console.WriteLine("")
        End Sub

        Sub Main()
            Dim ipcon As New IPConnection() ' Create IP connection
            Dim c As New BrickletColor(UID, ipcon) ' Create device object

            ipcon.Connect(HOST, PORT) ' Connect to brickd
            ' Don't use device before ipcon is connected

            ' Get threshold callbacks with a debounce time of 10 seconds (10000ms)
            c.SetDebouncePeriod(10000)

            ' Register threshold reached callback to function ReachedCB
            AddHandler c.ColorReached, AddressOf ReachedCB

            ' Configure threshold for color values,
            ' RED   greater than 100
            ' GREEN greater than 200
            ' BLUE  greater than 300
            ' CLEAR greater than 400
            c.SetColorCallbackThreshold(">"C, 100, 0, 200, 0, 300, 0, 400, 0)

            System.Console.WriteLine("Press key to exit")
            System.Console.ReadLine()
            ipcon.Disconnect()
        End Sub
    End Module

## API

Since Visual Basic .NET does not support multiple return values directly, we use the `ByRef` keyword to return multiple values from a function.

All functions and procedures listed below are thread-safe.

### Basic Functions

Class `BrickletColor`(ByVal uid As String, ByVal ipcon As IPConnection)

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

      Dim color As New BrickletColor("YOUR_DEVICE_UID", ipcon)

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

Sub `BrickletColor.``GetColor`(ByRef r As Integer, ByRef g As Integer, ByRef b As Integer, ByRef c As Integer)

  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 `Color` and set the period with `SetColorCallbackPeriod()`.

Sub `BrickletColor.``LightOn`()

  Turns the LED on.

Sub `BrickletColor.``LightOff`()

  Turns the LED off.

Function `BrickletColor.``IsLightOn`() As Byte

  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

Sub `BrickletColor.``SetConfig`(ByVal gain As Byte, ByVal integrationTime As Byte)

  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

Sub `BrickletColor.``GetConfig`(ByRef gain As Byte, ByRef integrationTime As Byte)

  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

Function `BrickletColor.``GetIlluminance`() As Long

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

Function `BrickletColor.``GetColorTemperature`() As Integer

  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

Function `BrickletColor.``GetAPIVersion`() As Byte()

  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.

Function `BrickletColor.``GetResponseExpected`(ByVal functionId As Byte) As 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.

Sub `BrickletColor.``SetResponseExpected`(ByVal functionId As Byte, ByVal responseExpected As 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

Sub `BrickletColor.``SetResponseExpectedAll`(ByVal responseExpected As Boolean)

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

Sub `BrickletColor.``GetIdentity`(ByRef uid As String, ByRef connectedUid As String, ByRef position As Char, ByRef hardwareVersion() As Byte, ByRef firmwareVersion() As Byte, ByRef deviceIdentifier As Integer)

  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

Sub `BrickletColor.``SetColorCallbackPeriod`(ByVal period As Long)

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

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

  The default value is 0.

Function `BrickletColor.``GetColorCallbackPeriod`() As Long

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

Sub `BrickletColor.``SetColorCallbackThreshold`(ByVal option As Char, ByVal minR As Integer, ByVal maxR As Integer, ByVal minG As Integer, ByVal maxG As Integer, ByVal minB As Integer, ByVal maxB As Integer, ByVal minC As Integer, ByVal maxC As Integer)

  Sets the thresholds for the `ColorReached` 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"C
  - BrickletColor.THRESHOLD_OPTION_OUTSIDE = "o"C
  - BrickletColor.THRESHOLD_OPTION_INSIDE = "i"C
  - BrickletColor.THRESHOLD_OPTION_SMALLER = "<"C
  - BrickletColor.THRESHOLD_OPTION_GREATER = ">"C

Sub `BrickletColor.``GetColorCallbackThreshold`(ByRef option As Char, ByRef minR As Integer, ByRef maxR As Integer, ByRef minG As Integer, ByRef maxG As Integer, ByRef minB As Integer, ByRef maxB As Integer, ByRef minC As Integer, ByRef maxC As Integer)

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

  The following constants are available for this function:

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

Sub `BrickletColor.``SetDebouncePeriod`(ByVal debounce As Long)

  Sets the period in ms with which the threshold callback

  - `ColorReached`

  is triggered, if the threshold

  - `SetColorCallbackThreshold()`

  keeps being reached.

  The default value is 100.

Function `BrickletColor.``GetDebouncePeriod`() As Long

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

Sub `BrickletColor.``SetIlluminanceCallbackPeriod`(ByVal period As Long)

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

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

  The default value is 0.

Function `BrickletColor.``GetIlluminanceCallbackPeriod`() As Long

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

Sub `BrickletColor.``SetColorTemperatureCallbackPeriod`(ByVal period As Long)

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

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

  The default value is 0.

Function `BrickletColor.``GetColorTemperatureCallbackPeriod`() As Long

  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 by assigning a procedure to an callback property of the device object:

>     Sub Callback(ByVal sender As BrickletColor, ByVal value As Short)
>         Console.WriteLine("Value: {0}", value)
>     End Sub

>     AddHandler color.Example, AddressOf Callback

The available callback property and their 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.

Event `BrickletColor.``Color`(ByVal sender As BrickletColor, ByVal r As Integer, ByVal g As Integer, ByVal b As Integer, ByVal c As Integer)

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

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

Event `BrickletColor.``ColorReached`(ByVal sender As BrickletColor, ByVal r As Integer, ByVal g As Integer, ByVal b As Integer, ByVal c As Integer)

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

Event `BrickletColor.``Illuminance`(ByVal sender As BrickletColor, ByVal illuminance As Long)

  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.

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

Event `BrickletColor.``ColorTemperature`(ByVal sender As BrickletColor, ByVal colorTemperature As Integer)

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

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

### Constants

Const `BrickletColor.``DEVICE_IDENTIFIER`

  This constant is used to identify a Color Bricklet.

  The `GetIdentity()` function and the `EnumerateCallback` callback of the IP Connection have a `deviceIdentifier` 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.