..
 #############################################################
 # 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       #
 #############################################################

:orphan:
:breadcrumbs: <a href="../../index.html">Home</a> / <a href="../../index.html#software-shell">Software</a> / Shell - Dust Detector Bricklet

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

.. _dust_detector_bricklet_shell:

Shell - Dust Detector Bricklet
==============================

.. note::
 This Bricklet is currently in the prototype stage and the software/hardware
 as well as the documentation is in an incomplete state.


This is the description of the :ref:`Shell API bindings <api_bindings_shell>` for the :ref:`Dust Detector Bricklet <dust_detector_bricklet>`. General information and technical
specifications for the Dust Detector Bricklet are summarized in its :ref:`hardware description
<dust_detector_bricklet_description>`.

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

.. _dust_detector_bricklet_shell_examples:


Examples
--------

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

.. _dust_detector_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 Ndust-detector-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 Dust Detector 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 Dust Detector Bricklet and exits


.. sh:function:: X Stinkerforge Pdispatch Ndust-detector-bricklet A[<option>..] L<uid> L<callback>

 :param <uid>: string
 :param <callback>: string

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


.. sh:function:: X Stinkerforge Scall Pdust-detector-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 Pdust-detector-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 dust-detector-bricklet <uid> get-dust-density  


 :returns dust-density: int

 Returns the dust density in µg/m³.
 
 If you want to get the dust density periodically, it is recommended 
 to use the callback :sh:func:`dust-density <dust-detector-bricklet dust-density>` and set the period with 
 :sh:func:`set-dust-density-callback-period <dust-detector-bricklet set-dust-density-callback-period>`.
 


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

.. sh:function:: tinkerforge call dust-detector-bricklet <uid> set-moving-average <average> 

 :param <average>: int

 :noreturn: no output

 Sets the length of a `moving averaging <http://en.wikipedia.org/wiki/Moving_average>`__ 
 for the dust_density.
 
 Setting the length to 0 will turn the averaging completely off. With less
 averaging, there is more noise on the data.
 
 The range for the averaging is 0-100.
 
 The default value is 100.
 
.. sh:function:: tinkerforge call dust-detector-bricklet <uid> get-moving-average  


 :returns average: int

 Returns the length moving average as set by :sh:func:`set-moving-average <dust-detector-bricklet set-moving-average>`.
 
.. sh:function:: tinkerforge call dust-detector-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|
 


Callback Configuration Functions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



.. sh:function:: tinkerforge call dust-detector-bricklet <uid> set-dust-density-callback-period <period> 

 :param <period>: int

 :noreturn: no output

 Sets the period in ms with which the :sh:func:`dust-density <dust-detector-bricklet dust-density>` callback is triggered
 periodically. A value of 0 turns the callback off.
 
 :sh:func:`dust-density <dust-detector-bricklet dust-density>` is only triggered if the dust density has changed since the
 last triggering.
 
 The default value is 0.
 
.. sh:function:: tinkerforge call dust-detector-bricklet <uid> get-dust-density-callback-period  


 :returns period: int

 Returns the period as set by :sh:func:`set-dust-density-callback-period <dust-detector-bricklet set-dust-density-callback-period>`.
 
.. sh:function:: tinkerforge call dust-detector-bricklet <uid> set-dust-density-callback-threshold <option> <min> <max> 

 :param <option>: char (has symbols)
 :param <min>: int
 :param <max>: int

 :noreturn: no output

 Sets the thresholds for the :sh:func:`dust-density-reached <dust-detector-bricklet dust-density-reached>` callback. 
 
 The following options are possible:
 
 .. csv-table::
  :header: "Option", "Description"
  :widths: 10, 100
 
  "'x'",    "Callback is turned off"
  "'o'",    "Callback is triggered when the dust density value is *outside* the min and max values"
  "'i'",    "Callback is triggered when the dust density value is *inside* the min and max values"
  "'<'",    "Callback is triggered when the dust density value is smaller than the min value (max is ignored)"
  "'>'",    "Callback is triggered when the dust density value is greater than the min value (max is ignored)"
 
 The default value is ('x', 0, 0).
 
 The following symbols are available for this function:
 
 * ``off`` = x, for <option>
 * ``outside`` = o, for <option>
 * ``inside`` = i, for <option>
 * ``smaller`` = <, for <option>
 * ``greater`` = >, for <option>
 
.. sh:function:: tinkerforge call dust-detector-bricklet <uid> get-dust-density-callback-threshold  


 :returns option: char (has symbols)
 :returns min: int
 :returns max: int

 Returns the threshold as set by :sh:func:`set-dust-density-callback-threshold <dust-detector-bricklet set-dust-density-callback-threshold>`.
 
 The following symbols are available for this function:
 
 * ``off`` = x, for option
 * ``outside`` = o, for option
 * ``inside`` = i, for option
 * ``smaller`` = <, for option
 * ``greater`` = >, for option
 
.. sh:function:: tinkerforge call dust-detector-bricklet <uid> set-debounce-period <debounce> 

 :param <debounce>: int

 :noreturn: no output

 Sets the period in ms with which the threshold callback
 
 * :sh:func:`dust-density-reached <dust-detector-bricklet dust-density-reached>`
 
 is triggered, if the threshold
 
 * :sh:func:`set-dust-density-callback-threshold <dust-detector-bricklet set-dust-density-callback-threshold>`
 
 keeps being reached.
 
 The default value is 100.
 
.. sh:function:: tinkerforge call dust-detector-bricklet <uid> get-debounce-period  


 :returns debounce: int

 Returns the debounce period as set by :sh:func:`set-debounce-period <dust-detector-bricklet set-debounce-period>`.
 


.. _dust_detector_bricklet_shell_callbacks:

Callbacks
^^^^^^^^^

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

.. code-block:: bash

    tinkerforge dispatch dust-detector-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 dust-detector-bricklet <uid> dust-density

 :returns dust-density: int


 This callback is triggered periodically with the period that is set by
 :sh:func:`set-dust-density-callback-period <dust-detector-bricklet set-dust-density-callback-period>`. The parameter is the 
 dust density of the sensor.
 
 :sh:func:`dust-density <dust-detector-bricklet dust-density>` is only triggered if the dust density value has changed since the
 last triggering.
 
.. sh:function::  tinkerforge dispatch dust-detector-bricklet <uid> dust-density-reached

 :returns dust-density: int


 This callback is triggered when the threshold as set by
 :sh:func:`set-dust-density-callback-threshold <dust-detector-bricklet set-dust-density-callback-threshold>` is reached.
 The parameter is the dust density of the sensor.
 
 If the threshold keeps being reached, the callback is triggered periodically
 with the period as set by :sh:func:`set-debounce-period <dust-detector-bricklet set-debounce-period>`.
 


