EN

CLI-Befehle

CLI-Befehle

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

- Funk - System - Routing - ACL (Access Control List, Zugriffssteuerungsliste) - Regionsverwaltung (v1.10+) - Beispiele für Regionen - GPS (wenn GPS-Unterstützung kompiliert ist) - Sensoren (wenn Sensor-Unterstützung kompiliert ist) - Bridge (wenn Bridge-Unterstützung kompiliert ist) - Ethernet (wenn Ethernet-Unterstützung kompiliert 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.

---

Uhrzeit zurücksetzen und neu starten

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

---

Uhrzeit mit dem Remote-Gerät synchronisieren

Verwendung:
  • clock sync
---

Aktuelle UTC-Zeit anzeigen

Verwendung:
  • clock
---

Uhrzeit auf einen bestimmten Zeitstempel einstellen

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

Eine Flut-Ankündigung (Flood Advert) senden

Verwendung:
  • advert
---

Eine Null-Hop-Ankündigung (Zero-Hop Advert) senden

Verwendung:
  • advert.zerohop
---

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

Verwendung:
  • start ota
---

Löschen/Werksreset (Factory Reset)

Verwendung:
  • erase
Nur seriell: Ja Warnung: _Dies ist zerstörerisch!_

---

Nachbarn (nur Repeater)

Nahegelegene Nachbarn auflisten

Verwendung:
  • neighbors
Hinweis: Die Ausgabe dieses Befehls ist auf die 8 neuesten Annoncierungen (adverts) beschränkt. Hinweis: Jede Zeile ist als {pubkey-prefix}:{timestamp}:{snr*4} kodiert.

---

Einen Nachbarn entfernen

Verwendung:
  • neighbor.remove
Parameter:
  • pubkey_prefix: Der öffentliche Schlüssel des Knotens, der aus der Nachbarschaftsliste 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 auf ein leeres Präfix hin, das mit allen vorhandenen Nachbarn übereinstimmt.

---

Null-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 – Rauschpegel (Noise Floor), letzter RSSI/SNR, Sendezeit (Airtime), Empfangsfehler

Verwendung: stats-radio Nur seriell: Ja

---

Paketstatistiken – Paket-Zähler: Empfangen, Gesendet

Verwendung: stats-packets Nur seriell: Ja

---

Protokollierung

Startet die Aufzeichnung des Rx-Protokolls im Knotenspeicher

Verwendung: log start

---

Beendet die Aufzeichnung des Rx-Protokolls im Knotenspeicher

Verwendung: log stop

---

Gespeichertes Protokoll löschen

Verwendung: log erase

---

Gespeichertes Protokoll auf dem 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 in kHz
  • sf: Spreading Factor (Spreizfaktor) (5-12)
  • cr: Coding Rate (Kodierungsrate) (5-8)
Durch Build-Flag gesetzt: LORA_FREQ, LORA_BW, LORA_SF, LORA_CR Standard: 869.618,62.5,8,5 Hinweis: Erfordert einen Neustart zur Anwendung

---

Sendeleistung dieses Knotens anzeigen oder ändern

Verwendung:
  • get tx
  • set tx
Parameter:
  • dbm: Leistungspegel in dBm (1-22)
Durch Build-Flag gesetzt: LORA_TX_POWER Standard: Variiert je nach Platine Hinweise: Diese Einstellung steuert nur den Leistungspegel des LoRa-Chips. Einige Knoten verfügen über eine zusätzliche Leistungsverstärkerstufe, die die Gesamtleistung 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: Spreading Factor (Spreizfaktor) (5-12)
  • cr: Coding Rate (Kodierungsrate) (5-8)
  • timeout_mins: Dauer in Minuten (muss > 0 sein)
Hinweis: Dies wird nicht in den Einstellungen gespeichert und geht bei einem Neustart verloren.

---

Frequenz dieses Knotens anzeigen oder ändern

Verwendung:
  • get freq
  • set freq
Parameter:
  • frequency: Frequenz in MHz
Standard: 869.618 Hinweis: Erfordert einen Neustart zur Anwendung 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|off Standard: on Temporärer Hinweis: Wenn Sie von einer älteren Version auf 1.14.1 aktualisiert haben, ohne den Flash zu löschen, ist diese Einstellung off aufgrund von #2118.

---

Gain-Status des LoRa FEM-Empfangspfads auf unterstützten Platinen anzeigen oder ändern

Verwendung:
  • get radio.fem.rxgain
  • set radio.fem.rxgain
Parameter:
  • state: on|off
Hinweise:
  • Dies steuert den externen LoRa FEM (Front-End Module) Empfangspfad-LNA (Low-Noise Amplifier), sofern die Platine dies unterstützt.
  • Dies ist getrennt von radio.rxgain, welches den Empfangs-Gain-Modus des Funkchips steuert.
---

Gain-Status des LoRa FEM-Sendepfads auf unterstützten Platinen anzeigen oder ändern

Verwendung:
  • get radio.fem.txgain
  • set radio.fem.txgain
Parameter:
  • state: on|off
Hinweise:
  • Dies steuert eine software-wählbare externe LoRa FEM Sende-Gain, sofern die Platine dies unterstützt.
  • Auf Station G3 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 Hardware-Jumper PA PL2 bestimmt, ob dies zwischen den Leistungsstufen 1/3 oder 2/4 wechselt.
  • Wählen Sie einen Betriebslevel und eine SX1262 Sendeleistung, die den lokalen HF-Grenzwerten und den Stromversorgungsanforderungen der Station G3 entsprechen.
  • Die Einstellung wird sofort gespeichert, aber auf Station G3 wird der Level bei Beginn des nächsten Sendevorgangs auf die Hardware angewendet, so dass die PA-Versorgungsschiene niemals neu ausgerichtet wird, während der PA betrieben wird. get meldet den konfigurierten Zustand, der der Hardware vor dem nächsten Senden des Knotens voraus sein kann.
---

System

Namen dieses Knotens anzeigen oder ändern

Verwendung:
  • get name
  • set name
Parameter:
  • name: Knotenname
Durch Build-Flag gesetzt: ADVERT_NAME Standard: Variiert je nach Platine Hinweis: Angekündigte Namen können bis zu 23 Byte verwenden, wenn der Standort enthalten ist, und 31 Byte, wenn nicht. Emoji- und Unicode-Zeichen können mehr als ein Byte belegen. Namen, die den verfügbaren Ankündigungsplatz überschreiten, werden an einer gültigen UTF-8-Codepunktgrenze abgeschnitten.

---

Breitengrad dieses Knotens anzeigen oder ändern

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

Längengrad dieses Knotens anzeigen oder ändern

Verwendung:
  • get lon
  • set lon
Durch Build-Flag gesetzt: 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 Hex-Zeichen)
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
Durch Build-Flag gesetzt: ADMIN_PASSWORD Standard: password Hinweis: Die Antwort des Befehls wiederholt das aktualisierte Passwort zur Bestätigung. Hinweis: Jeder Knoten, der dieses Passwort verwendet, wird zur Admin-ACL-Liste (Access Control List) hinzugefügt.

---

Gast-Passwort dieses Knotens anzeigen oder ändern

Verwendung:
  • get guest.password
  • set guest.password
Parameter:
  • password: Gast-Passwort
Durch Build-Flag gesetzt: 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-Multiplikator (0.0-10.0)
Standard: 0.0 (Wert wird von der Platine 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

---

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

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

---

Routing

Wiederholungs-Flag (Repeat Flag) dieses Knotens anzeigen oder ändern

Verwendung:
  • get repeat
  • set repeat
Parameter: - state: on|off Standard: on

---

Pfad-Hash-Größe (Advert Path Hash Size) 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) [max. 64 Flut] - 1: 2-Byte-Hash-Größe (65.536 eindeutige IDs) [max. 32 Flut] - 2: 3-Byte-Hash-Größe (16.777.216 eindeutige IDs) [max. 21 Flut] - 3: NICHT VERWENDEN (Reserviert) Standard: 0 Hinweis: path.hash.mode legt die Größe der Low-Level-ID/Hash-Kodierung fest, die von den Repeater-Ankündigungen verwendet wird. Diese Einstellung hat keinen Einfluss darauf, welche Paket-ID/Hash-Größe dieser Repeater weiterleitet; alle Größen sollten ab Firmware >= 1.14 weitergeleitet werden. Diese Funktion wurde in Firmware 1.14 hinzugefügt. Temporärer Hinweis: Ankündigungen mit ID/Hash-Größen von 2 oder 3 Bytes können in Ihrem Netzwerk eine begrenzte Flut-Verbreitung haben, da diese Funktion neu ist und Firmware v1.13.0 und älter Pakete mit Multibyte-Pfad-ID/Hashes verwerfen wird, da nur 1-Byte-Hashes unterstützt werden. Berücksichtigen Sie, dass Ihre Installationsbasis von Firmware >= 1.14 eine kritische Masse für eine effektive Netzwerkflutung 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 Mal (2-Byte) oder 1 oder mehr Mal (3-Byte) erscheint. - moderate: Pakete werden verworfen, wenn die ID/der Hash des Repeaters 2 oder mehr Mal (1-Byte), 1 oder mehr Mal (2-Byte) oder 1 oder mehr Mal (3-Byte) erscheint. - strict: Pakete werden verworfen, wenn die ID/der Hash des Repeaters 1 oder mehr Mal (1-Byte), 1 oder mehr Mal (2-Byte) oder 1 oder mehr Mal (3-Byte) erscheint. Standard: off Hinweis: Wenn aktiviert, werden Repeater jetzt Flutpakete ablehnen, die wie Schleifen 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/sein Hash bereits im Pfad vorhanden ist. Wenn er bereits 4 Mal kodiert ist, wird das Paket abgelehnt. Wenn das Paket eine 2-Byte-Pfadgröße verwendet und die eigene ID/der Hash des Repeaters bereits 2 Mal kodiert ist, lehnt er ab. Wenn das Paket eine 3-Byte-Pfadgröße verwendet und die eigene ID/der Hash des Repeaters bereits 1 Mal kodiert ist, lehnt er ab.

---

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

Verwendung:
  • get txdelay
  • set txdelay
Parameter:
  • value: Sende-Verzögerungsfaktor (0-2)
Standard: 0.5 Hinweis: Wenn mehrere nahegelegene Repeater dasselbe Flutpaket 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 einer erhöhten 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.3 (Repeater) - 0.2 (Raumserver, Sensor) Hinweis: Gleiches Zufallsfenster zur Kollisionsvermeidung wie txdelay, aber angewendet auf direkten (nicht-Flut, gerouteten) Verkehr. Der Standardwert ist niedriger, da direkte Pakete an einen bestimmten nächsten Hop adressiert sind, sodass weitaus 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 Flutpaket mit schwachem Signal empfangen haben, vor der Verarbeitung in einer Verzögerungswarteschlange gehalten, während diejenigen, die es mit starkem Signal empfangen haben, es sofort verarbeiten. Dies gibt Weiterleitungen mit starkem Signal Priorität. Bis Knoten mit schwachem Signal ihre Kopie verarbeiten, ist das Paket möglicherweise bereits verbreitet und wird als Duplikat unterdrückt, wodurch redundante Neuübertragungen reduziert werden.

---

Duty-Cycle-Grenzwert anzeigen oder ändern

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

---

Sendezeitfaktor (Duty-Cycle-Grenzwert) anzeigen oder ändern

Veraltet ab Firmware v1.15.0. Verwenden Sie stattdessen get/set dutycycle.
Verwendung:
  • get af
  • set af
Parameter:
  • value: Sendezeitfaktor (Airtime factor) (0-9). Nach jeder Übertragung erzwingt der Repeater eine Ruhezeit von ungefähr der Sendezeit in der Luft multipliziert mit dem Wert. Dies führt zu einem langfristigen Duty Cycle von ungefähr 1 geteilt durch (1 plus den Wert). Zum Beispiel:
- af = 1 → ~50% Duty - af = 2 → ~33% Duty - af = 3 → ~25% Duty - af = 9 → ~10% Duty 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) angemessen ist. Standard: 1.0

---

Lokalen Interferenzschwellenwert 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 Funkmodul vor der Übertragung einen Hardware-Kanalsuchlauf durch und verschiebt die Übertragung, wenn der Kanal belegt ist. Läuft unabhängig von int.thresh – entweder, beide oder keines können 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, 0-1020, abgerundet auf ein Vielfaches von 4 (17 wird zu 16). 0 zum Deaktivieren.
Standard: 0.0

---

Multi-Acks-Unterstützung aktivieren oder deaktivieren

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

---

Flut-Ankündigungsintervall anzeigen oder ändern

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

---

Null-Hop-Ankündigungsintervall 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: 2 auf einem fabrikneuen Knoten, dann 0 (deaktiviert), sobald konfiguriert. Hinweis: Eine neue Installation wird mit einem 2-minütigen Null-Hop-Ankündigungsintervall ausgeliefert. Das Speichern jeglicher Einstellungen setzt ein Intervall unterhalb des 60-Minuten-Minimums auf 0 zurück, unter der Annahme, dass der Knoten nun bewusst konfiguriert wurde. Um Null-Hop-Ankündigungen weiterhin auszuführen, setzen Sie einen expliziten Wert im Bereich 60-240.

---

Anzahl der Hops für eine Flut-Nachricht begrenzen

Verwendung:
  • get flood.max
  • set flood.max
Parameter:
  • value: Maximale Flut-Hop-Anzahl (0-64)
Standard: 64

---

Anzahl der Hops für eine nicht-bereichsgebundene (unscoped) Flut-Nachricht begrenzen

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

---

Anzahl der Hops für eine Ankündigungs-Flut-Nachricht begrenzen

Verwendung:
  • get flood.max.advert
  • set flood.max.advert
Parameter:
  • value: Maximale Flut-Hop-Anzahl (0-64) für ein Ankündigungspaket (advert packet)
Standard: 8

---

ACL

Berechtigungen für einen Begleiter hinzufügen, aktualisieren oder entfernen

Verwendung:
  • setperm
Parameter:
  • pubkey: Öffentlicher Schlüssel des Begleiters
  • permissions:
- 0: Gast - 1: Nur-Lesezugriff - 2: Lese-Schreibzugriff - 3: Administrator Hinweis: Entfernt den Eintrag, wenn permissions weggelassen wird.

---

Aktuelle ACL anzeigen

Verwendung:
  • get acl
Nur seriell: Ja

---

'Nur-Lesezugriff'-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 in großen Mengen laden

Verwendung:
  • region load
  • region load [flood_flag]
Parameter:
  • name: Ein Name einer Region. * repräsentiert die Wildcard-Region (Platzhalter-Region).
Hinweis: flood_flag: Optionales F, um Fluten (Flooding) zu erlauben. Hinweis: Einrückungen erzeugen Eltern-Kind-Beziehungen (maximal 8 Ebenen). Hinweis: region load mit einem leeren Namen funktioniert nicht remote (es ist interaktiv).

---

Änderungen an Regionen seit dem Neustart speichern

Verwendung:
  • region save
---

Eine Region zulassen

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

---

Eine Region blockieren

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

---

Informationen zu einer Region anzeigen

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

Heimregion dieses Knotens anzeigen oder ändern

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

Standard-Bereichsregion (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: Regionname
  • parent_name: Name der Elternregion (optional, Standard ist Wildcard)
---

Regionshierarchie 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, verschiebt dann den Cursor zu jump (muss bereits auf dem Knoten existieren oder zuvor in diesem Befehl erstellt worden sein). jump ist nicht der Elternteil von name; verwenden Sie diese Form, um zurückzuspringen und einen weiteren Zweig zu starten.
Verhalten: Jede erstellte Region erlaubt standardmäßig Fluten (entspricht region put). Die Antwort ist der resultierende Regionsbaum (gleiches Format wie region ohne Parameter); überprüfen Sie ihn, bevor Sie region save ausführen, um ihn zu speichern. Bei einem Fehler ist die Antwort Err - ..., und alle vor dem Fehler platzierten Regionen 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 serielle Repeater-Interface akzeptiert eine Zeile mit 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, daher leiten Sie den nächsten Befehl mit child|ancestor ein, um ihn neu zu positionieren. Jedes Token wird höchstens einmal an | getrennt – region def a|b|c|d ist keine Abkürzung 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 partieller Status:
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 dies zu überprüfen, und wiederholen Sie dann den Vorgang mit einem korrigierten Sprung oder reparieren Sie dies 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 Stamm zurückzusetzen:
CLI 
region def a|* b|* c|* d|* e|* f
region save

---

Eine Region entfernen

Verwendung:
  • region remove
Parameter:
  • name: Regionname
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|denied
Hinweis: Erfordert Firmware 1.12+.

---

Alle definierten Regionen und Flutberechtigungen ausgeben

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

---

Region Examples

Beispiel 1: Verwendung des F-Flags mit benannter öffentlicher Region
CLI 
region load
#Europe F
<leere Zeile, um region load zu beenden>
region save
Erklärung:
  • Erstellt eine Region namens #Europe mit aktivierter Flutung.
  • Pakete aus dieser Region werden an andere Knoten geflutet.
--- Beispiel 2: Verwendung der Wildcard mit F-Flag
CLI 
region load
* F
<leere Zeile, um region load zu beenden>
region save
Erklärung:
  • Erstellt eine Wildcard-Region * mit aktivierter Flutung.
  • Aktiviert die Flutung für alle Regionen automatisch.
  • Gilt nur für Pakete ohne Transportcodes.
--- Beispiel 3: Verwendung der Wildcard ohne F-Flag
CLI 
region load
*
<leere Zeile, um region load zu beenden>
region save
Erklärung:
  • Erstellt eine Wildcard-Region * ohne Flutung.
  • 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
<leere Zeile, um region load zu beenden>
region save
Erklärung:
  • Erstellt die Region #Europe mit aktivierter Flutung.
  • Fügt verschachtelte Kindregionen (#UK, #France) hinzu.
  • Alle verschachtelten Regionen erben das Flutungs-Flag vom Elternteil.
--- Beispiel 5: Wildcard mit verschachtelten öffentlichen Regionen
CLI 
region load
* F
  #NorthAmerica
    #USA
      #NewYork
      #California
    #Canada
      #Ontario
      #Quebec
<leere Zeile, um region load zu beenden>
region save
Erklärung:
  • Erstellt eine Wildcard-Region * mit aktivierter Flutung.
  • Fügt eine verschachtelte #NorthAmerica-Hierarchie hinzu.
  • Aktiviert die Flutung für alle Kindregionen automatisch.
  • Nützlich für globale Netzwerke mit spezifischen regionalen Regeln.
---

GPS (wenn GPS-Unterstützung kompiliert ist)

GPS-Status anzeigen oder ändern

Verwendung:
  • gps
  • gps
Parameter:
  • state: on|off
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 der GPS-Zeit synchronisieren

Verwendung:
  • gps sync
---

Standort dieses Knotens basierend auf den GPS-Koordinaten einstellen

Verwendung:
  • gps setloc
---

GPS-Ankündigungsrichtlinie (Advert Policy) anzeigen oder ändern

Verwendung:
  • gps advert
  • gps advert
Parameter:
  • policy: none|share|prefs
- none: Standort nicht in Ankündigungen (adverts) aufnehmen - share: GPS-Standort teilen (vom SensorManager) - prefs: Standort in den lat- und lon-Einstellungen des Knotens gespeichert Standard: prefs

---

Sensoren (wenn Sensor-Unterstützung kompiliert ist)

Liste der Sensoren auf diesem Knoten anzeigen

Verwendung: sensor list [start] Parameter:
  • start: Optionaler Startindex (Standard ist 0)
Hinweis: Ausgabeformat: =\n

---

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 kompiliert ist)

Kompilierten Bridge-Typ anzeigen

Verwendung: get bridge.type

---

Bridge-Aktivierungs-Flag anzeigen oder ändern

Verwendung:
  • get bridge.enabled
  • set bridge.enabled
Parameter:
  • state: on|off
Standard: off

---

Eine 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 die Überbrückung verwendet wird (nur ESPNow)

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

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 Platine

---

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, wenn die Platine keine Energiemanagement-Unterstützung bietet.

---

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

Verwendung: get pwrmgt.bootreason Hinweis: Gibt einen Fehler zurück, wenn die Platine keine Energiemanagement-Unterstützung bietet.

---

Boot-Spannung anzeigen

Verwendung: get pwrmgt.bootmv Hinweis: Gibt einen Fehler zurück, wenn die Platine keine Energiemanagement-Unterstützung bietet.

---

Ethernet (wenn Ethernet-Unterstützung kompiliert ist)

Ethernet-Unterstützung ist auf RAK4631-Platinen 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. Die Ethernet-Firmware des Companion-Radios bietet keine CLI.
  • Die Ethernet-Schnittstelle erhält automatisch beim Start eine IP-Adresse über DHCP.
  • Ein TCP-Server lauscht auf Port 23 (Standard) auf 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