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

Befehlsstruktur¶

Allgemeine Optionen des call und des dispatch Befehls sind hier zu finden. Im Folgenden wird die spezifische Befehlsstruktur dargestellt.

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

Parameter:	<uid> – Typ: String <function> – Typ: String

Der call Befehl wird verwendet um eine Funktion des Rotary Encoder Bricklet aufzurufen. Der Befehl kennt mehrere Optionen:

• --help zeigt Hilfe für den spezifischen call Befehl an und endet dann
• --list-functions zeigt eine Liste der bekannten Funktionen des Rotary Encoder Bricklet an und endet dann

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

Parameter:	<uid> – Typ: String <callback> – Typ: String

Der dispatch Befehl wird verwendet um eingehende Callbacks des Rotary Encoder Bricklet abzufertigen. Der Befehl kennt mehrere Optionen:

• --help zeigt Hilfe für den spezifischen dispatch Befehl an und endet dann
• --list-callbacks zeigt eine Liste der bekannten Callbacks des Rotary Encoder Bricklet an und endet dann

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

Parameter:	<uid> – Typ: String <function> – Typ: String

Abhängig von der Art der aufzurufenden <function> kennt diese verschiedene Optionen. Alle Funktionen kennen die folgenden Optionen:

• --help zeigt Hilfe für die spezifische <function> an und endet dann

Getter-Funktionen kennen zusätzlich die folgenden Optionen:

• --execute <command> Shell-Befehl der für jede eingehende Antwort ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)

Setter-Funktionen kennen zusätzlich die folgenden Optionen:

• --expect-response fragt Antwort an und wartet auf diese

Mit der --expect-response Option für Setter-Funktionen können Timeouts und andere Fehlerfälle auch für Aufrufe von Setter-Funktionen detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn diese Option für eine Setter-Funktion nicht angegeben ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

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

Parameter:	<uid> – Typ: String <callback> – Typ: String

Der abzufertigende <callback> kennt mehrere Optionen:

• --help zeigt Hilfe für den spezifische <callback> an und endet dann
• --execute <command> Shell-Befehlszeile der für jede eingehende Antwort ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)

Grundfunktionen¶

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

Parameter:	<reset> – Typ: Bool
Ausgabe:	count – Typ: Int, Wertebereich: [-231 bis 231 - 1]

Gibt den aktuellen Zählerwert des Encoders zurück. Wenn reset auf true gesetzt wird, wird der Zählerstand direkt nach dem auslesen auf 0 zurück gesetzt.

Der Encoder hat 24 Schritte pro Umdrehung.

Wenn der Encoder nach links gedreht wird wird der Zählerwert dekrementiert, d.h. negative Zählerwerte sind möglich.

tinkerforge call rotary-encoder-bricklet <uid> is-pressed¶

Ausgabe:	pressed – Typ: Bool

Gibt true zurück wenn der Taster gedrückt ist und sonst false.

Es wird empfohlen die pressed und released Callbacks zu nutzen, um den Taster programmatisch zu behandeln.

Fortgeschrittene Funktionen¶

tinkerforge call rotary-encoder-bricklet <uid> get-identity¶

Ausgabe:

uid – Typ: String, Länge: bis zu 8 connected-uid – Typ: String, Länge: bis zu 8 position – Typ: Char, Wertebereich: [a bis h, z] hardware-version – Typ: Int Array, Länge: 3 0: major – Typ: Int, Wertebereich: [0 bis 255] 1: minor – Typ: Int, Wertebereich: [0 bis 255] 2: revision – Typ: Int, Wertebereich: [0 bis 255] firmware-version – Typ: Int Array, Länge: 3 0: major – Typ: Int, Wertebereich: [0 bis 255] 1: minor – Typ: Int, Wertebereich: [0 bis 255] 2: revision – Typ: Int, Wertebereich: [0 bis 255] device-identifier – Typ: Int, Wertebereich: [0 bis 216 - 1]

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden. 

Konfigurationsfunktionen für Callbacks¶

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

Parameter:	<period> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Ausgabe:	keine Ausgabe

Setzt die Periode mit welcher der count Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der count Callback wird nur ausgelöst, wenn sich der Zählerwert seit der letzten Auslösung geändert hat.

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

Ausgabe:	period – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von set-count-callback-period gesetzt.

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

Parameter:	<option> – Typ: Char, Wertebereich: Siehe Symbole, Standardwert: x <min> – Typ: Int, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 <max> – Typ: Int, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Ausgabe:	keine Ausgabe

Setzt den Schwellwert für den count-reached Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Callback ist inaktiv
'o'	Callback wird ausgelöst, wenn der Zählerwert außerhalb der min und max Werte ist
'i'	Callback wird ausgelöst, wenn die Zählerwert innerhalb der min und max Werte ist
'<'	Callback wird ausgelöst, wenn die Zählerwert kleiner als der min Wert ist (max wird ignoriert)
'>'	Callback wird ausgelöst, wenn die Zählerwert größer als der min Wert ist (max wird ignoriert)

Die folgenden Symbole sind für diese Funktion verfügbar:

Für <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¶

Ausgabe:	option – Typ: Char, Wertebereich: Siehe Symbole, Standardwert: x min – Typ: Int, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: Int, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von set-count-callback-threshold gesetzt.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für 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>¶

Parameter:	<debounce> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100
Ausgabe:	keine Ausgabe

Setzt die Periode mit welcher der Schwellwert-Callback

• count-reached

ausgelöst wird, wenn der Schwellwert

• set-count-callback-threshold

weiterhin erreicht bleibt.

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

Ausgabe:	debounce – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von set-debounce-period gesetzt.

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten:

tinkerforge dispatch rotary-encoder-bricklet <uid> example

Die verfügbaren Callbacks werden weiter unten beschrieben.

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

Ausgabe:	count – Typ: Int, Wertebereich: [-231 bis 231 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit set-count-callback-period, ausgelöst. Der Parameter ist der Zählerwert des Encoders.

Der count Callback wird nur ausgelöst, wenn sich der Zähler seit der letzten Auslösung geändert hat.

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

Ausgabe:	count – Typ: Int, Wertebereich: [-231 bis 231 - 1]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von set-count-callback-threshold gesetzt, erreicht wird. Der Parameter ist der Zählerwert des Encoders.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit set-debounce-period gesetzt, ausgelöst.

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

Ausgabe:	keine Ausgabe

Dieser Callback wird ausgelöst, wenn der Taster gedrückt wird.

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

Ausgabe:	keine Ausgabe

Dieser Callback wird ausgelöst, wenn der Taster losgelassen wird.