This is the description of the Shell API bindings for the Motion Detector Bricklet. General information and technical specifications for the Motion Detector 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).
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
# handle incoming detected motion and end of detection cycle callbacks
# note: this chaining of two dispatches assumes that a detected callback is
# always followed by a detection cycle ended callback
tinkerforge dispatch motion-detector-bricklet $uid motion-detected\
--execute "echo Motion Detected;
tinkerforge dispatch --duration exit-after-first motion-detector-bricklet $uid detection-cycle-ended\
--execute 'echo Detection Cycle Ended \(next detection possible in \~3 seconds\)'"
|
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 Motion Detector Bricklet. It can take several options:
Parameters: |
|
---|
The dispatch command is used to dispatch a callback of the Motion Detector 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 1 if a motion was detected. How long this returns 1 after a motion was detected can be adjusted with one of the small potentiometers on the Motion Detector Bricklet, see here.
There is also a blue LED on the Bricklet that is on as long as the Bricklet is in the "motion detected" state.
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.
Callbacks can be used to receive time critical or recurring data from the device:
tinkerforge dispatch motion-detector-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: | no output |
---|
This callback is called after a motion was detected.
Output: | no output |
---|
This callback is called when the detection cycle ended. When this callback is called, a new motion can be detected again after approximately 2 seconds.