Shell - Laser Range Finder Bricklet 2.0

Dies ist die Beschreibung der Shell API Bindings für das Laser Range Finder Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Laser Range Finder Bricklet 2.0 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
 8
 9
10
11
12
13
14
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Laser Range Finder Bricklet 2.0

# Turn laser on and wait 250ms for very first measurement to be ready
tinkerforge call laser-range-finder-v2-bricklet $uid set-enable true
sleep 0.25

# Get current distance
tinkerforge call laser-range-finder-v2-bricklet $uid get-distance

# Turn laser off
tinkerforge call laser-range-finder-v2-bricklet $uid set-enable false

Callback

Download (example-callback.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Laser Range Finder Bricklet 2.0

# Turn laser on and wait 250ms for very first measurement to be ready
tinkerforge call laser-range-finder-v2-bricklet $uid set-enable true
sleep 0.25

# Handle incoming distance callbacks
tinkerforge dispatch laser-range-finder-v2-bricklet $uid distance &

# Set period for distance callback to 0.2s (200ms) without a threshold
tinkerforge call laser-range-finder-v2-bricklet $uid set-distance-callback-configuration 200 false threshold-option-off 0 0

echo "Press key to exit"; read dummy

# Turn laser off
tinkerforge call laser-range-finder-v2-bricklet $uid set-enable false

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

Threshold

Download (example-threshold.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Laser Range Finder Bricklet 2.0

# Turn laser on and wait 250ms for very first measurement to be ready
tinkerforge call laser-range-finder-v2-bricklet $uid set-enable true
sleep 0.25

# Handle incoming distance callbacks
tinkerforge dispatch laser-range-finder-v2-bricklet $uid distance &

# Configure threshold for distance "greater than 20 cm"
# with a debounce period of 1s (1000ms)
tinkerforge call laser-range-finder-v2-bricklet $uid set-distance-callback-configuration 1000 false threshold-option-greater 20 0

echo "Press key to exit"; read dummy

# Turn laser off
tinkerforge call laser-range-finder-v2-bricklet $uid set-enable false

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 laser-range-finder-v2-bricklet [<option>..] <uid> <function> [<argument>..]
Parameter:
  • <uid> – Typ: String
  • <function> – Typ: String

Der call Befehl wird verwendet um eine Funktion des Laser Range Finder Bricklet 2.0 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 Laser Range Finder Bricklet 2.0 an und endet dann
tinkerforge dispatch laser-range-finder-v2-bricklet [<option>..] <uid> <callback>
Parameter:
  • <uid> – Typ: String
  • <callback> – Typ: String

Der dispatch Befehl wird verwendet um eingehende Callbacks des Laser Range Finder Bricklet 2.0 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 Laser Range Finder Bricklet 2.0 an und endet dann
tinkerforge call laser-range-finder-v2-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 laser-range-finder-v2-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 laser-range-finder-v2-bricklet <uid> get-distance
Ausgabe:
  • distance – Typ: Int, Einheit: 1 cm, Wertebereich: [0 bis 4000]

Gibt die gemessene Distanz zurück.

Der Laser muss aktiviert werden, siehe set-enable.

Wenn der Wert periodisch benötigt wird, kann auch der distance Callback verwendet werden. Der Callback wird mit der Funktion set-distance-callback-configuration konfiguriert.

tinkerforge call laser-range-finder-v2-bricklet <uid> get-velocity
Ausgabe:
  • velocity – Typ: Int, Einheit: 1 cm/s, Wertebereich: [-12800 bis 12700]

Gibt die gemessene Geschwindigkeit zurück.

Die Geschwindigkeitsmessung liefert nur dann stabile Werte, wenn eine feste Messfrequenz (siehe set-configuration) eingestellt ist. Zusätzlich muss der Laser aktiviert werden, siehe set-enable.

Wenn der Wert periodisch benötigt wird, kann auch der velocity Callback verwendet werden. Der Callback wird mit der Funktion set-velocity-callback-configuration konfiguriert.

tinkerforge call laser-range-finder-v2-bricklet <uid> set-enable <enable>
Parameter:
  • <enable> – Typ: Bool, Standardwert: false
Ausgabe:
  • keine Ausgabe

Aktiviert den Laser des LIDAR wenn auf true gesetzt.

Wir empfehlen nach dem Aktivieren des Lasers 250ms zu warten bis zum ersten Aufruf von get-distance um stabile Messwerte zu garantieren.

tinkerforge call laser-range-finder-v2-bricklet <uid> get-enable
Ausgabe:
  • enable – Typ: Bool, Standardwert: false

Gibt den Wert zurück wie von set-enable gesetzt.

tinkerforge call laser-range-finder-v2-bricklet <uid> set-configuration <acquisition-count> <enable-quick-termination> <threshold-value> <measurement-frequency>
Parameter:
  • <acquisition-count> – Typ: Int, Wertebereich: [1 bis 255], Standardwert: 128
  • <enable-quick-termination> – Typ: Bool, Standardwert: false
  • <threshold-value> – Typ: Int, Wertebereich: [0 bis 255], Standardwert: 0
  • <measurement-frequency> – Typ: Int, Einheit: 1 Hz, Wertebereich: [0, 10 bis 500], Standardwert: 0
Ausgabe:
  • keine Ausgabe

Der Parameter Acquisition Count definiert die Anzahl der Datenerfassungen die integriert werden, um eine Korrelation zu finden. Mit einer größeren Anzahl kann das Bricklet höhere Distanzen messen, mit einer kleineren Anzahl ist die Messrate höher. Erlaubte Werte sind 1-255.

Wenn der Parameter Enable Quick Termination auf true gesetzt wird, wird die Distanzmessung abgeschlossen, sobald das erste mal ein hoher Peak erfasst wird. Dadurch kann eine höhere Messrate erreicht werden wobei gleichzeitig Messungen mit langer Distanz möglich sind. Die Wahrscheinlichkeit einer Falschmessung erhöht sich allerdings.

Normalerweise wird die Distanz mit Hilfe eines Detektionsalgorithmus berechnet. Dieser verwendet Peak-Werte, Signalstärke und Rauschen. Es ist möglich stattdessen über den Parameter Threshold Value einen festen Schwellwert zu setzen der zur Distanzbestimmung genutzt werden soll. Um den Abstand zu einem Objekt mit sehr niedriger Reflektivität zu messen (z.B. Glas) kann der Wert niedrig gesetzt werden. Um den Abstand zu einem Objekt mit sehr hoher Reflektivität zu messen (z.B. Spiegel) kann der Wert sehr hoch gesetzt werden. Mit einem Wert von 0 wird der Standardalgorithmus genutzt. Ansonsten ist der erlaubte Wertebereich 1-255.

Der Measurement Frequency Parameter wird gesetzt. Er erzwingt eine feste Messfrequenz. Wenn der Wert auf 0 gesetzt wird, nutzt das Laser Range Finder Bricklet die optimale Frequenz je nach Konfiguration und aktuell gemessener Distanz. Da die Messrate in diesem Fall nicht fest ist, ist die Geschwindigkeitsmessung nicht stabil. Für eine stabile Geschwindigkeitsmessung sollte eine feste Messfrequenz eingestellt werden. Je niedriger die Frequenz ist, desto größer ist die Auflösung der Geschwindigkeitsmessung. Der erlaubte Wertbereich ist 10Hz-500Hz (und 0 um die feste Messfrequenz auszustellen).

Die Standardwerte für Acquisition Count, Enable Quick Termination, Threshold Value und Measurement Frequency sind 128, false, 0 und 0.

tinkerforge call laser-range-finder-v2-bricklet <uid> get-configuration
Ausgabe:
  • acquisition-count – Typ: Int, Wertebereich: [1 bis 255], Standardwert: 128
  • enable-quick-termination – Typ: Bool, Standardwert: false
  • threshold-value – Typ: Int, Wertebereich: [0 bis 255], Standardwert: 0
  • measurement-frequency – Typ: Int, Einheit: 1 Hz, Wertebereich: [0, 10 bis 500], Standardwert: 0

Gibt die Konfiguration zurück, wie von set-configuration gesetzt.

tinkerforge call laser-range-finder-v2-bricklet <uid> set-distance-led-config <config>
Parameter:
  • <config> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3
Ausgabe:
  • keine Ausgabe

Konfiguriert die Distanz-LED. Die LED kann ausgeschaltet, eingeschaltet, im Herzschlagmodus betrieben werden. Zusätzlich gibt es die Option mit der LED die Distanz anzuzeigen (heller = Objekt näher).

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

Für <config>:

  • distance-led-config-off = 0
  • distance-led-config-on = 1
  • distance-led-config-show-heartbeat = 2
  • distance-led-config-show-distance = 3
tinkerforge call laser-range-finder-v2-bricklet <uid> get-distance-led-config
Ausgabe:
  • config – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die LED-Konfiguration zurück, wie von set-distance-led-config gesetzt.

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

Für config:

  • distance-led-config-off = 0
  • distance-led-config-on = 1
  • distance-led-config-show-heartbeat = 2
  • distance-led-config-show-distance = 3

Fortgeschrittene Funktionen

tinkerforge call laser-range-finder-v2-bricklet <uid> set-moving-average <distance-average-length> <velocity-average-length>
Parameter:
  • <distance-average-length> – Typ: Int, Wertebereich: [0 bis 255], Standardwert: 10
  • <velocity-average-length> – Typ: Int, Wertebereich: [0 bis 255], Standardwert: 10
Ausgabe:
  • keine Ausgabe

Setzt die Länge eines gleitenden Mittelwerts für die Entfernung und Geschwindigkeit.

Wenn die Länge auf 0 gesetzt wird, ist das Averaging komplett aus. Desto kleiner die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

tinkerforge call laser-range-finder-v2-bricklet <uid> get-moving-average
Ausgabe:
  • distance-average-length – Typ: Int, Wertebereich: [0 bis 255], Standardwert: 10
  • velocity-average-length – Typ: Int, Wertebereich: [0 bis 255], Standardwert: 10

Gibt die Länge des gleitenden Mittelwerts zurück, wie von set-moving-average gesetzt.

tinkerforge call laser-range-finder-v2-bricklet <uid> set-offset-calibration <offset>
Parameter:
  • <offset> – Typ: Int, Einheit: 1 cm, Wertebereich: [-215 bis 28767]
Ausgabe:
  • keine Ausgabe

Der Offset wird auf die Distanz addiert. Es wird in nicht-flüchtigen Speicher gespeichert und muss nur einmal gesetzt werden.

Der Offset wird für das Bricklet pro Sensor von Tinkerforge werkskalibriert. Ein Aufruf dieser Funktion sollte also nicht notwendig sein.

Wenn der Offset re-kalibriert werden soll muss er zuerst auf 0 gesetzt. Danach kann der Offset wieder gesetzt werden in dem die Differenz zu einer bekannte Distanz gemessen wird.

tinkerforge call laser-range-finder-v2-bricklet <uid> get-offset-calibration
Ausgabe:
  • offset – Typ: Int, Einheit: 1 cm, Wertebereich: [-215 bis 28767]

Gibt den Offset-Wert zurück, wie von set-offset-calibration gesetzt.

tinkerforge call laser-range-finder-v2-bricklet <uid> get-spitfp-error-count
Ausgabe:
  • error-count-ack-checksum – Typ: Int, Wertebereich: [0 bis 232 - 1]
  • error-count-message-checksum – Typ: Int, Wertebereich: [0 bis 232 - 1]
  • error-count-frame – Typ: Int, Wertebereich: [0 bis 232 - 1]
  • error-count-overflow – Typ: Int, Wertebereich: [0 bis 232 - 1]

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

tinkerforge call laser-range-finder-v2-bricklet <uid> set-status-led-config <config>
Parameter:
  • <config> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3
Ausgabe:
  • keine Ausgabe

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

Für <config>:

  • status-led-config-off = 0
  • status-led-config-on = 1
  • status-led-config-show-heartbeat = 2
  • status-led-config-show-status = 3
tinkerforge call laser-range-finder-v2-bricklet <uid> get-status-led-config
Ausgabe:
  • config – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die Konfiguration zurück, wie von set-status-led-config gesetzt.

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

Für config:

  • status-led-config-off = 0
  • status-led-config-on = 1
  • status-led-config-show-heartbeat = 2
  • status-led-config-show-status = 3
tinkerforge call laser-range-finder-v2-bricklet <uid> get-chip-temperature
Ausgabe:
  • temperature – Typ: Int, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

tinkerforge call laser-range-finder-v2-bricklet <uid> reset
Ausgabe:
  • keine Ausgabe

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

tinkerforge call laser-range-finder-v2-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 laser-range-finder-v2-bricklet <uid> set-distance-callback-configuration <period> <value-has-to-change> <option> <min> <max>
Parameter:
  • <period> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • <value-has-to-change> – Typ: Bool, Standardwert: false
  • <option> – Typ: Char, Wertebereich: Siehe Symbole, Standardwert: x
  • <min> – Typ: Int, Einheit: 1 cm, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • <max> – Typ: Int, Einheit: 1 cm, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
Ausgabe:
  • keine Ausgabe

Die Periode ist die Periode mit der der distance Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den distance Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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 laser-range-finder-v2-bricklet <uid> get-distance-callback-configuration
Ausgabe:
  • period – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value-has-to-change – Typ: Bool, Standardwert: false
  • option – Typ: Char, Wertebereich: Siehe Symbole, Standardwert: x
  • min – Typ: Int, Einheit: 1 cm, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • max – Typ: Int, Einheit: 1 cm, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

Gibt die Callback-Konfiguration zurück, wie mittels set-distance-callback-configuration 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 laser-range-finder-v2-bricklet <uid> set-velocity-callback-configuration <period> <value-has-to-change> <option> <min> <max>
Parameter:
  • <period> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • <value-has-to-change> – Typ: Bool, Standardwert: false
  • <option> – Typ: Char, Wertebereich: Siehe Symbole, Standardwert: x
  • <min> – Typ: Int, Einheit: 1 cm/s, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • <max> – Typ: Int, Einheit: 1 cm/s, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
Ausgabe:
  • keine Ausgabe

Die Periode ist die Periode mit der der velocity Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den velocity Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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 laser-range-finder-v2-bricklet <uid> get-velocity-callback-configuration
Ausgabe:
  • period – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value-has-to-change – Typ: Bool, Standardwert: false
  • option – Typ: Char, Wertebereich: Siehe Symbole, Standardwert: x
  • min – Typ: Int, Einheit: 1 cm/s, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • max – Typ: Int, Einheit: 1 cm/s, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

Gibt die Callback-Konfiguration zurück, wie mittels set-velocity-callback-configuration 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 = >

Callbacks

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

tinkerforge dispatch laser-range-finder-v2-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 laser-range-finder-v2-bricklet <uid> distance
Ausgabe:
  • distance – Typ: Int, Einheit: 1 cm, Wertebereich: [0 bis 4000]

Dieser Callback wird periodisch ausgelöst abhängig von der mittels set-distance-callback-configuration gesetzten Konfiguration

Der Parameter ist der gleiche wie get-distance.

tinkerforge dispatch laser-range-finder-v2-bricklet <uid> velocity
Ausgabe:
  • velocity – Typ: Int, Einheit: 1 cm/s, Wertebereich: [-12800 bis 12700]

Dieser Callback wird periodisch ausgelöst abhängig von der mittels set-velocity-callback-configuration gesetzten Konfiguration

Der Parameter ist der gleiche wie get-velocity.

Interne Funktionen

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

tinkerforge call laser-range-finder-v2-bricklet <uid> set-bootloader-mode <mode>
Parameter:
  • <mode> – Typ: Int, Wertebereich: Siehe Symbole
Ausgabe:
  • status – Typ: Int, Wertebereich: Siehe Symbole

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

Für <mode>:

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

Für status:

  • bootloader-status-ok = 0
  • bootloader-status-invalid-mode = 1
  • bootloader-status-no-change = 2
  • bootloader-status-entry-function-not-present = 3
  • bootloader-status-device-identifier-incorrect = 4
  • bootloader-status-crc-mismatch = 5
tinkerforge call laser-range-finder-v2-bricklet <uid> get-bootloader-mode
Ausgabe:
  • mode – Typ: Int, Wertebereich: Siehe Symbole

Gibt den aktuellen Bootloader-Modus zurück, siehe set-bootloader-mode.

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

Für mode:

  • bootloader-mode-bootloader = 0
  • bootloader-mode-firmware = 1
  • bootloader-mode-bootloader-wait-for-reboot = 2
  • bootloader-mode-firmware-wait-for-reboot = 3
  • bootloader-mode-firmware-wait-for-erase-and-reboot = 4
tinkerforge call laser-range-finder-v2-bricklet <uid> set-write-firmware-pointer <pointer>
Parameter:
  • <pointer> – Typ: Int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Ausgabe:
  • keine Ausgabe

Setzt den Firmware-Pointer für write-firmware. Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

tinkerforge call laser-range-finder-v2-bricklet <uid> write-firmware <data>
Parameter:
  • <data> – Typ: Int Array, Länge: 64, Wertebereich: [0 bis 255]
Ausgabe:
  • status – Typ: Int, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von set-write-firmware-pointer gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

tinkerforge call laser-range-finder-v2-bricklet <uid> write-uid <uid>
Parameter:
  • <uid> – Typ: Int, Wertebereich: [0 bis 232 - 1]
Ausgabe:
  • keine Ausgabe

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

tinkerforge call laser-range-finder-v2-bricklet <uid> read-uid
Ausgabe:
  • uid – Typ: Int, Wertebereich: [0 bis 232 - 1]

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.