Visual Basic .NET - UV Light Bricklet¶

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

Imports System
Imports Tinkerforge

Module ExampleSimple
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your UV Light Bricklet

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim uvl As 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
        Dim uvLight As Long = uvl.GetUVLight()
        Console.WriteLine("UV Light: " + (uvLight/10.0).ToString() + " mW/m²")

        Console.WriteLine("Press key to exit")
        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

Imports System
Imports Tinkerforge

Module ExampleCallback
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your UV Light Bricklet

    ' Callback subroutine for UV light callback
    Sub UVLightCB(ByVal sender As BrickletUVLight, ByVal uvLight As Long)
        Console.WriteLine("UV Light: " + (uvLight/10.0).ToString() + " mW/m²")
    End Sub

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim uvl As 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 subroutine UVLightCB
        AddHandler uvl.UVLightCallback, AddressOf 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 key to exit")
        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

Imports System
Imports Tinkerforge

Module ExampleThreshold
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your UV Light Bricklet

    ' Callback subroutine for UV light reached callback
    Sub UVLightReachedCB(ByVal sender As BrickletUVLight, ByVal uvLight As Long)
        Console.WriteLine("UV Light: " + (uvLight/10.0).ToString() + " mW/m²")
        Console.WriteLine("UV Index > 3. Use sunscreen!")
    End Sub

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim uvl As 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 subroutine UVLightReachedCB
        AddHandler uvl.UVLightReachedCallback, AddressOf UVLightReachedCB

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

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

Basic Functions¶

Class BrickletUVLight(ByVal uid As String, ByVal ipcon As IPConnection)¶

Creates an object with the unique device ID uid:

Dim uvLight As New BrickletUVLight("YOUR_DEVICE_UID", ipcon)

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

Function BrickletUVLight.GetUVLight() As Long¶

Returns:	uvLight – Type: Long, Unit: 1/10 mW/m², Range: [0 to 3280]

Returns the UV light intensity of the sensor. 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¶

Sub BrickletUVLight.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)¶

Output Parameters:

uid – Type: String, Length: up to 8 connectedUid – Type: String, Length: up to 8 position – Type: Char, Range: ["a"C to "h"C, "z"C] hardwareVersion – Type: Byte Array, 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 Array, 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: Integer, 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.

Callback Configuration Functions¶

Sub BrickletUVLight.SetUVLightCallbackPeriod(ByVal period As Long)¶

Parameters:	period – Type: Long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Sets the period 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.

Function BrickletUVLight.GetUVLightCallbackPeriod() As Long¶

Returns:	period – Type: Long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by SetUVLightCallbackPeriod().

Sub BrickletUVLight.SetUVLightCallbackThreshold(ByVal option As Char, ByVal min As Long, ByVal max As Long)¶

Parameters:	option – Type: Char, Range: See constants, Default: "x"C min – Type: Long, Unit: 1/10 mW/m², Range: [0 to 232 - 1], Default: 0 max – Type: Long, Unit: 1/10 mW/m², Range: [0 to 232 - 1], Default: 0

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 following constants are available for this function:

For option:

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

Sub BrickletUVLight.GetUVLightCallbackThreshold(ByRef option As Char, ByRef min As Long, ByRef max As Long)¶

Output Parameters:	option – Type: Char, Range: See constants, Default: "x"C min – Type: Long, Unit: 1/10 mW/m², Range: [0 to 232 - 1], Default: 0 max – Type: Long, Unit: 1/10 mW/m², Range: [0 to 232 - 1], Default: 0

Returns the threshold as set by SetUVLightCallbackThreshold().

The following constants are available for this function:

For option:

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

Sub BrickletUVLight.SetDebouncePeriod(ByVal debounce As Long)¶

Parameters:	debounce – Type: Long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Sets the period with which the threshold callbacks

• UVLightReachedCallback,

are triggered, if the thresholds

• SetUVLightCallbackThreshold(),

keep being reached.

Function BrickletUVLight.GetDebouncePeriod() As Long¶

Returns:	debounce – Type: Long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

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

Sub MyCallback(ByVal sender As BrickletUVLight, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

AddHandler uvLight.ExampleCallback, AddressOf MyCallback

The available callback property and their type of parameters are described below.

Event BrickletUVLight.UVLightCallback(ByVal sender As BrickletUVLight, ByVal uvLight As Long)¶

Callback Parameters:	sender – Type: BrickletUVLight uvLight – Type: Long, Unit: 1/10 mW/m², Range: [0 to 32800000]

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.

Event BrickletUVLight.UVLightReachedCallback(ByVal sender As BrickletUVLight, ByVal uvLight As Long)¶

Callback Parameters:	sender – Type: BrickletUVLight uvLight – Type: Long, Unit: 1/10 mW/m², Range: [0 to 32800000]

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

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.

Function BrickletUVLight.GetAPIVersion() As Byte()¶

Output Parameters:	apiVersion – Type: Byte Array, 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.

Function BrickletUVLight.GetResponseExpected(ByVal functionId As Byte) As Boolean¶

Parameters:	functionId – Type: Byte, Range: See constants
Returns:	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:

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

Sub BrickletUVLight.SetResponseExpected(ByVal functionId As Byte, ByVal responseExpected As Boolean)¶

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

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

Sub BrickletUVLight.SetResponseExpectedAll(ByVal responseExpected As Boolean)¶

Parameters:	responseExpected – Type: Boolean

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

Constants¶

Const BrickletUVLight.DEVICE_IDENTIFIER¶

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

Const BrickletUVLight.DEVICE_DISPLAY_NAME¶

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