Shell - Sound Intensity 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
          - Remote Switch Bricklet
          - Rotary Encoder Bricklet
          - Rotary Poti Bricklet
          - Segment Display 4x7 Bricklet
          - Solid State Relay Bricklet
          - Sound Intensity Bricklet
            - Examples
              - Simple
              - Callback
              - Threshold
            - API
              - Command Structure
              - Basic Functions
              - Advanced Functions
              - Callback Configuration Functions
              - Callbacks
          - 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 - Sound Intensity Bricklet

This is the description of the Shell API bindings for the Sound Intensity Bricklet. General information and technical specifications for the Sound Intensity 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 intensity
    tinkerforge call sound-intensity-bricklet $uid get-intensity

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

    # handle incoming intensity callbacks
    tinkerforge dispatch sound-intensity-bricklet $uid intensity

### Threshold

Download (example-threshold.sh)

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

    #!/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 1 seconds (1000ms)
    tinkerforge call sound-intensity-bricklet $uid set-debounce-period 1000

    # configure threshold for "greater than 2000"
    tinkerforge call sound-intensity-bricklet $uid set-intensity-callback-threshold greater 2000 0

    # handle incoming intensity-reached callbacks
    tinkerforge dispatch sound-intensity-bricklet $uid intensity-reached

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

  Parameters:

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

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

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

  Parameters:

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

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

tinkerforge call `sound-intensity-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 `sound-intensity-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 `sound-intensity-bricklet` <uid> `get-intensity`

  Output:

  - intensity -- int

  Returns the current sound intensity. The value has a range of 0 to 4095.

  The value corresponds to the upper envelop of the signal of the microphone capsule.

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

### Advanced Functions

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

  Parameters:

  - <period> -- int

  Output: | no output

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

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

  The default value is 0.

tinkerforge call `sound-intensity-bricklet` <uid> `get-intensity-callback-period`

  Output:

  - period -- int

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

tinkerforge call `sound-intensity-bricklet` <uid> `set-intensity-callback-threshold` <option> <min> <max>

  Parameters:

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

  Output: | no output

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

  The following options are possible:

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

  Output:

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

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

  Parameters:

  - <debounce> -- int

  Output: | no output

  Sets the period in ms with which the threshold callback

  - `intensity-reached`

  is triggered, if the thresholds

  - `set-intensity-callback-threshold`

  keeps being reached.

  The default value is 100.

tinkerforge call `sound-intensity-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 sound-intensity-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 `sound-intensity-bricklet` <uid> `intensity`

  Output:

  - intensity -- int

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

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

tinkerforge dispatch `sound-intensity-bricklet` <uid> `intensity-reached`

  Output:

  - intensity -- int

  This callback is triggered when the threshold as set by `set-intensity-callback-threshold` is reached. The parameter is the intensity of the encoder.

  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.