Deutsch
English
Menu
Software / API Bindings / C# / API Reference and Examples / Bricklets (Discontinued) / Solid State Relay Bricklet

C# - Solid State Relay Bricklet

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

Examples

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

Simple

Download (ExampleSimple.cs)

 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
26
27
28
29
30
31
32
33
using System;
using System.Threading;
using Tinkerforge;

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XYZ"; // Change XYZ to the UID of your Solid State Relay Bricklet

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletSolidStateRelay ssr =
          new 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(int i = 0; i < 5; i++)
        {
            Thread.Sleep(1000);
            ssr.SetState(true);
            Thread.Sleep(1000);
            ssr.SetState(false);
        }

        Console.WriteLine("Press enter to exit");
        Console.ReadLine();
        ipcon.Disconnect();
    }
}

API

Generally, every method of the C# 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 C# does not support multiple return values directly, we use the out keyword to return multiple values from a method.

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

All methods listed below are thread-safe.

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:

BrickletSolidStateRelay solidStateRelay = new BrickletSolidStateRelay("YOUR_DEVICE_UID", ipcon);

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

void BrickletSolidStateRelay.SetState(bool state)
Parameters:
  • state – Type: bool, 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.

bool BrickletSolidStateRelay.GetState()
Returns:
  • state – Type: bool, Default: false

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

Advanced Functions

void BrickletSolidStateRelay.SetMonoflop(bool state, long time)
Parameters:
  • state – Type: bool
  • 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.

void BrickletSolidStateRelay.GetMonoflop(out bool state, out long time, out long timeRemaining)
Output Parameters:
  • state – Type: bool
  • 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.

void BrickletSolidStateRelay.GetIdentity(out string uid, out string connectedUid, out char position, out byte[] hardwareVersion, out byte[] firmwareVersion, out int deviceIdentifier)
Output Parameters:
  • uid – Type: string, Length: up to 8
  • connectedUid – Type: string, Length: up to 8
  • position – Type: char, Range: ['a' to 'h', 'z']
  • hardwareVersion – Type: byte[], Length: 3
    • 0: major – Type: byte, Range: [0 to 255]
    • 1: minor – Type: byte, Range: [0 to 255]
    • 2: revision – Type: byte, Range: [0 to 255]
  • firmwareVersion – Type: byte[], Length: 3
    • 0: major – Type: byte, Range: [0 to 255]
    • 1: minor – Type: byte, Range: [0 to 255]
    • 2: revision – Type: byte, 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 by appending your callback handler to the corresponding event:

void MyCallback(BrickletSolidStateRelay sender, int value)
{
    System.Console.WriteLine("Value: " + value);
}

solidStateRelay.ExampleCallback += MyCallback;

The available events 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(BrickletSolidStateRelay sender, bool state)
Callback Parameters:
  • sender – Type: BrickletSolidStateRelay
  • state – Type: bool

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

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.

byte[] BrickletSolidStateRelay.GetAPIVersion()
Output Parameters:
  • apiVersion – Type: byte[], Length: 3
    • 0: major – Type: byte, Range: [0 to 255]
    • 1: minor – Type: byte, Range: [0 to 255]
    • 2: revision – Type: byte, 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.

bool BrickletSolidStateRelay.GetResponseExpected(byte functionId)
Parameters:
  • functionId – Type: byte, Range: See constants
Returns:
  • responseExpected – Type: bool

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, bool responseExpected)
Parameters:
  • functionId – Type: byte, Range: See constants
  • responseExpected – Type: bool

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(bool responseExpected)
Parameters:
  • responseExpected – Type: bool

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.