Software / API Bindings / Visual Basic .NET / API Reference and Examples / Bricklets / Remote Switch Bricklet 2.0

Visual Basic .NET - Remote Switch Bricklet 2.0¶

This is the description of the Visual Basic .NET API bindings for the Remote Switch Bricklet 2.0. General information and technical specifications for the Remote Switch 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).

Switch Socket¶

Download (ExampleSwitchSocket.vb)

Imports System
Imports Tinkerforge

Module ExampleSwitchSocket
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your Remote Switch Bricklet 2.0

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

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

        ' Switch on a type A socket with house code 17 and receiver code 1.
        ' House code 17 is 10001 in binary (least-significant bit first)
        ' and means that the DIP switches 1 and 5 are on and 2-4 are off.
        ' Receiver code 1 is 10000 in binary (least-significant bit first)
        ' and means that the DIP switch A is on and B-E are off.
        rs.SwitchSocketA(17, 1, BrickletRemoteSwitchV2.SWITCH_TO_ON)

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

Remote Callback¶

Download (ExampleRemoteCallback.vb)

Imports System
Imports Tinkerforge

Module ExampleRemoteCallback
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your Remote Switch Bricklet 2.0

    ' Callback subroutine for remote status a callback
    Sub RemoteStatusACB(ByVal sender As BrickletRemoteSwitchV2, ByVal houseCode As Byte, _
                        ByVal receiverCode As Byte, ByVal switchTo As Byte, _
                        ByVal repeats As Integer)
        Console.WriteLine("House Code: " + houseCode.ToString())
        Console.WriteLine("Receiver Code: " + receiverCode.ToString())

        If switchTo = BrickletRemoteSwitchV2.SWITCH_TO_OFF Then
            Console.WriteLine("Switch To: Off")
        Else If switchTo = BrickletRemoteSwitchV2.SWITCH_TO_ON Then
            Console.WriteLine("Switch To: On")
        End If

        Console.WriteLine("Repeats: " + repeats.ToString())
        Console.WriteLine("")
    End Sub

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

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

        ' Configure to receive from remote type A with minimum repeats set to 1 and enable callback
        rs.SetRemoteConfiguration(BrickletRemoteSwitchV2.REMOTE_TYPE_A, 1, True)

        ' Register remote status a callback to subroutine RemoteStatusACB
        AddHandler rs.RemoteStatusACallback, AddressOf RemoteStatusACB

        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 BrickletRemoteSwitchV2(ByVal uid As String, ByVal ipcon As IPConnection)¶

Creates an object with the unique device ID uid:

Dim remoteSwitchV2 As New BrickletRemoteSwitchV2("YOUR_DEVICE_UID", ipcon)

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

Function BrickletRemoteSwitchV2.GetSwitchingState() As Byte¶

Returns:	state – Type: Byte, Range: See constants

Returns the current switching state. If the current state is busy, the Bricklet is currently sending a code to switch a socket. It will not accept any calls of switch socket functions until the state changes to ready.

How long the switching takes is dependent on the number of repeats, see SetRepeats().

The following constants are available for this function:

For state:

BrickletRemoteSwitchV2.SWITCHING_STATE_READY = 0
BrickletRemoteSwitchV2.SWITCHING_STATE_BUSY = 1

Sub BrickletRemoteSwitchV2.SwitchSocketA(ByVal houseCode As Byte, ByVal receiverCode As Byte, ByVal switchTo As Byte)¶

Parameters:	houseCode – Type: Byte, Range: [0 to 31] receiverCode – Type: Byte, Range: [0 to 31] switchTo – Type: Byte, Range: See constants

To switch a type A socket you have to give the house code, receiver code and the state (on or off) you want to switch to.

A detailed description on how you can figure out the house and receiver code can be found here.

The following constants are available for this function:

For switchTo:

BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
BrickletRemoteSwitchV2.SWITCH_TO_ON = 1

Sub BrickletRemoteSwitchV2.SwitchSocketB(ByVal address As Long, ByVal unit As Byte, ByVal switchTo As Byte)¶

Parameters:	address – Type: Long, Range: [0 to 2²⁶ - 1] unit – Type: Byte, Range: [0 to 15, 255] switchTo – Type: Byte, Range: See constants

To switch a type B socket you have to give the address, unit and the state (on or off) you want to switch to.

To switch all devices with the same address use 255 for the unit.

A detailed description on how you can teach a socket the address and unit can be found here.

The following constants are available for this function:

For switchTo:

BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
BrickletRemoteSwitchV2.SWITCH_TO_ON = 1

Sub BrickletRemoteSwitchV2.DimSocketB(ByVal address As Long, ByVal unit As Byte, ByVal dimValue As Byte)¶

Parameters:	address – Type: Long, Range: [0 to 2²⁶ - 1] unit – Type: Byte, Range: [0 to 15, 255] dimValue – Type: Byte, Range: [0 to 255]

To control a type B dimmer you have to give the address, unit and the dim value you want to set the dimmer to.

A detailed description on how you can teach a dimmer the address and unit can be found here.

Sub BrickletRemoteSwitchV2.SwitchSocketC(ByVal systemCode As Char, ByVal deviceCode As Byte, ByVal switchTo As Byte)¶

Parameters:	systemCode – Type: Char, Range: ["A"C to "P"C] deviceCode – Type: Byte, Range: [1 to 16] switchTo – Type: Byte, Range: See constants

To switch a type C socket you have to give the system code, device code and the state (on or off) you want to switch to.

A detailed description on how you can figure out the system and device code can be found here.

The following constants are available for this function:

For switchTo:

BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
BrickletRemoteSwitchV2.SWITCH_TO_ON = 1

Sub BrickletRemoteSwitchV2.SetRemoteConfiguration(ByVal remoteType As Byte, ByVal minimumRepeats As Integer, ByVal callbackEnabled As Boolean)¶

Parameters:	remoteType – Type: Byte, Range: See constants, Default: 0 minimumRepeats – Type: Integer, Range: [0 to 2¹⁶ - 1], Default: 2 callbackEnabled – Type: Boolean, Default: false

Sets the configuration for receiving data from a remote of type A, B or C.

Remote Type: A, B or C depending on the type of remote you want to receive.
Minimum Repeats: The minimum number of repeated data packets until the callback is triggered (if enabled).
Callback Enabled: Enable or disable callback (see RemoteStatusACallback callback, RemoteStatusBCallback callback and RemoteStatusCCallback callback).

The following constants are available for this function:

For remoteType:

BrickletRemoteSwitchV2.REMOTE_TYPE_A = 0
BrickletRemoteSwitchV2.REMOTE_TYPE_B = 1
BrickletRemoteSwitchV2.REMOTE_TYPE_C = 2

Sub BrickletRemoteSwitchV2.GetRemoteConfiguration(ByRef remoteType As Byte, ByRef minimumRepeats As Integer, ByRef callbackEnabled As Boolean)¶

Output Parameters:	remoteType – Type: Byte, Range: See constants, Default: 0 minimumRepeats – Type: Integer, Range: [0 to 2¹⁶ - 1], Default: 2 callbackEnabled – Type: Boolean, Default: false

Returns the remote configuration as set by SetRemoteConfiguration()

The following constants are available for this function:

For remoteType:

BrickletRemoteSwitchV2.REMOTE_TYPE_A = 0
BrickletRemoteSwitchV2.REMOTE_TYPE_B = 1
BrickletRemoteSwitchV2.REMOTE_TYPE_C = 2

Sub BrickletRemoteSwitchV2.GetRemoteStatusA(ByRef houseCode As Byte, ByRef receiverCode As Byte, ByRef switchTo As Byte, ByRef repeats As Integer)¶

Output Parameters:	houseCode – Type: Byte, Range: [0 to 31] receiverCode – Type: Byte, Range: [0 to 31] switchTo – Type: Byte, Range: See constants repeats – Type: Integer, Range: [0 to 2¹⁶ - 1]

Returns the house code, receiver code, switch state (on/off) and number of repeats for remote type A.

Repeats == 0 means there was no button press. Repeats >= 1 means there was a button press with the specified house/receiver code. The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number.

Use the callback to get this data automatically when a button is pressed, see SetRemoteConfiguration() and RemoteStatusACallback callback.

The following constants are available for this function:

For switchTo:

BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
BrickletRemoteSwitchV2.SWITCH_TO_ON = 1

Sub BrickletRemoteSwitchV2.GetRemoteStatusB(ByRef address As Long, ByRef unit As Byte, ByRef switchTo As Byte, ByRef dimValue As Byte, ByRef repeats As Integer)¶

Output Parameters:	address – Type: Long, Range: [0 to 2²⁶ - 1] unit – Type: Byte, Range: [0 to 15] switchTo – Type: Byte, Range: See constants dimValue – Type: Byte, Range: [0 to 255] repeats – Type: Integer, Range: [0 to 2¹⁶ - 1]

Returns the address (unique per remote), unit (button number), switch state (on/off) and number of repeats for remote type B.

If the remote supports dimming the dim value is used instead of the switch state.

If repeats=0 there was no button press. If repeats >= 1 there was a button press with the specified address/unit. The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number.

Use the callback to get this data automatically when a button is pressed, see SetRemoteConfiguration() and RemoteStatusBCallback callback.

The following constants are available for this function:

For switchTo:

BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
BrickletRemoteSwitchV2.SWITCH_TO_ON = 1

Sub BrickletRemoteSwitchV2.GetRemoteStatusC(ByRef systemCode As Char, ByRef deviceCode As Byte, ByRef switchTo As Byte, ByRef repeats As Integer)¶

Output Parameters:	systemCode – Type: Char, Range: ["A"C to "P"C] deviceCode – Type: Byte, Range: [1 to 16] switchTo – Type: Byte, Range: See constants repeats – Type: Integer, Range: [0 to 2¹⁶ - 1]

Returns the system code, device code, switch state (on/off) and number of repeats for remote type C.

If repeats=0 there was no button press. If repeats >= 1 there was a button press with the specified system/device code. The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number.

Use the callback to get this data automatically when a button is pressed, see SetRemoteConfiguration() and RemoteStatusCCallback callback.

The following constants are available for this function:

For switchTo:

BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
BrickletRemoteSwitchV2.SWITCH_TO_ON = 1

Advanced Functions¶

Sub BrickletRemoteSwitchV2.SetRepeats(ByVal repeats As Byte)¶

Parameters:	repeats – Type: Byte, Range: [0 to 255], Default: 5

Sets the number of times the code is sent when one of the Switch Socket functions is called. The repeats basically correspond to the amount of time that a button of the remote is pressed.

Some dimmers are controlled by the length of a button pressed, this can be simulated by increasing the repeats.

Function BrickletRemoteSwitchV2.GetRepeats() As Byte¶

Returns:	repeats – Type: Byte, Range: [0 to 255], Default: 5

Returns the number of repeats as set by SetRepeats().

Sub BrickletRemoteSwitchV2.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 2³² - 1] errorCountMessageChecksum – Type: Long, Range: [0 to 2³² - 1] errorCountFrame – Type: Long, Range: [0 to 2³² - 1] errorCountOverflow – Type: Long, Range: [0 to 2³² - 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 BrickletRemoteSwitchV2.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:

BrickletRemoteSwitchV2.STATUS_LED_CONFIG_OFF = 0
BrickletRemoteSwitchV2.STATUS_LED_CONFIG_ON = 1
BrickletRemoteSwitchV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletRemoteSwitchV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

Function BrickletRemoteSwitchV2.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:

BrickletRemoteSwitchV2.STATUS_LED_CONFIG_OFF = 0
BrickletRemoteSwitchV2.STATUS_LED_CONFIG_ON = 1
BrickletRemoteSwitchV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletRemoteSwitchV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

Function BrickletRemoteSwitchV2.GetChipTemperature() As Short¶

Returns:	temperature – Type: Short, Unit: 1 °C, Range: [-2¹⁵ to 2¹⁵ - 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 BrickletRemoteSwitchV2.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 BrickletRemoteSwitchV2.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:

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 2¹⁶ - 1]

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 2¹⁶ - 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.

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

AddHandler remoteSwitchV2.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 BrickletRemoteSwitchV2.SwitchingDoneCallback(ByVal sender As BrickletRemoteSwitchV2)¶

Callback Parameters:	sender – Type: BrickletRemoteSwitchV2

This callback is triggered whenever the switching state changes from busy to ready, see GetSwitchingState().

Event BrickletRemoteSwitchV2.RemoteStatusACallback(ByVal sender As BrickletRemoteSwitchV2, ByVal houseCode As Byte, ByVal receiverCode As Byte, ByVal switchTo As Byte, ByVal repeats As Integer)¶

Callback Parameters:	sender – Type: BrickletRemoteSwitchV2 houseCode – Type: Byte, Range: [0 to 31] receiverCode – Type: Byte, Range: [0 to 31] switchTo – Type: Byte, Range: See constants repeats – Type: Integer, Range: [0 to 2¹⁶ - 1]

Returns the house code, receiver code, switch state (on/off) and number of repeats for remote type A.

The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number. The callback is triggered with every repeat.

You have to enable the callback with SetRemoteConfiguration(). The number of repeats that you can set in the configuration is the minimum number of repeats that have to be seen before the callback is triggered for the first time.

The following constants are available for this function:

For switchTo:

BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
BrickletRemoteSwitchV2.SWITCH_TO_ON = 1

Event BrickletRemoteSwitchV2.RemoteStatusBCallback(ByVal sender As BrickletRemoteSwitchV2, ByVal address As Long, ByVal unit As Byte, ByVal switchTo As Byte, ByVal dimValue As Byte, ByVal repeats As Integer)¶

Callback Parameters:	sender – Type: BrickletRemoteSwitchV2 address – Type: Long, Range: [0 to 2²⁶ - 1] unit – Type: Byte, Range: [0 to 15, 255] switchTo – Type: Byte, Range: See constants dimValue – Type: Byte, Range: [0 to 255] repeats – Type: Integer, Range: [0 to 2¹⁶ - 1]

Returns the address (unique per remote), unit (button number), switch state (on/off) and number of repeats for remote type B.

If the remote supports dimming the dim value is used instead of the switch state.

The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number. The callback is triggered with every repeat.

The following constants are available for this function:

For switchTo:

BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
BrickletRemoteSwitchV2.SWITCH_TO_ON = 1

Event BrickletRemoteSwitchV2.RemoteStatusCCallback(ByVal sender As BrickletRemoteSwitchV2, ByVal systemCode As Char, ByVal deviceCode As Byte, ByVal switchTo As Byte, ByVal repeats As Integer)¶

Callback Parameters:	sender – Type: BrickletRemoteSwitchV2 systemCode – Type: Char, Range: ["A"C to "P"C] deviceCode – Type: Byte, Range: [1 to 16] switchTo – Type: Byte, Range: See constants repeats – Type: Integer, Range: [0 to 2¹⁶ - 1]

Returns the system code, device code, switch state (on/off) and number of repeats for remote type C.

The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number. The callback is triggered with every repeat.

The following constants are available for this function:

For switchTo:

BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
BrickletRemoteSwitchV2.SWITCH_TO_ON = 1

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

BrickletRemoteSwitchV2.FUNCTION_SET_REPEATS = 3
BrickletRemoteSwitchV2.FUNCTION_SWITCH_SOCKET_A = 5
BrickletRemoteSwitchV2.FUNCTION_SWITCH_SOCKET_B = 6
BrickletRemoteSwitchV2.FUNCTION_DIM_SOCKET_B = 7
BrickletRemoteSwitchV2.FUNCTION_SWITCH_SOCKET_C = 8
BrickletRemoteSwitchV2.FUNCTION_SET_REMOTE_CONFIGURATION = 9
BrickletRemoteSwitchV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletRemoteSwitchV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletRemoteSwitchV2.FUNCTION_RESET = 243
BrickletRemoteSwitchV2.FUNCTION_WRITE_UID = 248

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

The following constants are available for this function:

For functionId:

BrickletRemoteSwitchV2.FUNCTION_SET_REPEATS = 3
BrickletRemoteSwitchV2.FUNCTION_SWITCH_SOCKET_A = 5
BrickletRemoteSwitchV2.FUNCTION_SWITCH_SOCKET_B = 6
BrickletRemoteSwitchV2.FUNCTION_DIM_SOCKET_B = 7
BrickletRemoteSwitchV2.FUNCTION_SWITCH_SOCKET_C = 8
BrickletRemoteSwitchV2.FUNCTION_SET_REMOTE_CONFIGURATION = 9
BrickletRemoteSwitchV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletRemoteSwitchV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletRemoteSwitchV2.FUNCTION_RESET = 243
BrickletRemoteSwitchV2.FUNCTION_WRITE_UID = 248

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

BrickletRemoteSwitchV2.BOOTLOADER_MODE_BOOTLOADER = 0
BrickletRemoteSwitchV2.BOOTLOADER_MODE_FIRMWARE = 1
BrickletRemoteSwitchV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BrickletRemoteSwitchV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BrickletRemoteSwitchV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

BrickletRemoteSwitchV2.BOOTLOADER_STATUS_OK = 0
BrickletRemoteSwitchV2.BOOTLOADER_STATUS_INVALID_MODE = 1
BrickletRemoteSwitchV2.BOOTLOADER_STATUS_NO_CHANGE = 2
BrickletRemoteSwitchV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
BrickletRemoteSwitchV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
BrickletRemoteSwitchV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5

Function BrickletRemoteSwitchV2.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:

BrickletRemoteSwitchV2.BOOTLOADER_MODE_BOOTLOADER = 0
BrickletRemoteSwitchV2.BOOTLOADER_MODE_FIRMWARE = 1
BrickletRemoteSwitchV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BrickletRemoteSwitchV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BrickletRemoteSwitchV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Sub BrickletRemoteSwitchV2.SetWriteFirmwarePointer(ByVal pointer As Long)¶

Parameters:	pointer – Type: Long, Unit: 1 B, Range: [0 to 2³² - 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 BrickletRemoteSwitchV2.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 BrickletRemoteSwitchV2.WriteUID(ByVal uid As Long)¶

Parameters:	uid – Type: Long, Range: [0 to 2³² - 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 BrickletRemoteSwitchV2.ReadUID() As Long¶

Returns:	uid – Type: Long, Range: [0 to 2³² - 1]

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

Constants¶

Const BrickletRemoteSwitchV2.DEVICE_IDENTIFIER¶

This constant is used to identify a Remote Switch 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 BrickletRemoteSwitchV2.DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Remote Switch Bricklet 2.0.