Note
This Bricklet is currently in the prototype stage and the software/hardware as well as the documentation is in an incomplete state.
This is the description of the Shell API bindings for the Accelerometer Bricklet. General information and technical specifications for the Accelerometer 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=sad
# get current acceleration
tinkerforge call accelerometer-bricklet $uid get-acceleration
|
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=sad
# set period for acceleration callback to 1s (1000ms)
# note: the acceleration callback is only called every second if the
# acceleration has changed since the last call!
tinkerforge call accelerometer-bricklet $uid set-acceleration-callback-period 1000
# handle incoming acceleration callbacks
tinkerforge dispatch accelerometer-bricklet $uid acceleration
|
Download (example-threshold.sh)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | #!/bin/sh
# connects to localhost:4223 by default, use --host and --port to change it
# change to your UID
uid=sad
# get threshold callbacks with a debounce time of 10 seconds (10000ms)
tinkerforge call accelerometer-bricklet $uid set-debounce-period 10000
# Configure threshold for acceleration values X, Y or Z greater than 2G
tinkerforge call accelerometer-bricklet $uid set-acceleration-callback-threshold greater 2000 0 2000 0 2000 0
# handle incoming acceleration-reached callbacks
tinkerforge dispatch accelerometer-bricklet $uid acceleration-reached\
--execute "echo 'Acceleration(X): {x}';
echo 'Acceleration(Y): {y}';
echo 'Acceleration(Z): {z}';
echo '';"
|
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 Accelerometer Bricklet. It can take several options:
Parameters: |
|
---|
The dispatch command is used to dispatch a callback of the Accelerometer 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 acceleration in x, y and z direction. The values are given in mG (1/1000 G).
If you want to get the acceleration periodically, it is recommended to use the callback acceleration and set the period with set-acceleration-callback-period.
Output: |
|
---|
Returns the temperature of the accelerometer in °C.
Output: | no output |
---|
Enables the LED on the Bricklet.
Output: | no output |
---|
Disables the LED on the Bricklet.
Output: |
|
---|
Returns true if the LED is enabled, false otherwise.
Parameters: |
|
---|---|
Output: | no output |
Configures the data rate, full scale range and filter bandwidth. Possible values are:
Decreasing data rate or full scale range will also decrease the noise on the data.
The default values are 100Hz data rate, -4G to +4G range and 200Hz filter bandwidth.
The following symbols are available for this function:
Output: |
|
---|
Returns the configuration as set by set-configuration.
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.
Parameters: |
|
---|---|
Output: | no output |
Sets the period in ms with which the acceleration callback is triggered periodically. A value of 0 turns the callback off.
acceleration is only triggered if the acceleration has changed since the last triggering.
The default value is 0.
Output: |
|
---|
Returns the period as set by set-acceleration-callback-period.
Parameters: |
|
---|---|
Output: | no output |
Sets the thresholds for the acceleration-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, 0, 0, 0, 0).
The following symbols are available for this function:
Output: |
|
---|
Returns the threshold as set by set-acceleration-callback-threshold.
The following symbols are available for this function:
Parameters: |
|
---|---|
Output: | no output |
Sets the period in ms with which the threshold callback
is triggered, if the threshold
keeps being reached.
The default value is 100.
Output: |
|
---|
Returns the debounce period as set by set-debounce-period.
Callbacks can be used to receive time critical or recurring data from the device:
tinkerforge dispatch accelerometer-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 is triggered periodically with the period that is set by set-acceleration-callback-period. The parameters are the X, Y and Z acceleration.
acceleration is only triggered if the acceleration has changed since the last triggering.
Output: |
|
---|
This callback is triggered when the threshold as set by set-acceleration-callback-threshold is reached. The parameters are the X, Y and Z acceleration.
If the threshold keeps being reached, the callback is triggered periodically with the period as set by set-debounce-period.