MATLAB/Octave - Solid State Relay Bricklet¶

Simple (MATLAB)¶

Download (matlab_example_simple.m)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

function matlab_example_simple()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletSolidStateRelay;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your Solid State Relay Bricklet

    ipcon = IPConnection(); % Create IP connection
    ssr = handle(BrickletSolidStateRelay(UID, ipcon), 'CallbackProperties'); % Create device object

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

    % Turn relay on/off 10 times with 1 second delay
    for i = 0:4
        pause(1);
        ssr.setState(true);
        pause(1);
        ssr.setState(false);
    end

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

Simple (Octave)¶

Download (octave_example_simple.m)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

function octave_example_simple()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your Solid State Relay Bricklet

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    ssr = javaObject("com.tinkerforge.BrickletSolidStateRelay", UID, ipcon); % Create device object

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

    % Turn relay on/off 10 times with 1 second delay
    for i = 0:4
        pause(1);
        ssr.setState(true);
        pause(1);
        ssr.setState(false);
    end

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

Basic Functions¶

class BrickletSolidStateRelay(String uid, IPConnection ipcon)¶

Parameters:	uid – Type: String ipcon – Type: IPConnection
Returns:	solidStateRelay – Type: BrickletSolidStateRelay

Creates an object with the unique device ID uid.

In MATLAB:

import com.tinkerforge.BrickletSolidStateRelay;

solidStateRelay = BrickletSolidStateRelay('YOUR_DEVICE_UID', ipcon);

In Octave:

solidStateRelay = java_new("com.tinkerforge.BrickletSolidStateRelay", "YOUR_DEVICE_UID", ipcon);

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

void BrickletSolidStateRelay.setState(boolean state)¶

Parameters:	state – Type: boolean, Default: false

Sets the state of the relays true means on and false means off.

A running monoflop timer will be aborted if this function is called.

boolean BrickletSolidStateRelay.getState()¶

Returns:	state – Type: boolean, Default: false

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

Advanced Functions¶

void BrickletSolidStateRelay.setMonoflop(boolean state, long time)¶

Parameters:	state – Type: boolean time – Type: long, Unit: 1 ms, Range: [0 to 232 - 1]

The first parameter is the desired state of the relay (true means on and false means off). The second parameter indicates the time 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.Monoflop BrickletSolidStateRelay.getMonoflop()¶

Return Object:	state – Type: boolean time – Type: long, Unit: 1 ms, Range: [0 to 232 - 1] timeRemaining – Type: long, Unit: 1 ms, Range: [0 to 232 - 1]

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.Identity BrickletSolidStateRelay.getIdentity()¶

Return Object:

uid – Type: String, Length: up to 8 connectedUid – Type: String, Length: up to 8 position – Type: char, Range: ['a' to 'h', 'z'] hardwareVersion – Type: short[], Length: 3 1: major – Type: short, Range: [0 to 255] 2: minor – Type: short, Range: [0 to 255] 3: revision – Type: short, Range: [0 to 255] firmwareVersion – Type: short[], Length: 3 1: major – Type: short, Range: [0 to 255] 2: minor – Type: short, Range: [0 to 255] 3: revision – Type: short, Range: [0 to 255] deviceIdentifier – Type: int, Range: [0 to 216 - 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 with "set" function of MATLAB. The parameters consist of the IP Connection object, the callback name and the callback function. For example, it looks like this in MATLAB:

function my_callback(e)
    fprintf('Parameter: %s\n', e.param);
end

set(device, 'ExampleCallback', @(h, e) my_callback(e));

Due to a difference in the Octave Java support the "set" function cannot be used in Octave. The registration is done with "add*Callback" functions of the device object. It looks like this in Octave:

function my_callback(e)
    fprintf("Parameter: %s\n", e.param);
end

device.addExampleCallback(@my_callback);

It is possible to add several callbacks and to remove them with the corresponding "remove*Callback" function.

The parameters of the callback are passed to the callback function as fields of the structure e, which is derived from the java.util.EventObject class. The available callback names with corresponding structure fields are described below.

callback BrickletSolidStateRelay.MonoflopDoneCallback¶

Event Object:	state – Type: boolean

This callback is triggered whenever the monoflop timer reaches 0. The parameter is the current state of the relay (the state after the monoflop).

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addMonoflopDoneCallback() function. An added callback function can be removed with the removeMonoflopDoneCallback() function.

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.

short[] BrickletSolidStateRelay.getAPIVersion()¶

Return Object:	apiVersion – Type: short[], Length: 3 1: major – Type: short, Range: [0 to 255] 2: minor – Type: short, Range: [0 to 255] 3: revision – Type: short, 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.

boolean BrickletSolidStateRelay.getResponseExpected(byte functionId)¶

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:

• BrickletSolidStateRelay.FUNCTION_SET_STATE = 1
• BrickletSolidStateRelay.FUNCTION_SET_MONOFLOP = 3

void BrickletSolidStateRelay.setResponseExpected(byte functionId, boolean responseExpected)¶

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.

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:

• BrickletSolidStateRelay.FUNCTION_SET_STATE = 1
• BrickletSolidStateRelay.FUNCTION_SET_MONOFLOP = 3

void BrickletSolidStateRelay.setResponseExpectedAll(boolean responseExpected)¶

Parameters:	responseExpected – Type: boolean

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

Constants¶

int BrickletSolidStateRelay.DEVICE_IDENTIFIER¶

This constant is used to identify a Solid State Relay 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.

String BrickletSolidStateRelay.DEVICE_DISPLAY_NAME¶

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