Mathematica - Solid State Relay Bricklet

This is the description of the Mathematica API bindings for the Solid State Relay Bricklet. General information and technical specifications for the Solid State Relay 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).

Simple

Download (ExampleSimple.nb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your Solid State Relay Bricklet*)

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

(*Turn relay on/off 10 times with 1 second delay*)
For[i=0,i<5,i++,
 Pause[1];
 ssr@SetState[True];
 Pause[1];
 ssr@SetState[False]
]

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

API

Generally, every method 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 method. 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

BrickletSolidStateRelay[uid, ipcon] → solidStateRelay
Parameters:
  • uid -- String
  • ipcon -- NETObject[IPConnection]
Returns:
  • solidStateRelay -- NETObject[BrickletSolidStateRelay]

Creates an object with the unique device ID uid:

solidStateRelay=NETNew["Tinkerforge.BrickletSolidStateRelay","YOUR_DEVICE_UID",ipcon]

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

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.

BrickletSolidStateRelay@SetState[state] → Null
Parameters:
  • state -- True/False

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.

BrickletSolidStateRelay@GetState[] → state
Returns:
  • state -- True/False

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

Advanced Functions

BrickletSolidStateRelay@SetMonoflop[state, time] → Null
Parameters:
  • state -- True/False
  • time -- Integer

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.

BrickletSolidStateRelay@GetMonoflop[out state, out time, out timeRemaining] → Null
Parameters:
  • state -- True/False
  • time -- Integer
  • timeRemaining -- Integer

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.

BrickletSolidStateRelay@GetAPIVersion[] → {apiVersion1, apiVersion2, apiVersion3}
Returns:
  • apiVersioni -- Integer

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.

BrickletSolidStateRelay@GetResponseExpected[functionId] → responseExpected
Parameters:
  • functionId -- Integer
Returns:
  • responseExpected -- 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 send and errors are silently ignored, because they cannot be detected.

See SetResponseExpected[] for the list of function ID constants available for this function.

BrickletSolidStateRelay@SetResponseExpected[functionId, responseExpected] → Null
Parameters:
  • functionId -- Integer
  • responseExpected -- 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.

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:

  • BrickletSolidStateRelay`FUNCTIONUSETUSTATE = 1
  • BrickletSolidStateRelay`FUNCTIONUSETUMONOFLOP = 3
BrickletSolidStateRelay@SetResponseExpectedAll[responseExpected] → Null
Parameters:
  • responseExpected -- True/False

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

BrickletSolidStateRelay@GetIdentity[out uid, out connectedUid, out position, out {hardwareVersion1, hardwareVersion2, hardwareVersion3}, out {firmwareVersion1, firmwareVersion2, firmwareVersion3}, out deviceIdentifier] → Null
Parameters:
  • uid -- String
  • connectedUid -- String
  • position -- Integer
  • hardwareVersioni -- Integer
  • firmwareVersioni -- Integer
  • deviceIdentifier -- 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 function to a callback property of the device object:

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

AddEventHandler[solidStateRelay@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 BrickletSolidStateRelay@MonoflopDoneCallback[sender, state]
Parameters:
  • sender -- NETObject[BrickletSolidStateRelay]
  • state -- True/False

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

BrickletSolidStateRelay`DEVICEUIDENTIFIER

This constant is used to identify a Solid State Relay Bricklet.

The GetIdentity[] function and the EnumerateCallback callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

BrickletSolidStateRelay`DEVICEDISPLAYNAME

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