Shell - PTC 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
          - 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
            - Examples
              - Simple
              - Callback
              - Threshold
            - API
              - Command Structure
              - Basic Functions
              - Advanced Functions
              - Callback Configuration Functions
              - Callbacks
          - 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 - PTC Bricklet

This is the description of the Shell API bindings for the PTC Bricklet. General information and technical specifications for the PTC 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 temperature (unit is °C/100)
    tinkerforge call ptc-bricklet $uid get-temperature

### 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 temperature callback to 1s (1000ms)
    # note: the temperature callback is only called every second if the
    #       temperature has changed since the last call!
    tinkerforge call ptc-bricklet $uid set-temperature-callback-period 1000

    # handle incoming temperature callbacks (unit is °C/100)
    tinkerforge dispatch ptc-bricklet $uid temperature

### 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 ptc-bricklet $uid set-debounce-period 10000

    # configure threshold for "greater than 30 °C" (unit is °C/100)
    tinkerforge call ptc-bricklet $uid set-temperature-callback-threshold greater 3000 0

    # handle incoming temperature-reached callbacks (unit is °C/100)
    tinkerforge dispatch ptc-bricklet $uid temperature-reached\
     --execute "echo We have {temperature} °C/100. It is too hot, we need air conditioning!"

## 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` `ptc-bricklet` [<option>..] <uid> <function> [<argument>..]

  Parameters:

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

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

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

  Parameters:

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

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

tinkerforge call `ptc-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 `ptc-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 `ptc-bricklet` <uid> `get-temperature`

  Output:

  - temperature -- int

  Returns the temperature of connected sensor. The value has a range of -246 to 849 °C and is given in °C/100, e.g. a value of 4223 means that a temperature of 42.23 °C is measured.

  If you want to get the temperature periodically, it is recommended to use the callback `temperature` and set the period with `set-temperature-callback-period`.

tinkerforge call `ptc-bricklet` <uid> `is-sensor-connected`

  Output:

  - connected -- bool

  Returns true if the sensor is connected correctly.

  If this function returns false, there is either no Pt100 or Pt1000 sensor connected, the sensor is connected incorrectly or the sensor itself is faulty.

tinkerforge call `ptc-bricklet` <uid> `set-wire-mode` <mode>

  Parameters:

  - <mode> -- int (has symbols)

  Output: | no output

  Sets the wire mode of the sensor. Possible values are 2, 3 and 4 which correspond to 2-, 3- and 4-wire sensors. The value has to match the jumper configuration on the Bricklet.

  The default value is 2 = 2-wire.

  The following symbols are available for this function:

  - `2` = 2, for <mode>
  - `3` = 3, for <mode>
  - `4` = 4, for <mode>

tinkerforge call `ptc-bricklet` <uid> `get-wire-mode`

  Output:

  - mode -- int (has symbols)

  Returns the wire mode as set by `set-wire-mode`

  The following symbols are available for this function:

  - `2` = 2, for mode
  - `3` = 3, for mode
  - `4` = 4, for mode

### Advanced Functions

tinkerforge call `ptc-bricklet` <uid> `get-resistance`

  Output:

  - resistance -- int

  Returns the value as measured by the MAX31865 precision delta-sigma ADC.

  The value can be converted with the following formulas:

  - Pt100: resistance = (value * 390) / 32768
  - Pt1000: resistance = (value * 3900) / 32768

  If you want to get the resistance periodically, it is recommended to use the callback `resistance` and set the period with `set-resistance-callback-period`.

tinkerforge call `ptc-bricklet` <uid> `set-noise-rejection-filter` <filter>

  Parameters:

  - <filter> -- int (has symbols)

  Output: | no output

  Sets the noise rejection filter to either 50Hz (0) or 60Hz (1). Noise from 50Hz or 60Hz power sources (including harmonics of the AC power's fundamental frequency) is attenuated by 82dB.

  Default value is 0 = 50Hz.

  The following symbols are available for this function:

  - `50hz` = 0, for <filter>
  - `60hz` = 1, for <filter>

tinkerforge call `ptc-bricklet` <uid> `get-noise-rejection-filter`

  Output:

  - filter -- int (has symbols)

  Returns the noise rejection filter option as set by `set-noise-rejection-filter`

  The following symbols are available for this function:

  - `50hz` = 0, for filter
  - `60hz` = 1, for filter

tinkerforge call `ptc-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 `ptc-bricklet` <uid> `set-temperature-callback-period` <period>

  Parameters:

  - <period> -- int

  Output: | no output

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

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

  The default value is 0.

tinkerforge call `ptc-bricklet` <uid> `get-temperature-callback-period`

  Output:

  - period -- int

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

tinkerforge call `ptc-bricklet` <uid> `set-resistance-callback-period` <period>

  Parameters:

  - <period> -- int

  Output: | no output

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

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

  The default value is 0.

tinkerforge call `ptc-bricklet` <uid> `get-resistance-callback-period`

  Output:

  - period -- int

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

tinkerforge call `ptc-bricklet` <uid> `set-temperature-callback-threshold` <option> <min> <max>

  Parameters:

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

  Output: | no output

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

  The following options are possible:

  Option | Description
  --- | ---
  'x' | Callback is turned off
  'o' | Callback is triggered when the temperature is outside the min and max values
  'i' | Callback is triggered when the temperature is inside the min and max values
  '<' | Callback is triggered when the temperature is smaller than the min value (max is ignored)
  '>' | Callback is triggered when the temperature 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 `ptc-bricklet` <uid> `get-temperature-callback-threshold`

  Output:

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

  Returns the threshold as set by `set-temperature-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 `ptc-bricklet` <uid> `set-resistance-callback-threshold` <option> <min> <max>

  Parameters:

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

  Output: | no output

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

  The following options are possible:

  Option | Description
  --- | ---
  'x' | Callback is turned off
  'o' | Callback is triggered when the temperature is outside the min and max values
  'i' | Callback is triggered when the temperature is inside the min and max values
  '<' | Callback is triggered when the temperature is smaller than the min value (max is ignored)
  '>' | Callback is triggered when the temperature 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 `ptc-bricklet` <uid> `get-resistance-callback-threshold`

  Output:

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

  Returns the threshold as set by `set-resistance-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 `ptc-bricklet` <uid> `set-debounce-period` <debounce>

  Parameters:

  - <debounce> -- int

  Output: | no output

  Sets the period in ms with which the threshold callback

  - `temperature-reached`,
  - `resistance-reached`

  is triggered, if the threshold

  - `set-temperature-callback-threshold`,
  - `set-resistance-callback-threshold`

  keeps being reached.

  The default value is 100.

tinkerforge call `ptc-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 ptc-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 `ptc-bricklet` <uid> `temperature`

  Output:

  - temperature -- int

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

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

tinkerforge dispatch `ptc-bricklet` <uid> `temperature-reached`

  Output:

  - temperature -- int

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

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

tinkerforge dispatch `ptc-bricklet` <uid> `resistance`

  Output:

  - resistance -- int

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

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

tinkerforge dispatch `ptc-bricklet` <uid> `resistance-reached`

  Output:

  - resistance -- int

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

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

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