Shell - Hall Effect Bricklet

Dies ist die Beschreibung der Shell API Bindings für das Hall Effect Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Hall Effect Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die Shell API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

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 Hall Effect Bricklet

# Get current edge count without reset
tinkerforge call hall-effect-bricklet $uid get-edge-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 Hall Effect Bricklet

# Handle incoming edge count callbacks
tinkerforge dispatch hall-effect-bricklet $uid edge-count &

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

echo "Press key to exit"; read dummy

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

API

Mögliche Exit Codes für alle tinkerforge Befehle sind:

  • 1: Unterbrochen (Ctrl+C)
  • 2: Syntaxfehler
  • 21: Python 2.5 oder neuer wird benötigt
  • 22: Python argparse Modul fehlt
  • 23: Socket-Fehler
  • 24: Andere Exception
  • 25: Ungültiger Platzhalter in Format-String
  • 26: Authentifizierungsfehler
  • 201: Timeout ist aufgetreten
  • 209: Ungültiger Argumentwert
  • 210: Funktion wird nicht unterstützt
  • 211: Unbekannter Fehler

Befehlsstruktur

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

tinkerforge call hall-effect-bricklet [<option>..] <uid> <function> [<argument>..]
Parameter:
  • <uid> -- string
  • <function> -- string

Der call Befehl wird verwendet um eine Funktion des Hall Effect 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 Hall Effect Bricklet an und endet dann
tinkerforge dispatch hall-effect-bricklet [<option>..] <uid> <callback>
Parameter:
  • <uid> -- string
  • <callback> -- string

Der dispatch Befehl wird verwendet um eingehende Callbacks des Hall Effect 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 Hall Effect Bricklet an und endet dann
tinkerforge call hall-effect-bricklet <uid> <function> [<option>..] [<argument>..]
Parameter:
  • <uid> -- string
  • <function> -- 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 hall-effect-bricklet <uid> <callback> [<option>..]
Parameter:
  • <uid> -- string
  • <callback> -- 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 hall-effect-bricklet <uid> get-value
Ausgabe:
  • value -- bool

Gibt true zurück wenn ein Magnetfeld mit 35 Gauss (3,5mT) oder größer detektiert wird.

tinkerforge call hall-effect-bricklet <uid> get-edge-count <reset-counter>
Parameter:
  • <reset-counter> -- bool
Ausgabe:
  • count -- int

Gibt den aktuellen Wert des Flankenzählers zurück. Die zu zählenden Flanken (steigend, fallend, beide) können mit set-edge-count-config konfiguriert werden.

Wenn reset counter auf true gesetzt wird, wird der Zählerstand direkt nach dem auslesen auf 0 zurückgesetzt.

Fortgeschrittene Funktionen

tinkerforge call hall-effect-bricklet <uid> set-edge-count-config <edge-type> <debounce>
Parameter:
  • <edge-type> -- int (hat Symbole)
  • <debounce> -- int
Ausgabe:

keine Ausgabe

Der edge type Parameter konfiguriert den zu zählenden Flankentyp. Es können steigende, fallende oder beide Flanken gezählt werden. Mögliche Flankentypen sind:

  • 0 = steigend (Standard)
  • 1 = fallend
  • 2 = beide

Wird ein Magnet in die Nähe des Bricklets gebracht (>35 Gauss) erzeugt dies ein low-Signal (fallende Flanke), wenn ein Magnet vom Bricklet entfernt (<25 Gauss) wird entsteht ein high-Signal (steigende Flanke).

Die Entprellzeit (debounce) wird in ms angegeben.

Durch das Konfigurieren wird der Wert des Flankenzählers auf 0 zurückgesetzt.

Falls unklar ist was dies alles bedeutet, kann diese Funktion einfach ignoriert werden. Die Standardwerte sind in fast allen Situationen OK.

Standardwerte: 0 (edge type) und 100ms (debounce).

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

  • edge-type-rising = 0, für <edge-type>
  • edge-type-falling = 1, für <edge-type>
  • edge-type-both = 2, für <edge-type>
tinkerforge call hall-effect-bricklet <uid> get-edge-count-config
Ausgabe:
  • edge-type -- int (hat Symbole)
  • debounce -- int

Gibt den Flankentyp sowie die Entprellzeit zurück, wie von set-edge-count-config gesetzt.

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

  • edge-type-rising = 0, für edge-type
  • edge-type-falling = 1, für edge-type
  • edge-type-both = 2, für edge-type
tinkerforge call hall-effect-bricklet <uid> get-identity
Ausgabe:
  • uid -- string
  • connected-uid -- string
  • position -- char
  • hardware-version -- int,int,int
  • firmware-version -- int,int,int
  • device-identifier -- int (hat Symbole)

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 kann 'a', 'b', 'c' oder 'd' sein.

Eine Liste der Device Identifier Werte ist hier zu finden. 

Konfigurationsfunktionen für Callbacks

tinkerforge call hall-effect-bricklet <uid> set-edge-interrupt <edges>
Parameter:
  • <edges> -- int
Ausgabe:

keine Ausgabe

Setzt die Anzahl der zu zählenden Flanken bis ein Interrupt aufgerufen wird.

Wenn edges auf n gesetzt ist, wird der Interrupt nach jeder n-ten detektierten Flanke aufgerufen.

Wenn edges auf 0 gesetzt ist, wird der Interrupt deaktiviert.

Standardwert ist 0.

tinkerforge call hall-effect-bricklet <uid> get-edge-interrupt
Ausgabe:
  • edges -- int

Gibt edges zurück, wie von set-edge-interrupt gesetzt.

tinkerforge call hall-effect-bricklet <uid> set-edge-count-callback-period <period>
Parameter:
  • <period> -- int
Ausgabe:

keine Ausgabe

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

Der edge-count Callback wird nur ausgelöst, wenn sich die Flankenzählung seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

tinkerforge call hall-effect-bricklet <uid> get-edge-count-callback-period
Ausgabe:
  • period -- int

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

Callbacks

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

tinkerforge dispatch hall-effect-bricklet <uid> example

Die verfügbaren Callbacks werden weiter unten beschrieben.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

tinkerforge dispatch hall-effect-bricklet <uid> edge-count
Ausgabe:
  • count -- int
  • value -- bool

Dieser Callback wird mit der Periode, wie gesetzt mit set-edge-count-callback-period, ausgelöst. Die Parameter sind der aktuelle Zählerstand und der aktuelle Wert (siehe get-value and get-edge-count).

Der edge-count Callback wird nur ausgelöst, wenn sich mindestens einer der beiden Werte seit der letzten Auslösung geändert hat.