halcmd(1) Manual Page

Bevor Sie die Echtzeitumgebung abbauen, führen Sie einen interaktiven halcmd aus. Gilt nur für halrun. Wenn -I verwendet wird, muss es vor allen anderen Befehlszeilenargumenten stehen.

Ignoriert Befehle auf der Kommandozeile, nimmt stattdessen Eingaben aus Datei. Wenn Datei nicht angegeben ist, wird die Eingabe von stdin übernommen.

Verwendet Variablen aus der angegebenen INI-Datei für Ersetzungen. Siehe SUBSTITUTION weiter unten.

Nach fehlgeschlagenem(n) Befehl(en) weitermachen. Standardmäßig wird bei einem fehlgeschlagenen Befehl angehalten und ein Fehler zurückgegeben.

nur Fehler anzeigen (Standard)

nichts anzeigen, Befehle lautlos ausführen

Skript-freundlicher Modus. In diesem Modus gibt show keine Titel für die angezeigten Elemente aus. Außerdem werden Modulnamen anstelle von ID-Codes in Pin-, Param- und Funktionsauflistungen gedruckt. Threads werden auf einer einzigen Zeile gedruckt, mit der Thread-Periode, der FP-Verwendung und dem Thread-Namen an erster Stelle, gefolgt von allen Funktionen des Threads in der Reihenfolge ihrer Ausführung. Signale werden in einer einzigen Zeile gedruckt, mit Typ, Wert und Signalname zuerst, gefolgt von einer Liste der mit dem Signal verbundenen Pins, die sowohl die Richtung als auch den Pin-Namen anzeigen.

Freigabe des HAL-Mutex. Dies ist nützlich für die Wiederherstellung, wenn eine HAL-Komponente abgestürzt ist, während sie den HAL-Mutex hielt.

Anzeige der Ergebnisse der einzelnen Befehle

zeigt eine Menge zunächst unnütz erscheinender Information zur Fehlerfindung

einen Hilfebildschirm anzeigen und beenden, zeigt die erweiterte Hilfe zum Befehl an, falls angegeben

(kurz für "load realItime module") Lädt ein Echtzeit-HAL-Modul namens Modulname. halcmd sucht das Modul in einem zur Kompilierzeit angegebenen Verzeichnis.

(unload realtime module) Entlädt ein Echtzeit-HAL-Modul namens modname. Wenn modname "all" ist, werden alle derzeit geladenen Echtzeit-HAL-Module entladen. unloadrt funktioniert auch durch Ausführung von linuxcnc_module_helper oder rtapi_app, genau wie loadrt.

(load Userspace component) Executes the given UNIX-command, usually to load a non-realtime component. [flags] may be one or more of:

(wait for Userspace component) Wartet darauf, dass die Nicht-Echtzeit-Komponente name die Verbindung zur HAL trennt (normalerweise beim Beenden). Die Komponente muss bereits geladen sein. Nützlich am Ende einer HAL-Datei, um zu warten, bis der Benutzer eine Komponente der Benutzeroberfläche schließt, bevor er sie aufräumt und verlässt.

(unload Userspace component) Entlädt eine Nicht-Echtzeitkomponente namens compname. Wenn compname "all" ist, werden alle Nicht-Echtzeit-Komponenten entladen. unloadusr> arbeitet, indem es SIGTERM an alle Nicht-Echtzeit-Komponenten sendet.

Entlädt eine Nicht-Echtzeitkomponente oder ein Echtzeitmodul. Wenn compname "all" ist, werden alle Nicht-Echtzeit-Komponenten und Echtzeit-Module entladen.

(OBSOLETE - stattdessen net verwenden) (new signal) Erzeugt ein neues HAL-Signal namens signame, das später zur Verbindung von zwei oder mehr HAL-Komponentenpins verwendet werden kann. type ist der Datentyp des neuen Signals und muss einer von "bit", "s32", "u32" oder "float" sein. Schlägt fehl, wenn ein Signal mit demselben Namen bereits existiert.

(delete signal) Löscht das HAL-Signal signame. Alle Pins, die derzeit mit dem Signal verknüpft sind, werden entkoppelt. Schlägt fehl, wenn signame nicht existiert.

(kurz für set sgnal) Setzt den Wert des Signals signname auf value. Schlägt fehl, wenn signname nicht existiert, wenn es bereits einen Writer hat oder wenn der Wert value kein gültiger Wert ist. Zulässige Werte hängen vom jeweiligen Signaltyp ab.

(signal type) Ermittelt den Typ des Signals name. Schlägt fehl, wenn name nicht als Signal existiert.

(get signal) Ermittelt den Wert des Signals signame. Schlägt fehl, wenn signame nicht existiert.

(VERALTET - verwenden Sie stattdessen net) (link pin to signal) Stellt eine Verbindung zwischen einem HAL-Komponentenpin Pin-Name und einem HAL-Signal Sig-Name her. Jeder vorherige Link zu Pin-Name wird unterbrochen. arrow kann "<=", "=>", "=" sein oder weggelassen werden. halcmd ignoriert Pfeile, aber sie können in Befehlsdateien nützlich sein, um die Richtung des Datenflusses zu dokumentieren. Pfeile sollten nicht in der Befehlszeile verwendet werden, da die Shell versuchen könnte, sie zu interpretieren. Es ist ein Fehler wenn Pin-Name oder Sig-Name nicht vorhanden sind oder wenn diese nicht gleichen Typs sind.

(VERALTET - verwenden Sie stattdessen net) (link signal to pin) Funktioniert wie linkps, kehrt aber die Reihenfolge der Argumente um. halcmd behandelt beide Link-Befehle genau gleich. Verwenden Sie, was Sie bevorzugen.

(VERALTET - stattdessen net verwenden) (link pin to pin) Abkürzung für linkps, was das Signal erzeugt (benannt nach dem ersten Pin), verbindet sie dann beide mit diesem Signal. halcmd behandelt dies so, als wäre es: halcmd treats this just as if it were: halcmd newsig pinname1 halcmd linksp pinname1 pinname1 halcmd linksp pinname1 pinname2

Erstelle signame, das dem Typ von Pinname entspricht, falls er noch nicht existiert. Verknüpfen Sie dann signame mit jedem Pinname der Reihe nach. Pfeile können wie in linkps verwendet werden. Wenn ein Pin zum ersten Mal mit einem Signal verknüpft wird, erbt der Signalwert den Standardwert des Pins.

(unlink pin) Unterbricht jede vorherige Verbindung zu pinname. Schlägt fehl, wenn pinname nicht vorhanden ist. Ein nicht verknüpfter Pin behält den letzten Wert des Signals, mit dem er verknüpft war.

(set parameter oder pin) Setzt den Wert von Parameter oder Pin Name auf Wert. Schlägt fehl, wenn Name nicht als Pin oder Parameter existiert, wenn es sich um einen Parameter handelt, der nicht beschreibbar ist, wenn es ein Pin ist, der ein Ausgang ist, wenn es ein Pin ist, der bereits mit einem Signal verbunden ist, oder wenn Wert kein zulässiger Wert ist. Die zulässigen Werte hängen vom Typ des Pins oder Parameters ab. Existieren sowohl ein Pin als auch ein Parameter mit dem angegebenen Namen, so wird auf den Parameter zugegriffen.

Identisch mit setp. Diese alternative Form des Befehls kann bei Verwendung in einer Datei bequemer und lesbarer sein.

(parameter oder pin Typ) Liefert den Typ von Parameter oder Pin name. Schlägt fehl, wenn name nicht als Pin oder Parameter vorhanden ist. Existieren sowohl ein Pin als auch ein Parameter mit dem angegebenen Namen, wird der Parameter berücksichtigt.

(get parameter or pin) Liefert den Typ von Parameter oder Pin name. Schlägt fehl, wenn name nicht als Pin oder Parameter vorhanden ist. Existieren sowohl ein Pin als auch ein Parameter mit dem angegebenen Namen, wird der Parameter berücksichtigt.

(add funktion) Fügt die Funktion functname zum Echtzeit-Thread threadname hinzu. functname wird nach allen Funktionen ausgeführt, die zuvor zum Thread hinzugefügt wurden. Schlägt fehl, wenn entweder functname oder threadname nicht existiert, oder wenn sie nicht kompatibel sind.

(init function) Registers functname to run once in realtime context on a dedicated init cycle of threadname, before the cyclic function list executes. Intended for one-shot setup that must run in the realtime task (for example EtherCAT slave configuration). Once the init cycle has run, further initf calls on that thread are rejected. Fails if either functname or threadname does not exist.

(delete funktion) Entfernt die Funktion functname aus dem Echtzeit-Thread threadname. Schlägt fehl, wenn entweder functname oder threadname nicht existiert, oder wenn functname derzeit nicht Teil von threadname ist.

Startet die Ausführung von Echtzeit-Threads. Jeder Thread ruft periodisch alle Funktionen auf, die ihm mit dem Befehl addf hinzugefügt wurden, und zwar in der Reihenfolge, in der sie hinzugefügt wurden.

Stoppt die Ausführung von Echtzeit-Threads. Die Threads werden ihre Funktionen nicht mehr aufrufen.

Gibt HAL-Elemente (engl. items) in menschenlesbarem Format auf stdout aus. I<element> kann eines von "comp" (Komponenten), "pin", "sig" (Signale), "param" (Parameter), "funct" (Funktionen), "thread", oder "alias". Der Typ "all" kann verwendet werden, um übereinstimmende Elemente aller vorangegangenen Typen anzuzeigen. Wenn element weggelassen wird, dann gibt show alles aus.

Gibt HAL-Elemente in Form von HAL-Befehlen auf stdout aus. Diese Befehle können in eine Datei umgeleitet und später mit halcmd -f ausgeführt werden, um die gespeicherte Konfiguration wiederherzustellen. Element kann einer der folgenden Werte sein:

Führt die Befehle in Dateiname.hal aus.

Weist alias als zweiten Namen für den Pin oder Parameter für "Name" zu. Für die meisten Operationen bietet ein Alias einen zweiten einen zweiten Namen, der verwendet werden kann, um auf einen Pin oder Parameter zu verweisen, sowohl der Originalname und der Alias funktionieren. "type" muss B<pin> oder B<param> sein. "name" muss ein bestehender Name oder B<alias> des angegebenen Typs sein. Beachten Sie, dass der Befehl "show" nur den Aliasnamen anzeigt, aber der ursprüngliche Name ist weiterhin gültig und kann in HAL verwendet werden. Die ursprünglichen Namen können weiterhin mit "show all" oder "show alias" angezeigt werden. Bestehende Netze bleiben erhalten, wenn ein Pin-Name aliasiert wird.

Entfernt jeden Alias aus dem Pin- oder Parameter-Alias. "Typ" muss pin oder param sein, "alias" muss ein vorhandener Name oder alias des angegebenen Typs sein.

Prints the names of HAL items of the specified type. type is comp, pin, sig, param, funct, or thread. If pattern is specified it prints only those names that match the pattern, which may be a shell glob. For sig, pin and param, the first pattern may be -tdatatype where datatype is the data type (e.g., float) in this case, the listed pins, signals, or parameters are restricted to the given data type Names are printed on a single line, space separated.

Druckt den Dateinamen, die Leinennummer und eine optionale Nachricht. Die Nachricht wird in Anführungszeichen eingeschlossen, wenn sie Leerzeichen enthält.

Sperrt HAL bis zu einem gewissen Grad. none - keine Sperre. tune - einige Einstellungen sind möglich (setp und so). all - HAL vollständig gesperrt.

Schaltet HAL bis zu einem gewissen Grad frei. tune - einige Einstellungen sind möglich (setp und so). all - HAL komplett freigeschaltet.

Prints status info about HAL. type is lock, mem, or all. If type is omitted, it assumes all.

Setzt den rtapi-Messaging-Level (siehe man3 rtapi_set_msg_level).

Gibt Hilfeinformationen zum Befehl. Wenn Befehl weggelassen wird, dann wird der Befehl mit einer kurzen Beschreibung aufgelistet.