C# - UV Light 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
26

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 UV Light Bricklet

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

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

        // Get current UV light
        long uvLight = uvl.GetUVLight();
        Console.WriteLine("UV Light: " + uvLight/10.0 + " mW/m²");

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

Callback¶

Download (ExampleCallback.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
26
27
28
29
30
31
32
33
34
35
36

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 UV Light Bricklet

    // Callback function for UV light callback
    static void UVLightCB(BrickletUVLight sender, long uvLight)
    {
        Console.WriteLine("UV Light: " + uvLight/10.0 + " mW/m²");
    }

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

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

        // Register UV light callback to function UVLightCB
        uvl.UVLightCallback += UVLightCB;

        // Set period for UV light callback to 1s (1000ms)
        // Note: The UV light callback is only called every second
        //       if the UV light has changed since the last call!
        uvl.SetUVLightCallbackPeriod(1000);

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

Threshold¶

Download (ExampleThreshold.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
26
27
28
29
30
31
32
33
34
35
36
37
38

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 UV Light Bricklet

    // Callback function for UV light reached callback
    static void UVLightReachedCB(BrickletUVLight sender, long uvLight)
    {
        Console.WriteLine("UV Light: " + uvLight/10.0 + " mW/m²");
        Console.WriteLine("UV Index > 3. Use sunscreen!");
    }

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletUVLight uvl = new BrickletUVLight(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)
        uvl.SetDebouncePeriod(10000);

        // Register UV light reached callback to function UVLightReachedCB
        uvl.UVLightReachedCallback += UVLightReachedCB;

        // Configure threshold for UV light "greater than 75 mW/m²"
        uvl.SetUVLightCallbackThreshold('>', 75*10, 0);

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

Basic Functions¶

public class BrickletUVLight(String uid, IPConnection ipcon)¶

Creates an object with the unique device ID uid:

BrickletUVLight uvLight = new BrickletUVLight("YOUR_DEVICE_UID", ipcon);

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

public long GetUVLight()¶

Returns the UV light intensity of the sensor, the intensity is given in 1/10 mW/m². The sensor has already weighted the intensity with the erythemal action spectrum to get the skin-affecting irradiation.

To get UV index you just have to divide the value by 250. For example, a UV light intensity of 500 is equivalent to an UV index of 2.

If you want to get the intensity periodically, it is recommended to use the UVLightCallback callback and set the period with SetUVLightCallbackPeriod().

Advanced Functions¶

public byte[] GetAPIVersion()¶

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.

public bool GetResponseExpected(byte functionId)¶

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.

public void SetResponseExpected(byte functionId, bool responseExpected)¶

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:

• BrickletUVLight.FUNCTION_SET_UV_LIGHT_CALLBACK_PERIOD = 2
• BrickletUVLight.FUNCTION_SET_UV_LIGHT_CALLBACK_THRESHOLD = 4
• BrickletUVLight.FUNCTION_SET_DEBOUNCE_PERIOD = 6

public void SetResponseExpectedAll(bool responseExpected)¶

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

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

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¶

public void SetUVLightCallbackPeriod(long period)¶

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

The UVLightCallback callback is only triggered if the intensity has changed since the last triggering.

The default value is 0.

public long GetUVLightCallbackPeriod()¶

Returns the period as set by SetUVLightCallbackPeriod().

public void SetUVLightCallbackThreshold(char option, long min, long max)¶

Sets the thresholds for the UVLightReachedCallback callback.

The following options are possible:

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

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

The following constants are available for this function:

• BrickletUVLight.THRESHOLD_OPTION_OFF = 'x'
• BrickletUVLight.THRESHOLD_OPTION_OUTSIDE = 'o'
• BrickletUVLight.THRESHOLD_OPTION_INSIDE = 'i'
• BrickletUVLight.THRESHOLD_OPTION_SMALLER = '<'
• BrickletUVLight.THRESHOLD_OPTION_GREATER = '>'

public void GetUVLightCallbackThreshold(out char option, out long min, out long max)¶

Returns the threshold as set by SetUVLightCallbackThreshold().

The following constants are available for this function:

• BrickletUVLight.THRESHOLD_OPTION_OFF = 'x'
• BrickletUVLight.THRESHOLD_OPTION_OUTSIDE = 'o'
• BrickletUVLight.THRESHOLD_OPTION_INSIDE = 'i'
• BrickletUVLight.THRESHOLD_OPTION_SMALLER = '<'
• BrickletUVLight.THRESHOLD_OPTION_GREATER = '>'

public void SetDebouncePeriod(long debounce)¶

Sets the period in ms with which the threshold callbacks

• UVLightReachedCallback,

are triggered, if the thresholds

• SetUVLightCallbackThreshold(),

keep being reached.

The default value is 100.

public long GetDebouncePeriod()¶

Returns the debounce period as set by SetDebouncePeriod().

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done by appending your callback handler to the corresponding event:

void MyCallback(BrickletUVLight sender, int value)
{
    System.Console.WriteLine("Value: " + value);
}

uvLight.ExampleCallback += MyCallback;

The available events are described below.

public event UVLightCallback(BrickletUVLight sender, long uvLight)¶

This callback is triggered periodically with the period that is set by SetUVLightCallbackPeriod(). The parameter is the UV Light intensity of the sensor.

The UVLightCallback callback is only triggered if the intensity has changed since the last triggering.

public event UVLightReachedCallback(BrickletUVLight sender, long uvLight)¶

This callback is triggered when the threshold as set by SetUVLightCallbackThreshold() is reached. The parameter is the UV Light intensity of the sensor.

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

Constants¶

public int DEVICE_IDENTIFIER¶

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

public string DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a UV Light Bricklet.