C# - Remote Switch Bricklet 2.0

This is the description of the C# API bindings for the Remote Switch Bricklet 2.0. General information and technical specifications for the Remote Switch Bricklet 2.0 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).

Switch Socket

Download (ExampleSwitchSocket.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
using System;
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 Remote Switch Bricklet 2.0

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletRemoteSwitchV2 rs = new BrickletRemoteSwitchV2(UID, ipcon); // Create device object

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

        // 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, BrickletRemoteSwitchV2.SWITCH_TO_ON);

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

Remote Callback

Download (ExampleRemoteCallback.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
34
35
36
37
38
39
using System;
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 Remote Switch Bricklet 2.0

    // Callback function for remote status a callback
    static void RemoteStatusACB(BrickletRemoteSwitchV2 sender, byte houseCode,
                                byte receiverCode, byte switchTo, int repeats)
    {
        Console.WriteLine("House Code: " + houseCode);
        Console.WriteLine("Receiver Code: " + receiverCode);
        Console.WriteLine("Switch To: " + switchTo);
        Console.WriteLine("Repeats: " + repeats);
        Console.WriteLine("");
    }

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletRemoteSwitchV2 rs = new BrickletRemoteSwitchV2(UID, ipcon); // Create device object

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

        // Configure to receive from remote type A with minimum repeats set to 1 and enable callback
        rs.SetRemoteConfiguration(BrickletRemoteSwitchV2.REMOTE_TYPE_A, 1, true);

        // Register remote status a callback to function RemoteStatusACB
        rs.RemoteStatusACallback += RemoteStatusACB;

        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

public class BrickletRemoteSwitchV2(String uid, IPConnection ipcon)

Creates an object with the unique device ID uid:

BrickletRemoteSwitchV2 remoteSwitchV2 = new BrickletRemoteSwitchV2("YOUR_DEVICE_UID", ipcon);

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

public byte GetSwitchingState()

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 switch socket functions 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:

  • BrickletRemoteSwitchV2.SWITCHING_STATE_READY = 0
  • BrickletRemoteSwitchV2.SWITCHING_STATE_BUSY = 1
public void SwitchSocketA(byte houseCode, byte receiverCode, byte switchTo)

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:

  • BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2.SWITCH_TO_ON = 1
public void SwitchSocketB(long address, byte unit, byte switchTo)

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:

  • BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2.SWITCH_TO_ON = 1
public void DimSocketB(long address, byte unit, byte dimValue)

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.

public void SwitchSocketC(char systemCode, byte deviceCode, byte switchTo)

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:

  • BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2.SWITCH_TO_ON = 1
public void SetRemoteConfiguration(byte remoteType, int minimumRepeats, bool callbackEnabled)

Sets the configuration for receiving data from a remote of type A, B or C.

  • Remote Type: A, B or C depending on the type of remote you want to receive.
  • Minimum Repeats: The minimum number of repeated data packets until the callback is triggered (if enabled).
  • Callback Enabled: Enable or disable callback (see RemoteStatusACallback callback, RemoteStatusBCallback callback and RemoteStatusCCallback callback).

Default is ('A', 2, false).

The following constants are available for this function:

  • BrickletRemoteSwitchV2.REMOTE_TYPE_A = 0
  • BrickletRemoteSwitchV2.REMOTE_TYPE_B = 1
  • BrickletRemoteSwitchV2.REMOTE_TYPE_C = 2
public void GetRemoteConfiguration(out byte remoteType, out int minimumRepeats, out bool callbackEnabled)

Returns the remote configuration as set by SetRemoteConfiguration()

The following constants are available for this function:

  • BrickletRemoteSwitchV2.REMOTE_TYPE_A = 0
  • BrickletRemoteSwitchV2.REMOTE_TYPE_B = 1
  • BrickletRemoteSwitchV2.REMOTE_TYPE_C = 2
public void GetRemoteStatusA(out byte houseCode, out byte receiverCode, out byte switchTo, out int repeats)

Returns the house code, receiver code, switch state (on/off) and number of repeats for remote type A.

Repeats == 0 means there was no button press. Repeats >= 1 means there was a button press with the specified house/receiver code. The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number.

Use the callback to get this data automatically when a button is pressed, see SetRemoteConfiguration() and RemoteStatusACallback callback.

The following constants are available for this function:

  • BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2.SWITCH_TO_ON = 1
public void GetRemoteStatusB(out long address, out byte unit, out byte switchTo, out byte dimValue, out int repeats)

Returns the address (unique per remote), unit (button number), switch state (on/off) and number of repeats for remote type B.

If the remote supports dimming the dim value is used instead of the switch state.

If repeats=0 there was no button press. If repeats >= 1 there was a button press with the specified address/unit. The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number.

Use the callback to get this data automatically when a button is pressed, see SetRemoteConfiguration() and RemoteStatusBCallback callback.

The following constants are available for this function:

  • BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2.SWITCH_TO_ON = 1
public void GetRemoteStatusC(out char systemCode, out byte deviceCode, out byte switchTo, out int repeats)

Returns the system code, device code, switch state (on/off) and number of repeats for remote type C.

If repeats=0 there was no button press. If repeats >= 1 there was a button press with the specified system/device code. The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number.

Use the callback to get this data automatically when a button is pressed, see SetRemoteConfiguration() and RemoteStatusCCallback callback.

The following constants are available for this function:

  • BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2.SWITCH_TO_ON = 1

Advanced Functions

public void SetRepeats(byte repeats)

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

The default value is 5.

public byte GetRepeats()

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

public byte[] GetAPIVersion()

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.

public bool GetResponseExpected(byte functionId)

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.

public void SetResponseExpected(byte functionId, bool responseExpected)

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:

  • BrickletRemoteSwitchV2.FUNCTION_SET_REPEATS = 3
  • BrickletRemoteSwitchV2.FUNCTION_SWITCH_SOCKET_A = 5
  • BrickletRemoteSwitchV2.FUNCTION_SWITCH_SOCKET_B = 6
  • BrickletRemoteSwitchV2.FUNCTION_DIM_SOCKET_B = 7
  • BrickletRemoteSwitchV2.FUNCTION_SWITCH_SOCKET_C = 8
  • BrickletRemoteSwitchV2.FUNCTION_SET_REMOTE_CONFIGURATION = 9
  • BrickletRemoteSwitchV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletRemoteSwitchV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletRemoteSwitchV2.FUNCTION_RESET = 243
  • BrickletRemoteSwitchV2.FUNCTION_WRITE_UID = 248
public void SetResponseExpectedAll(bool responseExpected)

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

public void GetSPITFPErrorCount(out long errorCountAckChecksum, out long errorCountMessageChecksum, out long errorCountFrame, out long errorCountOverflow)

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

  • ACK checksum errors,
  • message checksum errors,
  • framing errors and
  • overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

public byte SetBootloaderMode(byte mode)

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following constants are available for this function:

  • BrickletRemoteSwitchV2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletRemoteSwitchV2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletRemoteSwitchV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletRemoteSwitchV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletRemoteSwitchV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BrickletRemoteSwitchV2.BOOTLOADER_STATUS_OK = 0
  • BrickletRemoteSwitchV2.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletRemoteSwitchV2.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletRemoteSwitchV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletRemoteSwitchV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletRemoteSwitchV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5
public byte GetBootloaderMode()

Returns the current bootloader mode, see SetBootloaderMode().

The following constants are available for this function:

  • BrickletRemoteSwitchV2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletRemoteSwitchV2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletRemoteSwitchV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletRemoteSwitchV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletRemoteSwitchV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
public void SetWriteFirmwarePointer(long pointer)

Sets the firmware pointer for WriteFirmware(). The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

public byte WriteFirmware(byte[] data)

Writes 64 Bytes of firmware at the position as written by SetWriteFirmwarePointer() before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

public void SetStatusLEDConfig(byte config)

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following constants are available for this function:

  • BrickletRemoteSwitchV2.STATUS_LED_CONFIG_OFF = 0
  • BrickletRemoteSwitchV2.STATUS_LED_CONFIG_ON = 1
  • BrickletRemoteSwitchV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletRemoteSwitchV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
public byte GetStatusLEDConfig()

Returns the configuration as set by SetStatusLEDConfig()

The following constants are available for this function:

  • BrickletRemoteSwitchV2.STATUS_LED_CONFIG_OFF = 0
  • BrickletRemoteSwitchV2.STATUS_LED_CONFIG_ON = 1
  • BrickletRemoteSwitchV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletRemoteSwitchV2.STATUS_LED_CONFIG_SHOW_STATUS = 3
public short GetChipTemperature()

Returns the temperature in °C as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

public void Reset()

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

public void WriteUID(long uid)

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

public long ReadUID()

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

public void GetIdentity(out string uid, out string connectedUid, out char position, out byte[] hardwareVersion, out byte[] firmwareVersion, out int deviceIdentifier)

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 appending your callback handler to the corresponding event:

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

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

public event SwitchingDoneCallback(BrickletRemoteSwitchV2 sender)

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

public event RemoteStatusACallback(BrickletRemoteSwitchV2 sender, byte houseCode, byte receiverCode, byte switchTo, int repeats)

Returns the house code, receiver code, switch state (on/off) and number of repeats for remote type A.

The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number. The callback is triggered with every repeat.

You have to enable the callback with SetRemoteConfiguration(). The number of repeats that you can set in the configuration is the minimum number of repeats that have to be seen before the callback is triggered for the first time.

The following constants are available for this function:

  • BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2.SWITCH_TO_ON = 1
public event RemoteStatusBCallback(BrickletRemoteSwitchV2 sender, long address, byte unit, byte switchTo, byte dimValue, int repeats)

Returns the address (unique per remote), unit (button number), switch state (on/off) and number of repeats for remote type B.

If the remote supports dimming the dim value is used instead of the switch state.

The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number. The callback is triggered with every repeat.

You have to enable the callback with SetRemoteConfiguration(). The number of repeats that you can set in the configuration is the minimum number of repeats that have to be seen before the callback is triggered for the first time.

The following constants are available for this function:

  • BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2.SWITCH_TO_ON = 1
public event RemoteStatusCCallback(BrickletRemoteSwitchV2 sender, char systemCode, byte deviceCode, byte switchTo, int repeats)

Returns the system code, device code, switch state (on/off) and number of repeats for remote type C.

The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number. The callback is triggered with every repeat.

You have to enable the callback with SetRemoteConfiguration(). The number of repeats that you can set in the configuration is the minimum number of repeats that have to be seen before the callback is triggered for the first time.

The following constants are available for this function:

  • BrickletRemoteSwitchV2.SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2.SWITCH_TO_ON = 1

Constants

public int DEVICE_IDENTIFIER

This constant is used to identify a Remote Switch Bricklet 2.0.

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

public string DEVICE_DISPLAY_NAME

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