This is the description of the Shell 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 Shell API bindings is part of their general description.
The example code below is Public Domain (CC0 1.0).
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 this uid=XYZ # Change XYZ to the UID of your Solid State Relay Bricklet # Turn relay on/off 10 times with 1 second delay for i in 0 1 2 3 4; do sleep 1 tinkerforge call solid-state-relay-bricklet $uid set-state true sleep 1 tinkerforge call solid-state-relay-bricklet $uid set-state false done
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.
The call command is used to call a function of the Solid State Relay Bricklet. It can take several options:
The dispatch command is used to dispatch a callback of the Solid State Relay Bricklet. It can take several options:
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 sent and errors are silently ignored, because they cannot be detected.
The <callback> to be dispatched can take several options:
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.
Returns the state of the relay, true means on and false means off.
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.
Returns the current state and the time as set by set-monoflop 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.
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). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an Isolator Bricklet is always as position 'z'.
The device identifier numbers can be found here.
Callbacks can be used to receive time critical or recurring data from the device:
tinkerforge dispatch solid-state-relay-bricklet <uid> example
The available callbacks are described below.
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.
This callback is triggered whenever the monoflop timer reaches 0. The parameter is the current state of the relay (the state after the monoflop).