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.
The example code below is Public Domain (CC0 1.0).
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 tilt state
tinkerforge call tilt-bricklet $uid get-tilt-state
|
Download (example-callback.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 tilt state callback
tinkerforge call tilt-bricklet $uid enable-tilt-state-callback
# handle incoming tilt state callbacks
tinkerforge dispatch tilt-bricklet $uid tilt-state
|
Possible exit codes for all tinkerforge commands are:
The common options of the call and dispatch commands are documented here. The specific command structure is shown below.
Parameters: |
|
---|
The call command is used to call a function of the Tilt Bricklet. It can take several options:
Parameters: |
|
---|
The dispatch command is used to dispatch a callback of the Tilt Bricklet. It can take several options:
Parameters: |
|
---|
The <function> to be called can take different options depending of its kind. All functions can take the following options:
Getter functions can take the following options:
Setter functions can take the following options:
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.
Parameters: |
|
---|
The <callback> to be dispatched can take several options:
Output: |
|
---|
Returns the current tilt state. The state can either be
The following symbols are available for this function:
Output: |
|
---|
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.
Output: | no output |
---|
Enables the tilt-state callback.
Output: | no output |
---|
Disables the tilt-state callback.
Output: |
|
---|
Returns true if the tilt-state callback is enabled.
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.
Output: |
|
---|
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: