Shell - Tilt Bricklet

This is the description of the Shell API bindings for the Tilt Bricklet. General information and technical specifications for the Tilt 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
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Tilt Bricklet

# Get current tilt state
tinkerforge call tilt-bricklet $uid get-tilt-state

Callback

Download (example-callback.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 this

uid=XYZ # Change XYZ to the UID of your Tilt Bricklet

# Enable tilt state callback
tinkerforge call tilt-bricklet $uid enable-tilt-state-callback

# Handle incoming tilt state callbacks
tinkerforge dispatch tilt-bricklet $uid tilt-state &

echo "Press key to exit"; read dummy

kill -- -$$ # Stop callback dispatch in background

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 tilt-bricklet [<option>..] <uid> <function> [<argument>..]
Parameters:
  • <uid> -- string
  • <function> -- string

The call command is used to call a function of the Tilt 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 Tilt Bricklet and exits
tinkerforge dispatch tilt-bricklet [<option>..] <uid> <callback>
Parameters:
  • <uid> -- string
  • <callback> -- string

The dispatch command is used to dispatch a callback of the Tilt 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 Tilt Bricklet and exits
tinkerforge call tilt-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 tilt-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 tilt-bricklet <uid> get-tilt-state
Output:
  • state -- int (has symbols)

Returns the current tilt state. The state can either be

  • 0 = Closed: The ball in the tilt switch closes the circuit.
  • 1 = Open: The ball in the tilt switch does not close the circuit.
  • 2 = Closed Vibrating: The tilt switch is in motion (rapid change between open and close).
Tilt states

The following symbols are available for this function:

  • tilt-state-closed = 0, for state
  • tilt-state-open = 1, for state
  • tilt-state-closed-vibrating = 2, for state

Advanced Functions

tinkerforge call tilt-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 tilt-bricklet <uid> enable-tilt-state-callback
Output:no output

Enables the tilt-state callback.

tinkerforge call tilt-bricklet <uid> disable-tilt-state-callback
Output:no output

Disables the tilt-state callback.

tinkerforge call tilt-bricklet <uid> is-tilt-state-callback-enabled
Output:
  • enabled -- bool

Returns true if the tilt-state callback is enabled.

Callbacks

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

tinkerforge dispatch tilt-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 tilt-bricklet <uid> tilt-state
Output:
  • state -- int (has symbols)

This callback provides the current tilt state. It is called every time the state changes.

See get-tilt-state for a description of the states.

The following symbols are available for this function:

  • tilt-state-closed = 0, for state
  • tilt-state-open = 1, for state
  • tilt-state-closed-vibrating = 2, for state