Deutsch
English
Menu
Software / API Bindings / LabVIEW / API Reference and Examples / Bricklets (Discontinued) / RGB LED Bricklet

LabVIEW - RGB LED Bricklet

This is the description of the LabVIEW API bindings for the RGB LED Bricklet. General information and technical specifications for the RGB LED Bricklet are summarized in its hardware description.

An installation guide for the LabVIEW API bindings is part of their general description.

Examples

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

API

Generally, every function of the LabVIEW bindings that outputs a value can report a Tinkerforge.TimeoutException. This error gets reported if the device did not respond. If a cable based connection is used, it is unlikely that this exception gets thrown (assuming nobody plugs the device out). However, if a wireless connection is used, timeouts will occur if the distance to the device gets too big.

The namespace for all Brick/Bricklet bindings and the IPConnection is Tinkerforge.*.

Basic Functions

BrickletRGBLED(uid, ipcon) → rgbLED
Input:
  • uid – Type: String
  • ipcon – Type: .NET Refnum (IPConnection)
Output:
  • rgbLED – Type: .NET Refnum (BrickletRGBLED)

Creates an object with the unique device ID uid. This object can then be used after the IP Connection is connected.

BrickletRGBLED.SetRGBValue(r, g, b)
Input:
  • r – Type: Byte, Range: [0 to 255], Default: 0
  • g – Type: Byte, Range: [0 to 255], Default: 0
  • b – Type: Byte, Range: [0 to 255], Default: 0

Sets the r, g and b values for the LED.

BrickletRGBLED.GetRGBValue() → r, g, b
Output:
  • r – Type: Byte, Range: [0 to 255], Default: 0
  • g – Type: Byte, Range: [0 to 255], Default: 0
  • b – Type: Byte, Range: [0 to 255], Default: 0

Returns the r, g and b values of the LED as set by SetRGBValue().

Advanced Functions

BrickletRGBLED.GetIdentity() → uid, connectedUid, position, hardwareVersion, firmwareVersion, deviceIdentifier
Output:
  • uid – Type: String, Length: up to 8
  • connectedUid – Type: String, Length: up to 8
  • position – Type: Char, Range: ["a" to "h", "z"]
  • hardwareVersion – Type: Byte[3]
    • 0: major – Type: Byte, Range: [0 to 255]
    • 1: minor – Type: Byte, Range: [0 to 255]
    • 2: revision – Type: Byte, Range: [0 to 255]
  • firmwareVersion – Type: Byte[3]
    • 0: major – Type: Byte, Range: [0 to 255]
    • 1: minor – Type: Byte, Range: [0 to 255]
    • 2: revision – Type: Byte, Range: [0 to 255]
  • deviceIdentifier – Type: Int32, Range: [0 to 216 - 1]

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.

BrickletRGBLED.GetAPIVersion() → apiVersion
Output:
  • apiVersion – Type: Byte[3]
    • 0: major – Type: Byte, Range: [0 to 255]
    • 1: minor – Type: Byte, Range: [0 to 255]
    • 2: revision – Type: Byte, 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.

BrickletRGBLED.GetResponseExpected(functionId) → responseExpected
Input:
  • functionId – Type: Byte, Range: See constants
Output:
  • 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 functionId:

  • BrickletRGBLED.FUNCTION_SET_RGB_VALUE = 1
BrickletRGBLED.SetResponseExpected(functionId, responseExpected)
Input:
  • functionId – Type: Byte, Range: See constants
  • responseExpected – Type: 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 sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

  • BrickletRGBLED.FUNCTION_SET_RGB_VALUE = 1
BrickletRGBLED.SetResponseExpectedAll(responseExpected)
Input:
  • responseExpected – Type: Boolean

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

Constants

BrickletRGBLED.DEVICE_IDENTIFIER

This constant is used to identify a RGB LED Bricklet.

The GetIdentity() function and the IPConnection.EnumerateCallback callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

BrickletRGBLED.DEVICE_DISPLAY_NAME

This constant represents the human readable name of a RGB LED Bricklet.