Shell - Industrial Digital In 4 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
          - Distance IR Bricklet
          - Distance US Bricklet
          - Dual Button Bricklet
          - Dual Relay Bricklet
          - GPS Bricklet
          - Hall Effect Bricklet
          - Humidity Bricklet
          - Industrial Digital In 4 Bricklet
            - Examples
              - Simple
              - Interrupt
            - API
              - Command Structure
              - Basic Functions
              - Advanced Functions
              - Callback Configuration Functions
              - Callbacks
          - 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 - Industrial Digital In 4 Bricklet

This is the description of the Shell API bindings for the Industrial Digital In 4 Bricklet. General information and technical specifications for the Industrial Digital In 4 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 input status
    tinkerforge call industrial-digital-in-4-bricklet $uid get-value

### Interrupt

Download (example-interrupt.sh)

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11

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

    # change to your UID
    uid=XYZ

    # enable interrupt on pin 0
    tinkerforge call industrial-digital-in-4-bricklet $uid set-interrupt 1

    # handle incoming interrupt callbacks
    tinkerforge dispatch industrial-digital-in-4-bricklet $uid interrupt

## 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` `industrial-digital-in-4-bricklet` [<option>..] <uid> <function> [<argument>..]

  Parameters:

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

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

tinkerforge `dispatch` `industrial-digital-in-4-bricklet` [<option>..] <uid> <callback>

  Parameters:

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

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

tinkerforge call `industrial-digital-in-4-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 `industrial-digital-in-4-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 `industrial-digital-in-4-bricklet` <uid> `get-value`

  Output:

  - value-mask -- int

  Returns the input value with a bitmask. The bitmask is 16bit long, true refers to high and false refers to low.

  For example: The value 3 or 0b0011 means that pins 0-1 are high and the other pins are low.

  If no groups are used (see `set-group`), the pins correspond to the markings on the Digital In 4 Bricklet.

  If groups are used, the pins correspond to the element in the group. Element 1 in the group will get pins 0-3, element 2 pins 4-7, element 3 pins 8-11 and element 4 pins 12-15.

tinkerforge call `industrial-digital-in-4-bricklet` <uid> `get-edge-count` <pin> <reset-counter>

  Parameters:

  - <pin> -- int
  - <reset-counter> -- bool

  Output:

  - count -- int

  Returns the current value of the edge counter for the selected pin. You can configure the edges that are counted with `set-edge-count-config`.

  If you set the reset counter to true, the count is set back to 0 directly after it is read.

  New in version 2.0.1 (Plugin).

### Advanced Functions

tinkerforge call `industrial-digital-in-4-bricklet` <uid> `set-group` <group>

  Parameters:

  - <group> -- char,char,char,char

  Output: | no output

  Sets a group of Digital In 4 Bricklets that should work together. You can find Bricklets that can be grouped together with `get-available-for-group`.

  The group consists of 4 elements. Element 1 in the group will get pins 0-3, element 2 pins 4-7, element 3 pins 8-11 and element 4 pins 12-15.

  Each element can either be one of the ports ('a' to 'd') or 'n' if it should not be used.

  For example: If you have two Digital In 4 Bricklets connected to port A and port B respectively, you could call with `['a', 'b', 'n', 'n']`.

  Now the pins on the Digital In 4 on port A are assigned to 0-3 and the pins on the Digital In 4 on port B are assigned to 4-7. It is now possible to call `get-value` and read out two Bricklets at the same time.

  Changing the group configuration resets all edge counter configurations and values.

tinkerforge call `industrial-digital-in-4-bricklet` <uid> `get-group`

  Output:

  - group -- char,char,char,char

  Returns the group as set by `set-group`

tinkerforge call `industrial-digital-in-4-bricklet` <uid> `get-available-for-group`

  Output:

  - available -- int

  Returns a bitmask of ports that are available for grouping. For example the value 5 or 0b0101 means: Port A and port C are connected to Bricklets that can be grouped together.

tinkerforge call `industrial-digital-in-4-bricklet` <uid> `set-edge-count-config` <selection-mask> <edge-type> <debounce>

  Parameters:

  - <selection-mask> -- int
  - <edge-type> -- int (has symbols)
  - <debounce> -- int

  Output: | no output

  Configures the edge counter for the selected pins. A bitmask of 9 or 0b1001 will enable the edge counter for pins 0 and 3.

  The edge type parameter configures if rising edges, falling edges or both are counted if the pin is configured for input. Possible edge types are:

  - 0 = rising (default)
  - 1 = falling
  - 2 = both

  The debounce time is given in ms.

  Configuring an edge counter resets its value to 0.

  If you don't know what any of this means, just leave it at default. The default configuration is very likely OK for you.

  Default values: 0 (edge type) and 100ms (debounce time)

  The following symbols are available for this function:

  - `rising` = 0, for <edge-type>
  - `falling` = 1, for <edge-type>
  - `both` = 2, for <edge-type>

  New in version 2.0.1 (Plugin).

tinkerforge call `industrial-digital-in-4-bricklet` <uid> `get-edge-count-config` <pin>

  Parameters:

  - <pin> -- int

  Output:

  - edge-type -- int (has symbols)
  - debounce -- int

  Returns the edge type and debounce time for the selected pin as set by `set-edge-count-config`.

  The following symbols are available for this function:

  - `rising` = 0, for edge-type
  - `falling` = 1, for edge-type
  - `both` = 2, for edge-type

  New in version 2.0.1 (Plugin).

tinkerforge call `industrial-digital-in-4-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 `industrial-digital-in-4-bricklet` <uid> `set-debounce-period` <debounce>

  Parameters:

  - <debounce> -- int

  Output: | no output

  Sets the debounce period of the `interrupt` callback in ms.

  For example: If you set this value to 100, you will get the interrupt maximal every 100ms. This is necessary if something that bounces is connected to the Digital In 4 Bricklet, such as a button.

  The default value is 100.

tinkerforge call `industrial-digital-in-4-bricklet` <uid> `get-debounce-period`

  Output:

  - debounce -- int

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

tinkerforge call `industrial-digital-in-4-bricklet` <uid> `set-interrupt` <interrupt-mask>

  Parameters:

  - <interrupt-mask> -- int

  Output: | no output

  Sets the pins on which an interrupt is activated with a bitmask. Interrupts are triggered on changes of the voltage level of the pin, i.e. changes from high to low and low to high.

  For example: An interrupt bitmask of 9 or 0b1001 will enable the interrupt for pins 0 and 3.

  The interrupts use the grouping as set by `set-group`.

  The interrupt is delivered with the callback `interrupt`.

tinkerforge call `industrial-digital-in-4-bricklet` <uid> `get-interrupt`

  Output:

  - interrupt-mask -- int

  Returns the interrupt bitmask as set by `set-interrupt`.

### Callbacks

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

    tinkerforge dispatch industrial-digital-in-4-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 `industrial-digital-in-4-bricklet` <uid> `interrupt`

  Output:

  - interrupt-mask -- int
  - value-mask -- int

  This callback is triggered whenever a change of the voltage level is detected on pins where the interrupt was activated with `set-interrupt`.

  The values are a bitmask that specifies which interrupts occurred and the current value bitmask.

  For example:

  - (1, 1) or (0b0001, 0b0001) means that an interrupt on pin 0 occurred and currently pin 0 is high and pins 1-3 are low.
  - (9, 14) or (0b1001, 0b1110) means that interrupts on pins 0 and 3 occurred and currently pin 0 is low and pins 1-3 are high.

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