Naar inhoud springen

CLI Commando's

Uit MeshWiki

CLI Commando's

Overzicht van CLI commando's voor MeshCore repeaters, room servers en sensoren.

Verbind via seriële poort (USB) of remote via een companion app. Commando's gemarkeerd met Alleen serieel werken niet via remote verbinding.

Volledige Engelstalige documentatie: GitHub CLI Reference

Operationeel

Commando Omschrijving Opmerking
reboot Herstart de node
clkreboot Reset de klok en herstart
clock Toon huidige tijd (UTC)
clock sync Synchroniseer klok met het verbonden apparaat
time {epoch} Stel tijd in op een specifiek Unix-tijdstempel
advert Stuur een flood advertisement
advert.zerohop Stuur een zero-hop advertisement
start ota Start een Over-The-Air firmware update
erase Fabrieksinstellingen: wist alles en reset Alleen serieel. Destructief!

Informatie

Commando Omschrijving
ver Toon firmware versie
board Toon hardware type
get public.key Toon publieke sleutel van de node
get role Toon de geconfigureerde rol van de node

Neighbors (alleen repeater)

Commando Omschrijving Opmerking
neighbors Toon nabije nodes Max 8 meest recente adverts. Formaat: {pubkey-prefix}:{timestamp}:{snr*4}
neighbor.remove {pubkey-prefix} Verwijder neighbor uit lijst Prefix kan kort of volledig zijn. Een spatie als prefix verwijdert alle neighbors.

Statistieken en logging

Commando Omschrijving Opmerking
stats-core Batterij, uptime, queue length, debug flags Alleen serieel
stats-radio Noise floor, laatste RSSI/SNR, airtime, ontvangstfouten Alleen serieel
stats-packets Pakkettellers: ontvangen, verzonden Alleen serieel
clear stats Reset statistieken
log start Start packet logging
log stop Stop logging
log erase Verwijder logs
log Toon logs Alleen serieel

Radio instellingen

Commando Omschrijving Standaard
get radio / set radio {freq},{bw},{sf},{cr} LoRa parameters: frequentie (MHz), bandbreedte (kHz), spreading factor (5-12), coding rate (5-8) 869.525,250,11,5
get freq / set freq {MHz} Frequentie apart instellen. set freq is alleen serieel. 869.525
get tx / set tx {dBm} Zendvermogen (1-22 dBm). Dit is alleen het LoRa-chipvermogen; sommige boards hebben een extra versterker. Verschilt per board
get int.thresh / set int.thresh {dB} Interference threshold 0.0 (uit)
tempradio {freq},{bw},{sf},{cr},{minuten} Tijdelijke radio-instellingen voor opgegeven duur. Wordt niet opgeslagen en verdwijnt bij reboot.

Let op: set radio en set freq vereisen een reboot. set tx wordt direct toegepast zonder reboot. Houd rekening met wettelijke zendvermogenlimieten.

Systeem configuratie

Commando Omschrijving Standaard
get name / set name {naam} Naam van de node. Max 24 bytes als locatie is ingesteld, anders 32 bytes. Emoji en unicode kunnen meer dan 1 byte innemen.
get lat / set lat {graden} Breedtegraad 0
get lon / set lon {graden} Lengtegraad 0
password {wachtwoord} Stel admin wachtwoord in. Elke node die dit wachtwoord gebruikt wordt aan de admin ACL-lijst toegevoegd. password
get guest.password / set guest.password {ww} Guest wachtwoord Leeg
get owner.info / set owner.info {tekst} wordt vertaald naar newlines. Leeg
get prv.key / set prv.key {key} Identity (private key) in hex (64 tekens). get prv.key is alleen serieel. Vereist reboot.
get adc.multiplier / set adc.multiplier {waarde} Fine-tune batterijmeting (0.0-10.0). Geeft fout op boards zonder ondersteuning. 0.0 (boardwaarde)
powersaving / powersaving {on|off} Energiebesparing aan/uit (alleen repeater). Schakelt slaapmodus in tussen zendmomenten. on

Routing

Commando Omschrijving Standaard
get repeat / set repeat {on|off} Repeater modus aan/uit on
get flood.max / set flood.max {waarde} Maximum aantal hops voor flood berichten (0-64) 64
get txdelay / set txdelay {waarde} Vertraging bij doorsturen van flood verkeer (0-2) 0.5
get direct.txdelay / set direct.txdelay {waarde} Vertraging bij doorsturen van direct verkeer (0-2) 0.2
get rxdelay / set rxdelay {waarde} [Experimenteel] Verwerkingsvertraging voor ontvangen verkeer (0-20) 0.0
get af / set af {waarde} Airtime factor / duty cycle limiet (0-9). Na elke transmissie wordt een stille periode afgedwongen van de zendtijd × deze waarde. Voorbeeld: af=1 ≈ 50%, af=3 ≈ 25%, af=9 ≈ 10%. 1.0
get path.hash.mode / set path.hash.mode {waarde} Advert path hash grootte: 0 = 1 byte (256 IDs, max 64 flood), 1 = 2 bytes (65.536 IDs, max 32 flood), 2 = 3 bytes (16M IDs, max 21 flood). Sinds firmware 1.14. 0
get loop.detect / set loop.detect {modus} Loopdetectie: off, minimal, moderate, strict. Verwerpt flood pakketten die in een lus lijken te zitten. Sinds firmware 1.14. off
get agc.reset.interval / set agc.reset.interval {sec} AGC reset interval in seconden (afgerond naar veelvoud van 4) 0.0
get multi.acks / set multi.acks {0|1} Multi-ACK ondersteuning aan/uit 0
get flood.advert.interval / set flood.advert.interval {uren} Interval voor flood adverts (3-168 uur) 12 (repeater), 0 (sensor)
get advert.interval / set advert.interval {min} Interval voor zero-hop adverts (60-240 min, afgerond naar veelvoud van 2) 0

Access Control

Commando Omschrijving Opmerking
get acl Toon access control lijst Alleen serieel
setperm {pubkey} {level} Wijzig permissies: 0=Guest, 1=Read-only, 2=Read-write, 3=Admin. Zonder level wordt de entry verwijderd.
get allow.read.only / set allow.read.only {on|off} Read-only modus voor de room server off

Regio instellingen

Zie ook: Regio en scope

Commando Omschrijving Opmerking
region Toon alle regio's en flood permissions Alleen serieel voor firmware ouder dan 1.12
region list {allowed|denied} Toon regio's met filter Alleen serieel. Sinds firmware 1.12.
region load Bulk-load regio's. Inspringen creëert ouder-kind relaties (max 8 niveaus). Interactieve modus alleen serieel
region load {naam} [F] Voeg een regio toe. Optioneel F om flooding toe te staan.
region save Sla regio-wijzigingen op
region allowf {naam} Sta flooding toe voor regio. * als naam staat pakketten zonder regio transport codes toe.
region denyf {naam} Blokkeer flooding voor regio. * als naam blokkeert pakketten zonder regio transport codes.
region get {naam} Toon info voor regio
region home / region home {naam} Bekijk of wijzig thuis-regio
region put {naam} [parent] Maak nieuwe regio aan. Zonder parent wordt wildcard gebruikt.
region remove {naam} Verwijder regio. Alle child-regio's moeten eerst verwijderd zijn.

Zie Regio en scope voor voorbeelden van regio-configuratie.

GPS

Beschikbaar wanneer GPS-ondersteuning is meegecompileerd.

Commando Omschrijving Standaard
gps / gps {on|off} GPS module aan/uit. Toont status, fix en aantal satellieten wanneer ingeschakeld. off
gps sync Synchroniseer klok met GPS-tijd
gps setloc Stel locatie in op basis van GPS-coördinaten
gps advert / gps advert {policy} GPS advert beleid: none (niet delen), share (GPS-locatie delen), prefs (opgeslagen lat/lon gebruiken) prefs

Sensoren

Beschikbaar wanneer sensorondersteuning is meegecompileerd.

Commando Omschrijving
sensor list [start] Toon sensoren op de node. Optioneel startindex.
sensor get {key} Lees een sensorwaarde
sensor set {key} {waarde} Wijzig een sensorwaarde

Bridge

Beschikbaar wanneer bridge-ondersteuning is meegecompileerd.

Commando Omschrijving Standaard
get bridge.type Toon het gecompileerde bridge-type
get bridge.enabled / set bridge.enabled {on|off} Bridge aan/uit off
get bridge.delay / set bridge.delay {ms} Vertraging voor pakketten via de bridge (0-10000 ms) 500
get bridge.source / set bridge.source {logRx|logTx} Bron van pakketten naar de externe interface logTx
get bridge.baud / set bridge.baud {rate} Seriële snelheid (alleen RS-232): 9600, 19200, 38400, 57600, 115200 115200
get bridge.channel / set bridge.channel {kanaal} Kanaal voor bridging (alleen ESPNow, 1-14)
get bridge.secret / set bridge.secret {secret} ESP-Now bridge secret (max 15 tekens) Verschilt per board

Power management

Commando Omschrijving
get bootloader.ver Toon bootloader versie (alleen nRF52)
get pwrmgt.support Toon power management ondersteuning
get pwrmgt.source Toon huidige stroombron
get pwrmgt.bootreason Toon boot reset en shutdown redenen
get pwrmgt.bootmv Toon spanning bij boot

Let op: Power management commando's geven een fout op boards zonder ondersteuning.

Zie ook