Dies ist die Beschreibung der Shell API Bindings für das XMC1400 Breakout Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des XMC1400 Breakout Bricklet sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die Shell API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
1 2 3 4 5 6 7 8 9 10 11 12 | #!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this
uid=XYZ # Change XYZ to the UID of your XMC1400 Breakout Bricklet
# Set Port 1, Pin 0 alternating high/low for 5 times with 1s delay
for i in 0 1 2 3 4; do
sleep 1
tinkerforge call xmc1400-breakout-bricklet $uid set-gpio-config 1 0 gpio-mode-output-push-pull gpio-input-hysteresis-standard false
sleep 1
tinkerforge call xmc1400-breakout-bricklet $uid set-gpio-config 1 0 gpio-mode-output-push-pull gpio-input-hysteresis-standard true
done
|
Mögliche Exit Codes für alle tinkerforge Befehle sind:
Allgemeine Optionen des call und des dispatch Befehls sind hier zu finden. Im Folgenden wird die spezifische Befehlsstruktur dargestellt.
Parameter: |
|
---|
Der call Befehl wird verwendet um eine Funktion des XMC1400 Breakout Bricklet aufzurufen. Der Befehl kennt mehrere Optionen:
Parameter: |
|
---|
Der dispatch Befehl wird verwendet um eingehende Callbacks des XMC1400 Breakout Bricklet abzufertigen. Der Befehl kennt mehrere Optionen:
Parameter: |
|
---|
Abhängig von der Art der aufzurufenden <function> kennt diese verschiedene Optionen. Alle Funktionen kennen die folgenden Optionen:
Getter-Funktionen kennen zusätzlich die folgenden Optionen:
Setter-Funktionen kennen zusätzlich die folgenden Optionen:
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.
Parameter: |
|
---|
Der abzufertigende <callback> kennt mehrere Optionen:
Parameter: |
|
---|---|
Ausgabe: |
|
Beispiel für eine Setter-Funktion. Die Werte werden direkt an die Funktion XMC_GPIO_Init übergeben. Siehe communication.c in der Firmware.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für <mode>:
Für <input-hysteresis>:
Parameter: |
|
---|---|
Ausgabe: |
|
Beispiel für eine Getter-Funktion. Gibt das Resultat eines XMC_GPIO_GetInput-Aufrufs für den gegebenen Port/Pin zurück.
Parameter: |
|
---|---|
Ausgabe: |
|
Aktiviert einen ADC-Kanal für das ADC-Treiber Beispiel (adc.c/adc.h).
Es gibt 8 ADC-Kanäle und sie korrespondieren zu den folgenden Pinnen:
Parameter: |
|
---|---|
Ausgabe: |
|
Gibt die Konfiguration für den gegebenen Kanal zurück, wie von set-adc-channel-config gesetzt.
Parameter: |
|
---|---|
Ausgabe: |
|
Gibt den 12-Bit Wert für den gegebenen ADC-Kanal des ADC-Treiber-Beispiels zurück.
Ausgabe: |
|
---|
Gibt die Werte aller 8 ADC-Kanäle des ADC-Treiber-Beispiels zurück.
Diese Beispiel-Funktion hat auch einen korrespondierenden Callback.
Siehe set-adc-values-callback-configuration und adc-values Callback.
Ausgabe: |
|
---|
Gibt den Wert des Beispiel-Zählers zurück (siehe example.c).
Diese Beispiel-Funktion nutzt die "add_callback_value_function"-Hilfsfunktion im Generator. Der Getter sowie der Callback und die Callback-Konfigurations-Funktionen werden automatisch für die API und die Firmware generiert.
Wenn der Wert periodisch benötigt wird, kann auch der count Callback verwendet werden. Der Callback wird mit der Funktion set-count-callback-configuration konfiguriert.
Ausgabe: |
|
---|
Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.
Die Fehler sind aufgeteilt in
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.
Parameter: |
|
---|---|
Ausgabe: |
|
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>:
Für status:
Ausgabe: |
|
---|
Gibt den aktuellen Bootloader-Modus zurück, siehe set-bootloader-mode.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für mode:
Parameter: |
|
---|---|
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.
Parameter: |
|
---|---|
Ausgabe: |
|
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.
Parameter: |
|
---|---|
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>:
Ausgabe: |
|
---|
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:
Ausgabe: |
|
---|
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.
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.
Parameter: |
|
---|---|
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.
Ausgabe: |
|
---|
Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.
Ausgabe: |
|
---|
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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.
Eine Liste der Device Identifier Werte ist hier zu finden.
Parameter: |
|
---|---|
Ausgabe: |
|
Die Periode ist die Periode mit der der adc-values 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.
Ausgabe: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels set-adc-values-callback-configuration gesetzt.
Parameter: |
|
---|---|
Ausgabe: |
|
Die Periode ist die Periode mit der der count 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 count 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>:
Ausgabe: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels set-count-callback-configuration gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für option:
Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten:
tinkerforge dispatch xmc1400-breakout-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.
Ausgabe: |
|
---|
Dieser Callback wird periodisch ausgelöst abhängig von der mittels set-adc-values-callback-configuration gesetzten Konfiguration
Die Parameter sind der gleiche wie get-adc-values.
Ausgabe: |
|
---|
Dieser Callback wird periodisch ausgelöst abhängig von der mittels set-count-callback-configuration gesetzten Konfiguration
Der Parameter ist der gleiche wie get-count.