Shell - Motion Detector Bricklet 2.0¶

Indicator¶

Download (example-indicator.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 Motion Detector Bricklet 2.0

# Turn blue backlight LEDs on (maximum brightness)
tinkerforge call motion-detector-v2-bricklet $uid set-indicator 255 255 255

Callback¶

Download (example-callback.sh)

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

#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Motion Detector Bricklet 2.0

# Handle incoming motion detected callbacks
tinkerforge dispatch motion-detector-v2-bricklet $uid motion-detected\
 --execute "echo Motion Detected" &

# Handle incoming detection cycle ended callbacks
tinkerforge dispatch motion-detector-v2-bricklet $uid detection-cycle-ended\
 --execute "echo Detection Cycle Ended (next detection possible in ~2 seconds)" &

echo "Press key to exit"; read dummy

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

Command Structure¶

The common options of the call and dispatch commands are documented here. The specific command structure is shown below.

tinkerforge call motion-detector-v2-bricklet [<option>..] <uid> <function> [<argument>..]¶

Parameters:	<uid> -- string <function> -- string

The call command is used to call a function of the Motion Detector Bricklet 2.0. 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 Motion Detector Bricklet 2.0 and exits

tinkerforge dispatch motion-detector-v2-bricklet [<option>..] <uid> <callback>¶

Parameters:	<uid> -- string <callback> -- string

The dispatch command is used to dispatch a callback of the Motion Detector Bricklet 2.0. 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 Motion Detector Bricklet 2.0 and exits

tinkerforge call motion-detector-v2-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 motion-detector-v2-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 motion-detector-v2-bricklet <uid> get-motion-detected¶

Output:	motion -- int (has symbols)

Returns 1 if a motion was detected. It returns 1 approx. for 1.8 seconds until the sensor checks for a new movement.

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:

• motion-not-detected = 0, for motion
• motion-detected = 1, for motion

tinkerforge call motion-detector-v2-bricklet <uid> set-sensitivity <sensitivity>¶

Parameters:	<sensitivity> -- int
Output:	no output

Sets the sensitivity of the PIR sensor. The range is 0-100. At full sensitivity (100), the Bricklet can detect motion in a range of approximately 12m.

The actual range depends on many things in the environment (e.g. reflections) and the size of the object to be detected. While a big person might be detected in a range of 10m a cat may only be detected at 2m distance with the same setting.

So you will have to find a good sensitivity for your application by trial and error.

The default value is 50.

tinkerforge call motion-detector-v2-bricklet <uid> get-sensitivity¶

Output:	sensitivity -- int

Returns the sensitivity as set by set-sensitivity.

tinkerforge call motion-detector-v2-bricklet <uid> set-indicator <top-left> <top-right> <bottom>¶

Parameters:	<top-left> -- int <top-right> -- int <bottom> -- int
Output:	no output

Sets the blue backlight of the fresnel lens. The backlight consists of three LEDs. The brightness of each LED can be controlled with a 8-bit value (0-255). A value of 0 turns the LED off and a value of 255 turns the LED to full brightness.

The default value is 0, 0, 0.

tinkerforge call motion-detector-v2-bricklet <uid> get-indicator¶

Output:	top-left -- int top-right -- int bottom -- int

Returns the indicator configuration as set by set-indicator.

Advanced Functions¶

tinkerforge call motion-detector-v2-bricklet <uid> get-spitfp-error-count¶

Output:	error-count-ack-checksum -- int error-count-message-checksum -- int error-count-frame -- int error-count-overflow -- int

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

• ACK checksum errors,
• message checksum errors,
• framing errors and
• overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

tinkerforge call motion-detector-v2-bricklet <uid> set-bootloader-mode <mode>¶

Parameters:	<mode> -- int (has symbols)
Output:	status -- int (has symbols)

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following symbols are available for this function:

• bootloader-mode-bootloader = 0, for <mode>
• bootloader-mode-firmware = 1, for <mode>
• bootloader-mode-bootloader-wait-for-reboot = 2, for <mode>
• bootloader-mode-firmware-wait-for-reboot = 3, for <mode>
• bootloader-mode-firmware-wait-for-erase-and-reboot = 4, for <mode>
• bootloader-status-ok = 0, for status
• bootloader-status-invalid-mode = 1, for status
• bootloader-status-no-change = 2, for status
• bootloader-status-entry-function-not-present = 3, for status
• bootloader-status-device-identifier-incorrect = 4, for status
• bootloader-status-crc-mismatch = 5, for status

tinkerforge call motion-detector-v2-bricklet <uid> get-bootloader-mode¶

Output:	mode -- int (has symbols)

Returns the current bootloader mode, see set-bootloader-mode.

The following symbols are available for this function:

• bootloader-mode-bootloader = 0, for mode
• bootloader-mode-firmware = 1, for mode
• bootloader-mode-bootloader-wait-for-reboot = 2, for mode
• bootloader-mode-firmware-wait-for-reboot = 3, for mode
• bootloader-mode-firmware-wait-for-erase-and-reboot = 4, for mode

tinkerforge call motion-detector-v2-bricklet <uid> set-write-firmware-pointer <pointer>¶

Parameters:	<pointer> -- int
Output:	no output

Sets the firmware pointer for write-firmware. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

tinkerforge call motion-detector-v2-bricklet <uid> write-firmware <data>¶

Parameters:	<data> -- int,int,..61x..,int
Output:	status -- int

Writes 64 Bytes of firmware at the position as written by set-write-firmware-pointer before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

tinkerforge call motion-detector-v2-bricklet <uid> set-status-led-config <config>¶

Parameters:	<config> -- int (has symbols)
Output:	no output

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following symbols are available for this function:

• status-led-config-off = 0, for <config>
• status-led-config-on = 1, for <config>
• status-led-config-show-heartbeat = 2, for <config>
• status-led-config-show-status = 3, for <config>

tinkerforge call motion-detector-v2-bricklet <uid> get-status-led-config¶

Output:	config -- int (has symbols)

Returns the configuration as set by set-status-led-config

The following symbols are available for this function:

• status-led-config-off = 0, for config
• status-led-config-on = 1, for config
• status-led-config-show-heartbeat = 2, for config
• status-led-config-show-status = 3, for config

tinkerforge call motion-detector-v2-bricklet <uid> get-chip-temperature¶

Output:	temperature -- int

Returns the temperature in °C as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

tinkerforge call motion-detector-v2-bricklet <uid> reset¶

Output:	no output

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

tinkerforge call motion-detector-v2-bricklet <uid> write-uid <uid>¶

Parameters:	<uid> -- int
Output:	no output

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

tinkerforge call motion-detector-v2-bricklet <uid> read-uid¶

Output:	uid -- int

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

tinkerforge call motion-detector-v2-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. 

Callbacks¶

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

tinkerforge dispatch motion-detector-v2-bricklet <uid> example

The available callbacks are described below.

tinkerforge dispatch motion-detector-v2-bricklet <uid> motion-detected¶

Output:	no output

This callback is called after a motion was detected.

tinkerforge dispatch motion-detector-v2-bricklet <uid> detection-cycle-ended¶

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.