LabVIEW - Remote Switch Bricklet 2.0

This is the description of the LabVIEW 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 LabVIEW API bindings is part of their general description.

API

Generally, every method of the LabVIEW bindings that outputs a value can report a Tinkerforge.TimeoutException. This error gets reported if the device did not respond. If a cable based connection is used, it is unlikely that this exception gets thrown (assuming nobody plugs the device out). However, if a wireless connection is used, timeouts will occur if the distance to the device gets too big.

The namespace for all Brick/Bricklet bindings and the IPConnection is Tinkerforge.*.

Basic Functions

BrickletRemoteSwitchV2(uid, ipcon) → remoteSwitchV2
Input:
  • uid -- String
  • ipcon -- .NET Refnum (IPConnection)
Output:
  • remoteSwitchV2 -- .NET Refnum (BrickletRemoteSwitchV2)

Creates an object with the unique device ID uid. This object can then be used after the IP Connection is connected (see examples above).

BrickletRemoteSwitchV2.GetSwitchingState() → state
Output:
  • state -- Byte

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:

  • BrickletRemoteSwitchV2.SWITCHING_STATE_READY = 0
  • BrickletRemoteSwitchV2.SWITCHING_STATE_BUSY = 1
BrickletRemoteSwitchV2.SwitchSocketA(houseCode, receiverCode, switchTo)
Input:
  • houseCode -- Byte
  • receiverCode -- Byte
  • switchTo -- Byte

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.

The house code and receiver code have a range of 0 to 31 (5bit).

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:

  • BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2.SWITCH_TO_ON = 1
BrickletRemoteSwitchV2.SwitchSocketB(address, unit, switchTo)
Input:
  • address -- Int64
  • unit -- Byte
  • switchTo -- Byte

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

The address has a range of 0 to 67108863 (26bit) and the unit has a range of 0 to 15 (4bit). 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:

  • BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2.SWITCH_TO_ON = 1
BrickletRemoteSwitchV2.DimSocketB(address, unit, dimValue)
Input:
  • address -- Int64
  • unit -- Byte
  • dimValue -- Byte

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

The address has a range of 0 to 67108863 (26bit), the unit and the dim value has a range of 0 to 15 (4bit).

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

BrickletRemoteSwitchV2.SwitchSocketC(systemCode, deviceCode, switchTo)
Input:
  • systemCode -- Char
  • deviceCode -- Byte
  • switchTo -- Byte

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.

The system code has a range of 'A' to 'P' (4bit) and the device code has a range of 1 to 16 (4bit).

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:

  • BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2.SWITCH_TO_ON = 1
BrickletRemoteSwitchV2.SetRemoteConfiguration(remoteType, minimumRepeats, callbackEnabled)
Input:
  • remoteType -- Byte
  • minimumRepeats -- Int32
  • callbackEnabled -- Boolean

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

Default is ('A', 2, false).

The following constants are available for this function:

  • BrickletRemoteSwitchV2.REMOTE_TYPE_A = 0
  • BrickletRemoteSwitchV2.REMOTE_TYPE_B = 1
  • BrickletRemoteSwitchV2.REMOTE_TYPE_C = 2
BrickletRemoteSwitchV2.GetRemoteConfiguration() → remoteType, minimumRepeats, callbackEnabled
Output:
  • remoteType -- Byte
  • minimumRepeats -- Int32
  • callbackEnabled -- Boolean

Returns the remote configuration as set by SetRemoteConfiguration()

The following constants are available for this function:

  • BrickletRemoteSwitchV2.REMOTE_TYPE_A = 0
  • BrickletRemoteSwitchV2.REMOTE_TYPE_B = 1
  • BrickletRemoteSwitchV2.REMOTE_TYPE_C = 2
BrickletRemoteSwitchV2.GetRemoteStatusA() → houseCode, receiverCode, switchTo, repeats
Output:
  • houseCode -- Byte
  • receiverCode -- Byte
  • switchTo -- Byte
  • repeats -- Int32

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:

  • BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2.SWITCH_TO_ON = 1
BrickletRemoteSwitchV2.GetRemoteStatusB() → address, unit, switchTo, dimValue, repeats
Output:
  • address -- Int64
  • unit -- Byte
  • switchTo -- Byte
  • dimValue -- Byte
  • repeats -- Int32

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:

  • BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2.SWITCH_TO_ON = 1
BrickletRemoteSwitchV2.GetRemoteStatusC() → systemCode, deviceCode, switchTo, repeats
Output:
  • systemCode -- Char
  • deviceCode -- Byte
  • switchTo -- Byte
  • repeats -- Int32

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:

  • BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2.SWITCH_TO_ON = 1

Advanced Functions

BrickletRemoteSwitchV2.SetRepeats(repeats)
Input:
  • repeats -- Byte

Sets the number of times the code is send 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.

The default value is 5.

BrickletRemoteSwitchV2.GetRepeats() → repeats
Output:
  • repeats -- Byte

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

BrickletRemoteSwitchV2.GetAPIVersion() → apiVersion
Output:
  • apiVersion -- Byte[3]

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.

BrickletRemoteSwitchV2.GetResponseExpected(functionId) → responseExpected
Input:
  • functionId -- Byte
Output:
  • responseExpected -- 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.

BrickletRemoteSwitchV2.SetResponseExpected(functionId, responseExpected)
Input:
  • functionId -- Byte
  • responseExpected -- 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:

  • 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
BrickletRemoteSwitchV2.SetResponseExpectedAll(responseExpected)
Input:
  • responseExpected -- Boolean

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

BrickletRemoteSwitchV2.GetSPITFPErrorCount() → errorCountAckChecksum, errorCountMessageChecksum, errorCountFrame, errorCountOverflow
Output:
  • errorCountAckChecksum -- Int64
  • errorCountMessageChecksum -- Int64
  • errorCountFrame -- Int64
  • errorCountOverflow -- Int64

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.

BrickletRemoteSwitchV2.SetBootloaderMode(mode) → status
Input:
  • mode -- Byte
Output:
  • status -- 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:

  • 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
  • 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
BrickletRemoteSwitchV2.GetBootloaderMode() → mode
Output:
  • mode -- Byte

Returns the current bootloader mode, see SetBootloaderMode().

The following constants are available for this function:

  • 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
BrickletRemoteSwitchV2.SetWriteFirmwarePointer(pointer)
Input:
  • pointer -- Int64

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.

BrickletRemoteSwitchV2.WriteFirmware(data) → status
Input:
  • data -- Byte[64]
Output:
  • status -- 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.

BrickletRemoteSwitchV2.SetStatusLEDConfig(config)
Input:
  • config -- 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:

  • 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
BrickletRemoteSwitchV2.GetStatusLEDConfig() → config
Output:
  • config -- Byte

Returns the configuration as set by SetStatusLEDConfig()

The following constants are available for this function:

  • 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
BrickletRemoteSwitchV2.GetChipTemperature() → temperature
Output:
  • temperature -- Int16

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.

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!

BrickletRemoteSwitchV2.WriteUID(uid)
Input:
  • uid -- Int64

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.

BrickletRemoteSwitchV2.ReadUID() → uid
Output:
  • uid -- Int64

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

BrickletRemoteSwitchV2.GetIdentity() → uid, connectedUid, position, hardwareVersion, firmwareVersion, deviceIdentifier
Output:
  • uid -- String
  • connectedUid -- String
  • position -- Char
  • hardwareVersion -- Byte[3]
  • firmwareVersion -- Byte[3]
  • deviceIdentifier -- Int32

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 function to a callback property of the device object. 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(sender)
Input:
  • sender -- .NET Refnum (BrickletRemoteSwitchV2)

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

event BrickletRemoteSwitchV2.RemoteStatusACallback(sender, houseCode, receiverCode, switchTo, repeats)
Input:
  • sender -- .NET Refnum (BrickletRemoteSwitchV2)
  • houseCode -- Byte
  • receiverCode -- Byte
  • switchTo -- Byte
  • repeats -- Int32

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:

  • BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2.SWITCH_TO_ON = 1
event BrickletRemoteSwitchV2.RemoteStatusBCallback(sender, address, unit, switchTo, dimValue, repeats)
Input:
  • sender -- .NET Refnum (BrickletRemoteSwitchV2)
  • address -- Int64
  • unit -- Byte
  • switchTo -- Byte
  • dimValue -- Byte
  • repeats -- Int32

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.

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:

  • BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2.SWITCH_TO_ON = 1
event BrickletRemoteSwitchV2.RemoteStatusCCallback(sender, systemCode, deviceCode, switchTo, repeats)
Input:
  • sender -- .NET Refnum (BrickletRemoteSwitchV2)
  • systemCode -- Char
  • deviceCode -- Byte
  • switchTo -- Byte
  • repeats -- Int32

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.

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:

  • BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2.SWITCH_TO_ON = 1

Constants

BrickletRemoteSwitchV2.DEVICE_IDENTIFIER

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

BrickletRemoteSwitchV2.DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Remote Switch Bricklet 2.0.