Delphi/Lazarus - UV Light Bricklet 2.0¶

Callback¶

Download (ExampleCallback.pas)

 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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

program ExampleCallback;

{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}

uses
  SysUtils, IPConnection, BrickletUVLightV2;

type
  TExample = class
  private
    ipcon: TIPConnection;
    uvl: TBrickletUVLightV2;
  public
    procedure UVICB(sender: TBrickletUVLightV2; const uvi: longint);
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your UV Light Bricklet 2.0 }

var
  e: TExample;

{ Callback procedure for UV index callback }
procedure TExample.UVICB(sender: TBrickletUVLightV2; const uvi: longint);
begin
  WriteLn(Format('UV Index: %f', [uvi/10.0]));
end;

procedure TExample.Execute;
begin
  { Create IP connection }
  ipcon := TIPConnection.Create;

  { Create device object }
  uvl := TBrickletUVLightV2.Create(UID, ipcon);

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

  { Register UV index callback to procedure UVICB }
  uvl.OnUVI := {$ifdef FPC}@{$endif}UVICB;

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

  WriteLn('Press key to exit');
  ReadLn;
  ipcon.Destroy; { Calls ipcon.Disconnect internally }
end;

begin
  e := TExample.Create;
  e.Execute;
  e.Destroy;
end.

Simple¶

Download (ExampleSimple.pas)

 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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

program ExampleSimple;

{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}

uses
  SysUtils, IPConnection, BrickletUVLightV2;

type
  TExample = class
  private
    ipcon: TIPConnection;
    uvl: TBrickletUVLightV2;
  public
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your UV Light Bricklet 2.0 }

var
  e: TExample;

procedure TExample.Execute;
var uva, uvb, uvi: longint;
begin
  { Create IP connection }
  ipcon := TIPConnection.Create;

  { Create device object }
  uvl := TBrickletUVLightV2.Create(UID, ipcon);

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

  { Get current UV-A }
  uva := uvl.GetUVA;
  WriteLn(Format('UV-A: %f mW/m²', [uva/10.0]));

  { Get current UV-B }
  uvb := uvl.GetUVB;
  WriteLn(Format('UV-B: %f mW/m²', [uvb/10.0]));

  { Get current UV index }
  uvi := uvl.GetUVI;
  WriteLn(Format('UV Index: %f', [uvi/10.0]));

  WriteLn('Press key to exit');
  ReadLn;
  ipcon.Destroy; { Calls ipcon.Disconnect internally }
end;

begin
  e := TExample.Create;
  e.Execute;
  e.Destroy;
end.

Threshold¶

Download (ExampleThreshold.pas)

 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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

program ExampleThreshold;

{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}

uses
  SysUtils, IPConnection, BrickletUVLightV2;

type
  TExample = class
  private
    ipcon: TIPConnection;
    uvl: TBrickletUVLightV2;
  public
    procedure UVICB(sender: TBrickletUVLightV2; const uvi: longint);
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your UV Light Bricklet 2.0 }

var
  e: TExample;

{ Callback procedure for UV index callback }
procedure TExample.UVICB(sender: TBrickletUVLightV2; const uvi: longint);
begin
  WriteLn(Format('UV Index: %f', [uvi/10.0]));
  WriteLn('UV index > 3. Use sunscreen!');
end;

procedure TExample.Execute;
begin
  { Create IP connection }
  ipcon := TIPConnection.Create;

  { Create device object }
  uvl := TBrickletUVLightV2.Create(UID, ipcon);

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

  { Register UV index callback to procedure UVICB }
  uvl.OnUVI := {$ifdef FPC}@{$endif}UVICB;

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

  WriteLn('Press key to exit');
  ReadLn;
  ipcon.Destroy; { Calls ipcon.Disconnect internally }
end;

begin
  e := TExample.Create;
  e.Execute;
  e.Destroy;
end.

Basic Functions¶

constructor TBrickletUVLightV2.Create(const uid: string; ipcon: TIPConnection)¶

Parameters:	uid – Type: string ipcon – Type: TIPConnection
Returns:	uvLightV2 – Type: TBrickletUVLightV2

Creates an object with the unique device ID uid:

uvLightV2 := TBrickletUVLightV2.Create('YOUR_DEVICE_UID', ipcon);

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

function TBrickletUVLightV2.GetUVA: longint¶

Returns:	uva – Type: longint, Unit: 1/10 mW/m², Range: [-1 to 231 - 1]

Returns the UVA intensity of the sensor. 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 OnUVA callback and set the period with SetUVACallbackConfiguration.

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

function TBrickletUVLightV2.GetUVB: longint¶

Returns:	uvb – Type: longint, Unit: 1/10 mW/m², Range: [-1 to 231 - 1]

Returns the UVB intensity of the sensor. 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 OnUVB callback and set the period with SetUVBCallbackConfiguration.

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

function TBrickletUVLightV2.GetUVI: longint¶

Returns:	uvi – Type: longint, Unit: 1/10 , Range: [-1 to 231 - 1]

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 OnUVI callback and set the period with SetUVICallbackConfiguration.

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

Advanced Functions¶

procedure TBrickletUVLightV2.SetConfiguration(const integrationTime: byte)¶

Parameters:	integrationTime – Type: byte, Range: See constants, Default: 3

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.

The following constants are available for this function:

For integrationTime:

• BRICKLET_UV_LIGHT_V2_INTEGRATION_TIME_50MS = 0
• BRICKLET_UV_LIGHT_V2_INTEGRATION_TIME_100MS = 1
• BRICKLET_UV_LIGHT_V2_INTEGRATION_TIME_200MS = 2
• BRICKLET_UV_LIGHT_V2_INTEGRATION_TIME_400MS = 3
• BRICKLET_UV_LIGHT_V2_INTEGRATION_TIME_800MS = 4

function TBrickletUVLightV2.GetConfiguration: byte¶

Returns:	integrationTime – Type: byte, Range: See constants, Default: 3

Returns the configuration as set by SetConfiguration.

The following constants are available for this function:

For integrationTime:

• BRICKLET_UV_LIGHT_V2_INTEGRATION_TIME_50MS = 0
• BRICKLET_UV_LIGHT_V2_INTEGRATION_TIME_100MS = 1
• BRICKLET_UV_LIGHT_V2_INTEGRATION_TIME_200MS = 2
• BRICKLET_UV_LIGHT_V2_INTEGRATION_TIME_400MS = 3
• BRICKLET_UV_LIGHT_V2_INTEGRATION_TIME_800MS = 4

procedure TBrickletUVLightV2.GetSPITFPErrorCount(out errorCountAckChecksum: longword; out errorCountMessageChecksum: longword; out errorCountFrame: longword; out errorCountOverflow: longword)¶

Output Parameters:	errorCountAckChecksum – Type: longword, Range: [0 to 232 - 1] errorCountMessageChecksum – Type: longword, Range: [0 to 232 - 1] errorCountFrame – Type: longword, Range: [0 to 232 - 1] errorCountOverflow – Type: longword, Range: [0 to 232 - 1]

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.

procedure TBrickletUVLightV2.SetStatusLEDConfig(const config: byte)¶

Parameters:	config – Type: byte, Range: See constants, Default: 3

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:

For config:

• BRICKLET_UV_LIGHT_V2_STATUS_LED_CONFIG_OFF = 0
• BRICKLET_UV_LIGHT_V2_STATUS_LED_CONFIG_ON = 1
• BRICKLET_UV_LIGHT_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BRICKLET_UV_LIGHT_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

function TBrickletUVLightV2.GetStatusLEDConfig: byte¶

Returns:	config – Type: byte, Range: See constants, Default: 3

Returns the configuration as set by SetStatusLEDConfig

The following constants are available for this function:

For config:

• BRICKLET_UV_LIGHT_V2_STATUS_LED_CONFIG_OFF = 0
• BRICKLET_UV_LIGHT_V2_STATUS_LED_CONFIG_ON = 1
• BRICKLET_UV_LIGHT_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BRICKLET_UV_LIGHT_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

function TBrickletUVLightV2.GetChipTemperature: smallint¶

Returns:	temperature – Type: smallint, Unit: 1 °C, Range: [-215 to 215 - 1]

Returns the temperature 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.

procedure TBrickletUVLightV2.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!

procedure TBrickletUVLightV2.GetIdentity(out uid: string; out connectedUid: string; out position: char; out hardwareVersion: array [0..2] of byte; out firmwareVersion: array [0..2] of byte; out deviceIdentifier: word)¶

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: array [0..2] of byte 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: array [0..2] of byte 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: word, 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¶

procedure TBrickletUVLightV2.SetUVACallbackConfiguration(const period: longword; const valueHasToChange: boolean; const option: char; const min: longint; const max: longint)¶

Parameters:	period – Type: longword, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 valueHasToChange – Type: boolean, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: longint, Unit: 1/10 mW/m², Range: [-231 to 231 - 1], Default: 0 max – Type: longint, Unit: 1/10 mW/m², Range: [-231 to 231 - 1], Default: 0

The period is the period with which the OnUVA 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 OnUVA 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 following constants are available for this function:

For option:

• BRICKLET_UV_LIGHT_V2_THRESHOLD_OPTION_OFF = 'x'
• BRICKLET_UV_LIGHT_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
• BRICKLET_UV_LIGHT_V2_THRESHOLD_OPTION_INSIDE = 'i'
• BRICKLET_UV_LIGHT_V2_THRESHOLD_OPTION_SMALLER = '<'
• BRICKLET_UV_LIGHT_V2_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletUVLightV2.GetUVACallbackConfiguration(out period: longword; out valueHasToChange: boolean; out option: char; out min: longint; out max: longint)¶

Output Parameters:	period – Type: longword, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 valueHasToChange – Type: boolean, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: longint, Unit: 1/10 mW/m², Range: [-231 to 231 - 1], Default: 0 max – Type: longint, Unit: 1/10 mW/m², Range: [-231 to 231 - 1], Default: 0

Returns the callback configuration as set by SetUVACallbackConfiguration.

The following constants are available for this function:

For option:

• BRICKLET_UV_LIGHT_V2_THRESHOLD_OPTION_OFF = 'x'
• BRICKLET_UV_LIGHT_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
• BRICKLET_UV_LIGHT_V2_THRESHOLD_OPTION_INSIDE = 'i'
• BRICKLET_UV_LIGHT_V2_THRESHOLD_OPTION_SMALLER = '<'
• BRICKLET_UV_LIGHT_V2_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletUVLightV2.SetUVBCallbackConfiguration(const period: longword; const valueHasToChange: boolean; const option: char; const min: longint; const max: longint)¶

Parameters:	period – Type: longword, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 valueHasToChange – Type: boolean, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: longint, Unit: 1/10 mW/m², Range: [-231 to 231 - 1], Default: 0 max – Type: longint, Unit: 1/10 mW/m², Range: [-231 to 231 - 1], Default: 0

The period is the period with which the OnUVB 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 OnUVB 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 following constants are available for this function:

For option:

• BRICKLET_UV_LIGHT_V2_THRESHOLD_OPTION_OFF = 'x'
• BRICKLET_UV_LIGHT_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
• BRICKLET_UV_LIGHT_V2_THRESHOLD_OPTION_INSIDE = 'i'
• BRICKLET_UV_LIGHT_V2_THRESHOLD_OPTION_SMALLER = '<'
• BRICKLET_UV_LIGHT_V2_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletUVLightV2.GetUVBCallbackConfiguration(out period: longword; out valueHasToChange: boolean; out option: char; out min: longint; out max: longint)¶

Output Parameters:	period – Type: longword, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 valueHasToChange – Type: boolean, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: longint, Unit: 1/10 mW/m², Range: [-231 to 231 - 1], Default: 0 max – Type: longint, Unit: 1/10 mW/m², Range: [-231 to 231 - 1], Default: 0

Returns the callback configuration as set by SetUVBCallbackConfiguration.

The following constants are available for this function:

For option:

• BRICKLET_UV_LIGHT_V2_THRESHOLD_OPTION_OFF = 'x'
• BRICKLET_UV_LIGHT_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
• BRICKLET_UV_LIGHT_V2_THRESHOLD_OPTION_INSIDE = 'i'
• BRICKLET_UV_LIGHT_V2_THRESHOLD_OPTION_SMALLER = '<'
• BRICKLET_UV_LIGHT_V2_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletUVLightV2.SetUVICallbackConfiguration(const period: longword; const valueHasToChange: boolean; const option: char; const min: longint; const max: longint)¶

Parameters:	period – Type: longword, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 valueHasToChange – Type: boolean, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: longint, Unit: 1/10 , Range: [-231 to 231 - 1], Default: 0 max – Type: longint, Unit: 1/10 , Range: [-231 to 231 - 1], Default: 0

The period is the period with which the OnUVI 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 OnUVI 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 following constants are available for this function:

For option:

• BRICKLET_UV_LIGHT_V2_THRESHOLD_OPTION_OFF = 'x'
• BRICKLET_UV_LIGHT_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
• BRICKLET_UV_LIGHT_V2_THRESHOLD_OPTION_INSIDE = 'i'
• BRICKLET_UV_LIGHT_V2_THRESHOLD_OPTION_SMALLER = '<'
• BRICKLET_UV_LIGHT_V2_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletUVLightV2.GetUVICallbackConfiguration(out period: longword; out valueHasToChange: boolean; out option: char; out min: longint; out max: longint)¶

Output Parameters:	period – Type: longword, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 valueHasToChange – Type: boolean, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: longint, Unit: 1/10 , Range: [-231 to 231 - 1], Default: 0 max – Type: longint, Unit: 1/10 , Range: [-231 to 231 - 1], Default: 0

Returns the callback configuration as set by SetUVICallbackConfiguration.

The following constants are available for this function:

For option:

• BRICKLET_UV_LIGHT_V2_THRESHOLD_OPTION_OFF = 'x'
• BRICKLET_UV_LIGHT_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
• BRICKLET_UV_LIGHT_V2_THRESHOLD_OPTION_INSIDE = 'i'
• BRICKLET_UV_LIGHT_V2_THRESHOLD_OPTION_SMALLER = '<'
• BRICKLET_UV_LIGHT_V2_THRESHOLD_OPTION_GREATER = '>'

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:

procedure TExample.MyCallback(sender: TBrickletUVLightV2; const value: longint);
begin
  WriteLn(Format('Value: %d', [value]));
end;

uvLightV2.OnExample := {$ifdef FPC}@{$endif}example.MyCallback;

The available callback properties and their parameter types are described below.

property TBrickletUVLightV2.OnUVA¶

procedure(sender: TBrickletUVLightV2; const uva: longint) of object;

Callback Parameters:	sender – Type: TBrickletUVLightV2 uva – Type: longint, Unit: 1/10 mW/m², Range: [-1 to 231 - 1]

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

The parameter is the same as GetUVA.

property TBrickletUVLightV2.OnUVB¶

procedure(sender: TBrickletUVLightV2; const uvb: longint) of object;

Callback Parameters:	sender – Type: TBrickletUVLightV2 uvb – Type: longint, Unit: 1/10 mW/m², Range: [-1 to 231 - 1]

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

The parameter is the same as GetUVB.

property TBrickletUVLightV2.OnUVI¶

procedure(sender: TBrickletUVLightV2; const uvi: longint) of object;

Callback Parameters:	sender – Type: TBrickletUVLightV2 uvi – Type: longint, Unit: 1/10 , Range: [-1 to 231 - 1]

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

The parameter is the same as GetUVI.

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 TBrickletUVLightV2.GetAPIVersion: array [0..2] of byte¶

Output Parameters:	apiVersion – Type: array [0..2] of byte 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 TBrickletUVLightV2.GetResponseExpected(const functionId: byte): 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:

• BRICKLET_UV_LIGHT_V2_FUNCTION_SET_UVA_CALLBACK_CONFIGURATION = 2
• BRICKLET_UV_LIGHT_V2_FUNCTION_SET_UVB_CALLBACK_CONFIGURATION = 6
• BRICKLET_UV_LIGHT_V2_FUNCTION_SET_UVI_CALLBACK_CONFIGURATION = 10
• BRICKLET_UV_LIGHT_V2_FUNCTION_SET_CONFIGURATION = 13
• BRICKLET_UV_LIGHT_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BRICKLET_UV_LIGHT_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
• BRICKLET_UV_LIGHT_V2_FUNCTION_RESET = 243
• BRICKLET_UV_LIGHT_V2_FUNCTION_WRITE_UID = 248

procedure TBrickletUVLightV2.SetResponseExpected(const functionId: byte; const responseExpected: 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:

• BRICKLET_UV_LIGHT_V2_FUNCTION_SET_UVA_CALLBACK_CONFIGURATION = 2
• BRICKLET_UV_LIGHT_V2_FUNCTION_SET_UVB_CALLBACK_CONFIGURATION = 6
• BRICKLET_UV_LIGHT_V2_FUNCTION_SET_UVI_CALLBACK_CONFIGURATION = 10
• BRICKLET_UV_LIGHT_V2_FUNCTION_SET_CONFIGURATION = 13
• BRICKLET_UV_LIGHT_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BRICKLET_UV_LIGHT_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
• BRICKLET_UV_LIGHT_V2_FUNCTION_RESET = 243
• BRICKLET_UV_LIGHT_V2_FUNCTION_WRITE_UID = 248

procedure TBrickletUVLightV2.SetResponseExpectedAll(const responseExpected: boolean)¶

Parameters:	responseExpected – Type: boolean

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

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

function TBrickletUVLightV2.SetBootloaderMode(const mode: byte): byte¶

Parameters:	mode – Type: byte, Range: See constants
Returns:	status – Type: byte, Range: See constants

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:

For mode:

• BRICKLET_UV_LIGHT_V2_BOOTLOADER_MODE_BOOTLOADER = 0
• BRICKLET_UV_LIGHT_V2_BOOTLOADER_MODE_FIRMWARE = 1
• BRICKLET_UV_LIGHT_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BRICKLET_UV_LIGHT_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BRICKLET_UV_LIGHT_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

• BRICKLET_UV_LIGHT_V2_BOOTLOADER_STATUS_OK = 0
• BRICKLET_UV_LIGHT_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
• BRICKLET_UV_LIGHT_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
• BRICKLET_UV_LIGHT_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• BRICKLET_UV_LIGHT_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• BRICKLET_UV_LIGHT_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5

function TBrickletUVLightV2.GetBootloaderMode: byte¶

Returns:	mode – Type: byte, Range: See constants

Returns the current bootloader mode, see SetBootloaderMode.

The following constants are available for this function:

For mode:

• BRICKLET_UV_LIGHT_V2_BOOTLOADER_MODE_BOOTLOADER = 0
• BRICKLET_UV_LIGHT_V2_BOOTLOADER_MODE_FIRMWARE = 1
• BRICKLET_UV_LIGHT_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BRICKLET_UV_LIGHT_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BRICKLET_UV_LIGHT_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

procedure TBrickletUVLightV2.SetWriteFirmwarePointer(const pointer: longword)¶

Parameters:	pointer – Type: longword, Unit: 1 B, Range: [0 to 232 - 1]

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.

function TBrickletUVLightV2.WriteFirmware(const data: array [0..63] of byte): byte¶

Parameters:	data – Type: array [0..63] of byte, Range: [0 to 255]
Returns:	status – Type: byte, Range: [0 to 255]

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.

procedure TBrickletUVLightV2.WriteUID(const uid: longword)¶

Parameters:	uid – Type: longword, Range: [0 to 232 - 1]

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.

function TBrickletUVLightV2.ReadUID: longword¶

Returns:	uid – Type: longword, Range: [0 to 232 - 1]

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

Constants¶

const BRICKLET_UV_LIGHT_V2_DEVICE_IDENTIFIER¶

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

The GetIdentity function and the TIPConnection.OnEnumerate callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

const BRICKLET_UV_LIGHT_V2_DEVICE_DISPLAY_NAME¶

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