Visual Basic .NET - Solid State Relay Bricklet 2.0

This is the description of the Visual Basic .NET API bindings for the Solid State Relay Bricklet 2.0. General information and technical specifications for the Solid State Relay Bricklet 2.0 are summarized in its hardware description.

An installation guide for the Visual Basic .NET API bindings is part of their general description.

Examples

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

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
25
26
27
28
29
30
Imports System
Imports System.Threading
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 Solid State Relay Bricklet 2.0

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim ssr As New BrickletSolidStateRelayV2(UID, ipcon) ' Create device object

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

        ' Turn relay on/off 10 times with 1 second delay
        Dim i As Integer
        For i = 0 To 4
            Thread.Sleep(1000)
            ssr.SetState(True)
            Thread.Sleep(1000)
            ssr.SetState(False)
        Next i

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

API

Since Visual Basic .NET does not support multiple return values directly, we use the ByRef keyword to return multiple values from a function.

All functions and procedures listed below are thread-safe.

Basic Functions

Class BrickletSolidStateRelayV2(ByVal uid As String, ByVal ipcon As IPConnection)

Creates an object with the unique device ID uid:

Dim solidStateRelayV2 As New BrickletSolidStateRelayV2("YOUR_DEVICE_UID", ipcon)

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

Sub BrickletSolidStateRelayV2.SetState(ByVal state As Boolean)

Sets the state of the relays true means on and false means off.

Running monoflop timers will be overwritten if this function is called.

The default value is false.

Function BrickletSolidStateRelayV2.GetState() As Boolean

Returns the state of the relay, true means on and false means off.

Advanced Functions

Sub BrickletSolidStateRelayV2.SetMonoflop(ByVal state As Boolean, ByVal time As Long)

The first parameter is the desired state of the relay (true means on and false means off). The second parameter indicates the time (in ms) that the relay should hold the state.

If this function is called with the parameters (true, 1500): The relay will turn on and in 1.5s it will turn off again.

A monoflop can be used as a failsafe mechanism. For example: Lets assume you have a RS485 bus and a Solid State Relay Bricklet connected to one of the slave stacks. You can now call this function every second, with a time parameter of two seconds. The relay will be on all the time. If now the RS485 connection is lost, the relay will turn off in at most two seconds.

Sub BrickletSolidStateRelayV2.GetMonoflop(ByRef state As Boolean, ByRef time As Long, ByRef timeRemaining As Long)

Returns the current state and the time as set by SetMonoflop() as well as the remaining time until the state flips.

If the timer is not running currently, the remaining time will be returned as 0.

Function BrickletSolidStateRelayV2.GetAPIVersion() As Byte()

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.

Function BrickletSolidStateRelayV2.GetResponseExpected(ByVal functionId As Byte) As 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 send and errors are silently ignored, because they cannot be detected.

See SetResponseExpected() for the list of function ID constants available for this function.

Sub BrickletSolidStateRelayV2.SetResponseExpected(ByVal functionId As Byte, ByVal responseExpected As 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 send and errors are silently ignored, because they cannot be detected.

The following function ID constants are available for this function:

  • BrickletSolidStateRelayV2.FUNCTION_SET_STATE = 1
  • BrickletSolidStateRelayV2.FUNCTION_SET_MONOFLOP = 3
  • BrickletSolidStateRelayV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletSolidStateRelayV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletSolidStateRelayV2.FUNCTION_RESET = 243
  • BrickletSolidStateRelayV2.FUNCTION_WRITE_UID = 248
Sub BrickletSolidStateRelayV2.SetResponseExpectedAll(ByVal responseExpected As Boolean)

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

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

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.

Function BrickletSolidStateRelayV2.SetBootloaderMode(ByVal mode As Byte) As Byte

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:

  • BrickletSolidStateRelayV2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletSolidStateRelayV2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletSolidStateRelayV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletSolidStateRelayV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletSolidStateRelayV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BrickletSolidStateRelayV2.BOOTLOADER_STATUS_OK = 0
  • BrickletSolidStateRelayV2.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletSolidStateRelayV2.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletSolidStateRelayV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletSolidStateRelayV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletSolidStateRelayV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5
Function BrickletSolidStateRelayV2.GetBootloaderMode() As Byte

Returns the current bootloader mode, see SetBootloaderMode().

The following constants are available for this function:

  • BrickletSolidStateRelayV2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletSolidStateRelayV2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletSolidStateRelayV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletSolidStateRelayV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletSolidStateRelayV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
Sub BrickletSolidStateRelayV2.SetWriteFirmwarePointer(ByVal pointer As Long)

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 BrickletSolidStateRelayV2.WriteFirmware(ByVal data() As Byte) As Byte

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 BrickletSolidStateRelayV2.SetStatusLEDConfig(ByVal config As Byte)

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:

  • BrickletSolidStateRelayV2.STATUS_LED_CONFIG_OFF = 0
  • BrickletSolidStateRelayV2.STATUS_LED_CONFIG_ON = 1
  • BrickletSolidStateRelayV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletSolidStateRelayV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
Function BrickletSolidStateRelayV2.GetStatusLEDConfig() As Byte

Returns the configuration as set by SetStatusLEDConfig()

The following constants are available for this function:

  • BrickletSolidStateRelayV2.STATUS_LED_CONFIG_OFF = 0
  • BrickletSolidStateRelayV2.STATUS_LED_CONFIG_ON = 1
  • BrickletSolidStateRelayV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletSolidStateRelayV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
Function BrickletSolidStateRelayV2.GetChipTemperature() As Short

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.

Sub BrickletSolidStateRelayV2.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 BrickletSolidStateRelayV2.WriteUID(ByVal uid As Long)

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 BrickletSolidStateRelayV2.ReadUID() As Long

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

Sub BrickletSolidStateRelayV2.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)

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.

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

AddHandler solidStateRelayV2.ExampleCallback, AddressOf MyCallback

The available callback property and their type of parameters 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.

Event BrickletSolidStateRelayV2.MonoflopDoneCallback(ByVal sender As BrickletSolidStateRelayV2, ByVal state As Boolean)

This callback is triggered whenever the monoflop timer reaches 0. The parameter is the current state of the relay (the state after the monoflop).

Constants

Const BrickletSolidStateRelayV2.DEVICE_IDENTIFIER

This constant is used to identify a Solid State Relay 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.

Const BrickletSolidStateRelayV2.DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Solid State Relay Bricklet 2.0.