LabVIEW - Remote Switch Bricklet

This is the description of the LabVIEW API bindings for the Remote Switch Bricklet. General information and technical specifications for the Remote Switch Bricklet are summarized in its hardware description.

An installation guide for the LabVIEW API bindings is part of their general description.

Examples

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

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

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

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

BrickletRemoteSwitch.SwitchSocket(houseCode, receiverCode, switchTo)
Input:
  • houseCode -- Byte
  • receiverCode -- Byte
  • switchTo -- Byte

This function is deprecated, use SwitchSocketA() instead.

The following constants are available for this function:

  • BrickletRemoteSwitch.SWITCH_TO_OFF = 0
  • BrickletRemoteSwitch.SWITCH_TO_ON = 1
BrickletRemoteSwitch.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 SwitchSocket() 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:

  • BrickletRemoteSwitch.SWITCHING_STATE_READY = 0
  • BrickletRemoteSwitch.SWITCHING_STATE_BUSY = 1
BrickletRemoteSwitch.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:

  • BrickletRemoteSwitch.SWITCH_TO_OFF = 0
  • BrickletRemoteSwitch.SWITCH_TO_ON = 1

New in version 2.0.1 (Plugin).

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

  • BrickletRemoteSwitch.SWITCH_TO_OFF = 0
  • BrickletRemoteSwitch.SWITCH_TO_ON = 1

New in version 2.0.1 (Plugin).

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

New in version 2.0.1 (Plugin).

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

  • BrickletRemoteSwitch.SWITCH_TO_OFF = 0
  • BrickletRemoteSwitch.SWITCH_TO_ON = 1

New in version 2.0.1 (Plugin).

Advanced Functions

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

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

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

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

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

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

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

  • BrickletRemoteSwitch.FUNCTION_SWITCH_SOCKET = 1
  • BrickletRemoteSwitch.FUNCTION_SET_REPEATS = 4
  • BrickletRemoteSwitch.FUNCTION_SWITCH_SOCKET_A = 6
  • BrickletRemoteSwitch.FUNCTION_SWITCH_SOCKET_B = 7
  • BrickletRemoteSwitch.FUNCTION_DIM_SOCKET_B = 8
  • BrickletRemoteSwitch.FUNCTION_SWITCH_SOCKET_C = 9
BrickletRemoteSwitch.SetResponseExpectedAll(responseExpected)
Input:
  • responseExpected -- Boolean

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

BrickletRemoteSwitch.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 BrickletRemoteSwitch.SwitchingDoneCallback(sender)
Input:
  • sender -- .NET Refnum (BrickletRemoteSwitch)

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

Constants

BrickletRemoteSwitch.DEVICE_IDENTIFIER

This constant is used to identify a Remote Switch Bricklet.

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.

BrickletRemoteSwitch.DEVICE_DISPLAY_NAME

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