C# - UV Light Bricklet 2.0

This is the description of the C# API bindings for the UV Light Bricklet 2.0. General information and technical specifications for the UV Light Bricklet 2.0 are summarized in its hardware description.

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

Examples

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

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
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 2.0

    // Callback function for UV index callback
    static void UVICB(BrickletUVLightV2 sender, int uvi)
    {
        Console.WriteLine("UV Index: " + uvi/10.0);
    }

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

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

        // Register UV index callback to function UVICB
        uvl.UVICallback += UVICB;

        // Set period for UVI callback to 1s (1000ms) without a threshold
        uvl.SetUVICallbackConfiguration(1000, false, 'x', 0, 0);

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

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
27
28
29
30
31
32
33
34
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 2.0

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

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

        // Get current UV-A
        int uva = uvl.GetUVA();
        Console.WriteLine("UV-A: " + uva/10.0 + " mW/m²");

        // Get current UV-B
        int uvb = uvl.GetUVB();
        Console.WriteLine("UV-B: " + uvb/10.0 + " mW/m²");

        // Get current UV index
        int uvi = uvl.GetUVI();
        Console.WriteLine("UV Index: " + uvi/10.0);

        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
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 2.0

    // Callback function for UV index callback
    static void UVICB(BrickletUVLightV2 sender, int uvi)
    {
        Console.WriteLine("UV Index: " + uvi/10.0);
        Console.WriteLine("UV index > 3. Use sunscreen!");
    }

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

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

        // Register UV index callback to function UVICB
        uvl.UVICallback += UVICB;

        // Configure threshold for UV index "greater than 3"
        // with a debounce period of 1s (1000ms)
        uvl.SetUVICallbackConfiguration(1000, false, '>', 3*10, 0);

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

API

Generally, every method of the C# bindings that returns a value can throw a Tinkerforge.TimeoutException. This exception gets thrown 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.

Since C# does not support multiple return values directly, we use the out keyword to return multiple values from a method.

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

All methods listed below are thread-safe.

Basic Functions

public class BrickletUVLightV2(String uid, IPConnection ipcon)

Creates an object with the unique device ID uid:

BrickletUVLightV2 uvLightV2 = new BrickletUVLightV2("YOUR_DEVICE_UID", ipcon);

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

public int GetUVA()

Returns the UVA intensity of the sensor, the intensity is given in 1/10 mW/m². The sensor has not weighted the intensity with the erythemal action spectrum to get the skin-affecting irradiation. Therefore, you cannot just divide the value by 250 to get the UVA index. To get the UV index use GetUVI().

If the sensor is saturated, then -1 is returned, see SetConfiguration().

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

If you want to get the value periodically, it is recommended to use the UVACallback callback. You can set the callback configuration with SetUVACallbackConfiguration().

public int GetUVB()

Returns the UVB intensity of the sensor, the intensity is given in 1/10 mW/m². The sensor has not weighted the intensity with the erythemal action spectrum to get the skin-affecting irradiation. Therefore, you cannot just divide the value by 250 to get the UVB index. To get the UV index use GetUVI().

If the sensor is saturated, then -1 is returned, see SetConfiguration().

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

If you want to get the value periodically, it is recommended to use the UVBCallback callback. You can set the callback configuration with SetUVBCallbackConfiguration().

public int GetUVI()

Returns the UV index of the sensor, the index is given in 1/10.

If the sensor is saturated, then -1 is returned, see SetConfiguration().

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

If you want to get the value periodically, it is recommended to use the UVICallback callback. You can set the callback configuration with SetUVICallbackConfiguration().

Advanced Functions

public void SetConfiguration(byte integrationTime)

Sets the configuration of the sensor. The integration time can be configured between 50 and 800 ms. With a shorter integration time the sensor reading updates more often but contains more noise. With a longer integration the sensor reading contains less noise but updates less often.

With a longer integration time (especially 800 ms) and a higher UV intensity the sensor can be saturated. If this happens the UVA/UVB/UVI readings are all -1. In this case you need to choose a shorter integration time.

Default value: 400 ms.

The following constants are available for this function:

  • BrickletUVLightV2.INTEGRATION_TIME_50MS = 0
  • BrickletUVLightV2.INTEGRATION_TIME_100MS = 1
  • BrickletUVLightV2.INTEGRATION_TIME_200MS = 2
  • BrickletUVLightV2.INTEGRATION_TIME_400MS = 3
  • BrickletUVLightV2.INTEGRATION_TIME_800MS = 4
public byte GetConfiguration()

Returns the configuration as set by SetConfiguration().

The following constants are available for this function:

  • BrickletUVLightV2.INTEGRATION_TIME_50MS = 0
  • BrickletUVLightV2.INTEGRATION_TIME_100MS = 1
  • BrickletUVLightV2.INTEGRATION_TIME_200MS = 2
  • BrickletUVLightV2.INTEGRATION_TIME_400MS = 3
  • BrickletUVLightV2.INTEGRATION_TIME_800MS = 4
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:

  • BrickletUVLightV2.FUNCTION_SET_UVA_CALLBACK_CONFIGURATION = 2
  • BrickletUVLightV2.FUNCTION_SET_UVB_CALLBACK_CONFIGURATION = 6
  • BrickletUVLightV2.FUNCTION_SET_UVI_CALLBACK_CONFIGURATION = 10
  • BrickletUVLightV2.FUNCTION_SET_CONFIGURATION = 13
  • BrickletUVLightV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletUVLightV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletUVLightV2.FUNCTION_RESET = 243
  • BrickletUVLightV2.FUNCTION_WRITE_UID = 248
public void SetResponseExpectedAll(bool responseExpected)

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

public void GetSPITFPErrorCount(out long errorCountAckChecksum, out long errorCountMessageChecksum, out long errorCountFrame, out long errorCountOverflow)

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

  • ACK checksum errors,
  • message checksum errors,
  • framing errors and
  • overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

public byte SetBootloaderMode(byte mode)

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following constants are available for this function:

  • BrickletUVLightV2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletUVLightV2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletUVLightV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletUVLightV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletUVLightV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BrickletUVLightV2.BOOTLOADER_STATUS_OK = 0
  • BrickletUVLightV2.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletUVLightV2.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletUVLightV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletUVLightV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletUVLightV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5
public byte GetBootloaderMode()

Returns the current bootloader mode, see SetBootloaderMode().

The following constants are available for this function:

  • BrickletUVLightV2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletUVLightV2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletUVLightV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletUVLightV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletUVLightV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
public void SetWriteFirmwarePointer(long pointer)

Sets the firmware pointer for WriteFirmware(). The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

public byte WriteFirmware(byte[] data)

Writes 64 Bytes of firmware at the position as written by SetWriteFirmwarePointer() before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

public void SetStatusLEDConfig(byte config)

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following constants are available for this function:

  • BrickletUVLightV2.STATUS_LED_CONFIG_OFF = 0
  • BrickletUVLightV2.STATUS_LED_CONFIG_ON = 1
  • BrickletUVLightV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletUVLightV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
public byte GetStatusLEDConfig()

Returns the configuration as set by SetStatusLEDConfig()

The following constants are available for this function:

  • BrickletUVLightV2.STATUS_LED_CONFIG_OFF = 0
  • BrickletUVLightV2.STATUS_LED_CONFIG_ON = 1
  • BrickletUVLightV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletUVLightV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
public short GetChipTemperature()

Returns the temperature in °C as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

public void Reset()

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

public void WriteUID(long uid)

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

public long ReadUID()

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

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 SetUVACallbackConfiguration(long period, bool valueHasToChange, char option, int min, int max)

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

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the UVACallback callback.

The following options are possible:

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

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

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

The following constants are available for this function:

  • BrickletUVLightV2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletUVLightV2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletUVLightV2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletUVLightV2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletUVLightV2.THRESHOLD_OPTION_GREATER = '>'
public void GetUVACallbackConfiguration(out long period, out bool valueHasToChange, out char option, out int min, out int max)

Returns the callback configuration as set by SetUVACallbackConfiguration().

The following constants are available for this function:

  • BrickletUVLightV2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletUVLightV2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletUVLightV2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletUVLightV2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletUVLightV2.THRESHOLD_OPTION_GREATER = '>'
public void SetUVBCallbackConfiguration(long period, bool valueHasToChange, char option, int min, int max)

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

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the UVBCallback callback.

The following options are possible:

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

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

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

The following constants are available for this function:

  • BrickletUVLightV2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletUVLightV2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletUVLightV2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletUVLightV2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletUVLightV2.THRESHOLD_OPTION_GREATER = '>'
public void GetUVBCallbackConfiguration(out long period, out bool valueHasToChange, out char option, out int min, out int max)

Returns the callback configuration as set by SetUVBCallbackConfiguration().

The following constants are available for this function:

  • BrickletUVLightV2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletUVLightV2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletUVLightV2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletUVLightV2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletUVLightV2.THRESHOLD_OPTION_GREATER = '>'
public void SetUVICallbackConfiguration(long period, bool valueHasToChange, char option, int min, int max)

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

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the UVICallback callback.

The following options are possible:

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

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

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

The following constants are available for this function:

  • BrickletUVLightV2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletUVLightV2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletUVLightV2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletUVLightV2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletUVLightV2.THRESHOLD_OPTION_GREATER = '>'
public void GetUVICallbackConfiguration(out long period, out bool valueHasToChange, out char option, out int min, out int max)

Returns the callback configuration as set by SetUVICallbackConfiguration().

The following constants are available for this function:

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

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(BrickletUVLightV2 sender, int value)
{
    System.Console.WriteLine("Value: " + value);
}

uvLightV2.ExampleCallback += MyCallback;

The available events 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.

public event UVACallback(BrickletUVLightV2 sender, int uva)

This callback is triggered periodically according to the configuration set by SetUVACallbackConfiguration().

The parameter is the same as GetUVA().

public event UVBCallback(BrickletUVLightV2 sender, int uvb)

This callback is triggered periodically according to the configuration set by SetUVBCallbackConfiguration().

The parameter is the same as GetUVB().

public event UVICallback(BrickletUVLightV2 sender, int uvi)

This callback is triggered periodically according to the configuration set by SetUVICallbackConfiguration().

The parameter is the same as GetUVI().

Constants

public int DEVICE_IDENTIFIER

This constant is used to identify a UV Light Bricklet 2.0.

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