Shell - Solid State Relay Bricklet – Tinkerforge

- Getting Started
  - Primer
  - Tutorials
  - FAQ
- Hardware
  - Bricks
  - Bricklets
  - Master Extensions
  - Power Supplies
  - Accessories
  - Timeline
- Software
  - Brick Daemon (brickd)
  - Brick Viewer (brickv)
  - API Bindings
    - C/C++
    - C/C++ (iOS)
    - C#
    - C# (Windows Phone)
    - Delphi/Lazarus
    - Java
    - Java (Android)
    - JavaScript
    - LabVIEW
    - Mathematica
    - MATLAB/Octave
    - Perl
    - PHP
    - Python
    - Ruby
    - Shell
      - Requirements
      - Installation
      - Testing an Example
      - API Reference and Examples
        - IP Connection
        - Bricks
        - Bricklets
          - Ambient Light Bricklet
          - Analog In Bricklet
          - Analog Out Bricklet
          - Barometer Bricklet
          - Color Bricklet
          - Current12 Bricklet
          - Current25 Bricklet
          - Distance IR Bricklet
          - Distance US Bricklet
          - Dual Button Bricklet
          - Dual Relay Bricklet
          - GPS Bricklet
          - Hall Effect Bricklet
          - Humidity Bricklet
          - Industrial Digital In 4 Bricklet
          - Industrial Digital Out 4 Bricklet
          - Industrial Dual 0-20mA Bricklet
          - Industrial Quad Relay Bricklet
          - IO-16 Bricklet
          - IO-4 Bricklet
          - Joystick Bricklet
          - LCD 16x2 Bricklet
          - LCD 20x4 Bricklet
          - LED Strip Bricklet
          - Line Bricklet
          - Linear Poti Bricklet
          - Moisture Bricklet
          - Motion Detector Bricklet
          - Multi Touch Bricklet
          - NFC/RFID Bricklet
          - Piezo Buzzer Bricklet
          - Piezo Speaker Bricklet
          - PTC Bricklet
          - Remote Switch Bricklet
          - Rotary Encoder Bricklet
          - Rotary Poti Bricklet
          - Segment Display 4x7 Bricklet
          - Solid State Relay Bricklet
            - Examples
              - Simple
            - API
              - Command Structure
              - Basic Functions
              - Advanced Functions
              - Callbacks
          - Sound Intensity Bricklet
          - Temperature Bricklet
          - Temperature IR Bricklet
          - Tilt Bricklet
          - Voltage Bricklet
          - Voltage/Current Bricklet
    - Visual Basic .NET
  - Firmwares and Plugins
  - Device Identifier
  - Source Code and Bug Tracking
  - Programming Interface
- Starter Kits
  - Weather Station
  - Hardware Hacking
  - Server Room Monitoring
  - Blinkenlights
  - Internet of Things
  - Camera Slider
- Embedded Boards
  - Raspberry Pi
- Specifications
  - Technical Data
  - TCP/IP Protocol
  - Modbus Protocol
  - Wireshark Dissector

# Shell - Solid State Relay Bricklet

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.

## Examples

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

### Simple

Download (example-simple.sh)

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

    #!/bin/sh
    # connects to localhost:4223 by default, use --host and --port to change it

    # change to your UID
    uid=dbs

    # Turn relay on/off for 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

## 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` `solid-state-relay-bricklet` [<option>..] <uid> <function> [<argument>..]

  Parameters:

  - <uid> -- string
  - <function> -- string

  The `call` command is used to call a function of the Solid State Relay 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 Solid State Relay Bricklet and exits

tinkerforge `dispatch` `solid-state-relay-bricklet` [<option>..] <uid> <callback>

  Parameters:

  - <uid> -- string
  - <callback> -- string

  The `dispatch` command is used to dispatch a callback of the Solid State Relay 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 Solid State Relay Bricklet and exits

tinkerforge call `solid-state-relay-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 `solid-state-relay-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 `solid-state-relay-bricklet` <uid> `set-state` <state>

  Parameters:

  - <state> -- bool

  Output: | no output

  Sets the state of the relays true means on and false means off.

  Running monoflop timers will be overwritten if this function is called.

  The default value is false.

tinkerforge call `solid-state-relay-bricklet` <uid> `get-state`

  Output:

  - state -- bool

  Returns the state of the relay, true means on and false means off.

### Advanced Functions

tinkerforge call `solid-state-relay-bricklet` <uid> `set-monoflop` <state> <time>

  Parameters:

  - <state> -- bool
  - <time> -- int

  Output: | no output

  The first parameter is the desired state of the relay (true means on and false means off). The second parameter indicates the time (in ms) 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.

tinkerforge call `solid-state-relay-bricklet` <uid> `get-monoflop`

  Output:

  - state -- bool
  - time -- int
  - time-remaining -- int

  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.

tinkerforge call `solid-state-relay-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 solid-state-relay-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 `solid-state-relay-bricklet` <uid> `monoflop-done`

  Output:

  - state -- bool

  This callback is triggered whenever the monoflop timer reaches 0. The parameter is the current state of the relay (the state after the monoflop).

The content of this page is licensed under Creative Commons Attribution 3.0 Unported License.