C# - RGB LED Bricklet¶

Simple¶

Download (ExampleSimple.cs)

 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

using System;
using Tinkerforge;

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XYZ"; // Change XYZ to the UID of your RGB LED Bricklet

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletRGBLED rl = new BrickletRGBLED(UID, ipcon); // Create device object

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

        // Set light blue color
        rl.SetRGBValue(0, 170, 234);

        Console.WriteLine("Press enter to exit");
        Console.ReadLine();
        ipcon.Disconnect();
    }
}

Basic Functions¶

class BrickletRGBLED(string uid, IPConnection ipcon)¶

Parameters:	uid – Type: string ipcon – Type: IPConnection
Returns:	rgbLED – Type: BrickletRGBLED

Creates an object with the unique device ID uid:

BrickletRGBLED rgbLED = new BrickletRGBLED("YOUR_DEVICE_UID", ipcon);

This object can then be used after the IP Connection is connected.

void BrickletRGBLED.SetRGBValue(byte r, byte g, byte b)¶

Parameters:	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.

void BrickletRGBLED.GetRGBValue(out byte r, out byte g, out byte b)¶

Output Parameters:	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¶

void BrickletRGBLED.GetIdentity(out string uid, out string connectedUid, out char position, out byte[] hardwareVersion, out byte[] firmwareVersion, out int deviceIdentifier)¶

Output 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: byte[], Length: 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[], Length: 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: int, 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.

byte[] BrickletRGBLED.GetAPIVersion()¶

Output Parameters:	apiVersion – Type: byte[], Length: 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.

bool BrickletRGBLED.GetResponseExpected(byte functionId)¶

Parameters:	functionId – Type: byte, Range: See constants
Returns:	responseExpected – Type: bool

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

void BrickletRGBLED.SetResponseExpected(byte functionId, bool responseExpected)¶

Parameters:	functionId – Type: byte, Range: See constants responseExpected – Type: bool

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

void BrickletRGBLED.SetResponseExpectedAll(bool responseExpected)¶

Parameters:	responseExpected – Type: bool

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

Constants¶

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

string BrickletRGBLED.DEVICE_DISPLAY_NAME¶

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