Visual Basic .NET - Temperature IR Bricklet 2.0¶

Simple¶

Download (ExampleSimple.vb)

 1Imports System
 2Imports Tinkerforge
 3
 4Module ExampleSimple
 5    Const HOST As String = "localhost"
 6    Const PORT As Integer = 4223
 7    Const UID As String = "XYZ" ' Change XYZ to the UID of your Temperature IR Bricklet 2.0
 8
 9    Sub Main()
10        Dim ipcon As New IPConnection() ' Create IP connection
11        Dim tir As New BrickletTemperatureIRV2(UID, ipcon) ' Create device object
12
13        ipcon.Connect(HOST, PORT) ' Connect to brickd
14        ' Don't use device before ipcon is connected
15
16        ' Get current ambient temperature
17        Dim ambientTemperature As Short = tir.GetAmbientTemperature()
18        Console.WriteLine("Ambient Temperature: " + (ambientTemperature/10.0).ToString() + " °C")
19
20        ' Get current object temperature
21        Dim objectTemperature As Short = tir.GetObjectTemperature()
22        Console.WriteLine("Object Temperature: " + (objectTemperature/10.0).ToString() + " °C")
23
24        Console.WriteLine("Press key to exit")
25        Console.ReadLine()
26        ipcon.Disconnect()
27    End Sub
28End Module

Callback¶

Download (ExampleCallback.vb)

 1Imports System
 2Imports Tinkerforge
 3
 4Module ExampleCallback
 5    Const HOST As String = "localhost"
 6    Const PORT As Integer = 4223
 7    Const UID As String = "XYZ" ' Change XYZ to the UID of your Temperature IR Bricklet 2.0
 8
 9    ' Callback subroutine for object temperature callback
10    Sub ObjectTemperatureCB(ByVal sender As BrickletTemperatureIRV2, _
11                            ByVal temperature As Short)
12        Console.WriteLine("Object Temperature: " + (temperature/10.0).ToString() + " °C")
13    End Sub
14
15    Sub Main()
16        Dim ipcon As New IPConnection() ' Create IP connection
17        Dim tir As New BrickletTemperatureIRV2(UID, ipcon) ' Create device object
18
19        ipcon.Connect(HOST, PORT) ' Connect to brickd
20        ' Don't use device before ipcon is connected
21
22        ' Register object temperature callback to subroutine ObjectTemperatureCB
23        AddHandler tir.ObjectTemperatureCallback, AddressOf ObjectTemperatureCB
24
25        ' Set period for object temperature callback to 1s (1000ms) without a threshold
26        tir.SetObjectTemperatureCallbackConfiguration(1000, False, "x"C, 0, 0)
27
28        Console.WriteLine("Press key to exit")
29        Console.ReadLine()
30        ipcon.Disconnect()
31    End Sub
32End Module

Water Boiling¶

Download (ExampleWaterBoiling.vb)

 1Imports System
 2Imports Tinkerforge
 3
 4Module ExampleWaterBoiling
 5    Const HOST As String = "localhost"
 6    Const PORT As Integer = 4223
 7    Const UID As String = "XYZ" ' Change XYZ to the UID of your Temperature IR Bricklet 2.0
 8
 9    ' Callback subroutine for object temperature reached callback
10    Sub ObjectTemperatureCB(ByVal sender As BrickletTemperatureIRV2, _
11                            ByVal temperature As Short)
12        Console.WriteLine("Object Temperature: " + (temperature/10.0).ToString() + " °C")
13        Console.WriteLine("The water is boiling!")
14    End Sub
15
16    Sub Main()
17        Dim ipcon As New IPConnection() ' Create IP connection
18        Dim tir As New BrickletTemperatureIRV2(UID, ipcon) ' Create device object
19
20        ipcon.Connect(HOST, PORT) ' Connect to brickd
21        ' Don't use device before ipcon is connected
22
23        ' Set emissivity to 0.98 (emissivity of water, 65535 * 0.98 = 64224.299)
24        tir.SetEmissivity(64224)
25
26        ' Register object temperature reached callback to subroutine ObjectTemperatureCB
27        AddHandler tir.ObjectTemperatureCallback, AddressOf ObjectTemperatureCB
28
29        ' Configure threshold for object temperature "greater than 100 °C"
30        ' with a debounce period of 10s (10000ms)
31        tir.SetObjectTemperatureCallbackConfiguration(10000, False, ">"C, 100*10, 0)
32
33        Console.WriteLine("Press key to exit")
34        Console.ReadLine()
35        ipcon.Disconnect()
36    End Sub
37End Module

Basic Functions¶

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

Creates an object with the unique device ID uid:

Dim temperatureIRV2 As New BrickletTemperatureIRV2("YOUR_DEVICE_UID", ipcon)

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

Function BrickletTemperatureIRV2.GetAmbientTemperature() As Short¶

Returns:	temperature – Type: Short, Unit: 1/10 °C, Range: [-400 to 1250]

Returns the ambient temperature of the sensor.

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

Function BrickletTemperatureIRV2.GetObjectTemperature() As Short¶

Returns:	temperature – Type: Short, Unit: 1/10 °C, Range: [-700 to 3800]

Returns the object temperature of the sensor, i.e. the temperature of the surface of the object the sensor is aimed at.

The temperature of different materials is dependent on their emissivity. The emissivity of the material can be set with SetEmissivity().

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

Advanced Functions¶

Sub BrickletTemperatureIRV2.SetEmissivity(ByVal emissivity As Integer)¶

Parameters:	emissivity – Type: Integer, Unit: 1/65535, Range: [6553 to 216 - 1], Default: 216 - 1

Sets the emissivity that is used to calculate the surface temperature as returned by GetObjectTemperature().

The emissivity is usually given as a value between 0.0 and 1.0. A list of emissivities of different materials can be found here.

The parameter of SetEmissivity() has to be given with a factor of 65535 (16-bit). For example: An emissivity of 0.1 can be set with the value 6553, an emissivity of 0.5 with the value 32767 and so on.

Note

If you need a precise measurement for the object temperature, it is absolutely crucial that you also provide a precise emissivity.

The emissivity is stored in non-volatile memory and will still be used after a restart or power cycle of the Bricklet.

Function BrickletTemperatureIRV2.GetEmissivity() As Integer¶

Returns:	emissivity – Type: Integer, Unit: 1/65535, Range: [6553 to 216 - 1], Default: 216 - 1

Returns the emissivity as set by SetEmissivity().

Sub BrickletTemperatureIRV2.GetSPITFPErrorCount(ByRef errorCountAckChecksum As Long, ByRef errorCountMessageChecksum As Long, ByRef errorCountFrame As Long, ByRef errorCountOverflow As Long)¶

Output Parameters:	errorCountAckChecksum – Type: Long, Range: [0 to 232 - 1] errorCountMessageChecksum – Type: Long, Range: [0 to 232 - 1] errorCountFrame – Type: Long, Range: [0 to 232 - 1] errorCountOverflow – Type: Long, 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.

Sub BrickletTemperatureIRV2.SetStatusLEDConfig(ByVal config As 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:

• BrickletTemperatureIRV2.STATUS_LED_CONFIG_OFF = 0

• BrickletTemperatureIRV2.STATUS_LED_CONFIG_ON = 1

• BrickletTemperatureIRV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2

• BrickletTemperatureIRV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

Function BrickletTemperatureIRV2.GetStatusLEDConfig() As 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:

• BrickletTemperatureIRV2.STATUS_LED_CONFIG_OFF = 0

• BrickletTemperatureIRV2.STATUS_LED_CONFIG_ON = 1

• BrickletTemperatureIRV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2

• BrickletTemperatureIRV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

Function BrickletTemperatureIRV2.GetChipTemperature() As Short¶

Returns:	temperature – Type: Short, 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.

Sub BrickletTemperatureIRV2.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!

Sub BrickletTemperatureIRV2.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 BrickletTemperatureIRV2.SetAmbientTemperatureCallbackConfiguration(ByVal period As Long, ByVal valueHasToChange As Boolean, ByVal option As Char, ByVal min As Short, ByVal max As Short)¶

Parameters:	period – Type: Long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 valueHasToChange – Type: Boolean, Default: false option – Type: Char, Range: See constants, Default: "x"C min – Type: Short, Unit: 1/10 °C, Range: [-215 to 215 - 1], Default: 0 max – Type: Short, Unit: 1/10 °C, Range: [-215 to 215 - 1], Default: 0

The period is the period with which the AmbientTemperatureCallback 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 AmbientTemperatureCallback 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:

• BrickletTemperatureIRV2.THRESHOLD_OPTION_OFF = "x"C

• BrickletTemperatureIRV2.THRESHOLD_OPTION_OUTSIDE = "o"C

• BrickletTemperatureIRV2.THRESHOLD_OPTION_INSIDE = "i"C

• BrickletTemperatureIRV2.THRESHOLD_OPTION_SMALLER = "<"C

• BrickletTemperatureIRV2.THRESHOLD_OPTION_GREATER = ">"C

Sub BrickletTemperatureIRV2.GetAmbientTemperatureCallbackConfiguration(ByRef period As Long, ByRef valueHasToChange As Boolean, ByRef option As Char, ByRef min As Short, ByRef max As Short)¶

Output Parameters:	period – Type: Long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 valueHasToChange – Type: Boolean, Default: false option – Type: Char, Range: See constants, Default: "x"C min – Type: Short, Unit: 1/10 °C, Range: [-215 to 215 - 1], Default: 0 max – Type: Short, Unit: 1/10 °C, Range: [-215 to 215 - 1], Default: 0

Returns the callback configuration as set by SetAmbientTemperatureCallbackConfiguration().

The following constants are available for this function:

For option:

• BrickletTemperatureIRV2.THRESHOLD_OPTION_OFF = "x"C

• BrickletTemperatureIRV2.THRESHOLD_OPTION_OUTSIDE = "o"C

• BrickletTemperatureIRV2.THRESHOLD_OPTION_INSIDE = "i"C

• BrickletTemperatureIRV2.THRESHOLD_OPTION_SMALLER = "<"C

• BrickletTemperatureIRV2.THRESHOLD_OPTION_GREATER = ">"C

Sub BrickletTemperatureIRV2.SetObjectTemperatureCallbackConfiguration(ByVal period As Long, ByVal valueHasToChange As Boolean, ByVal option As Char, ByVal min As Short, ByVal max As Short)¶

Parameters:	period – Type: Long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 valueHasToChange – Type: Boolean, Default: false option – Type: Char, Range: See constants, Default: "x"C min – Type: Short, Unit: 1/10 °C, Range: [-215 to 215 - 1], Default: 0 max – Type: Short, Unit: 1/10 °C, Range: [-215 to 215 - 1], Default: 0

The period is the period with which the ObjectTemperatureCallback 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 ObjectTemperatureCallback 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:

• BrickletTemperatureIRV2.THRESHOLD_OPTION_OFF = "x"C

• BrickletTemperatureIRV2.THRESHOLD_OPTION_OUTSIDE = "o"C

• BrickletTemperatureIRV2.THRESHOLD_OPTION_INSIDE = "i"C

• BrickletTemperatureIRV2.THRESHOLD_OPTION_SMALLER = "<"C

• BrickletTemperatureIRV2.THRESHOLD_OPTION_GREATER = ">"C

Sub BrickletTemperatureIRV2.GetObjectTemperatureCallbackConfiguration(ByRef period As Long, ByRef valueHasToChange As Boolean, ByRef option As Char, ByRef min As Short, ByRef max As Short)¶

Output Parameters:	period – Type: Long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 valueHasToChange – Type: Boolean, Default: false option – Type: Char, Range: See constants, Default: "x"C min – Type: Short, Unit: 1/10 °C, Range: [-215 to 215 - 1], Default: 0 max – Type: Short, Unit: 1/10 °C, Range: [-215 to 215 - 1], Default: 0

Returns the callback configuration as set by SetObjectTemperatureCallbackConfiguration().

The following constants are available for this function:

For option:

• BrickletTemperatureIRV2.THRESHOLD_OPTION_OFF = "x"C

• BrickletTemperatureIRV2.THRESHOLD_OPTION_OUTSIDE = "o"C

• BrickletTemperatureIRV2.THRESHOLD_OPTION_INSIDE = "i"C

• BrickletTemperatureIRV2.THRESHOLD_OPTION_SMALLER = "<"C

• BrickletTemperatureIRV2.THRESHOLD_OPTION_GREATER = ">"C

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 BrickletTemperatureIRV2, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

AddHandler temperatureIRV2.ExampleCallback, AddressOf MyCallback

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

Event BrickletTemperatureIRV2.AmbientTemperatureCallback(ByVal sender As BrickletTemperatureIRV2, ByVal temperature As Short)¶

Callback Parameters:	sender – Type: BrickletTemperatureIRV2 temperature – Type: Short, Unit: 1/10 °C, Range: [-400 to 1250]

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

The parameter is the same as GetAmbientTemperature().

Event BrickletTemperatureIRV2.ObjectTemperatureCallback(ByVal sender As BrickletTemperatureIRV2, ByVal temperature As Short)¶

Callback Parameters:	sender – Type: BrickletTemperatureIRV2 temperature – Type: Short, Unit: 1/10 °C, Range: [-700 to 3800]

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

The parameter is the same as GetObjectTemperature().

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

• BrickletTemperatureIRV2.FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_CONFIGURATION = 2

• BrickletTemperatureIRV2.FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_CONFIGURATION = 6

• BrickletTemperatureIRV2.FUNCTION_SET_EMISSIVITY = 9

• BrickletTemperatureIRV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237

• BrickletTemperatureIRV2.FUNCTION_SET_STATUS_LED_CONFIG = 239

• BrickletTemperatureIRV2.FUNCTION_RESET = 243

• BrickletTemperatureIRV2.FUNCTION_WRITE_UID = 248

Sub BrickletTemperatureIRV2.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:

• BrickletTemperatureIRV2.FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_CONFIGURATION = 2

• BrickletTemperatureIRV2.FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_CONFIGURATION = 6

• BrickletTemperatureIRV2.FUNCTION_SET_EMISSIVITY = 9

• BrickletTemperatureIRV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237

• BrickletTemperatureIRV2.FUNCTION_SET_STATUS_LED_CONFIG = 239

• BrickletTemperatureIRV2.FUNCTION_RESET = 243

• BrickletTemperatureIRV2.FUNCTION_WRITE_UID = 248

Sub BrickletTemperatureIRV2.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.

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 BrickletTemperatureIRV2.SetBootloaderMode(ByVal mode As Byte) As 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:

• BrickletTemperatureIRV2.BOOTLOADER_MODE_BOOTLOADER = 0

• BrickletTemperatureIRV2.BOOTLOADER_MODE_FIRMWARE = 1

• BrickletTemperatureIRV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2

• BrickletTemperatureIRV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3

• BrickletTemperatureIRV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

• BrickletTemperatureIRV2.BOOTLOADER_STATUS_OK = 0

• BrickletTemperatureIRV2.BOOTLOADER_STATUS_INVALID_MODE = 1

• BrickletTemperatureIRV2.BOOTLOADER_STATUS_NO_CHANGE = 2

• BrickletTemperatureIRV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3

• BrickletTemperatureIRV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4

• BrickletTemperatureIRV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5

Function BrickletTemperatureIRV2.GetBootloaderMode() As 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:

• BrickletTemperatureIRV2.BOOTLOADER_MODE_BOOTLOADER = 0

• BrickletTemperatureIRV2.BOOTLOADER_MODE_FIRMWARE = 1

• BrickletTemperatureIRV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2

• BrickletTemperatureIRV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3

• BrickletTemperatureIRV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Sub BrickletTemperatureIRV2.SetWriteFirmwarePointer(ByVal pointer As Long)¶

Parameters:	pointer – Type: Long, 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 BrickletTemperatureIRV2.WriteFirmware(ByVal data() As Byte) As Byte¶

Parameters:	data – Type: Byte Array, Length: 64, 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.

Sub BrickletTemperatureIRV2.WriteUID(ByVal uid As Long)¶

Parameters:	uid – Type: Long, 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 BrickletTemperatureIRV2.ReadUID() As Long¶

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

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

Constants¶

Const BrickletTemperatureIRV2.DEVICE_IDENTIFIER¶

This constant is used to identify a Temperature IR Bricklet 2.0.

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 BrickletTemperatureIRV2.DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a Temperature IR Bricklet 2.0.