Software / API Bindings / Mathematica / API Reference and Examples / Bricklets (Discontinued) / Remote Switch Bricklet

Mathematica - Remote Switch Bricklet¶

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

Examples¶

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

Switch Socket¶

Download (ExampleSwitchSocket.nb)

Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your Remote Switch Bricklet*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
rs=NETNew["Tinkerforge.BrickletRemoteSwitch",uid,ipcon]
ipcon@Connect[host,port]

(*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,Tinkerforge`BrickletRemoteSwitch`SWITCHUTOUON]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[rs]
ReleaseNETObject[ipcon]

API¶

Generally, every function of the Mathematica bindings that returns a value can throw a Tinkerforge.TimeoutException. This exception gets thrown 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.

Since .NET/Link does not support multiple return values directly, we use the out keyword to return multiple values from a function. For further information about the out keyword in .NET/Link see the corresponding Mathematica .NET/Link documentation.

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

Basic Functions¶

BrickletRemoteSwitch[uid, ipcon] → remoteSwitch¶

Parameters:	uid – Type: String ipcon – Type: NETObject[IPConnection]
Returns:	remoteSwitch – Type: NETObject[BrickletRemoteSwitch]

Creates an object with the unique device ID uid:

remoteSwitch=NETNew["Tinkerforge.BrickletRemoteSwitch","YOUR_DEVICE_UID",ipcon]

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

The .NET runtime has built-in garbage collection that frees objects that are no longer in use by a program. But because Mathematica can not automatically tell when a Mathematica "program" doesn't use a .NET object anymore, this has to be done by the program. For this the ReleaseNETObject[] function is used in the examples.

For further information about object management in .NET/Link see the corresponding Mathematica .NET/Link documentation.

BrickletRemoteSwitch@SwitchSocket[houseCode, receiverCode, switchTo] → Null¶

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

This function is deprecated, use SwitchSocketA[] instead.

The following constants are available for this function:

For switchTo:

BrickletRemoteSwitch`SWITCHUTOUOFF = 0
BrickletRemoteSwitch`SWITCHUTOUON = 1

BrickletRemoteSwitch@GetSwitchingState[] → state¶

Returns:	state – Type: Integer, 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 requests to switch sockets 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:

BrickletRemoteSwitch`SWITCHINGUSTATEUREADY = 0
BrickletRemoteSwitch`SWITCHINGUSTATEUBUSY = 1

BrickletRemoteSwitch@SwitchSocketA[houseCode, receiverCode, switchTo] → Null¶

Parameters:	houseCode – Type: Integer, Range: [0 to 31] receiverCode – Type: Integer, Range: [0 to 31] switchTo – Type: Integer, 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:

BrickletRemoteSwitch`SWITCHUTOUOFF = 0
BrickletRemoteSwitch`SWITCHUTOUON = 1

New in version 2.0.1 (Plugin).

BrickletRemoteSwitch@SwitchSocketB[address, unit, switchTo] → Null¶

Parameters:	address – Type: Integer, Range: [0 to 2²⁶ - 1] unit – Type: Integer, Range: [0 to 15, 255] switchTo – Type: Integer, 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:

BrickletRemoteSwitch`SWITCHUTOUOFF = 0
BrickletRemoteSwitch`SWITCHUTOUON = 1

New in version 2.0.1 (Plugin).

BrickletRemoteSwitch@DimSocketB[address, unit, dimValue] → Null¶

Parameters:	address – Type: Integer, Range: [0 to 2²⁶ - 1] unit – Type: Integer, Range: [0 to 15, 255] dimValue – Type: Integer, 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.

New in version 2.0.1 (Plugin).

BrickletRemoteSwitch@SwitchSocketC[systemCode, deviceCode, switchTo] → Null¶

Parameters:	systemCode – Type: Integer, Range: [ToCharacterCode["A"][[0]] to ToCharacterCode["P"][[0]]] deviceCode – Type: Integer, Range: [1 to 16] switchTo – Type: Integer, 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:

BrickletRemoteSwitch`SWITCHUTOUOFF = 0
BrickletRemoteSwitch`SWITCHUTOUON = 1

New in version 2.0.1 (Plugin).

Advanced Functions¶

BrickletRemoteSwitch@SetRepeats[repeats] → Null¶

Parameters:	repeats – Type: Integer, 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.

BrickletRemoteSwitch@GetRepeats[] → repeats¶

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

Returns the number of repeats as set by SetRepeats[].

BrickletRemoteSwitch@GetIdentity[out uid, out connectedUid, out position, out {hardwareVersion1, hardwareVersion2, hardwareVersion3}, out {firmwareVersion1, firmwareVersion2, firmwareVersion3}, out deviceIdentifier] → Null¶

Output Parameters:

Output Parameters:	uid – Type: String, Length: up to 8 connectedUid – Type: String, Length: up to 8 position – Type: Integer, Range: [ToCharacterCode["a"][[0]] to ToCharacterCode["h"][[0]], ToCharacterCode["z"][[0]]] hardwareVersioni – Type: Integer 1: major – Type: Integer, Range: [0 to 255] 2: minor – Type: Integer, Range: [0 to 255] 3: revision – Type: Integer, Range: [0 to 255] firmwareVersioni – Type: Integer 1: major – Type: Integer, Range: [0 to 255] 2: minor – Type: Integer, Range: [0 to 255] 3: revision – Type: Integer, 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: Integer, Range: [ToCharacterCode["a"][[0]] to ToCharacterCode["h"][[0]], ToCharacterCode["z"][[0]]]
hardwareVersioni – Type: Integer

1: major – Type: Integer, Range: [0 to 255]
2: minor – Type: Integer, Range: [0 to 255]
3: revision – Type: Integer, Range: [0 to 255]

firmwareVersioni – Type: Integer

1: major – Type: Integer, Range: [0 to 255]
2: minor – Type: Integer, Range: [0 to 255]
3: revision – Type: Integer, 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 function to a callback property of the device object:

MyCallback[sender_,value_]:=Print["Value: "<>ToString[value]]

AddEventHandler[remoteSwitch@ExampleCallback,MyCallback]

For further information about event handling using .NET/Link see the corresponding Mathematica .NET/Link documentation.

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]¶

Callback Parameters:	sender – Type: NETObject[BrickletRemoteSwitch]

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

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.

BrickletRemoteSwitch@GetAPIVersion[] → {apiVersion1, apiVersion2, apiVersion3}¶

Output Parameters:	apiVersioni – Type: Integer 1: major – Type: Integer, Range: [0 to 255] 2: minor – Type: Integer, Range: [0 to 255] 3: revision – Type: Integer, 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.

BrickletRemoteSwitch@GetResponseExpected[functionId] → responseExpected¶

Parameters:	functionId – Type: Integer, Range: See constants
Returns:	responseExpected – Type: True/False

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:

BrickletRemoteSwitch`FUNCTIONUSWITCHUSOCKET = 1
BrickletRemoteSwitch`FUNCTIONUSETUREPEATS = 4
BrickletRemoteSwitch`FUNCTIONUSWITCHUSOCKETUA = 6
BrickletRemoteSwitch`FUNCTIONUSWITCHUSOCKETUB = 7
BrickletRemoteSwitch`FUNCTIONUDIMUSOCKETUB = 8
BrickletRemoteSwitch`FUNCTIONUSWITCHUSOCKETUC = 9

BrickletRemoteSwitch@SetResponseExpected[functionId, responseExpected] → Null¶

Parameters:	functionId – Type: Integer, Range: See constants responseExpected – Type: True/False

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:

BrickletRemoteSwitch`FUNCTIONUSWITCHUSOCKET = 1
BrickletRemoteSwitch`FUNCTIONUSETUREPEATS = 4
BrickletRemoteSwitch`FUNCTIONUSWITCHUSOCKETUA = 6
BrickletRemoteSwitch`FUNCTIONUSWITCHUSOCKETUB = 7
BrickletRemoteSwitch`FUNCTIONUDIMUSOCKETUB = 8
BrickletRemoteSwitch`FUNCTIONUSWITCHUSOCKETUC = 9

BrickletRemoteSwitch@SetResponseExpectedAll[responseExpected] → Null¶

Parameters:	responseExpected – Type: True/False

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

Constants¶

BrickletRemoteSwitch`DEVICEUIDENTIFIER¶

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`DEVICEDISPLAYNAME¶: This constant represents the human readable name of a Remote Switch Bricklet.