network management client

Wichtig

? Meshtastic Network Management Client benötigt einen neuen Plattform -Eigentümer / -verwalter?

Weitere Details finden Sie in Ausgabe Nr. 473.

Einführung

Diese Anwendung ist ein Desktop -Client für das Meshtastic -Projekt, mit dem Benutzer große, dezentrale Netznetzwerke zuverlässig verwalten können. Derzeit bietet das Meshtastic Client-Ökosystem eine starke Unterstützung für die Verwaltung einzelner Knoten, jedoch nur eine minimale Unterstützung für das Management und die Analyse auf Netzwerkebene. Ziel dieses Projekts ist es, den Benutzern durch neue algorithmische Analyse und Erkenntnisse auf Verbindungsebene in ihre Meshtastic-Netzwerke vertrauen.

Diese Anwendung wird mit dem Tauri -Framework erstellt, einem modernen, sicheren Nachfolger des Elektronengerüsts. Dies ermöglicht es uns, Linux, MacOS und Windows innerhalb derselben Codebasis ohne Leistung oder Speicheraufwand eines Chrombrowsers nativ zu unterstützen. Unsere Kernanwendungsinfrastruktur ist aufgrund ihrer Leistung und Sicherheit in Rost geschrieben, und unsere UI- und Client -Funktionalität wird in React TypeScript unter Verwendung von VITE geschrieben. Dieses Projekt befindet sich in frühen Entwicklungsstadien und ist als solche noch nicht für die Produktionsnutzung geeignet .

Fordern Sie Beiträge

Zum Zeitpunkt des Schreibens wird dieses Projekt derzeit von einem einzelnen Entwickler aufrechterhalten. Daher sucht das Projekt nach Entwicklern, die bereit sind, die folgenden wichtigen Initiativen beizutragen oder diese zu übernehmen:

• Vollständige Offline-Kartenunterstützung, einschließlich regionaler Herunterladen und Laden von benutzerdefinierten Karten (benötigt einen Meshtastic-Spiegel der OSM Tile DB)
• Anhaltungsstatus über Client -Sitzungen hinweg fortbestehen (vollendet)
• Rost -Backend -Test (Einheit, Integration, E2E, Rauch)
• TS Frontend Tests (Einheit, Integration, E2E, Rauch)
• Hinzufügen von Unterstützung für die Remote -Knotenkonfiguration
• Integration von UI -Komponenten in das Storybook -Framework
• Hinzufügen von Unterstützung für i18n -Übersetzungen innerhalb der UI -Schicht (vollendet)
• Allgemeine Umstrukturierung der Anwendungsdateistruktur, um das Projekt intuitiv zu gestalten

Funktionalität

Dieses Projekt befindet sich noch in frühen Entwicklungsstadien, aber hier ist eine grobe Roadmap von Funktionen, an denen wir arbeiten. Wir haben eine hohe Priorität, wenn wir unsere Kerninfrastruktur richtig machen, da dies der Kern einer robusten und effektiven UI -Schicht ist.

• ? Kerndatenflow -Infrastruktur
  • Serielle Daten senden/empfangen
  • Rost -Protobuf -Integration (.Proto -> .rs)
  • Paket codieren/decodieren
  • Gerätezustandsmanagement
• ? Kern -UI -Infrastruktur
  • Tauri Command Management
  • Tauri Event Management
  • Redux -Saga -Datenflow
• ? ️ Netzwerk -Topologiesammlung
  • RFC für neuartiges Paket (abgeschlossen)
  • MVP -Protobufänderungen (abgeschlossen)
  • MVP -Firmware -Änderungen (abgeschlossen)
  • Community Protobuf Review (abgeschlossen)
  • Community Firmware Review (abgeschlossen)
• ? Algorithmische Analyse
  • Infrastruktur
    • Netzwerkpaketaufnahme
    • Netzwerkgrafikkonstruktion
    • Algorithmus -Läufer
  • Ui
    • MVP -Algorithmus -Runner -Bereich
    • On-Map-Algorithmus UI
    • Automatischer Algorithmus erneut
• ? Knotenmanagement
  • Knotenpeer -Tabelle
  • Netzwerkkonfiguration (Multi-Device)
  • Remote -Knotenkonfiguration
• ? Wegpunktmanagement
  • Verwaltete Wegpunkt Tabelle
  • Überkanal-Wegpunkt Senden
  • On-Map-Wegpunkt-Tooltip
• Web Client Parity (UI)
  • Kartenknotenansicht
  • SMS -Nachrichten
  • Kanalimport/Export über QR -Code
  • Konfiguration
    • Gerätekonfiguration
    • Modulkonfiguration
    • Kanalkonfiguration
• ? Offline -Kartenansicht
  • Offline -Kartenspeicher
  • Regionaler Herunterladen
• ? Netzwerkdatenexport

? Hardwareanforderungen

Dieses Projekt basiert auf dem Meshtastic -Hardware -Ökosystem. Aus diesem Fall verlangt dieser Client, dass Sie Zugriff auf ein Meshtastic -Radio haben. Dies kann sich in Zukunft ändern, aber vorerst ist ein physisches Radio erforderlich, um diesen Kunden zu verwenden.

Ich habe hier einige persönliche Hardwareempfehlungen geschrieben.

Entwicklung

Voraussetzungen

Dieses Projekt ist in Rost- und React -Typscript integriert und mit dem PNPM -Paketmanager verwaltet. In diesem Projekt müssen die folgenden Programme auf Ihrem Entwicklungsgerät installiert werden:

• Rostsprache
• Node.js
• PNPM -Paketmanager

Installation

Um dieses Projekt lokal auszuführen, befolgen Sie die folgenden Schritte:

1. Stellen Sie sicher, dass Sie Rost, Node.js und PNPM installiert haben (siehe Voraussetzungen)
2. Stellen Sie sicher, dass alle Tauri -Abhängigkeiten installiert sind (abhängig von Ihrem Betriebssystem)
3. Klonen Sie diese Repository in ein lokales Verzeichnis. Dies kann durch Ausführen git clone https://github.com/meshtastic/network-management-client.git erfolgen
4. Klonen Sie rekursiv unsere Git -Submodules, indem Sie git submodule update --init
5. Installieren Sie alle erforderlichen NPM -Pakete mit pnpm i
6. Sobald Sie diese Schritte ausgeführt haben, überprüfen Sie Ihre Installation mit dem Befehl pnpm run rust:dev . Die Anwendung sollte erfolgreich zusammengestellt werden, und Sie sollten die Anwendung erfolgreich geöffnet sehen. Wenn dieser Vorgang für Sie fehlschlägt, lassen Sie es uns bitte wissen!

Empfohlener IDE -Setup

Während dieses Projekt in jedem Texteditor entwickelt werden kann, empfehlen wir den Visual Studio Code Editor. Bei Verwendung von VSCODE empfehlen wir dringend, die folgenden Visual Studio -Code -Erweiterungen zu installieren. Diese Erweiterungen erzwingen den Code -Stil und ermöglichen die Sprach- und Framework -Unterstützung für unseren Tech -Stapel.

• Schöner - Formatierer für unseren UI -Code
• Eslint - Linter für unseren UI -Code
• Rost -Analyzer - Rost LSP mit Code -Lining, Formatierung und Qualitätsvorschlägen

Einige optionale Erweiterungen, die nicht erforderlich sind, aber wir finden sehr hilfreich:

• Tauri - Fügt Tauri -Befehlsausschnitte und Konfigurations -JSON -Validierung hinzu
• Gitlens - Ein hilfreiches Plugin für die Arbeit mit Git -Historien

Entwicklungsbefehle

Um unseren Entwicklungsfluss zu standardisieren, verwenden wir PNPM -Befehle, die in package.json definiert sind. Diese Befehle können mit dem pnpm run NAME ...ARGS Syntax. Unsere Befehle werden in zwei primäre Kategorien unterteilt, rust:* Befehle und ui:* -Fandte. Die Befehle rust:* Führen Sie die gesamte Desktop -Anwendung aus, wobei die ui:* Befehle nur die UI -Ebene ausführen.

HINWEIS: Wir empfehlen dringend gegen die Verwendung der ui:dev und ui:build . Diese Befehle werden intern vom rust:dev und rust:build aufgerufen. Sie können beim Ausführen des Befehls ui:dev keine herstellen, da diese logik nicht in der ui -Ebene behandelt wird.

Wir arbeiten derzeit daran, Unterstützung für das Storybook -Framework hinzuzufügen, mit dem die Mitwirkenden UI -Komponenten entwickeln können, ohne die gesamte Desktop -Anwendung auszuführen.

• pnpm run rust:dev - Startet die Desktop -Anwendung im Entwicklungsmodus und ermöglicht das heiße Nachladen von UI und Rostcode

• pnpm run rust:build - Erstellt die Desktop -Anwendung im Produktionsmodus für Ihre Systemarchitektur. Derzeit verwenden wir diesen Befehl nur zum Testen des CLI -Arguments unserer Anwendung.

• pnpm run rust:test - Führen Sie Backend -Tests im Rust -Codebasis -Verzeichnis ( /src-tauri ) aus. Dieser Befehl generiert auch TypeScript-Client-Bindungen im Verzeichnis /src-tauri/bindings . Fügen Sie -- --show-output um Rust println! Makroanrufe in Testsuiten.

• pnpm run ui:dev - Startet den UI -Entwicklungsserver und ermöglicht die UI -Entwicklung in einer Browserumgebung. Beachten Sie, dass jeder Code, der mit dem Rost -Backend die Schnittstelle in dieser Browser -Umgebung fällt, nicht funktionieren , was bedeutet, dass Sie in diesem Zusammenhang keine Verbindung zu seriellen Geräten herstellen können

• pnpm run ui:build : - Führen Sie einen Produktionsaufbau auf dem UI -Code in das dist -Verzeichnis aus

• pnpm run ui:lint - verwendet ESLINT, um nach Codestilfehlern zu suchen. Beachten Sie, dass unsere CI -Pipeline erfordert, dass dieser Befehl erfolgreich ist, bevor Änderungen zusammengeführt werden können

• pnpm run ui:format - Format der UI -Codebasis mit hübscherem und Eslint. Wir empfehlen Ihnen dringend, dies auszuführen, bevor wir eine PR erstellen!

• pnpm run ui:test - Führen Sie die UI -Testsuite mit Scherz aus. Derzeit hat das Projekt keine UI -Testsuite, aber wir sind sehr offen für Beiträge!

• pnpm run ui:preview - Läuft die gebaute Benutzeroberfläche aus dem dist -Verzeichnis. Dieser Befehl muss nach ui:build (veraltet)

Hinweis: Unter Linux hat Ihr Benutzer möglicherweise keine Berechtigung, auf einen bestimmten seriellen Port zugreifen zu können. In diesem Fall müssen Sie Ihren Benutzer wahrscheinlich der Gruppe hinzufügen, die den seriellen Port steuert, auf den Sie zugreifen möchten. Sie finden die Gruppe, die einen seriellen Port über den Befehl ls -ld PATH_TO_PORT_HERE steuert. Sie können Ihren Benutzer dieser Gruppe über den Befehl usermod -a -G GROUP_NAME_HERE $USER addieren.

❤️ beitragen

Da wir noch sehr früh in der Entwicklung sind, haben wir noch keinen standardisierten Rahmen für die Akzeptanz von Beiträgen. Abgesehen davon sind wir sehr offen für Vorschläge und/oder Codeänderungen! Wenn Sie daran interessiert sind, zu diesem Repository beizutragen, bitten wir Sie, unser Ausgabenausschuss zuerst zu überprüfen, um sicherzustellen, dass Ihre Arbeit die Arbeit anderer nicht dupliziert. Machen Sie dann bitte ein Problem in unserem Vorstand, damit wir wissen, woran Sie daran interessiert sind. Wenn Sie Fragen zum Projekt haben, würden wir gerne von Ihnen hören!