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.
The example code below is Public Domain (CC0 1.0).
Download (example-switch-socket.sh)
1 2 3 4 5 6 7 8 9 10 11 12 | #!/bin/sh
# connects to localhost:4223 by default, use --host and --port to change it
# change to your UID
uid=XYZ
# 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 on
|
Possible exit codes for all tinkerforge commands are:
The common options of the call and dispatch commands are documented here. The specific command structure is shown below.
Parameters: |
|
---|
The call command is used to call a function of the Remote Switch Bricklet. It can take several options:
Parameters: |
|
---|
The dispatch command is used to dispatch a callback of the Remote Switch Bricklet. It can take several options:
Parameters: |
|
---|
The <function> to be called can take different options depending of its kind. All functions can take the following options:
Getter functions can take the following options:
Setter functions can take the following options:
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.
Parameters: |
|
---|
The <callback> to be dispatched can take several options:
Parameters: |
|
---|---|
Output: | no output |
This function is deprecated, use switch-socket-a instead.
The following symbols are available for this function:
Output: |
|
---|
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:
Parameters: |
|
---|---|
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:
New in version 2.0.1 (Plugin).
Parameters: |
|
---|---|
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:
New in version 2.0.1 (Plugin).
Parameters: |
|
---|---|
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).
Parameters: |
|
---|---|
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:
New in version 2.0.1 (Plugin).
Parameters: |
|
---|---|
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.
Output: |
|
---|
Returns the number of repeats as set by set-repeats.
Output: |
|
---|
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 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.
Output: | no output |
---|
This callback is called whenever the switching state changes from busy to ready, see get-switching-state.