Shell - Joystick Bricklet¶

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 Joystick Bricklet

# Get current position
tinkerforge call joystick-bricklet $uid get-position

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 Joystick Bricklet

# Handle incoming pressed callbacks
tinkerforge dispatch joystick-bricklet $uid pressed\
 --execute "echo Pressed" &

# Handle incoming released callbacks
tinkerforge dispatch joystick-bricklet $uid released\
 --execute "echo Released" &

echo "Press key to exit"; read dummy

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

Find Borders¶

Download (example-find-borders.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

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

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

# Get threshold callbacks with a debounce time of 0.2 seconds (200ms)
tinkerforge call joystick-bricklet $uid set-debounce-period 200

# Handle incoming position reached callbacks
tinkerforge dispatch joystick-bricklet $uid position-reached\
 --execute "if   [ {y} -eq 100 ];
            then echo Top;
            elif [ {y} -eq -100 ];
            then echo Bottom;
            fi;
            if   [ {x} -eq 100 ];
            then echo Right;
            elif [ {x} -eq -100 ];
            then echo Left;
            fi" &

# Configure threshold for position "outside of -99, -99 to 99, 99"
tinkerforge call joystick-bricklet $uid set-position-callback-threshold threshold-option-outside -99 99 -99 99

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 joystick-bricklet [<option>..] <uid> <function> [<argument>..]¶

Parameters:	<uid> – Type: String <function> – Type: String

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

tinkerforge dispatch joystick-bricklet [<option>..] <uid> <callback>¶

Parameters:	<uid> – Type: String <callback> – Type: String

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

tinkerforge call joystick-bricklet <uid> <function> [<option>..] [<argument>..]¶

Parameters:	<uid> – Type: String <function> – Type: 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 sent and errors are silently ignored, because they cannot be detected.

tinkerforge dispatch joystick-bricklet <uid> <callback> [<option>..]¶

Parameters:	<uid> – Type: String <callback> – Type: 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 joystick-bricklet <uid> get-position¶

Output:	x – Type: Int, Range: [-100 to 100] y – Type: Int, Range: [-100 to 100]

Returns the position of the joystick. The middle position of the joystick is x=0, y=0. The returned values are averaged and calibrated (see calibrate).

If you want to get the position periodically, it is recommended to use the position callback and set the period with set-position-callback-period.

tinkerforge call joystick-bricklet <uid> is-pressed¶

Output:	pressed – Type: Bool

Returns true if the button is pressed and false otherwise.

It is recommended to use the pressed and released callbacks to handle the button.

Advanced Functions¶

tinkerforge call joystick-bricklet <uid> get-analog-value¶

Output:	x – Type: Int, Range: [0 to 212 - 1] y – Type: Int, Range: [0 to 212 - 1]

Returns the values as read by a 12-bit analog-to-digital converter.

Note

The values returned by get-position are averaged over several samples to yield less noise, while get-analog-value gives back raw unfiltered analog values. The only reason to use get-analog-value is, if you need the full resolution of the analog-to-digital converter.

If you want the analog values periodically, it is recommended to use the analog-value callback and set the period with set-analog-value-callback-period.

tinkerforge call joystick-bricklet <uid> calibrate¶

Output:	no output

Calibrates the middle position of the joystick. If your Joystick Bricklet does not return x=0 and y=0 in the middle position, call this function while the joystick is standing still in the middle position.

The resulting calibration will be saved on the EEPROM of the Joystick Bricklet, thus you only have to calibrate it once.

tinkerforge call joystick-bricklet <uid> get-identity¶

Output:

uid – Type: String, Length: up to 8 connected-uid – Type: String, Length: up to 8 position – Type: Char, Range: [a to h, z] hardware-version – Type: Int Array, Length: 3 0: major – Type: Int, Range: [0 to 255] 1: minor – Type: Int, Range: [0 to 255] 2: revision – Type: Int, Range: [0 to 255] firmware-version – Type: Int Array, Length: 3 0: major – Type: Int, Range: [0 to 255] 1: minor – Type: Int, Range: [0 to 255] 2: revision – Type: Int, Range: [0 to 255] device-identifier – Type: Int, Range: [0 to 216 - 1]

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', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

The device identifier numbers can be found here. 

Callback Configuration Functions¶

tinkerforge call joystick-bricklet <uid> set-position-callback-period <period>¶

Parameters:	<period> – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Output:	no output

Sets the period with which the position callback is triggered periodically. A value of 0 turns the callback off.

The position callback is only triggered if the position has changed since the last triggering.

tinkerforge call joystick-bricklet <uid> get-position-callback-period¶

Output:	period – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by set-position-callback-period.

tinkerforge call joystick-bricklet <uid> set-analog-value-callback-period <period>¶

Parameters:	<period> – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Output:	no output

Sets the period with which the analog-value callback is triggered periodically. A value of 0 turns the callback off.

The analog-value callback is only triggered if the analog values have changed since the last triggering.

tinkerforge call joystick-bricklet <uid> get-analog-value-callback-period¶

Output:	period – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by set-analog-value-callback-period.

tinkerforge call joystick-bricklet <uid> set-position-callback-threshold <option> <min-x> <max-x> <min-y> <max-y>¶

Parameters:	<option> – Type: Char, Range: See symbols, Default: x <min-x> – Type: Int, Range: [-215 to 215 - 1], Default: 0 <max-x> – Type: Int, Range: [-215 to 215 - 1], Default: 0 <min-y> – Type: Int, Range: [-215 to 215 - 1], Default: 0 <max-y> – Type: Int, Range: [-215 to 215 - 1], Default: 0
Output:	no output

Sets the thresholds for the position-reached callback.

The following options are possible:

Option	Description
'x'	Callback is turned off
'o'	Callback is triggered when the position is outside the min and max values
'i'	Callback is triggered when the position is inside the min and max values
'<'	Callback is triggered when the position is smaller than the min values (max is ignored)
'>'	Callback is triggered when the position is greater than the min values (max is ignored)

The following symbols are available for this function:

For <option>:

• threshold-option-off = x
• threshold-option-outside = o
• threshold-option-inside = i
• threshold-option-smaller = <
• threshold-option-greater = >

tinkerforge call joystick-bricklet <uid> get-position-callback-threshold¶

Output:	option – Type: Char, Range: See symbols, Default: x min-x – Type: Int, Range: [-215 to 215 - 1], Default: 0 max-x – Type: Int, Range: [-215 to 215 - 1], Default: 0 min-y – Type: Int, Range: [-215 to 215 - 1], Default: 0 max-y – Type: Int, Range: [-215 to 215 - 1], Default: 0

Returns the threshold as set by set-position-callback-threshold.

The following symbols are available for this function:

For option:

• threshold-option-off = x
• threshold-option-outside = o
• threshold-option-inside = i
• threshold-option-smaller = <
• threshold-option-greater = >

tinkerforge call joystick-bricklet <uid> set-analog-value-callback-threshold <option> <min-x> <max-x> <min-y> <max-y>¶

Parameters:	<option> – Type: Char, Range: See symbols, Default: x <min-x> – Type: Int, Range: [0 to 216 - 1], Default: 0 <max-x> – Type: Int, Range: [0 to 216 - 1], Default: 0 <min-y> – Type: Int, Range: [0 to 216 - 1], Default: 0 <max-y> – Type: Int, Range: [0 to 216 - 1], Default: 0
Output:	no output

Sets the thresholds for the analog-value-reached callback.

The following options are possible:

Option	Description
'x'	Callback is turned off
'o'	Callback is triggered when the analog values are outside the min and max values
'i'	Callback is triggered when the analog values are inside the min and max values
'<'	Callback is triggered when the analog values are smaller than the min values (max is ignored)
'>'	Callback is triggered when the analog values are greater than the min values (max is ignored)

The following symbols are available for this function:

For <option>:

• threshold-option-off = x
• threshold-option-outside = o
• threshold-option-inside = i
• threshold-option-smaller = <
• threshold-option-greater = >

tinkerforge call joystick-bricklet <uid> get-analog-value-callback-threshold¶

Output:	option – Type: Char, Range: See symbols, Default: x min-x – Type: Int, Range: [0 to 216 - 1], Default: 0 max-x – Type: Int, Range: [0 to 216 - 1], Default: 0 min-y – Type: Int, Range: [0 to 216 - 1], Default: 0 max-y – Type: Int, Range: [0 to 216 - 1], Default: 0

Returns the threshold as set by set-analog-value-callback-threshold.

The following symbols are available for this function:

For option:

• threshold-option-off = x
• threshold-option-outside = o
• threshold-option-inside = i
• threshold-option-smaller = <
• threshold-option-greater = >

tinkerforge call joystick-bricklet <uid> set-debounce-period <debounce>¶

Parameters:	<debounce> – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100
Output:	no output

Sets the period with which the threshold callbacks

• position-reached,
• analog-value-reached

are triggered, if the thresholds

• set-position-callback-threshold,
• set-analog-value-callback-threshold

keep being reached.

tinkerforge call joystick-bricklet <uid> get-debounce-period¶

Output:	debounce – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Returns the debounce period as set by set-debounce-period.

Callbacks¶

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

tinkerforge dispatch joystick-bricklet <uid> example

The available callbacks are described below.

tinkerforge dispatch joystick-bricklet <uid> position¶

Output:	x – Type: Int, Range: [-100 to 100] y – Type: Int, Range: [-100 to 100]

This callback is triggered periodically with the period that is set by set-position-callback-period. The parameter is the position of the joystick.

The position callback is only triggered if the position has changed since the last triggering.

tinkerforge dispatch joystick-bricklet <uid> analog-value¶

Output:	x – Type: Int, Range: [0 to 212 - 1] y – Type: Int, Range: [0 to 212 - 1]

This callback is triggered periodically with the period that is set by set-analog-value-callback-period. The parameters are the analog values of the joystick.

The analog-value callback is only triggered if the values have changed since the last triggering.

tinkerforge dispatch joystick-bricklet <uid> position-reached¶

Output:	x – Type: Int, Range: [-100 to 100] y – Type: Int, Range: [-100 to 100]

This callback is triggered when the threshold as set by set-position-callback-threshold is reached. The parameters are the position of the joystick.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by set-debounce-period.

tinkerforge dispatch joystick-bricklet <uid> analog-value-reached¶

Output:	x – Type: Int, Range: [0 to 212 - 1] y – Type: Int, Range: [0 to 212 - 1]

This callback is triggered when the threshold as set by set-analog-value-callback-threshold is reached. The parameters are the analog values of the joystick.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by set-debounce-period.

tinkerforge dispatch joystick-bricklet <uid> pressed¶

Output:	no output

This callback is triggered when the button is pressed.

tinkerforge dispatch joystick-bricklet <uid> released¶

Output:	no output

This callback is triggered when the button is released.