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

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

.. _barometer_bricklet_shell:

Shell - Barometer Bricklet
==========================

This is the description of the :ref:`Shell API bindings <api_bindings_shell>` for the :ref:`Barometer Bricklet <barometer_bricklet>`. General information and technical
specifications for the Barometer Bricklet are summarized in its :ref:`hardware description
<barometer_bricklet_description>`.

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

.. _barometer_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/barometer-bricklet/raw/master/software/examples/shell/example-simple.sh>`__

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

Callback
^^^^^^^^

`Download (example-callback.sh) <https://github.com/Tinkerforge/barometer-bricklet/raw/master/software/examples/shell/example-callback.sh>`__

.. literalinclude:: Barometer_Bricklet_Shell_example-callback.sh
 :language: bash
 :linenos:
 :tab-width: 4

Threshold
^^^^^^^^^

`Download (example-threshold.sh) <https://github.com/Tinkerforge/barometer-bricklet/raw/master/software/examples/shell/example-threshold.sh>`__

.. literalinclude:: Barometer_Bricklet_Shell_example-threshold.sh
 :language: bash
 :linenos:
 :tab-width: 4

.. _barometer_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 Nbarometer-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 Barometer 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 Barometer Bricklet and exits


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

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

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


.. sh:function:: X Stinkerforge Scall Pbarometer-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 Pbarometer-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 barometer-bricklet <uid> get-air-pressure  


 :returns air-pressure: int

 Returns the air pressure of the air pressure sensor. The value
 has a range of 10000 to 1200000 and is given in mbar/1000, i.e. a value
 of 1001092 means that an air pressure of 1001.092 mbar is measured.
 
 If you want to get the air pressure periodically, it is recommended to use the
 callback :sh:func:`air-pressure <barometer-bricklet air-pressure>` and set the period with
 :sh:func:`set-air-pressure-callback-period <barometer-bricklet set-air-pressure-callback-period>`.
 
.. sh:function:: tinkerforge call barometer-bricklet <uid> get-altitude  


 :returns altitude: int

 Returns the relative altitude of the air pressure sensor. The value is given in
 cm and is calculated based on the difference between the current air pressure
 and the reference air pressure that can be set with :sh:func:`set-reference-air-pressure <barometer-bricklet set-reference-air-pressure>`.
 
 If you want to get the altitude periodically, it is recommended to use the
 callback :sh:func:`altitude <barometer-bricklet altitude>` and set the period with
 :sh:func:`set-altitude-callback-period <barometer-bricklet set-altitude-callback-period>`.
 
.. sh:function:: tinkerforge call barometer-bricklet <uid> set-reference-air-pressure <air-pressure> 

 :param <air-pressure>: int

 :noreturn: no output

 Sets the reference air pressure in mbar/1000 for the altitude calculation.
 Setting the reference to the current air pressure results in a calculated
 altitude of 0cm. Passing 0 is a shortcut for passing the current air pressure as
 reference.
 
 Well known reference values are the Q codes
 `QNH <http://en.wikipedia.org/wiki/QNH>`__ and
 `QFE <http://en.wikipedia.org/wiki/Mean_sea_level_pressure#Mean_sea_level_pressure>`__
 used in aviation.
 
 The default value is 1013.25mbar.
 
.. sh:function:: tinkerforge call barometer-bricklet <uid> get-reference-air-pressure  


 :returns air-pressure: int

 Returns the reference air pressure as set by :sh:func:`set-reference-air-pressure <barometer-bricklet set-reference-air-pressure>`.
 


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

.. sh:function:: tinkerforge call barometer-bricklet <uid> get-chip-temperature  


 :returns temperature: int

 Returns the temperature of the air pressure sensor. The value
 has a range of -4000 to 8500 and is given in °C/100, i.e. a value
 of 2007 means that a temperature of 20.07 °C is measured.
 
 This temperature is used internally for temperature compensation of the air
 pressure measurement. It is not as accurate as the temperature measured by the
 :ref:`temperature_bricklet` or the :ref:`temperature_ir_bricklet`.
 
.. sh:function:: tinkerforge call barometer-bricklet <uid> set-averaging <moving-average-pressure> <average-pressure> <average-temperature> 

 :param <moving-average-pressure>: int
 :param <average-pressure>: int
 :param <average-temperature>: int

 :noreturn: no output

 Sets the different averaging parameters. It is possible to set
 the length of a normal averaging for the temperature and pressure,
 as well as an additional length of a 
 `moving average <http://en.wikipedia.org/wiki/Moving_average>`__ 
 for the pressure. The moving average is calculated from the normal 
 averages.  There is no moving average for the temperature.
 
 The maximum length for the pressure average is 10, for the
 temperature average is 255 and for the moving average is 25.
 
 Setting the all three parameters to 0 will turn the averaging
 completely off. If the averaging is off, there is lots of noise
 on the data, but the data is without delay. Thus we recommend
 to turn the averaging off if the Barometer Bricklet data is
 to be used for sensor fusion with other sensors.
 
 The default values are 10 for the normal averages and 25 for the
 moving average.
 
 .. versionadded:: 2.0.1~(Plugin)
 
.. sh:function:: tinkerforge call barometer-bricklet <uid> get-averaging  


 :returns moving-average-pressure: int
 :returns average-pressure: int
 :returns average-temperature: int

 Returns the averaging configuration as set by :sh:func:`set-averaging <barometer-bricklet set-averaging>`.
 
 .. versionadded:: 2.0.1~(Plugin)
 
.. sh:function:: tinkerforge call barometer-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 barometer-bricklet <uid> set-air-pressure-callback-period <period> 

 :param <period>: int

 :noreturn: no output

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


 :returns period: int

 Returns the period as set by :sh:func:`set-air-pressure-callback-period <barometer-bricklet set-air-pressure-callback-period>`.
 
.. sh:function:: tinkerforge call barometer-bricklet <uid> set-altitude-callback-period <period> 

 :param <period>: int

 :noreturn: no output

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


 :returns period: int

 Returns the period as set by :sh:func:`set-altitude-callback-period <barometer-bricklet set-altitude-callback-period>`.
 
.. sh:function:: tinkerforge call barometer-bricklet <uid> set-air-pressure-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:`air-pressure-reached <barometer-bricklet air-pressure-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 air pressure is *outside* the min and max values"
  "'i'",    "Callback is triggered when the air pressure is *inside* the min and max values"
  "'<'",    "Callback is triggered when the air pressure is smaller than the min value (max is ignored)"
  "'>'",    "Callback is triggered when the air pressure 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 barometer-bricklet <uid> get-air-pressure-callback-threshold  


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

 Returns the threshold as set by :sh:func:`set-air-pressure-callback-threshold <barometer-bricklet set-air-pressure-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 barometer-bricklet <uid> set-altitude-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:`altitude-reached <barometer-bricklet altitude-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 altitude is *outside* the min and max values"
  "'i'",    "Callback is triggered when the altitude is *inside* the min and max values"
  "'<'",    "Callback is triggered when the altitude is smaller than the min value (max is ignored)"
  "'>'",    "Callback is triggered when the altitude 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 barometer-bricklet <uid> get-altitude-callback-threshold  


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

 Returns the threshold as set by :sh:func:`set-altitude-callback-threshold <barometer-bricklet set-altitude-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 barometer-bricklet <uid> set-debounce-period <debounce> 

 :param <debounce>: int

 :noreturn: no output

 Sets the period in ms with which the threshold callbacks
 
 * :sh:func:`air-pressure-reached <barometer-bricklet air-pressure-reached>`,
 * :sh:func:`altitude-reached <barometer-bricklet altitude-reached>`
 
 are triggered, if the thresholds
 
 * :sh:func:`set-air-pressure-callback-threshold <barometer-bricklet set-air-pressure-callback-threshold>`,
 * :sh:func:`set-altitude-callback-threshold <barometer-bricklet set-altitude-callback-threshold>`
 
 keep being reached.
 
 The default value is 100.
 
.. sh:function:: tinkerforge call barometer-bricklet <uid> get-debounce-period  


 :returns debounce: int

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


.. _barometer_bricklet_shell_callbacks:

Callbacks
^^^^^^^^^

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

.. code-block:: bash

    tinkerforge dispatch barometer-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 barometer-bricklet <uid> air-pressure

 :returns air-pressure: int


 This callback is triggered periodically with the period that is set by
 :sh:func:`set-air-pressure-callback-period <barometer-bricklet set-air-pressure-callback-period>`. The parameter is the air pressure of the
 air pressure sensor.
 
 :sh:func:`air-pressure <barometer-bricklet air-pressure>` is only triggered if the air pressure has changed since the
 last triggering.
 
.. sh:function::  tinkerforge dispatch barometer-bricklet <uid> altitude

 :returns altitude: int


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

 :returns air-pressure: int


 This callback is triggered when the threshold as set by
 :sh:func:`set-air-pressure-callback-threshold <barometer-bricklet set-air-pressure-callback-threshold>` is reached.
 The parameter is the air pressure of the air pressure sensor.
 
 If the threshold keeps being reached, the callback is triggered periodically
 with the period as set by :sh:func:`set-debounce-period <barometer-bricklet set-debounce-period>`.
 
.. sh:function::  tinkerforge dispatch barometer-bricklet <uid> altitude-reached

 :returns altitude: int


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


