Shell - Rotary Encoder 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 Rotary Encoder Bricklet

# Get current count without reset
tinkerforge call rotary-encoder-bricklet $uid get-count false

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 Rotary Encoder Bricklet

# Handle incoming count callbacks
tinkerforge dispatch rotary-encoder-bricklet $uid count &

# Set period for count callback to 0.05s (50ms)
# Note: The count callback is only called every 0.05 seconds
#       if the count has changed since the last call!
tinkerforge call rotary-encoder-bricklet $uid set-count-callback-period 50

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

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

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

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

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

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

tinkerforge call rotary-encoder-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 rotary-encoder-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 rotary-encoder-bricklet <uid> get-count <reset>¶

Parameters:	<reset> – Type: Bool
Output:	count – Type: Int, Range: [-231 to 231 - 1]

Returns the current count of the encoder. If you set reset to true, the count is set back to 0 directly after the current count is read.

The encoder has 24 steps per rotation

Turning the encoder to the left decrements the counter, so a negative count is possible.

tinkerforge call rotary-encoder-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 rotary-encoder-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 rotary-encoder-bricklet <uid> set-count-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 count callback is triggered periodically. A value of 0 turns the callback off.

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

tinkerforge call rotary-encoder-bricklet <uid> get-count-callback-period¶

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

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

tinkerforge call rotary-encoder-bricklet <uid> set-count-callback-threshold <option> <min> <max>¶

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

Sets the thresholds for the count-reached callback.

The following options are possible:

Option	Description
'x'	Callback is turned off
'o'	Callback is triggered when the count is outside the min and max values
'i'	Callback is triggered when the count is inside the min and max values
'<'	Callback is triggered when the count is smaller than the min value (max is ignored)
'>'	Callback is triggered when the count is greater than the min value (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 rotary-encoder-bricklet <uid> get-count-callback-threshold¶

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

Returns the threshold as set by set-count-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 rotary-encoder-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 callback

• count-reached

is triggered, if the thresholds

• set-count-callback-threshold

keeps being reached.

tinkerforge call rotary-encoder-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 rotary-encoder-bricklet <uid> example

The available callbacks are described below.

tinkerforge dispatch rotary-encoder-bricklet <uid> count¶

Output:	count – Type: Int, Range: [-231 to 231 - 1]

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

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

tinkerforge dispatch rotary-encoder-bricklet <uid> count-reached¶

Output:	count – Type: Int, Range: [-231 to 231 - 1]

This callback is triggered when the threshold as set by set-count-callback-threshold is reached. The parameter is the count of the encoder.

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

tinkerforge dispatch rotary-encoder-bricklet <uid> pressed¶

Output:	no output

This callback is triggered when the button is pressed.

tinkerforge dispatch rotary-encoder-bricklet <uid> released¶

Output:	no output

This callback is triggered when the button is released.