Shell - Current25 Bricklet – Tinkerforge

- Getting Started
  - Primer
  - Tutorials
  - FAQ
- Hardware
  - Bricks
  - Bricklets
  - Master Extensions
  - Power Supplies
  - Accessories
  - Timeline
- Software
  - Brick Daemon (brickd)
  - Brick Viewer (brickv)
  - API Bindings
    - C/C++
    - C/C++ (iOS)
    - C#
    - C# (Windows Phone)
    - Delphi/Lazarus
    - Java
    - Java (Android)
    - JavaScript
    - LabVIEW
    - Mathematica
    - MATLAB/Octave
    - Perl
    - PHP
    - Python
    - Ruby
    - Shell
      - Requirements
      - Installation
      - Testing an Example
      - API Reference and Examples
        - IP Connection
        - Bricks
        - Bricklets
          - Ambient Light Bricklet
          - Analog In Bricklet
          - Analog Out Bricklet
          - Barometer Bricklet
          - Color Bricklet
          - Current12 Bricklet
          - Current25 Bricklet
            - Examples
              - Simple
              - Callback
              - Threshold
            - API
              - Command Structure
              - Basic Functions
              - Advanced Functions
              - Callback Configuration Functions
              - Callbacks
          - Distance IR Bricklet
          - Distance US Bricklet
          - Dual Button Bricklet
          - Dual Relay Bricklet
          - GPS Bricklet
          - Hall Effect Bricklet
          - Humidity Bricklet
          - Industrial Digital In 4 Bricklet
          - Industrial Digital Out 4 Bricklet
          - Industrial Dual 0-20mA Bricklet
          - Industrial Quad Relay Bricklet
          - IO-16 Bricklet
          - IO-4 Bricklet
          - Joystick Bricklet
          - LCD 16x2 Bricklet
          - LCD 20x4 Bricklet
          - LED Strip Bricklet
          - Line Bricklet
          - Linear Poti Bricklet
          - Moisture Bricklet
          - Motion Detector Bricklet
          - Multi Touch Bricklet
          - NFC/RFID Bricklet
          - Piezo Buzzer Bricklet
          - Piezo Speaker Bricklet
          - PTC Bricklet
          - Remote Switch Bricklet
          - Rotary Encoder Bricklet
          - Rotary Poti Bricklet
          - Segment Display 4x7 Bricklet
          - Solid State Relay Bricklet
          - Sound Intensity Bricklet
          - Temperature Bricklet
          - Temperature IR Bricklet
          - Tilt Bricklet
          - Voltage Bricklet
          - Voltage/Current Bricklet
    - Visual Basic .NET
  - Firmwares and Plugins
  - Device Identifier
  - Source Code and Bug Tracking
  - Programming Interface
- Starter Kits
  - Weather Station
  - Hardware Hacking
  - Server Room Monitoring
  - Blinkenlights
  - Internet of Things
  - Camera Slider
- Embedded Boards
  - Raspberry Pi
- Specifications
  - Technical Data
  - TCP/IP Protocol
  - Modbus Protocol
  - Wireshark Dissector

# Shell - Current25 Bricklet

This is the description of the Shell API bindings for the Current25 Bricklet. General information and technical specifications for the Current25 Bricklet are summarized in its hardware description.

An installation guide for the Shell API bindings is part of their general description.

## Examples

The example code below is Public Domain (CC0 1.0).

### Simple

Download (example-simple.sh)

    1
    2
    3
    4
    5
    6
    7
    8

    #!/bin/sh
    # connects to localhost:4223 by default, use --host and --port to change it

    # change to your UID
    uid=XYZ

    # get current current (unit is mA)
    tinkerforge call current25-bricklet $uid get-current

### Callback

Download (example-callback.sh)

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13

    #!/bin/sh
    # connects to localhost:4223 by default, use --host and --port to change it

    # change to your UID
    uid=XYZ

    # set period for current callback to 1s (1000ms)
    # note: the current callback is only called every second if the
    #       current has changed since the last call!
    tinkerforge call current25-bricklet $uid set-current-callback-period 1000

    # handle incoming current callbacks (unit is mA)
    tinkerforge dispatch current25-bricklet $uid current

### Threshold

Download (example-threshold.sh)

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15

    #!/bin/sh
    # connects to localhost:4223 by default, use --host and --port to change it

    # change to your UID
    uid=XYZ

    # get threshold callbacks with a debounce time of 10 seconds (10000ms)
    tinkerforge call current25-bricklet $uid set-debounce-period 10000

    # configure threshold for "greater than 5A" (unit is mA)
    tinkerforge call current25-bricklet $uid set-current-callback-threshold greater 5000 0

    # handle incoming current-reached callbacks (unit is mA)
    tinkerforge dispatch current25-bricklet $uid current-reached\
     --execute "echo Current is greater than 5A: {current} mA"

## 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 here. The specific command structure is shown below.

tinkerforge `call` `current25-bricklet` [<option>..] <uid> <function> [<argument>..]

  Parameters:

  - <uid> -- string
  - <function> -- string

  The `call` command is used to call a function of the Current25 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 Current25 Bricklet and exits

tinkerforge `dispatch` `current25-bricklet` [<option>..] <uid> <callback>

  Parameters:

  - <uid> -- string
  - <callback> -- string

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

tinkerforge call `current25-bricklet` <uid> `<function>` [<option>..] [<argument>..]

  Parameters:

  - <uid> -- string
  - <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 output formatting 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.

tinkerforge dispatch `current25-bricklet` <uid> `<callback>` [<option>..]

  Parameters:

  - <uid> -- string
  - <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 output formatting for details)

### Basic Functions

tinkerforge call `current25-bricklet` <uid> `get-current`

  Output:

  - current -- int

  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 `current` and set the period with `set-current-callback-period`.

### Advanced Functions

tinkerforge call `current25-bricklet` <uid> `calibrate`

  Output: | no output

  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.

tinkerforge call `current25-bricklet` <uid> `is-over-current`

  Output:

  - over -- bool

  Returns true if more than 25A were measured.

  Note

  To reset this value you have to power cycle the Bricklet.

tinkerforge call `current25-bricklet` <uid> `get-analog-value`

  Output:

  - value -- int

  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 `get-current` is averaged over several samples to yield less noise, while `get-analog-value` gives back raw unfiltered analog values. The only reason to use `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 `analog-value` and set the period with `set-analog-value-callback-period`.

tinkerforge call `current25-bricklet` <uid> `get-identity`

  Output:

  - uid -- string
  - connected-uid -- string
  - position -- char
  - hardware-version -- int,int,int
  - firmware-version -- int,int,int
  - 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 here.

### Callback Configuration Functions

tinkerforge call `current25-bricklet` <uid> `set-current-callback-period` <period>

  Parameters:

  - <period> -- int

  Output: | no output

  Sets the period in ms with which the `current` callback is triggered periodically. A value of 0 turns the callback off.

  `current` is only triggered if the current has changed since the last triggering.

  The default value is 0.

tinkerforge call `current25-bricklet` <uid> `get-current-callback-period`

  Output:

  - period -- int

  Returns the period as set by `set-current-callback-period`.

tinkerforge call `current25-bricklet` <uid> `set-analog-value-callback-period` <period>

  Parameters:

  - <period> -- int

  Output: | no output

  Sets the period in ms with which the `analog-value` callback is triggered periodically. A value of 0 turns the callback off.

  `analog-value` is only triggered if the analog value has changed since the last triggering.

  The default value is 0.

tinkerforge call `current25-bricklet` <uid> `get-analog-value-callback-period`

  Output:

  - period -- int

  Returns the period as set by `set-analog-value-callback-period`.

tinkerforge call `current25-bricklet` <uid> `set-current-callback-threshold` <option> <min> <max>

  Parameters:

  - <option> -- char (has symbols)
  - <min> -- int
  - <max> -- int

  Output: | no output

  Sets the thresholds for the `current-reached` callback.

  The following options are possible:

  Option | Description
  --- | ---
  '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>

tinkerforge call `current25-bricklet` <uid> `get-current-callback-threshold`

  Output:

  - option -- char (has symbols)
  - min -- int
  - max -- int

  Returns the threshold as set by `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

tinkerforge call `current25-bricklet` <uid> `set-analog-value-callback-threshold` <option> <min> <max>

  Parameters:

  - <option> -- char (has symbols)
  - <min> -- int
  - <max> -- int

  Output: | no output

  Sets the thresholds for the `analog-value-reached` callback.

  The following options are possible:

  Option | Description
  --- | ---
  '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).

  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>

tinkerforge call `current25-bricklet` <uid> `get-analog-value-callback-threshold`

  Output:

  - option -- char (has symbols)
  - min -- int
  - max -- int

  Returns the threshold as set by `set-analog-value-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

tinkerforge call `current25-bricklet` <uid> `set-debounce-period` <debounce>

  Parameters:

  - <debounce> -- int

  Output: | no output

  Sets the period in ms with which the threshold callbacks

  - `current-reached`,
  - `analog-value-reached`

  are triggered, if the thresholds

  - `set-current-callback-threshold`,
  - `set-analog-value-callback-threshold`

  keep being reached.

  The default value is 100.

tinkerforge call `current25-bricklet` <uid> `get-debounce-period`

  Output:

  - debounce -- int

  Returns the debounce period as set by `set-debounce-period`.

### Callbacks

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

    tinkerforge dispatch current25-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.

tinkerforge dispatch `current25-bricklet` <uid> `current`

  Output:

  - current -- int

  This callback is triggered periodically with the period that is set by `set-current-callback-period`. The parameter is the current of the sensor.

  `current` is only triggered if the current has changed since the last triggering.

tinkerforge dispatch `current25-bricklet` <uid> `analog-value`

  Output:

  - value -- int

  This callback is triggered periodically with the period that is set by `set-analog-value-callback-period`. The parameter is the analog value of the sensor.

  `analog-value` is only triggered if the current has changed since the last triggering.

tinkerforge dispatch `current25-bricklet` <uid> `current-reached`

  Output:

  - current -- int

  This callback is triggered when the threshold as set by `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 `set-debounce-period`.

tinkerforge dispatch `current25-bricklet` <uid> `analog-value-reached`

  Output:

  - value -- int

  This callback is triggered when the threshold as set by `set-analog-value-callback-threshold` is reached. The parameter is the analog value of the sensor.

  If the threshold keeps being reached, the callback is triggered periodically with the period as set by `set-debounce-period`.

tinkerforge dispatch `current25-bricklet` <uid> `over-current`

  Output: | no output

  This callback is triggered when an over current is measured (see `is-over-current`).

The content of this page is licensed under Creative Commons Attribution 3.0 Unported License.