Shell - Remote Switch Bricklet 2.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 2.0

# 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-v2-bricklet $uid switch-socket-a 17 1 switch-to-on

Remote Callback¶

Download (example-remote-callback.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

#!/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 2.0

# Configure to receive from remote type A with minimum repeats set to 1 and enable callback
tinkerforge call remote-switch-v2-bricklet $uid set-remote-configuration remote-type-a 1 true

# Handle incoming remote status a callbacks
tinkerforge dispatch remote-switch-v2-bricklet $uid remote-status-a &

echo "Press key to exit"; read dummy

kill -- -$$ # Stop callback dispatch in background

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-v2-bricklet [<option>..] <uid> <function> [<argument>..]¶

Parameters:	<uid> – Type: String <function> – Type: String

The call command is used to call a function of the Remote Switch Bricklet 2.0. 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 2.0 and exits

tinkerforge dispatch remote-switch-v2-bricklet [<option>..] <uid> <callback>¶

Parameters:	<uid> – Type: String <callback> – Type: String

The dispatch command is used to dispatch a callback of the Remote Switch Bricklet 2.0. 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 2.0 and exits

tinkerforge call remote-switch-v2-bricklet <uid> <function> [<option>..] [<argument>..]¶

Parameters:	<uid> – Type: String <function> – Type: 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 sent and errors are silently ignored, because they cannot be detected.

tinkerforge dispatch remote-switch-v2-bricklet <uid> <callback> [<option>..]¶

Parameters:	<uid> – Type: String <callback> – Type: 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-v2-bricklet <uid> get-switching-state¶

Output:	state – Type: Int, Range: See 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 functions 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:

For state:

• switching-state-ready = 0
• switching-state-busy = 1

tinkerforge call remote-switch-v2-bricklet <uid> switch-socket-a <house-code> <receiver-code> <switch-to>¶

Parameters:	<house-code> – Type: Int, Range: [0 to 31] <receiver-code> – Type: Int, Range: [0 to 31] <switch-to> – Type: Int, Range: See 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.

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:

For <switch-to>:

• switch-to-off = 0
• switch-to-on = 1

tinkerforge call remote-switch-v2-bricklet <uid> switch-socket-b <address> <unit> <switch-to>¶

Parameters:	<address> – Type: Int, Range: [0 to 226 - 1] <unit> – Type: Int, Range: [0 to 15, 255] <switch-to> – Type: Int, Range: See 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.

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:

For <switch-to>:

• switch-to-off = 0
• switch-to-on = 1

tinkerforge call remote-switch-v2-bricklet <uid> dim-socket-b <address> <unit> <dim-value>¶

Parameters:	<address> – Type: Int, Range: [0 to 226 - 1] <unit> – Type: Int, Range: [0 to 15, 255] <dim-value> – Type: Int, Range: [0 to 255]
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.

A detailed description on how you can teach a dimmer the address and unit can be found here.

tinkerforge call remote-switch-v2-bricklet <uid> switch-socket-c <system-code> <device-code> <switch-to>¶

Parameters:	<system-code> – Type: Char, Range: [A to P] <device-code> – Type: Int, Range: [1 to 16] <switch-to> – Type: Int, Range: See 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.

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:

For <switch-to>:

• switch-to-off = 0
• switch-to-on = 1

tinkerforge call remote-switch-v2-bricklet <uid> set-remote-configuration <remote-type> <minimum-repeats> <callback-enabled>¶

Parameters:	<remote-type> – Type: Int, Range: See symbols, Default: 0 <minimum-repeats> – Type: Int, Range: [0 to 216 - 1], Default: 2 <callback-enabled> – Type: Bool, Default: false
Output:	no output

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 remote-status-a callback, remote-status-b callback and remote-status-c callback).

The following symbols are available for this function:

For <remote-type>:

• remote-type-a = 0
• remote-type-b = 1
• remote-type-c = 2

tinkerforge call remote-switch-v2-bricklet <uid> get-remote-configuration¶

Output:	remote-type – Type: Int, Range: See symbols, Default: 0 minimum-repeats – Type: Int, Range: [0 to 216 - 1], Default: 2 callback-enabled – Type: Bool, Default: false

Returns the remote configuration as set by set-remote-configuration

The following symbols are available for this function:

For remote-type:

• remote-type-a = 0
• remote-type-b = 1
• remote-type-c = 2

tinkerforge call remote-switch-v2-bricklet <uid> get-remote-status-a¶

Output:	house-code – Type: Int, Range: [0 to 31] receiver-code – Type: Int, Range: [0 to 31] switch-to – Type: Int, Range: See symbols repeats – Type: Int, Range: [0 to 216 - 1]

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 set-remote-configuration and remote-status-a callback.

The following symbols are available for this function:

For switch-to:

• switch-to-off = 0
• switch-to-on = 1

tinkerforge call remote-switch-v2-bricklet <uid> get-remote-status-b¶

Output:	address – Type: Int, Range: [0 to 226 - 1] unit – Type: Int, Range: [0 to 15] switch-to – Type: Int, Range: See symbols dim-value – Type: Int, Range: [0 to 255] repeats – Type: Int, Range: [0 to 216 - 1]

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 set-remote-configuration and remote-status-b callback.

The following symbols are available for this function:

For switch-to:

• switch-to-off = 0
• switch-to-on = 1

tinkerforge call remote-switch-v2-bricklet <uid> get-remote-status-c¶

Output:	system-code – Type: Char, Range: [A to P] device-code – Type: Int, Range: [1 to 16] switch-to – Type: Int, Range: See symbols repeats – Type: Int, Range: [0 to 216 - 1]

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 set-remote-configuration and remote-status-c callback.

The following symbols are available for this function:

For switch-to:

• switch-to-off = 0
• switch-to-on = 1

Advanced Functions¶

tinkerforge call remote-switch-v2-bricklet <uid> set-repeats <repeats>¶

Parameters:	<repeats> – Type: Int, Range: [0 to 255], Default: 5
Output:	no output

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

tinkerforge call remote-switch-v2-bricklet <uid> get-repeats¶

Output:	repeats – Type: Int, Range: [0 to 255], Default: 5

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

tinkerforge call remote-switch-v2-bricklet <uid> get-spitfp-error-count¶

Output:	error-count-ack-checksum – Type: Int, Range: [0 to 232 - 1] error-count-message-checksum – Type: Int, Range: [0 to 232 - 1] error-count-frame – Type: Int, Range: [0 to 232 - 1] error-count-overflow – Type: Int, Range: [0 to 232 - 1]

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.

tinkerforge call remote-switch-v2-bricklet <uid> set-status-led-config <config>¶

Parameters:	<config> – Type: Int, Range: See symbols, Default: 3
Output:	no output

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

For <config>:

• status-led-config-off = 0
• status-led-config-on = 1
• status-led-config-show-heartbeat = 2
• status-led-config-show-status = 3

tinkerforge call remote-switch-v2-bricklet <uid> get-status-led-config¶

Output:	config – Type: Int, Range: See symbols, Default: 3

Returns the configuration as set by set-status-led-config

The following symbols are available for this function:

For config:

• status-led-config-off = 0
• status-led-config-on = 1
• status-led-config-show-heartbeat = 2
• status-led-config-show-status = 3

tinkerforge call remote-switch-v2-bricklet <uid> get-chip-temperature¶

Output:	temperature – Type: Int, Unit: 1 °C, Range: [-215 to 215 - 1]

Returns the temperature 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.

tinkerforge call remote-switch-v2-bricklet <uid> reset¶

Output:	no output

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!

tinkerforge call remote-switch-v2-bricklet <uid> get-identity¶

Output:

uid – Type: String, Length: up to 8 connected-uid – Type: String, Length: up to 8 position – Type: Char, Range: [a to h, z] hardware-version – Type: Int Array, Length: 3 0: major – Type: Int, Range: [0 to 255] 1: minor – Type: Int, Range: [0 to 255] 2: revision – Type: Int, Range: [0 to 255] firmware-version – Type: Int Array, Length: 3 0: major – Type: Int, Range: [0 to 255] 1: minor – Type: Int, Range: [0 to 255] 2: revision – Type: Int, Range: [0 to 255] device-identifier – 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. 

Callbacks¶

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

tinkerforge dispatch remote-switch-v2-bricklet <uid> example

The available callbacks are described below.

tinkerforge dispatch remote-switch-v2-bricklet <uid> switching-done¶

Output:	no output

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

tinkerforge dispatch remote-switch-v2-bricklet <uid> remote-status-a¶

Output:	house-code – Type: Int, Range: [0 to 31] receiver-code – Type: Int, Range: [0 to 31] switch-to – Type: Int, Range: See symbols repeats – Type: Int, Range: [0 to 216 - 1]

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 set-remote-configuration. 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 symbols are available for this function:

For switch-to:

• switch-to-off = 0
• switch-to-on = 1

tinkerforge dispatch remote-switch-v2-bricklet <uid> remote-status-b¶

Output:	address – Type: Int, Range: [0 to 226 - 1] unit – Type: Int, Range: [0 to 15, 255] switch-to – Type: Int, Range: See symbols dim-value – Type: Int, Range: [0 to 255] repeats – Type: Int, Range: [0 to 216 - 1]

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 set-remote-configuration. 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 symbols are available for this function:

For switch-to:

• switch-to-off = 0
• switch-to-on = 1

tinkerforge dispatch remote-switch-v2-bricklet <uid> remote-status-c¶

Output:	system-code – Type: Char, Range: [A to P] device-code – Type: Int, Range: [1 to 16] switch-to – Type: Int, Range: See symbols repeats – Type: Int, Range: [0 to 216 - 1]

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 set-remote-configuration. 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 symbols are available for this function:

For switch-to:

• switch-to-off = 0
• switch-to-on = 1

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

tinkerforge call remote-switch-v2-bricklet <uid> set-bootloader-mode <mode>¶

Parameters:	<mode> – Type: Int, Range: See symbols
Output:	status – Type: Int, Range: See symbols

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

For <mode>:

• bootloader-mode-bootloader = 0
• bootloader-mode-firmware = 1
• bootloader-mode-bootloader-wait-for-reboot = 2
• bootloader-mode-firmware-wait-for-reboot = 3
• bootloader-mode-firmware-wait-for-erase-and-reboot = 4

For status:

• bootloader-status-ok = 0
• bootloader-status-invalid-mode = 1
• bootloader-status-no-change = 2
• bootloader-status-entry-function-not-present = 3
• bootloader-status-device-identifier-incorrect = 4
• bootloader-status-crc-mismatch = 5

tinkerforge call remote-switch-v2-bricklet <uid> get-bootloader-mode¶

Output:	mode – Type: Int, Range: See symbols

Returns the current bootloader mode, see set-bootloader-mode.

The following symbols are available for this function:

For mode:

• bootloader-mode-bootloader = 0
• bootloader-mode-firmware = 1
• bootloader-mode-bootloader-wait-for-reboot = 2
• bootloader-mode-firmware-wait-for-reboot = 3
• bootloader-mode-firmware-wait-for-erase-and-reboot = 4

tinkerforge call remote-switch-v2-bricklet <uid> set-write-firmware-pointer <pointer>¶

Parameters:	<pointer> – Type: Int, Unit: 1 B, Range: [0 to 232 - 1]
Output:	no output

Sets the firmware pointer for write-firmware. 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.

tinkerforge call remote-switch-v2-bricklet <uid> write-firmware <data>¶

Parameters:	<data> – Type: Int Array, Length: 64, Range: [0 to 255]
Output:	status – Type: Int, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by set-write-firmware-pointer 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.

tinkerforge call remote-switch-v2-bricklet <uid> write-uid <uid>¶

Parameters:	<uid> – Type: Int, Range: [0 to 232 - 1]
Output:	no output

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.

tinkerforge call remote-switch-v2-bricklet <uid> read-uid¶

Output:	uid – Type: Int, Range: [0 to 232 - 1]

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