Shell - XMC1400 Breakout Bricklet¶

Gpio¶

Download (example-gpio.sh)

 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

Befehlsstruktur¶

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

tinkerforge call xmc1400-breakout-bricklet [<option>..] <uid> <function> [<argument>..]¶

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

Der call Befehl wird verwendet um eine Funktion des XMC1400 Breakout 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 XMC1400 Breakout Bricklet an und endet dann

tinkerforge dispatch xmc1400-breakout-bricklet [<option>..] <uid> <callback>¶

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

Der dispatch Befehl wird verwendet um eingehende Callbacks des XMC1400 Breakout 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 XMC1400 Breakout Bricklet an und endet dann

tinkerforge call xmc1400-breakout-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 xmc1400-breakout-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 xmc1400-breakout-bricklet <uid> set-gpio-config <port> <pin> <mode> <input-hysteresis> <output-level>¶

Parameter:	<port> – Typ: Int, Wertebereich: [0 bis 4] <pin> – Typ: Int, Wertebereich: ? <mode> – Typ: Int, Wertebereich: Siehe Symbole <input-hysteresis> – Typ: Int, Wertebereich: Siehe Symbole <output-level> – Typ: Bool
Ausgabe:	keine 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>:

• gpio-mode-input-tristate = 0
• gpio-mode-input-pull-down = 1
• gpio-mode-input-pull-up = 2
• gpio-mode-input-sampling = 3
• gpio-mode-input-inverted-tristate = 4
• gpio-mode-input-inverted-pull-down = 5
• gpio-mode-input-inverted-pull-up = 6
• gpio-mode-input-inverted-sampling = 7
• gpio-mode-output-push-pull = 8
• gpio-mode-output-open-drain = 9

Für <input-hysteresis>:

• gpio-input-hysteresis-standard = 0
• gpio-input-hysteresis-large = 4

tinkerforge call xmc1400-breakout-bricklet <uid> get-gpio-input <port> <pin>¶

Parameter:	<port> – Typ: Int, Wertebereich: [0 bis 4] <pin> – Typ: Int, Wertebereich: ?
Ausgabe:	value – Typ: Bool

Beispiel für eine Getter-Funktion. Gibt das Resultat eines XMC_GPIO_GetInput-Aufrufs für den gegebenen Port/Pin zurück.

tinkerforge call xmc1400-breakout-bricklet <uid> set-adc-channel-config <channel> <enable>¶

Parameter:	<channel> – Typ: Int, Wertebereich: [0 bis 7] <enable> – Typ: Bool
Ausgabe:	keine 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:

• Kanal 0: P2_6
• Kanal 1: P2_8
• Kanal 2: P2_9
• Kanal 3: P2_10
• Kanal 4: P2_11
• Kanal 5: P2_0
• Kanal 6: P2_1
• Kanal 7: P2_2

tinkerforge call xmc1400-breakout-bricklet <uid> get-adc-channel-config <channel>¶

Parameter:	<channel> – Typ: Int, Wertebereich: [0 bis 7]
Ausgabe:	enable – Typ: Bool

Gibt die Konfiguration für den gegebenen Kanal zurück, wie von set-adc-channel-config gesetzt.

tinkerforge call xmc1400-breakout-bricklet <uid> get-adc-channel-value <channel>¶

Parameter:	<channel> – Typ: Int, Wertebereich: [0 bis 7]
Ausgabe:	value – Typ: Int, Wertebereich: [0 bis 4095]

Gibt den 12-Bit Wert für den gegebenen ADC-Kanal des ADC-Treiber-Beispiels zurück.

tinkerforge call xmc1400-breakout-bricklet <uid> get-adc-values¶

Ausgabe:	values – Typ: Int Array, Länge: 8, Wertebereich: [0 bis 4095]

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.

tinkerforge call xmc1400-breakout-bricklet <uid> get-count¶

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

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.

Fortgeschrittene Funktionen¶

tinkerforge call xmc1400-breakout-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 xmc1400-breakout-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 xmc1400-breakout-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 xmc1400-breakout-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 xmc1400-breakout-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 xmc1400-breakout-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 xmc1400-breakout-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 xmc1400-breakout-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 xmc1400-breakout-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 xmc1400-breakout-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 xmc1400-breakout-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.

tinkerforge call xmc1400-breakout-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, i, 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 '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. 

Konfigurationsfunktionen für Callbacks¶

tinkerforge call xmc1400-breakout-bricklet <uid> set-adc-values-callback-configuration <period> <value-has-to-change>¶

Parameter:	<period> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 <value-has-to-change> – Typ: Bool, Standardwert: false
Ausgabe:	keine 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.

tinkerforge call xmc1400-breakout-bricklet <uid> get-adc-values-callback-configuration¶

Ausgabe:	period – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 value-has-to-change – Typ: Bool, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels set-adc-values-callback-configuration gesetzt.

tinkerforge call xmc1400-breakout-bricklet <uid> set-count-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, Wertebereich: [0 bis 232 - 1], Standardwert: 0 <max> – Typ: Int, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Ausgabe:	keine 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>:

• threshold-option-off = x
• threshold-option-outside = o
• threshold-option-inside = i
• threshold-option-smaller = <
• threshold-option-greater = >

tinkerforge call xmc1400-breakout-bricklet <uid> get-count-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, Wertebereich: [0 bis 232 - 1], Standardwert: 0 max – Typ: Int, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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:

• 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 xmc1400-breakout-bricklet <uid> example

Die verfügbaren Callbacks werden weiter unten beschrieben.

tinkerforge dispatch xmc1400-breakout-bricklet <uid> adc-values¶

Ausgabe:	values – Typ: Int Array, Länge: 8, Wertebereich: [0 bis 4095]

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.

tinkerforge dispatch xmc1400-breakout-bricklet <uid> count¶

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

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.