EN

CLI-Befehle

CLI-Befehle

Dieses Dokument bietet eine Übersicht über die CLI-Befehle (Command Line Interface – Befehlszeilenschnittstelle), die an MeshCore Repeater, Raumserver und Sensoren gesendet werden können.

- Funk - System - Routing - ACL - Regionsverwaltung (v1.10.+) - Regionsbeispiele - GPS (wenn GPS-Unterstützung einkompiliert ist) - Sensoren (wenn Sensor-Unterstützung einkompiliert ist) - Bridge (wenn Bridge-Unterstützung einkompiliert ist) - Ethernet (wenn Ethernet-Unterstützung einkompiliert ist)

---

Operationell

Knoten neu starten

Verwendung:
  • reboot
Hinweis: Es wird keine Antwort gesendet.

---

Knoten ausschalten

Verwendung:
  • poweroff, oder
  • shutdown
Hinweis: Es wird keine Antwort gesendet.

---

Uhr zurücksetzen und neu starten

Verwendung:
  • clkreboot
Hinweis: Es wird keine Antwort gesendet.

---

Uhr mit dem entfernten Gerät synchronisieren

Verwendung:
  • clock sync
---

Aktuelle Zeit in UTC anzeigen

Verwendung:
  • clock
---

Zeit auf einen bestimmten Zeitstempel einstellen

Verwendung:
  • time
Parameter:
  • epoch_seconds: Unix-Epoch-Zeit (Anzahl der Sekunden seit dem 1. Jänner 1970, 00:00:00 UTC)
---

Eine Flood-Anzeige (advert) senden

Verwendung:
  • advert
---

Eine Zero-Hop-Anzeige (advert) senden

Verwendung:
  • advert.zerohop
---

Eine Over-The-Air (OTA) Firmware-Aktualisierung starten

Verwendung:
  • start ota
---

Löschen/Werksreset

Verwendung:
  • erase
Nur Seriell: Ja Warnung: _Dies ist destruktiv!_ (Alle Daten werden gelöscht.)

---

Nachbarn (nur Repeater)

Nahegelegene Nachbarn auflisten

Verwendung:
  • neighbors
Hinweis: Die Ausgabe dieses Befehls ist auf die 8 aktuellsten Anzeigen (adverts) beschränkt. Hinweis: Jede Zeile ist als {pubkey-prefix}:{timestamp}:{snr*4} codiert (öffentlicher Schlüssel-Präfix:Zeitstempel:Signal-Rausch-Verhältnis*4).

---

Einen Nachbarn entfernen

Verwendung:
  • neighbor.remove
Parameter:
  • pubkey_prefix: Der öffentliche Schlüssel (public key) des Knotens, der aus der Nachbarliste entfernt werden soll. Dies kann ein kurzes Präfix oder der vollständige Schlüssel sein. Alle Nachbarn, die dem angegebenen Präfix entsprechen, werden entfernt.
Hinweis: Sie können alle Nachbarn entfernen, indem Sie ein Leerzeichen als Präfix senden. Das Leerzeichen deutet ein leeres Präfix an, welches mit allen vorhandenen Nachbarn übereinstimmt.

---

Zero-Hop-Nachbarn entdecken

Verwendung:
  • discover.neighbors
---

Statistiken

Statistiken löschen

Verwendung: clear stats

---

Systemstatistiken – Batterie, Betriebszeit, Warteschlangenlänge und Debug-Flags

Verwendung:
  • stats-core
Nur Seriell: Ja

---

Funkstatistiken – Grundrauschen, letzter RSSI/SNR, Sendezeit, Empfangsfehler

Verwendung: stats-radio Nur Seriell: Ja

---

Paketstatistiken – Paket-Zähler: Empfangen, Gesendet

Verwendung: stats-packets Nur Seriell: Ja

---

Protokollierung

Start der Aufzeichnung des RX-Protokolls im Knotenspeicher

Verwendung: log start

---

Ende der Aufzeichnung des RX-Protokolls im Knotenspeicher

Verwendung: log stop

---

Aufgezeichnetes Protokoll löschen

Verwendung: log erase

---

Aufgezeichnetes Protokoll am seriellen Terminal ausgeben

Verwendung: log Nur Seriell: Ja

---

Informationen

Version abrufen

Verwendung: ver

---

Hardware-Namen anzeigen

Verwendung: board

---

Konfiguration

Funk

Funkparameter dieses Knotens anzeigen oder ändern

Verwendung:
  • get radio
  • set radio ,,,
Parameter:
  • freq: Frequenz in MHz
  • bw: Bandbreite (Bandwidth) in kHz
  • sf: Spreizfaktor (Spreading Factor) (5-12)
  • cr: Codierungsrate (Coding Rate) (5-8)
Festgelegt durch Build-Flag: LORA_FREQ, LORA_BW, LORA_SF, LORA_CR Standard: 869.525,250,11,5 Hinweis: Erfordert einen Neustart, um angewendet zu werden.

---

Sendeleistung dieses Knotens anzeigen oder ändern

Verwendung:
  • get tx
  • set tx
Parameter:
  • dbm: Leistungspegel in dBm (1-22)
Festgelegt durch Build-Flag: LORA_TX_POWER Standard: Variiert je nach Board Hinweise: Diese Einstellung steuert nur den Leistungspegel des LoRa-Chips. Einige Knoten haben eine zusätzliche Leistungsverstärkerstufe (Power Amplifier, PA), die die Gesamtausgabe erhöht. Beachten Sie das Handbuch des Knotens für die korrekte Einstellung. Das Einstellen eines zu hohen Wertes kann gegen die Gesetze in Ihrem Land verstoßen.

---

Funkparameter für eine festgelegte Dauer ändern

Verwendung:
  • tempradio ,,,,
Parameter:
  • freq: Frequenz in MHz (300-2500)
  • bw: Bandbreite in kHz (7.8-500)
  • sf: Spreizfaktor (5-12)
  • cr: Codierungsrate (5-8)
  • timeout_mins: Dauer in Minuten (muss > 0 sein)
Hinweis: Dies wird nicht in den Einstellungen gespeichert und geht beim Neustart verloren.

---

Frequenz dieses Knotens anzeigen oder ändern

Verwendung:
  • get freq
  • set freq
Parameter:
  • frequency: Frequenz in MHz
Standard: 869.525 Hinweis: Erfordert einen Neustart, um angewendet zu werden. Nur Seriell: set freq

---

Rx Boosted Gain Modus dieses Knotens anzeigen oder ändern (SX12xx und LR1110, v1.14.1+)

Verwendung:
  • get radio.rxgain
  • set radio.rxgain
Parameter:
  • state: on (ein) oder off (aus)
Standard: on Temporärer Hinweis: Wenn Sie von einer älteren Version auf 1.14.1 aktualisiert haben, ohne den Flash-Speicher zu löschen, ist diese Einstellung off aufgrund von #2118.

---

LoRa FEM Empfangspfad-Verstärkungsstatus auf unterstützten Boards anzeigen oder ändern

Verwendung:
  • get radio.fem.rxgain
  • set radio.fem.rxgain
Parameter:
  • state: on (ein) oder off (aus)
Hinweise:
  • Dies steuert den externen LoRa FEM (Front-End Modul) Empfangspfad LNA (Low Noise Amplifier – rauscharmen Verstärker), sofern das Board dies unterstützt.
  • Dies ist getrennt von radio.rxgain, welches den Empfangsverstärkungsmodus des Funkchips steuert.
---

LoRa FEM Sendepfad-Verstärkungsstatus auf unterstützten Boards anzeigen oder ändern

Verwendung:
  • get radio.fem.txgain
  • set radio.fem.txgain
Parameter:
  • state: on (ein) oder off (aus)
Hinweise:
  • Dies steuert eine softwareseitig wählbare externe LoRa FEM Sende-Verstärkung, sofern das Board dies unterstützt.
  • Auf Station G3 Boards entfernen Sie den PA PL1 Jumper, um die Software-Steuerung zu ermöglichen. on wählt PA PL1 high/kurz und off wählt PA PL1 low/offen. Der PA PL2 Hardware-Jumper bestimmt, ob dies zwischen Leistungsstufen 1/3 oder 2/4 umschaltet.
  • Wählen Sie einen Betriebslevel und eine SX1262 Sendeleistung, die den lokalen RF-Grenzwerten und den Stromversorgungsanforderungen des Station G3 entsprechen.
  • Die Einstellung wird sofort gespeichert, aber auf Station G3 wird der Pegel erst beim Start der nächsten Übertragung auf die Hardware angewendet, sodass die PA-Versorgungsleitung niemals neu ausgerichtet wird, während der PA betrieben wird. get meldet den konfigurierten Zustand, der die Hardware leiten kann, bis der Knoten das nächste Mal sendet.
---

System

Namen dieses Knotens anzeigen oder ändern

Verwendung:
  • get name
  • set name
Parameter:
  • name: Name des Knotens
Festgelegt durch Build-Flag: ADVERT_NAME Standard: Variiert je nach Board Hinweis: Werbliche Namen (Advertised names) können bis zu 23 Bytes verwenden, wenn der Standort enthalten ist, und 31 Bytes sonst. Emojis und Unicode-Zeichen können mehr als ein Byte belegen. Namen, die den verfügbaren Werbeplatz überschreiten, werden an einer gültigen UTF-8-Codepunktgrenze gekürzt.

---

Breitengrad dieses Knotens anzeigen oder ändern

Verwendung:
  • get lat
  • set lat
Festgelegt durch Build-Flag: ADVERT_LAT Standard: 0 Parameter:
  • degrees: Breitengrad in Grad
---

Längengrad dieses Knotens anzeigen oder ändern

Verwendung:
  • get lon
  • set lon
Festgelegt durch Build-Flag: ADVERT_LON Standard: 0 Parameter:
  • degrees: Längengrad in Grad
---

Identität (Privater Schlüssel) dieses Knotens anzeigen oder ändern

Verwendung:
  • get prv.key
  • set prv.key
Parameter:
  • private_key: Privater Schlüssel im Hex-Format (64 Hexadezimalzeichen)
Nur Seriell:
  • get prv.key: Ja
  • set prv.key: Nein
Hinweis: Erfordert einen Neustart, um nach der Einstellung wirksam zu werden.

---

Admin-Passwort dieses Knotens ändern

Verwendung:
  • password
Parameter:
  • new_password: Neues Admin-Passwort
Festgelegt durch Build-Flag: ADMIN_PASSWORD Standard: password Hinweis: Die Befehlsantwort wiederholt das aktualisierte Passwort zur Bestätigung. Hinweis: Jeder Knoten, der dieses Passwort verwendet, wird zur Admin-ACL-Liste (Access Control List – Zugriffssteuerungsliste) hinzugefügt.

---

Gast-Passwort dieses Knotens anzeigen oder ändern

Verwendung:
  • get guest.password
  • set guest.password
Parameter:
  • password: Gast-Passwort
Festgelegt durch Build-Flag: ROOM_PASSWORD (nur Raumserver) Standard: (leer)

---

Eigentümerinformationen dieses Knotens anzeigen oder ändern

Verwendung:
  • get owner.info
  • set owner.info
Parameter:
  • text: Text der Eigentümerinformationen
Standard: (leer) Hinweis: |-Zeichen werden in Zeilenumbrüche übersetzt. Hinweis: Erfordert Firmware 1.12+.

---

Batteriewert feinabstimmen

Verwendung:
  • get adc.multiplier
  • set adc.multiplier
Parameter:
  • value: ADC (Analog-Digital-Wandler) Multiplikator (0.0-10.0)
Standard: 0.0 (Wert wird vom Board definiert) Hinweis: Gibt "Error: unsupported by this board" zurück, wenn die Hardware dies nicht unterstützt.

---

Öffentlichen Schlüssel dieses Knotens anzeigen

Verwendung: get public.key

---

Firmware-Version dieses Knotens anzeigen

Verwendung: ver

---

Konfigurierte Rolle dieses Knotens anzeigen

Verwendung: get role

---

Energiespar-Flag dieses Knotens anzeigen oder ändern (nur Repeater)

Verwendung:
  • powersaving
  • powersaving on
  • powersaving off
Parameter:
  • on: Energiesparen aktivieren
  • off: Energiesparen deaktivieren
Standard: off Hinweis: Wenn aktiviert, wechselt das Gerät zwischen Funkübertragungen in den Schlafmodus.

---

Routing

Wiederholungs-Flag (repeat flag) dieses Knotens anzeigen oder ändern

Verwendung:
  • get repeat
  • set repeat
Parameter:
  • state: on (ein) oder off (aus)
Standard: on

---

Hash-Größe des Anzeigenpfades (advert path hash) dieses Knotens anzeigen oder ändern

Verwendung:
  • get path.hash.mode
  • set path.hash.mode
Parameter:
  • value: Pfad-Hash-Größe (0-2)
- 0: 1 Byte Hash-Größe (256 eindeutige IDs) [64 maximale Flut] - 1: 2 Byte Hash-Größe (65.536 eindeutige IDs) [32 maximale Flut] - 2: 3 Byte Hash-Größe (16.777.216 eindeutige IDs) [21 maximale Flut] - 3: NICHT VERWENDEN (Reserviert) Standard: 0 Hinweis: Der 'path.hash.mode' legt die Größe der Low-Level-ID/Hash-Codierung fest, die verwendet wird, wenn der Repeater Anzeigen (adverts) sendet. Diese Einstellung hat keinen Einfluss darauf, welche Paket-ID/Hash-Größe dieser Repeater weiterleitet; alle Größen sollten unter Firmware >= 1.14 weitergeleitet werden. Diese Funktion wurde in Firmware 1.14 hinzugefügt. Temporärer Hinweis: Anzeigen (adverts) mit ID/Hash-Größen von 2 oder 3 Bytes können eine begrenzte Flutausbreitung in Ihrem Netzwerk haben, solange diese Funktion neu ist, da Firmware v1.13.0 und älter Pakete mit Multibyte-Pfad-IDs/Hashes fallen lässt, da nur 1-Byte-Hashes unterstützt werden. Berücksichtigen Sie, dass Ihre Installationsbasis von Firmware >=1.14 einen kritischen Punkt für eine effektive Netzwerkflut erreicht hat, bevor Sie höhere ID/Hash-Größen implementieren.

---

Schleifenerkennung (loop detection) dieses Knotens anzeigen oder ändern

Verwendung:
  • get loop.detect
  • set loop.detect
Parameter:
  • state:
- off: Es wird keine Schleifenerkennung durchgeführt - minimal: Pakete werden verworfen, wenn die ID/der Hash des Repeaters 4 oder mehr Mal (1-Byte), 2 oder mehr (2-Byte), 1 oder mehr (3-Byte) vorkommt - moderate: Pakete werden verworfen, wenn die ID/der Hash des Repeaters 2 oder mehr Mal (1-Byte), 1 oder mehr (2-Byte), 1 oder mehr (3-Byte) vorkommt - strict: Pakete werden verworfen, wenn die ID/der Hash des Repeaters 1 oder mehr Mal (1-Byte), 1 oder mehr (2-Byte), 1 oder mehr (3-Byte) vorkommt Standard: off Hinweis: Wenn aktiviert, lehnen Repeater nun Flood-Pakete ab, die wie eine Schleife aussehen. Dies geschah in letzter Zeit in einigen Meshes, wenn es nur eine einzelne 'schlechte' Repeater-Firmware gab (wahrscheinlich eine geforkte oder benutzerdefinierte Firmware). Wenn die Nutzdaten manipuliert und dann weitergeleitet werden, verursacht dasselbe Paket einen Paketsturm, der bis zu den maximalen 64 Hops wiederholt wird. Diese Funktion wurde in Firmware 1.14 hinzugefügt. Beispiel: Wenn die Einstellung loop.detect minimal ist und ein 1-Byte-Pfadgrößenpaket empfangen wird, prüft der Repeater, ob seine eigene ID/Hash bereits im Pfad vorhanden ist. Wenn sie bereits 4 Mal codiert ist, lehnt er das Paket ab. Wenn das Paket eine 2-Byte-Pfadgröße verwendet und die eigene ID/Hash des Repeaters bereits 2 Mal codiert ist, lehnt er es ab. Wenn das Paket eine 3-Byte-Pfadgröße verwendet und die eigene ID/Hash des Repeaters bereits 1 Mal codiert ist, lehnt er es ab.

---

Retransmission-Verzögerungsfaktor für Flood-Verkehr anzeigen oder ändern

Verwendung:
  • get txdelay
  • set txdelay
Parameter:
  • value: Sende-Verzögerungsfaktor (0-2)
Standard: 0.5 Hinweis: Wenn mehrere nahegelegene Repeater dasselbe Flood-Paket hören, wartet jeder eine zufällige Zeitspanne, bevor er es erneut sendet, um gleichzeitige Kollisionen zu vermeiden. Dieser Faktor skaliert die Größe dieses zufälligen Fensters. Höhere Werte reduzieren das Kollisionsrisiko auf Kosten erhöhter Latenz. 0 deaktiviert das Fenster vollständig.

---

Retransmission-Verzögerungsfaktor für direkten Verkehr anzeigen oder ändern

Verwendung:
  • get direct.txdelay
  • set direct.txdelay
Parameter:
  • value: Direkter Sende-Verzögerungsfaktor (0-2)
Standard: 0.2 Hinweis: Dasselbe zufällige Kollisionsvermeidungsfenster wie txdelay, aber angewendet auf direkten (nicht-Flood, gerouteten) Verkehr. Der Standardwert ist niedriger, da direkte Pakete an einen bestimmten nächsten Hop adressiert sind, sodass weit weniger Knoten um die erneute Übertragung konkurrieren.

---

[Experimentell] Verarbeitungsverzögerung für empfangenen Verkehr anzeigen oder ändern

Verwendung:
  • get rxdelay
  • set rxdelay
Parameter:
  • value: Empfangsverzögerungsbasis (0-20)
Standard: 0.0 Hinweis: Wenn aktiviert, werden Repeater, die ein Flood-Paket mit schwachem Signal empfangen haben, in einer Verzögerungswarteschlange gehalten, bevor sie verarbeitet werden, während diejenigen, die es mit starkem Signal empfangen haben, es sofort verarbeiten. Dies gibt Wegen mit starkem Signal Weiterleitungspriorität. Bis Knoten mit schwachem Signal ihre Kopie verarbeiten, kann das Paket bereits weitergeleitet worden sein und wird als Duplikat unterdrückt, wodurch redundante Neuübertragungen reduziert werden.

---

Sendezeitbegrenzung (Duty Cycle Limit) anzeigen oder ändern

Verwendung:
  • get dutycycle
  • set dutycycle
Parameter:
  • value: Prozentsatz der Sendezeitbegrenzung (1-100)
Standard: 50% (entspricht einem Airtime-Faktor von 1.0) Beispiele:
  • set dutycycle 100 — keine Sendezeitbegrenzung
  • set dutycycle 50 — 50% Sendezeitbegrenzung (Standard)
  • set dutycycle 10 — 10% Sendezeitbegrenzung
  • set dutycycle 1 — 1% Sendezeitbegrenzung (strengste EU-Anforderung)
Hinweis: Hinzugefügt in Firmware v1.15.0

---

Airtime-Faktor (Sendezeitbegrenzung) anzeigen oder ändern

Veraltet ab Firmware v1.15.0. Verwenden Sie stattdessen get/set dutycycle.
Verwendung:
  • get af
  • set af
Parameter:
  • value: Airtime-Faktor (0-9). Nach jeder Übertragung erzwingt der Repeater eine stille Periode, die ungefähr der Sendezeit in der Luft multipliziert mit dem Wert entspricht. Dies führt zu einer langfristigen Sendezeitbegrenzung (Duty Cycle) von ungefähr 1 geteilt durch (1 plus den Wert). Zum Beispiel:
- af = 1 → ~50% Sendezeit - af = 2 → ~33% Sendezeit - af = 3 → ~25% Sendezeit - af = 9 → ~10% Sendezeit Sie sind dafür verantwortlich, einen Wert zu wählen, der für Ihre Gerichtsbarkeit und Ihren Kanalplan (z.B. EU 868 Mhz 10% Duty Cycle-Regulierung) geeignet ist. Standard: 1.0

---

Lokale Interferenzschwelle anzeigen oder ändern

Verwendung:
  • get int.thresh
  • set int.thresh
Parameter:
  • value: Interferenzschwellenwert
Standard: 0.0

---

Hardware-Kanalsuchlauf (Channel Activity Detection, CAD) aktivieren oder deaktivieren

Verwendung:
  • get cad
  • set cad
Beschreibung: Wenn aktiviert, führt das Funkgerät vor dem Senden einen Hardware-Kanalsuchlauf durch und verschiebt die Übertragung, wenn der Kanal belegt ist. Läuft unabhängig von int.thresh – entweder beides, keines oder eines davon kann aktiv sein. Parameter:
  • on|off: Hardware-CAD aktivieren oder deaktivieren
Standard: off

---

AGC-Reset-Intervall (Automatic Gain Control) anzeigen oder ändern

Verwendung:
  • get agc.reset.interval
  • set agc.reset.interval
Parameter:
  • value: Intervall in Sekunden, abgerundet auf ein Vielfaches von 4 (17 wird zu 16). 0 zum Deaktivieren.
Standard: 0.0

---

Unterstützung für Multi-Acks aktivieren oder deaktivieren

Verwendung:
  • get multi.acks
  • set multi.acks
Parameter:
  • state: 0 (deaktivieren) oder 1 (aktivieren)
Standard: 0

---

Flood-Anzeige-Intervall (Flood Advert Interval) anzeigen oder ändern

Verwendung:
  • get flood.advert.interval
  • set flood.advert.interval
Parameter:
  • hours: Intervall in Stunden (3-168)
Standard: 12 (Repeater) - 0 (Sensor)

---

Zero-Hop-Anzeige-Intervall (Zero-Hop Advert Interval) anzeigen oder ändern

Verwendung:
  • get advert.interval
  • set advert.interval
Parameter:
  • minutes: Intervall in Minuten, abgerundet auf das nächste Vielfache von 2 (61 wird zu 60) (60-240)
Standard: 0

---

Maximale Hop-Anzahl für eine Flood-Nachricht begrenzen

Verwendung:
  • get flood.max
  • set flood.max
Parameter:
  • value: Maximale Hop-Anzahl für Floods (0-64)
Standard: 64

---

Maximale Hop-Anzahl für eine unbestimmte (unscoped) Flood-Nachricht begrenzen

Verwendung:
  • get flood.max.unscoped
  • set flood.max.unscoped
Parameter:
  • value: Maximale Hop-Anzahl für Floods (0-64) für ein Paket ohne Geltungsbereich (keine Region festgelegt)
Standard: 64 - (0xFF deutet an, dass es noch nicht gesetzt wurde; es wird flood.max verfolgen, bis es gesetzt wird.) Hinweis: Eine Alternative zu region denyf * ist, flood.max.unscoped auf einen niedrigeren Wert wie 3 zu setzen, um die Verbreitung lokaler unbestimmter Nachrichten zu ermöglichen, während verhindert wird, dass laute Nachbarn eine lokale Region überfluten.

---

Maximale Hop-Anzahl für eine Anzeige-Flood-Nachricht (Advert Flood) begrenzen

Verwendung:
  • get flood.max.advert
  • set flood.max.advert
Parameter:
  • value: Maximale Hop-Anzahl für Floods (0-64) für ein Anzeige-Paket
Standard: 8

---

ACL

Berechtigungen für einen Companion (Begleitgerät) hinzufügen, aktualisieren oder entfernen

Verwendung:
  • setperm
Parameter:
  • pubkey: Öffentlicher Schlüssel des Companion
  • permissions:
- 0: Gast - 1: Nur lesen - 2: Lesen-Schreiben - 3: Admin Hinweis: Entfernt den Eintrag, wenn permissions weggelassen wird.

---

Aktuelle ACL (Access Control List) anzeigen

Verwendung:
  • get acl
Nur Seriell: Ja

---

'Nur-Lesen'-Flag dieses Raumservers anzeigen oder ändern

Verwendung:
  • get allow.read.only
  • set allow.read.only
Parameter:
  • state: on (aktivieren) oder off (deaktivieren)
Standard: off

---

Regionsverwaltung (v1.10.+)

Regionenlisten im Bulk laden

Verwendung:
  • region load
  • region load [flood_flag]
Parameter:
  • name: Ein Name einer Region. * steht für die Wildcard-Region.
Hinweis: flood_flag: Optional F, um Flood (Flut) zu erlauben. Hinweis: Einrückungen erzeugen Eltern-Kind-Beziehungen (max. 8 Ebenen). Hinweis: region load mit einem leeren Namen funktioniert nicht fern (es ist interaktiv).

---

Seit dem Neustart vorgenommene Änderungen an Regionen speichern

Verwendung:
  • region save
---

Eine Region zulassen

Verwendung:
  • region allowf
Parameter:
  • name: Regionsname (oder * für Wildcard)
Hinweis: Das Setzen auf Wildcard * erlaubt Pakete ohne Regions-Transportcodes.

---

Eine Region blockieren

Verwendung:
  • region denyf
Parameter:
  • name: Regionsname (oder * für Wildcard)
Hinweis: Das Setzen auf Wildcard * verwirft Pakete ohne Regions-Transportcodes.

---

Informationen für eine Region anzeigen

Verwendung:
  • region get
Parameter:
  • name: Regionsname (oder * für Wildcard)
---

Heimatregion (Home Region) für diesen Knoten anzeigen oder ändern

Verwendung:
  • region home
  • region home
Parameter:
  • name: Regionsname
---

Standard-Scope-Region (Default Scope Region) für diesen Knoten anzeigen oder ändern

Verwendung:
  • region default
  • region default {name|}
Parameter:
  • name: Regionsname, oder zum Zurücksetzen/Löschen
---

Eine neue Region erstellen

Verwendung:
  • region put [parent_name]
Parameter:
  • name: Regionsname
  • parent_name: Name der Elternregion (optional, Standard ist Wildcard)
---

Regionen-Hierarchie definieren (einzeilig)

Verwendung:
  • region def [ ...]
Parameter (Tokens): Leerzeichengetrennt. Ein logischer Cursor beginnt bei der Wildcard *.
  • name — Erstellt name als Kind des aktuellen Cursors (entspricht region put name mit dem Cursor als Elternteil). Der Cursor bewegt sich zu name.
  • name|jump *(oder name,jump)* — Erstellt name als Kind des aktuellen Cursors, bewegt dann den Cursor zu jump (muss bereits auf dem Knoten existieren oder früher in diesem Befehl erstellt worden sein). jump ist nicht der Elternteil von name; verwenden Sie diese Form, um zurückzuspringen und einen anderen Zweig zu beginnen.
Verhalten: Jede erstellte Region erlaubt standardmäßig Flooding (entspricht region put). Die Antwort ist der resultierende Regionsbaum (gleiches Format wie ein einfaches region); überprüfen Sie ihn, bevor Sie region save ausführen, um ihn zu speichern. Bei einem Fehler ist die Antwort Err - ... und alle Regionen, die vor dem Fehler platziert wurden, bleiben auf dem Knoten, genau wie eine teilweise Kette von region put. Bestehende Regionen: region def löscht den bestehenden Baum nicht – wenn ein Name bereits existiert, wird sein Elternteil auf den aktuellen Cursor aktualisiert; andernfalls wird eine neue Region erstellt. Um von Grund auf neu zu beginnen, entfernen Sie die unerwünschten Regionen zuerst mit region remove. Einschränkungen: Das Repeater-Seriell akzeptiert eine Zeile bis zu 160 Zeichen. Für größere Bäume teilen Sie den Befehl in mehrere region def-Befehle auf; der Cursor wird zwischen den Befehlen auf * zurückgesetzt, also führen Sie den nächsten Befehl mit child|ancestor an, um neu zu positionieren. Jedes Token wird höchstens einmal an | getrennt – region def a|b|c|d ist keine Kurzform für eine flache Liste; siehe das Beispiel für eine flache Liste unten. Beispiel — lineare Kette (jedes Token wird ein Kind des vorherigen):
CLI 
region def a b c d e
region save
Beispiel — verzweigter Baum (entspricht region put a, region put b a, region put c b, region put d c, region put e b, region put f e):
CLI 
region def a b c d|b e f
region save
Beispiel — Fehler und teilweiser Zustand:
CLI 
region def a b c|nope d
Die Antwort ist Err - unknown jump: nope. a, b und c wurden vor dem Fehler platziert; d nicht. Führen Sie region aus, um zu prüfen, und wiederholen Sie dann den Befehl mit einem korrigierten Sprung oder reparieren Sie ihn mit region remove / region put. Beispiel — flache Liste (jede Region ein Kind von *). Verwenden Sie |* nach jedem Token, um den Cursor vor dem nächsten Token zum Root zurückzusetzen:
CLI 
region def a|* b|* c|* d|* e|* f
region save

---

Eine Region entfernen

Verwendung:
  • region remove
Parameter:
  • name: Regionsname
Hinweis: Alle Kindregionen müssen entfernt werden, bevor die Region selbst entfernt werden kann.

---

Alle Regionen anzeigen

Verwendung:
  • region list
Nur Seriell: Ja Parameter:
  • filter: allowed (erlaubt) oder denied (verweigert)
Hinweis: Erfordert Firmware 1.12+.

---

Alle definierten Regionen und Flood-Berechtigungen ausgeben

Verwendung:
  • region
Nur Seriell: Für Firmware älter als 1.12.0

---

Regionsbeispiele

Beispiel 1: Verwenden des F-Flags mit einer benannten öffentlichen Region
CLI 
region load
#Europe F
<Leerzeile, um Regionen laden zu beenden>
region save
Erklärung:
  • Erstellt eine Region namens #Europe mit aktivierter Flut (Flooding).
  • Pakete aus dieser Region werden an andere Knoten weitergeleitet (geflutet).
--- Beispiel 2: Verwenden von Wildcard mit F-Flag
CLI 
region load
* F
<Leerzeile, um Regionen laden zu beenden>
region save
Erklärung:
  • Erstellt eine Wildcard-Region * mit aktivierter Flut (Flooding).
  • Aktiviert das Fluten für alle Regionen automatisch.
  • Gilt nur für Pakete ohne Transportcodes.
--- Beispiel 3: Verwenden von Wildcard ohne F-Flag
CLI 
region load
*
<Leerzeile, um Regionen laden zu beenden>
region save
Erklärung:
  • Erstellt eine Wildcard-Region * ohne Flut (Flooding).
  • Diese Region existiert, beeinflusst aber die Paketverteilung nicht.
  • Wird als Standard-/leere Region verwendet.
--- Beispiel 4: Verschachtelte öffentliche Region mit F-Flag
CLI 
region load
#Europe F
  #UK
    #London
    #Manchester
  #France
    #Paris
    #Lyon
<Leerzeile, um Regionen laden zu beenden>
region save
Erklärung:
  • Erstellt die Region #Europe mit aktivierter Flut (Flooding).
  • Fügt verschachtelte Kindregionen (#UK, #France) hinzu.
  • Alle verschachtelten Regionen erben das Flut-Flag von der Elternregion.
--- Beispiel 5: Wildcard mit verschachtelten öffentlichen Regionen
CLI 
region load
* F
  #NorthAmerica
    #USA
      #NewYork
      #California
    #Canada
      #Ontario
      #Quebec
<Leerzeile, um Regionen laden zu beenden>
region save
Erklärung:
  • Erstellt eine Wildcard-Region * mit aktivierter Flut (Flooding).
  • Fügt eine verschachtelte #NorthAmerica-Hierarchie hinzu.
  • Aktiviert das Fluten für alle Kindregionen automatisch.
  • Nützlich für globale Netzwerke mit spezifischen regionalen Regeln.
---

GPS (wenn GPS-Unterstützung einkompiliert ist)

GPS-Status anzeigen oder ändern

Verwendung:
  • gps
  • gps
Parameter:
  • state: on (ein) oder off (aus)
Standard: off Hinweis: Ausgabeformat:
  • off, wenn die GPS-Hardware deaktiviert ist
  • on, {active|deactivated}, {fix|no fix}, {sat count} sats, wenn die GPS-Hardware aktiviert ist
---

Uhrzeit dieses Knotens mit GPS-Zeit synchronisieren

Verwendung:
  • gps sync
---

Standort dieses Knotens basierend auf GPS-Koordinaten festlegen

Verwendung:
  • gps setloc
---

GPS-Anzeigenrichtlinie (advert policy) anzeigen oder ändern

Verwendung:
  • gps advert
  • gps advert
Parameter:
  • policy: none (keine) | share (teilen) | prefs (Einstellungen)
- none: Standort nicht in Anzeigen (adverts) aufnehmen - share: GPS-Standort teilen (vom SensorManager) - prefs: Standort in den Lat- (Breitengrad) und Lon- (Längengrad) Einstellungen des Knotens gespeichert Standard: prefs

---

Sensoren (wenn Sensor-Unterstützung einkompiliert ist)

Liste der Sensoren auf diesem Knoten anzeigen

Verwendung: sensor list [start] Parameter:
  • start: Optionaler Startindex (Standard ist 0)
Hinweis: Ausgabeformat: =\n (Variablenname=Wert, gefolgt von einem Zeilenumbruch)

---

Wert eines Sensors anzeigen oder ändern

Verwendung:
  • sensor get
  • sensor set
Parameter:
  • key: Name der Sensoreinstellung
  • value: Der Wert, auf den der Sensor eingestellt werden soll
---

Bridge (wenn Bridge-Unterstützung einkompiliert ist)

Kompilierten Bridge-Typ anzeigen

Verwendung: get bridge.type

---

Bridge-Aktivierungsflag anzeigen oder ändern

Verwendung:
  • get bridge.enabled
  • set bridge.enabled
Parameter:
  • state: on (ein) oder off (aus)
Standard: off

---

Verzögerung zu Paketen hinzufügen, die über diese Bridge geroutet werden

Verwendung:
  • get bridge.delay
  • set bridge.delay
Parameter:
  • ms: Verzögerung in Millisekunden (0-10000)
Standard: 500

---

Quelle der Pakete anzeigen oder ändern, die zur externen Schnittstelle überbrückt werden

Verwendung:
  • get bridge.source
  • set bridge.source
Parameter:
  • source:
- logRx: Empfangene Pakete überbrücken - logTx: Gesendete Pakete überbrücken Standard: logTx

---

Geschwindigkeit der Bridge anzeigen oder ändern (nur RS-232)

Verwendung:
  • get bridge.baud
  • set bridge.baud
Parameter:
  • rate: Baudrate (9600, 19200, 38400, 57600, oder 115200)
Standard: 115200

---

Kanal anzeigen oder ändern, der für Bridging verwendet wird (nur ESPNow)

Verwendung:
  • get bridge.channel
  • set bridge.channel
Parameter:
  • channel: Kanalnummer (1-14)
---

Das ESP-Now Geheimnis festlegen

Verwendung:
  • get bridge.secret
  • set bridge.secret
Parameter:
  • secret: ESP-NOW Bridge-Geheimnis, bis zu 15 Zeichen
Standard: Variiert je nach Board

---

Bootloader-Version anzeigen (nur nRF52)

Verwendung: get bootloader.ver

---

Unterstützung für Energiemanagement anzeigen

Verwendung: get pwrmgt.support

---

Aktuelle Stromquelle anzeigen

Verwendung: get pwrmgt.source Hinweis: Gibt einen Fehler zurück auf Boards ohne Unterstützung für Energiemanagement.

---

Gründe für Boot-Reset und Herunterfahren anzeigen

Verwendung: get pwrmgt.bootreason Hinweis: Gibt einen Fehler zurück auf Boards ohne Unterstützung für Energiemanagement.

---

Boot-Spannung anzeigen

Verwendung: get pwrmgt.bootmv Hinweis: Gibt einen Fehler zurück auf Boards ohne Unterstützung für Energiemanagement.

---

Ethernet (wenn Ethernet-Unterstützung einkompiliert ist)

Ethernet-Unterstützung ist auf RAK4631-Boards mit einem RAK13800 (W5100S) Ethernet-Modul verfügbar. Verwenden Sie die _ethernet-Firmware-Varianten (z.B. RAK_4631_repeater_ethernet), um diese Funktion zu aktivieren.

---

Ethernet-Verbindungsstatus anzeigen

Verwendung:
  • eth.status
Ausgabe:
  • ETH: :, wenn verbunden (z.B. ETH: 192.168.1.50:23)
  • ETH: not connected, wenn Ethernet nicht aktiv ist
Hinweise:
  • Nur auf Repeater- und Raumserver-Firmware verfügbar. Companion-Radio-Ethernet-Firmware bietet keine CLI.
  • Die Ethernet-Schnittstelle erhält eine IP-Adresse über DHCP automatisch beim Booten.
  • Ein TCP-Server lauscht auf Port 23 (Standard) für CLI-Verbindungen.
  • Verbinden Sie sich mit jedem TCP-Client (z.B. nc, PuTTY), um auf dieselbe CLI zuzugreifen, die über seriell verfügbar ist.
← Einführung Companion-Protokoll →

Quelle: docs.meshcore.io