..
 #############################################################
 # 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-modbus">Software</a> / Modbus - Current25 Bricklet

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

.. _current25_bricklet_modbus:

Modbus - Current25 Bricklet
===========================

This is the description of the :ref:`Modbus protocol <llproto_modbus>` for the :ref:`Current25 Bricklet <current25_bricklet>`. General information and technical
specifications for the Current25 Bricklet are summarized in its :ref:`hardware description
<current25_bricklet_description>`.

.. _current25_bricklet_modbus_api:

API
---

A general description of the Modbus protocol structure can be found
:ref:`here <llproto_modbus>`.




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



.. modbus:function:: BrickletCurrent25.get_current

 :functionid: 1
 :emptyrequest: empty payload

 :response current: int16

 Returns the current of the sensor. The value is in mA
 and between -25000mA and 25000mA.
 
 If you want to get the current periodically, it is recommended to use the
 callback :modbus:func:`CALLBACK_CURRENT <BrickletCurrent25.CALLBACK_CURRENT>` and set the period with 
 :modbus:func:`set_current_callback_period <BrickletCurrent25.set_current_callback_period>`.
 


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

.. modbus:function:: BrickletCurrent25.calibrate

 :functionid: 2
 :emptyrequest: empty payload

 :noresponse: no response

 Calibrates the 0 value of the sensor. You have to call this function
 when there is no current present. 
 
 The zero point of the current sensor
 is depending on the exact properties of the analog-to-digital converter,
 the length of the Bricklet cable and the temperature. Thus, if you change
 the Brick or the environment in which the Bricklet is used, you might
 have to recalibrate.
 
 The resulting calibration will be saved on the EEPROM of the Current
 Bricklet.
 
.. modbus:function:: BrickletCurrent25.is_over_current

 :functionid: 3
 :emptyrequest: empty payload

 :response over: bool

 Returns *true* if more than 25A were measured.
 
 .. note::
  To reset this value you have to power cycle the Bricklet.
 
.. modbus:function:: BrickletCurrent25.get_analog_value

 :functionid: 4
 :emptyrequest: empty payload

 :response value: uint16

 Returns the value as read by a 12-bit analog-to-digital converter.
 The value is between 0 and 4095.
 
 .. note::
  The value returned by :modbus:func:`get_current <BrickletCurrent25.get_current>` is averaged over several samples
  to yield less noise, while :modbus:func:`get_analog_value <BrickletCurrent25.get_analog_value>` gives back raw
  unfiltered analog values. The only reason to use :modbus:func:`get_analog_value <BrickletCurrent25.get_analog_value>` is,
  if you need the full resolution of the analog-to-digital converter.
 
 If you want the analog value periodically, it is recommended to use the 
 callback :modbus:func:`CALLBACK_ANALOG_VALUE <BrickletCurrent25.CALLBACK_ANALOG_VALUE>` and set the period with 
 :modbus:func:`set_analog_value_callback_period <BrickletCurrent25.set_analog_value_callback_period>`.
 
.. modbus:function:: BrickletCurrent25.get_identity

 :functionid: 255
 :emptyrequest: empty payload

 :response uid: char[8]
 :response connected_uid: char[8]
 :response position: char
 :response hardware_version: uint8[3]
 :response firmware_version: uint8[3]
 :response device_identifier: uint16

 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
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



.. modbus:function:: BrickletCurrent25.set_current_callback_period

 :functionid: 5
 :request period: uint32

 :noresponse: no response

 Sets the period in ms with which the :modbus:func:`CALLBACK_CURRENT <BrickletCurrent25.CALLBACK_CURRENT>` callback is triggered
 periodically. A value of 0 turns the callback off.
 
 :modbus:func:`CALLBACK_CURRENT <BrickletCurrent25.CALLBACK_CURRENT>` is only triggered if the current has changed since the
 last triggering.
 
 The default value is 0.
 
.. modbus:function:: BrickletCurrent25.get_current_callback_period

 :functionid: 6
 :emptyrequest: empty payload

 :response period: uint32

 Returns the period as set by :modbus:func:`set_current_callback_period <BrickletCurrent25.set_current_callback_period>`.
 
.. modbus:function:: BrickletCurrent25.set_analog_value_callback_period

 :functionid: 7
 :request period: uint32

 :noresponse: no response

 Sets the period in ms with which the :modbus:func:`CALLBACK_ANALOG_VALUE <BrickletCurrent25.CALLBACK_ANALOG_VALUE>` callback is triggered
 periodically. A value of 0 turns the callback off.
 
 :modbus:func:`CALLBACK_ANALOG_VALUE <BrickletCurrent25.CALLBACK_ANALOG_VALUE>` is only triggered if the analog value has changed since the
 last triggering.
 
 The default value is 0.
 
.. modbus:function:: BrickletCurrent25.get_analog_value_callback_period

 :functionid: 8
 :emptyrequest: empty payload

 :response period: uint32

 Returns the period as set by :modbus:func:`set_analog_value_callback_period <BrickletCurrent25.set_analog_value_callback_period>`.
 
.. modbus:function:: BrickletCurrent25.set_current_callback_threshold

 :functionid: 9
 :request option: char
 :request min: int16
 :request max: int16

 :noresponse: no response

 Sets the thresholds for the :modbus:func:`CALLBACK_CURRENT_REACHED <BrickletCurrent25.CALLBACK_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).
 
.. modbus:function:: BrickletCurrent25.get_current_callback_threshold

 :functionid: 10
 :emptyrequest: empty payload

 :response option: char
 :response min: int16
 :response max: int16

 Returns the threshold as set by :modbus:func:`set_current_callback_threshold <BrickletCurrent25.set_current_callback_threshold>`.
 
.. modbus:function:: BrickletCurrent25.set_analog_value_callback_threshold

 :functionid: 11
 :request option: char
 :request min: uint16
 :request max: uint16

 :noresponse: no response

 Sets the thresholds for the :modbus:func:`CALLBACK_ANALOG_VALUE_REACHED <BrickletCurrent25.CALLBACK_ANALOG_VALUE_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 analog value is *outside* the min and max values"
  "'i'",    "Callback is triggered when the analog value is *inside* the min and max values"
  "'<'",    "Callback is triggered when the analog value is smaller than the min value (max is ignored)"
  "'>'",    "Callback is triggered when the analog value is greater than the min value (max is ignored)"
 
 The default value is ('x', 0, 0).
 
.. modbus:function:: BrickletCurrent25.get_analog_value_callback_threshold

 :functionid: 12
 :emptyrequest: empty payload

 :response option: char
 :response min: uint16
 :response max: uint16

 Returns the threshold as set by :modbus:func:`set_analog_value_callback_threshold <BrickletCurrent25.set_analog_value_callback_threshold>`.
 
.. modbus:function:: BrickletCurrent25.set_debounce_period

 :functionid: 13
 :request debounce: uint32

 :noresponse: no response

 Sets the period in ms with which the threshold callbacks
 
 * :modbus:func:`CALLBACK_CURRENT_REACHED <BrickletCurrent25.CALLBACK_CURRENT_REACHED>`,
 * :modbus:func:`CALLBACK_ANALOG_VALUE_REACHED <BrickletCurrent25.CALLBACK_ANALOG_VALUE_REACHED>`
 
 are triggered, if the thresholds
 
 * :modbus:func:`set_current_callback_threshold <BrickletCurrent25.set_current_callback_threshold>`,
 * :modbus:func:`set_analog_value_callback_threshold <BrickletCurrent25.set_analog_value_callback_threshold>`
 
 keep being reached.
 
 The default value is 100.
 
.. modbus:function:: BrickletCurrent25.get_debounce_period

 :functionid: 14
 :emptyrequest: empty payload

 :response debounce: uint32

 Returns the debounce period as set by :modbus:func:`set_debounce_period <BrickletCurrent25.set_debounce_period>`.
 


.. _current25_bricklet_modbus_callbacks:

Callbacks
^^^^^^^^^

.. modbus:function:: BrickletCurrent25.CALLBACK_CURRENT

 :functionid: 15

 :response current: int16


 This callback is triggered periodically with the period that is set by
 :modbus:func:`set_current_callback_period <BrickletCurrent25.set_current_callback_period>`. The response value is the current of the
 sensor.
 
 :modbus:func:`CALLBACK_CURRENT <BrickletCurrent25.CALLBACK_CURRENT>` is only triggered if the current has changed since the
 last triggering.
 
.. modbus:function:: BrickletCurrent25.CALLBACK_ANALOG_VALUE

 :functionid: 16

 :response value: uint16


 This callback is triggered periodically with the period that is set by
 :modbus:func:`set_analog_value_callback_period <BrickletCurrent25.set_analog_value_callback_period>`. The response value is the analog value of the
 sensor.
 
 :modbus:func:`CALLBACK_ANALOG_VALUE <BrickletCurrent25.CALLBACK_ANALOG_VALUE>` is only triggered if the current has changed since the
 last triggering.
 
.. modbus:function:: BrickletCurrent25.CALLBACK_CURRENT_REACHED

 :functionid: 17

 :response current: int16


 This callback is triggered when the threshold as set by
 :modbus:func:`set_current_callback_threshold <BrickletCurrent25.set_current_callback_threshold>` is reached.
 The response value is the current of the sensor.
 
 If the threshold keeps being reached, the callback is triggered periodically
 with the period as set by :modbus:func:`set_debounce_period <BrickletCurrent25.set_debounce_period>`.
 
.. modbus:function:: BrickletCurrent25.CALLBACK_ANALOG_VALUE_REACHED

 :functionid: 18

 :response value: uint16


 This callback is triggered when the threshold as set by
 :modbus:func:`set_analog_value_callback_threshold <BrickletCurrent25.set_analog_value_callback_threshold>` is reached.
 The response value is the analog value of the sensor.
 
 If the threshold keeps being reached, the callback is triggered periodically
 with the period as set by :modbus:func:`set_debounce_period <BrickletCurrent25.set_debounce_period>`.
 
.. modbus:function:: BrickletCurrent25.CALLBACK_OVER_CURRENT

 :functionid: 19

 :emptyresponse: empty payload


 This callback is triggered when an over current is measured
 (see :modbus:func:`is_over_current <BrickletCurrent25.is_over_current>`).
 


