..
 #############################################################
 # 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 - Voltage/Current Bricklet

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

.. _voltage_current_bricklet_shell:

Shell - Voltage/Current Bricklet
================================

This is the description of the :ref:`Shell API bindings <api_bindings_shell>` for the :ref:`Voltage/Current Bricklet <voltage_current_bricklet>`. General information and technical
specifications for the Voltage/Current Bricklet are summarized in its :ref:`hardware description
<voltage_current_bricklet_description>`.

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

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

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

Callback
^^^^^^^^

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

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

Threshold
^^^^^^^^^

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

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

.. _voltage_current_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 Nvoltage-current-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 Voltage/Current 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 Voltage/Current Bricklet and exits


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

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

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


.. sh:function:: X Stinkerforge Scall Pvoltage-current-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 Pvoltage-current-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 voltage-current-bricklet <uid> get-current  


 :returns current: int

 Returns the current. The value is in mA
 and between -20000mA and 20000mA.
 
 If you want to get the current periodically, it is recommended to use the
 callback :sh:func:`current <voltage-current-bricklet current>` and set the period with 
 :sh:func:`set-current-callback-period <voltage-current-bricklet set-current-callback-period>`.
 
.. sh:function:: tinkerforge call voltage-current-bricklet <uid> get-voltage  


 :returns voltage: int

 Returns the voltage. The value is in mV
 and between 0mV and 36000mV.
 
 If you want to get the voltage periodically, it is recommended to use the
 callback :sh:func:`voltage <voltage-current-bricklet voltage>` and set the period with 
 :sh:func:`set-voltage-callback-period <voltage-current-bricklet set-voltage-callback-period>`.
 
.. sh:function:: tinkerforge call voltage-current-bricklet <uid> get-power  


 :returns power: int

 Returns the power. The value is in mW
 and between 0mV and 720000mW.
 
 If you want to get the power periodically, it is recommended to use the
 callback :sh:func:`power <voltage-current-bricklet power>` and set the period with 
 :sh:func:`set-power-callback-period <voltage-current-bricklet set-power-callback-period>`.
 
.. sh:function:: tinkerforge call voltage-current-bricklet <uid> set-configuration <averaging> <voltage-conversion-time> <current-conversion-time> 

 :param <averaging>: int (has symbols)
 :param <voltage-conversion-time>: int
 :param <current-conversion-time>: int

 :noreturn: no output

 Sets the configuration of the Voltage/Current Bricklet. It is
 possible to configure number of averages as well as
 voltage and current conversion time.
 
 Averaging:
 
 .. csv-table::
  :header: "Value", "Number of Averages"
  :widths: 20, 20
 
  "0",    "1"
  "1",    "4"
  "2",    "16"
  "3",    "64"
  "4",    "128"
  "5",    "256"
  "6",    "512"
  ">=7",  "1024"
 
 Voltage/Current conversion:
 
 .. csv-table::
  :header: "Value", "Conversion time"
  :widths: 20, 20
 
  "0",    "140µs"
  "1",    "204µs"
  "2",    "332µs"
  "3",    "588µs"
  "4",    "1.1ms"
  "5",    "2.116ms"
  "6",    "4.156ms"
  ">=7",  "8.244ms"
 
 The default values are 3, 4 and 4 (64, 1.1ms, 1.1ms) for averaging, voltage 
 conversion and current conversion.
 
 The following symbols are available for this function:
 
 * ``1`` = 0, for <averaging>
 * ``4`` = 1, for <averaging>
 * ``16`` = 2, for <averaging>
 * ``64`` = 3, for <averaging>
 * ``128`` = 4, for <averaging>
 * ``256`` = 5, for <averaging>
 * ``512`` = 6, for <averaging>
 * ``1024`` = 7, for <averaging>
 
.. sh:function:: tinkerforge call voltage-current-bricklet <uid> get-configuration  


 :returns averaging: int (has symbols)
 :returns voltage-conversion-time: int
 :returns current-conversion-time: int

 Returns the configuration as set by :sh:func:`set-configuration <voltage-current-bricklet set-configuration>`.
 
 The following symbols are available for this function:
 
 * ``1`` = 0, for averaging
 * ``4`` = 1, for averaging
 * ``16`` = 2, for averaging
 * ``64`` = 3, for averaging
 * ``128`` = 4, for averaging
 * ``256`` = 5, for averaging
 * ``512`` = 6, for averaging
 * ``1024`` = 7, for averaging
 


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

.. sh:function:: tinkerforge call voltage-current-bricklet <uid> set-calibration <gain-multiplier> <gain-divisor> 

 :param <gain-multiplier>: int
 :param <gain-divisor>: int

 :noreturn: no output

 Since the shunt resistor that is used to measure the current is not
 perfectly precise, it needs to be calibrated by a multiplier and
 divisor if a very precise reading is needed.
 
 For example, if you are expecting a measurement of 1000mA and you
 are measuring 1023mA, you can calibrate the Voltage/Current Bricklet 
 by setting the multiplier to 1000 and the divisor to 1023.
 
.. sh:function:: tinkerforge call voltage-current-bricklet <uid> get-calibration  


 :returns gain-multiplier: int
 :returns gain-divisor: int

 Returns the calibration as set by :sh:func:`set-calibration <voltage-current-bricklet set-calibration>`.
 
.. sh:function:: tinkerforge call voltage-current-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 voltage-current-bricklet <uid> set-current-callback-period <period> 

 :param <period>: int

 :noreturn: no output

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


 :returns period: int

 Returns the period as set by :sh:func:`set-current-callback-period <voltage-current-bricklet set-current-callback-period>`.
 
.. sh:function:: tinkerforge call voltage-current-bricklet <uid> set-voltage-callback-period <period> 

 :param <period>: int

 :noreturn: no output

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


 :returns period: int

 Returns the period as set by :sh:func:`set-voltage-callback-period <voltage-current-bricklet set-voltage-callback-period>`.
 
.. sh:function:: tinkerforge call voltage-current-bricklet <uid> set-power-callback-period <period> 

 :param <period>: int

 :noreturn: no output

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


 :returns period: int

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


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

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


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

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


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

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

 :param <debounce>: int

 :noreturn: no output

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


 :returns debounce: int

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


.. _voltage_current_bricklet_shell_callbacks:

Callbacks
^^^^^^^^^

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

.. code-block:: bash

    tinkerforge dispatch voltage-current-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 voltage-current-bricklet <uid> current

 :returns current: int


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

 :returns voltage: int


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

 :returns power: int


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

 :returns current: int


 This callback is triggered when the threshold as set by
 :sh:func:`set-current-callback-threshold <voltage-current-bricklet set-current-callback-threshold>` is reached.
 The parameter is the current 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 <voltage-current-bricklet set-debounce-period>`.
 
.. sh:function::  tinkerforge dispatch voltage-current-bricklet <uid> voltage-reached

 :returns voltage: int


 This callback is triggered when the threshold as set by
 :sh:func:`set-voltage-callback-threshold <voltage-current-bricklet set-voltage-callback-threshold>` is reached.
 The parameter is the voltage 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 <voltage-current-bricklet set-debounce-period>`.
 
.. sh:function::  tinkerforge dispatch voltage-current-bricklet <uid> power-reached

 :returns power: int


 This callback is triggered when the threshold as set by
 :sh:func:`set-power-callback-threshold <voltage-current-bricklet set-power-callback-threshold>` is reached.
 The parameter is the power 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 <voltage-current-bricklet set-debounce-period>`.
 


