network management client

สำคัญ

- ไคลเอนต์การจัดการเครือข่าย Meshtastic ต้องการเจ้าของแพลตฟอร์ม / ผู้ดูแลใหม่หรือไม่?

รายละเอียดเพิ่มเติมมีอยู่ในปัญหา #473

การแนะนำ

แอปพลิเคชันนี้เป็นไคลเอนต์เดสก์ท็อปสำหรับโครงการ Meshtastic ที่ออกแบบมาเพื่อให้ผู้ใช้สามารถจัดการเครือข่ายตาข่ายขนาดใหญ่ที่มีการกระจายอำนาจได้อย่างน่าเชื่อถือ ปัจจุบันระบบนิเวศไคลเอนต์ Meshtastic ได้รับการสนับสนุนที่แข็งแกร่งสำหรับการจัดการโหนดเดี่ยว แต่การสนับสนุนขั้นต่ำสำหรับการจัดการและการวิเคราะห์ระดับเครือข่าย เป้าหมายของโครงการนี้คือการให้ความมั่นใจแก่ผู้ใช้ในเครือข่าย meshtastic ของพวกเขาในฐานะโครงสร้างพื้นฐานการสื่อสารที่เชื่อถือได้ผ่านการวิเคราะห์อัลกอริทึมแบบใหม่และข้อมูลเชิงลึกระดับการเชื่อมต่อ

แอปพลิเคชั่นนี้สร้างขึ้นโดยใช้ Tauri Framework ซึ่งเป็นผู้สืบทอดที่ทันสมัยและปลอดภัยต่อเฟรมเวิร์กอิเล็กตรอน สิ่งนี้ช่วยให้เราสามารถรองรับ Linux, MacOS และ Windows ภายใน codebase เดียวกันโดยไม่ต้องมีประสิทธิภาพหรือหน่วยความจำค่าใช้จ่ายของเบราว์เซอร์โครเมียม โครงสร้างพื้นฐานแอปพลิเคชันหลักของเราเขียนขึ้นเป็นสนิมเนื่องจากประสิทธิภาพและความปลอดภัยและฟังก์ชั่น UI และไคลเอนต์ของเราเขียนด้วย React TypeScript โดยใช้ VITE โครงการนี้อยู่ในช่วงเริ่มต้นของการพัฒนาและ ยังไม่เหมาะสำหรับการใช้งานการผลิต

เรียกร้องให้มีส่วนร่วม

ในช่วงเวลาของการเขียนโครงการนี้ได้รับการดูแลโดยนักพัฒนาคนเดียว ดังนั้นโครงการกำลังมองหานักพัฒนาที่เต็มใจที่จะมีส่วนร่วมหรือเป็นผู้นำในการริเริ่มที่สำคัญต่อไปนี้:

• การสนับสนุนแผนที่ออฟไลน์แบบเต็มรวมถึงการดาวน์โหลดตามภูมิภาคและการโหลดแผนที่ที่กำหนดเอง (จะต้องใช้ Meshtastic Mirror ของ DB Tile OSM)
• สถานะแอปพลิเคชันที่คงอยู่ในเซสชันไคลเอนต์ (สมบูรณ์)
• การทดสอบแบ็กเอนด์สนิม (หน่วย, การรวม, E2E, ควัน)
• การทดสอบ Frontend TS (หน่วย, การรวม, E2E, ควัน)
• การเพิ่มการสนับสนุนสำหรับการกำหนดค่าโหนดระยะไกล
• การรวมส่วนประกอบ UI เข้ากับกรอบนิทาน
• การเพิ่มการสนับสนุนสำหรับการแปล I18N ภายในเลเยอร์ UI (สมบูรณ์)
• การปรับโครงสร้างโครงสร้างไฟล์แอปพลิเคชันทั่วไปเพื่อให้โครงการใช้งานง่าย

ฟังก์ชั่น

โครงการนี้ยังอยู่ในช่วงเริ่มต้นของการพัฒนา แต่นี่เป็นแผนงานที่ยากลำบากของฟังก์ชั่นที่เรากำลังทำอยู่ เราให้ความสำคัญสูงในการทำให้โครงสร้างพื้นฐานหลักของเราถูกต้องเนื่องจากนี่เป็นแกนหลักของเลเยอร์ UI ที่แข็งแกร่งและมีประสิทธิภาพ

• - โครงสร้างพื้นฐานการไหลของข้อมูลหลัก
  • ข้อมูลอนุกรมส่ง/รับ
  • Rust Protobuf Integration (.proto -> .rs)
  • แพ็คเก็ตเข้ารหัส/ถอดรหัส
  • การจัดการสถานะอุปกรณ์
• - โครงสร้างพื้นฐาน UI หลัก
  • การจัดการคำสั่งของ Tauri
  • การจัดการเหตุการณ์ Tauri
  • Redux Saga dataflow
• ️คอลเลกชันโทโพโลยีเครือข่าย
  • RFC สำหรับแพ็คเก็ตนวนิยาย (เสร็จสมบูรณ์)
  • การเปลี่ยนแปลง MVP Protobuf (เสร็จสมบูรณ์)
  • การเปลี่ยนแปลงเฟิร์มแวร์ MVP (เสร็จสมบูรณ์)
  • การทบทวนชุมชน Protobuf (เสร็จสมบูรณ์)
  • การตรวจสอบเฟิร์มแวร์ชุมชน (เสร็จสมบูรณ์)
• - การวิเคราะห์อัลกอริทึม
  • โครงสร้างพื้นฐาน
    • การเปรียบเทียบแพ็คเก็ตเครือข่าย
    • การสร้างกราฟเครือข่าย
    • นักวิ่งอัลกอริทึม
  • UI
    • บานหน้าต่างนักวิ่งอัลกอริทึม MVP
    • อัลกอริทึมบนแผนที่ UI
    • อัลกอริทึมอัตโนมัติวิ่งซ้ำ
• - การจัดการโหนด
  • ตาราง Peer Node
  • การกำหนดค่าเครือข่าย (หลายอุปกรณ์)
  • การกำหนดค่าโหนดระยะไกล
• - การจัดการจุดอ้างอิง
  • ตาราง Waypoint ที่ได้รับการจัดการ
  • การส่งจุดทางในช่องทาง
  • คำแนะนำเครื่องมือ waypoint บนแผนที่
• เว็บไคลเอนต์พาริตี้ (UI)
  • แผนที่โหนด
  • การส่งข้อความ
  • นำเข้าช่อง/ส่งออกผ่านรหัส QR
  • การกำหนดค่า
    • การกำหนดค่าอุปกรณ์
    • การกำหนดค่าโมดูล
    • การกำหนดค่าช่องสัญญาณ
• - มุมมองแผนที่ออฟไลน์
  • ที่เก็บแผนที่ออฟไลน์
  • การดาวน์โหลดตามภูมิภาค
• - การส่งออกข้อมูลเครือข่าย

- ข้อกำหนดของฮาร์ดแวร์

โครงการนี้สร้างขึ้นบนระบบนิเวศฮาร์ดแวร์ Meshtastic และลูกค้ารายนี้ต้องการให้คุณสามารถเข้าถึงวิทยุ meshtastic ได้ สิ่งนี้อาจเปลี่ยนแปลงได้ในอนาคต แต่ในขณะนี้จำเป็นต้องใช้วิทยุทางกายภาพเพื่อใช้ไคลเอนต์นี้

ฉันได้เขียนคำแนะนำฮาร์ดแวร์ส่วนตัวที่นี่

การพัฒนา

ข้อกำหนดเบื้องต้น

โครงการนี้สร้างขึ้นใน Rust และ React Typescript และจัดการโดยใช้ PNPM Package Manager ดังนั้นโครงการนี้ต้องใช้โปรแกรมต่อไปนี้ที่จะติดตั้งบนเครื่องพัฒนาของคุณ:

• ภาษาสนิม
• node.js
• PNPM Package Manager

การติดตั้ง

ในการเรียกใช้โครงการนี้ในพื้นที่ให้ทำตามขั้นตอนด้านล่าง:

1. ตรวจสอบให้แน่ใจว่าคุณมีการติดตั้ง Rust, Node.js และ PNPM (ดูสิ่งที่จำเป็นต้องมี)
2. ตรวจสอบให้แน่ใจว่าคุณติดตั้งการพึ่งพา Tauri ทั้งหมด (ขึ้นอยู่กับระบบปฏิบัติการของคุณ)
3. โคลน repositiory นี้ไปยังไดเรกทอรีท้องถิ่น สามารถทำได้โดยใช้ git clone https://github.com/meshtastic/network-management-client.git
4. โคลน submodules git ของเราซ้ำโดยเรียกใช้ git submodule update --init
5. ติดตั้งแพ็คเกจ NPM ที่จำเป็นทั้งหมดด้วย pnpm i
6. เมื่อคุณทำตามขั้นตอนเหล่านี้เสร็จแล้วให้ตรวจสอบการติดตั้งของคุณด้วยคำสั่ง pnpm run rust:dev แอปพลิเคชันควรรวบรวมได้สำเร็จและคุณควรเห็นแอปพลิเคชันเปิดสำเร็จ หากกระบวนการนี้ล้มเหลวสำหรับคุณโปรดแจ้งให้เราทราบ!

การตั้งค่า IDE ที่แนะนำ

ในขณะที่โครงการนี้สามารถพัฒนาได้ภายในตัวแก้ไขข้อความใด ๆ เราขอแนะนำตัวแก้ไขรหัส Visual Studio หากใช้ VSCODE เราขอแนะนำอย่างยิ่งให้คุณติดตั้งส่วนขยายรหัส Visual Studio ต่อไปนี้ ส่วนขยายเหล่านี้มีทั้งรูปแบบรหัสและเปิดใช้งานการสนับสนุนภาษาและกรอบสำหรับสแต็กเทคโนโลยีของเรา

• Prettier - Formatter สำหรับรหัส UI ของเรา
• ESLINT - LINTER สำหรับรหัส UI ของเรา
• Rust -Analyzer - Rust LSP พร้อมรหัสผ้าสำลีการจัดรูปแบบและคำแนะนำคุณภาพ

ส่วนขยายเสริมบางอย่างที่ไม่จำเป็น แต่เราพบว่ามีประโยชน์มาก:

• tauri - เพิ่มตัวอย่างคำสั่ง tauri และการตรวจสอบการกำหนดค่า JSON
• Gitlens - ปลั๊กอินที่มีประโยชน์สำหรับการทำงานกับ Git Histories

คำสั่งการพัฒนา

เพื่อสร้างมาตรฐานการพัฒนาของเราเราใช้คำสั่ง PNPM ที่กำหนดไว้ใน package.json คำสั่งเหล่านี้สามารถรันได้ด้วย pnpm run NAME ...ARGS ไวยากรณ์ คำสั่งของเราแบ่งออกเป็นสองประเภทหลัก rust:* คำสั่งและ ui:* คำสั่ง คำสั่ง rust:* เรียกใช้แอปพลิเคชันเดสก์ท็อปทั้งหมดโดยที่คำสั่ง ui:* เรียกใช้เลเยอร์ UI เท่านั้น

หมายเหตุ: เราขอแนะนำอย่างยิ่งต่อการใช้ ui:dev และ ui:build คำสั่งด้วยตนเอง คำสั่งเหล่านี้ถูกเรียกใช้ภายในโดย The rust:dev และ rust:build Commands ตามลำดับ คุณจะ ไม่ สามารถเชื่อมต่อกับ Devce แบบอนุกรมเมื่อเรียกใช้คำสั่ง ui:dev เนื่องจากตรรกะนี้ไม่ได้รับการจัดการในชั้น UI

ขณะนี้เรากำลังทำงานเพื่อเพิ่มการสนับสนุนสำหรับกรอบนิทานซึ่งจะช่วยให้ผู้มีส่วนร่วมในการพัฒนาส่วนประกอบ UI โดยไม่ต้องใช้แอปพลิเคชันเดสก์ท็อปทั้งหมด

• pnpm run rust:dev - เริ่มแอปพลิเคชันเดสก์ท็อปในโหมดการพัฒนาช่วยให้สามารถโหลด UI และรหัสสนิมได้อย่างร้อนแรง

• pnpm run rust:build - สร้างแอปพลิเคชันเดสก์ท็อปในโหมดการผลิตสำหรับสถาปัตยกรรมระบบของคุณ ขณะนี้เราใช้คำสั่งนี้สำหรับการทดสอบตัวแยกวิเคราะห์อาร์กิวเมนต์ CLI ของแอปพลิเคชันเท่านั้น

• pnpm run rust:test - เรียกใช้การทดสอบแบ็กเอนด์บนไดเรกทอรี Rust Codebase ( /src-tauri ) คำสั่งนี้ยังสร้างการผูกไคลเอนต์ TypeScript ในไดเรกทอรี /src-tauri/bindings เพิ่ม -- --show-output เพื่อแสดง println! การโทรแมโครภายในชุดทดสอบ

• pnpm run ui:dev - เริ่มต้นเซิร์ฟเวอร์การพัฒนา UI เพื่อให้สามารถพัฒนา UI ในสภาพแวดล้อมของเบราว์เซอร์ โปรดทราบว่ารหัสใด ๆ ที่เชื่อมต่อกับแบ็กเอนด์ Rust จะไม่ทำงาน ภายในสภาพแวดล้อมของเบราว์เซอร์นี้ซึ่งหมายความว่าคุณจะไม่สามารถเชื่อมต่อกับอุปกรณ์อนุกรมในบริบทนี้ได้

• pnpm run ui:build : - เรียกใช้การผลิตการสร้างบนรหัส UI ลงในไดเรกทอรี dist

• pnpm run ui:lint - ใช้ ESLINT เพื่อตรวจสอบข้อผิดพลาดสไตล์รหัส โปรดทราบว่าไปป์ไลน์ CI ของเราต้องการให้คำสั่งนี้สำเร็จก่อนที่จะสามารถรวมการเปลี่ยนแปลงใด ๆ ได้

• pnpm run ui:format - รูปแบบ UI Codebase โดยใช้ Prettier และ Eslint เราขอแนะนำให้คุณเรียกใช้สิ่งนี้ก่อนที่จะสร้าง PR!

• pnpm run ui:test - เรียกใช้ชุดทดสอบ UI โดยใช้ JEST ปัจจุบันโครงการไม่มีชุดทดสอบ UI แต่เราเปิดรับการสนับสนุนมาก!

• pnpm run ui:preview - เรียกใช้ UI ที่สร้างขึ้นจากไดเรกทอรี dist คำสั่งนี้จะต้องเรียกใช้หลังจาก ui:build (เลิกใช้แล้ว)

หมายเหตุ: บน Linux ผู้ใช้ของคุณอาจไม่ได้รับอนุญาตให้เข้าถึงพอร์ตอนุกรมที่กำหนด หากสิ่งนี้เกิดขึ้นคุณอาจต้องเพิ่มผู้ใช้ของคุณในกลุ่มที่ควบคุมพอร์ตอนุกรมที่คุณต้องการเข้าถึง คุณสามารถค้นหากลุ่มที่ควบคุมพอร์ตอนุกรมผ่านคำสั่ง ls -ld PATH_TO_PORT_HERE คุณสามารถเพิ่มผู้ใช้ของคุณในกลุ่มนี้ผ่านคำสั่ง usermod -a -G GROUP_NAME_HERE $USER

❤มีส่วนร่วม

เนื่องจากเรายังคงอยู่ในช่วงต้นของการพัฒนาเรายังไม่มีกรอบมาตรฐานสำหรับการยอมรับการมีส่วนร่วม สิ่งนี้ถูกกล่าวว่าเราเปิดกว้างสำหรับคำแนะนำและ/หรือการเปลี่ยนแปลงรหัส! หากคุณสนใจที่จะมีส่วนร่วมในที่เก็บข้อมูลนี้เราจะขอให้คุณตรวจสอบบอร์ดปัญหาของเราก่อนเพื่อให้แน่ใจว่างานของคุณไม่ได้ทำซ้ำการทำงานของผู้อื่น จากนั้นโปรดสร้างปัญหาบนกระดานของเราเพื่อให้เรารู้ว่าคุณสนใจทำงานอย่างไร หากคุณมีคำถามใด ๆ เกี่ยวกับโครงการเรายินดีที่จะได้ยินจากคุณ!