Shell - Remote Switch Bricklet

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

Examples

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

Switch Socket

Download (example-switch-socket.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Remote Switch Bricklet

# 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.
tinkerforge call remote-switch-bricklet $uid switch-socket-a 17 1 switch-to-on

API

Possible exit codes for all tinkerforge commands are:

  • 1: interrupted (ctrl+c)
  • 2: syntax error
  • 21: Python 2.5 or newer is required
  • 22: Python argparse module is missing
  • 23: socket error
  • 24: other exception
  • 25: invalid placeholder in format string
  • 26: authentication error
  • 201: timeout occurred
  • 209: invalid argument value
  • 210: function is not supported
  • 211: unknown error

Command Structure

The common options of the call and dispatch commands are documented here. The specific command structure is shown below.

tinkerforge call remote-switch-bricklet [<option>..] <uid> <function> [<argument>..]
Parameters:
  • <uid> -- string
  • <function> -- string

The call command is used to call a function of the Remote Switch Bricklet. It can take several options:

  • --help shows help for the specific call command and exits
  • --list-functions shows a list of known functions of the Remote Switch Bricklet and exits
tinkerforge dispatch remote-switch-bricklet [<option>..] <uid> <callback>
Parameters:
  • <uid> -- string
  • <callback> -- string

The dispatch command is used to dispatch a callback of the Remote Switch Bricklet. It can take several options:

  • --help shows help for the specific dispatch command and exits
  • --list-callbacks shows a list of known callbacks of the Remote Switch Bricklet and exits
tinkerforge call remote-switch-bricklet <uid> <function> [<option>..] [<argument>..]
Parameters:
  • <uid> -- string
  • <function> -- string

The <function> to be called can take different options depending of its kind. All functions can take the following options:

  • --help shows help for the specific function and exits

Getter functions can take the following options:

  • --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Setter functions can take the following options:

  • --expect-response requests response and waits for it

The --expect-response option for setter functions allows to detect timeouts and other error conditions calls of setters as well. The device will then send a response for this purpose. If this option is not given for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

tinkerforge dispatch remote-switch-bricklet <uid> <callback> [<option>..]
Parameters:
  • <uid> -- string
  • <callback> -- string

The <callback> to be dispatched can take several options:

  • --help shows help for the specific callback and exits
  • --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Basic Functions

tinkerforge call remote-switch-bricklet <uid> switch-socket <house-code> <receiver-code> <switch-to>
Parameters:
  • <house-code> -- int
  • <receiver-code> -- int
  • <switch-to> -- int (has symbols)
Output:

no output

This function is deprecated, use switch-socket-a instead.

The following symbols are available for this function:

  • switch-to-off = 0, for <switch-to>
  • switch-to-on = 1, for <switch-to>
tinkerforge call remote-switch-bricklet <uid> get-switching-state
Output:
  • state -- int (has symbols)

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 until the state changes to ready.

How long the switching takes is dependent on the number of repeats, see set-repeats.

The following symbols are available for this function:

  • switching-state-ready = 0, for state
  • switching-state-busy = 1, for state
tinkerforge call remote-switch-bricklet <uid> switch-socket-a <house-code> <receiver-code> <switch-to>
Parameters:
  • <house-code> -- int
  • <receiver-code> -- int
  • <switch-to> -- int (has symbols)
Output:

no output

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 symbols are available for this function:

  • switch-to-off = 0, for <switch-to>
  • switch-to-on = 1, for <switch-to>

New in version 2.0.1 (Plugin).

tinkerforge call remote-switch-bricklet <uid> switch-socket-b <address> <unit> <switch-to>
Parameters:
  • <address> -- int
  • <unit> -- int
  • <switch-to> -- int (has symbols)
Output:

no output

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 symbols are available for this function:

  • switch-to-off = 0, for <switch-to>
  • switch-to-on = 1, for <switch-to>

New in version 2.0.1 (Plugin).

tinkerforge call remote-switch-bricklet <uid> dim-socket-b <address> <unit> <dim-value>
Parameters:
  • <address> -- int
  • <unit> -- int
  • <dim-value> -- int
Output:

no output

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.

New in version 2.0.1 (Plugin).

tinkerforge call remote-switch-bricklet <uid> switch-socket-c <system-code> <device-code> <switch-to>
Parameters:
  • <system-code> -- char
  • <device-code> -- int
  • <switch-to> -- int (has symbols)
Output:

no output

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 symbols are available for this function:

  • switch-to-off = 0, for <switch-to>
  • switch-to-on = 1, for <switch-to>

New in version 2.0.1 (Plugin).

Advanced Functions

tinkerforge call remote-switch-bricklet <uid> set-repeats <repeats>
Parameters:
  • <repeats> -- int
Output:

no output

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

tinkerforge call remote-switch-bricklet <uid> get-repeats
Output:
  • repeats -- int

Returns the number of repeats as set by set-repeats.

tinkerforge call remote-switch-bricklet <uid> get-identity
Output:
  • uid -- string
  • connected-uid -- string
  • position -- char
  • hardware-version -- int,int,int
  • firmware-version -- int,int,int
  • device-identifier -- int (has symbols)

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

Callbacks

Callbacks can be used to receive time critical or recurring data from the device:

tinkerforge dispatch remote-switch-bricklet <uid> example

The available callbacks 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.

tinkerforge dispatch remote-switch-bricklet <uid> switching-done
Output:no output

This callback is triggered whenever the switching state changes from busy to ready, see get-switching-state.