..
 #############################################################
 # This file was automatically generated on 2015-05-08.      #
 #                                                           #
 # If you have a bugfix for this file and want to commit it, #
 # please fix the bug in the generator. You can find a link  #
 # to the generators git repository on tinkerforge.com       #
 #############################################################


:breadcrumbs: <a href="../../index.html">Home</a> / <a href="../../index.html#software-shell">Software</a> / Shell - Solid State Relay Bricklet

.. |device_identifier_constant| unicode:: 0xA0
   :trim:

.. _solid_state_relay_bricklet_shell:

Shell - Solid State Relay Bricklet
==================================

This is the description of the :ref:`Shell API bindings <api_bindings_shell>` for the :ref:`Solid State Relay Bricklet <solid_state_relay_bricklet>`. General information and technical
specifications for the Solid State Relay Bricklet are summarized in its :ref:`hardware description
<solid_state_relay_bricklet_description>`.

An :ref:`installation guide <api_bindings_shell_install>` for the Shell API
bindings is part of their general description.

.. _solid_state_relay_bricklet_shell_examples:


Examples
--------

The example code below is `Public Domain (CC0 1.0)
<http://creativecommons.org/publicdomain/zero/1.0/>`__.

Simple
^^^^^^

`Download (example-simple.sh) <https://github.com/Tinkerforge/solid-state-relay-bricklet/raw/master/software/examples/shell/example-simple.sh>`__

.. literalinclude:: SolidStateRelay_Bricklet_Shell_example-simple.sh
 :language: bash
 :linenos:
 :tab-width: 4

.. _solid_state_relay_bricklet_shell_api:

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
:ref:`here <ipcon_shell_api>`. The specific command structure is shown below.

.. sh:function:: X Stinkerforge Pcall Nsolid-state-relay-bricklet A[<option>..] L<uid> L<function> L[<argument>..]

 :param <uid>: string
 :param <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


.. sh:function:: X Stinkerforge Pdispatch Nsolid-state-relay-bricklet A[<option>..] L<uid> L<callback>

 :param <uid>: string
 :param <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


.. sh:function:: X Stinkerforge Scall Psolid-state-relay-bricklet L<uid> N<function> A[<option>..] L[<argument>..]

 :param <uid>: string
 :param <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 :ref:`output formatting <ipcon_shell_output>`
   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.


.. sh:function:: X Stinkerforge Sdispatch Psolid-state-relay-bricklet L<uid> N<callback> A[<option>..]

 :param <uid>: string
 :param <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 :ref:`output formatting <ipcon_shell_output>`
   for details)



Basic Functions
^^^^^^^^^^^^^^^



.. sh:function:: tinkerforge call solid-state-relay-bricklet <uid> set-state <state> 

 :param <state>: bool

 :noreturn: 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*.
 
.. sh:function:: tinkerforge call solid-state-relay-bricklet <uid> get-state  


 :returns state: bool

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


Advanced Functions
^^^^^^^^^^^^^^^^^^

.. sh:function:: tinkerforge call solid-state-relay-bricklet <uid> set-monoflop <state> <time> 

 :param <state>: bool
 :param <time>: int

 :noreturn: 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.
 
.. sh:function:: tinkerforge call solid-state-relay-bricklet <uid> get-monoflop  


 :returns state: bool
 :returns time: int
 :returns time-remaining: int

 Returns the current state and the time as set by 
 :sh:func:`set-monoflop <solid-state-relay-bricklet 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.
 
.. sh:function:: tinkerforge call solid-state-relay-bricklet <uid> get-identity  


 :returns uid: string
 :returns connected-uid: string
 :returns position: char
 :returns hardware-version: int,int,int
 :returns firmware-version: int,int,int
 :returns 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 :ref:`here <device_identifier>`.
 |device_identifier_constant|
 


.. _solid_state_relay_bricklet_shell_callbacks:

Callbacks
^^^^^^^^^

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

.. code-block:: bash

    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.

.. sh:function::  tinkerforge dispatch solid-state-relay-bricklet <uid> monoflop-done

 :returns 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).
 


