network management client

Важный

? Клиент Meshtastic Network Management нуждается в новой владельце / сопровождающем платформы?

Более подробная информация доступна в выпуске № 473.

Введение

Это приложение является настольным клиентом для мештастичного проекта, предназначенного для того, чтобы пользователи могли надежно управлять крупными децентрализованными сетками. В настоящее время мештастичная клиентская экосистема обладает сильной поддержкой для управления отдельными узлами, но минимальной поддержкой управления и анализа сетевого уровня. Цель этого проекта состоит в том, чтобы дать пользователям уверенность в их мештастичных сетях в качестве надежной инфраструктуры связи посредством нового алгоритмического анализа и понимания уровня соединения.

Это приложение построено с использованием структуры Tauri, современного, безопасного преемника электронного фреймворка. Это позволяет нам изначально поддерживать Linux, MacOS и Windows в той же кодовой базе без производительности или накладных расходов на память браузера Chromium. Наша основная инфраструктура приложений написана в Rust из -за ее производительности и безопасности, а наша функциональность пользовательского интерфейса и клиента написана в REACT TypeScript с использованием VITE. Этот проект находится на ранних стадиях разработки, и поэтому еще не подходит для использования в производстве .

Призовать взносы

На момент написания этого проекта в настоящее время поддерживается одним разработчиком. Таким образом, проект ищет разработчиков, желающих внести свой вклад или взять на себя инициативу по следующим основным инициативам:

• Полная поддержка карты в автономном режиме, в том числе загрузка и загрузка на основе региона и загрузка пользовательских карт (потребует мештастического зеркала плитки OSM DB)
• Постоянное состояние заявки на сеансы клиентов (завершенный)
• Тестирование бэкэнд ржавчины (единица, интеграция, E2E, дым)
• TS Frontend Testing (единица, интеграция, E2E, дым)
• Добавление поддержки для конфигурации удаленного узла
• Интеграция компонентов пользовательского интерфейса в структуру сборника рассказов
• Добавление поддержки для переводов I18N в слое пользовательского интерфейса (завершенный)
• Общая реорганизация структуры файла приложения, чтобы сделать проект интуитивно понятной

Функциональность

Этот проект все еще находится на ранних стадиях развития, но вот грубая дорожная карта функциональности, над которой мы работаем. Мы уделяем высокий приоритет в том, чтобы сделать нашу основную инфраструктуру правильно, поскольку это является ядром любого надежного и эффективного уровня пользовательского интерфейса.

• ? Основная инфраструктура данных
  • Последовательные данные отправить/получить
  • Интеграция протобуфа ржавчины (.proto -> .rs)
  • Пакет кодирует/декодирует
  • Управление государством устройства
• ? Основная инфраструктура пользовательского интерфейса
  • Управление командами Таури
  • Управление событиями Таури
  • Redux Saga DataFlow
• ? ️ Коллекция топологии сети
  • RFC для нового пакета (завершен)
  • MVP Protobuf изменяется (завершено)
  • Изменения прошивки MVP (завершено)
  • Обзор Protobuf сообщества (завершено)
  • Обзор прошивки сообщества (завершено)
• ? Алгоритмический анализ
  • Инфраструктура
    • СОЕДИНЕНИЕ СЕТИ
    • Конструкция сетевого графа
    • Алгоритм бегуны
  • UI
    • Алгоритм MVP панель бегуна
    • На карте Algorithm UI
    • Автоматический алгоритм повторяется
• ? Управление узлами
  • Таблица сверстников узла
  • Конфигурация сети (многолетняя)
  • Конфигурация удаленного узла
• ? Управление путевой точкой
  • Управляемая таблица путевой точки
  • Входная путевая точка отправка
  • На карте Waypoint Tooltip
• Паритет веб -клиента (пользовательский интерфейс)
  • Карта узла
  • Текстовые сообщения
  • Импорт/экспорт канала через QR -код
  • Конфигурация
    • Конфигурация устройства
    • Конфигурация модуля
    • Конфигурация канала
• ? Офлайн -карта
  • В автономном хранении карты
  • Загрузка на основе региона
• ? Экспорт сетевых данных

? Аппаратные требования

Этот проект построен на мештастичной аппаратной экосистеме, и поэтому этот клиент требует, чтобы у вас был доступ к мештастичному радио. Это может измениться в будущем, но для использования этого клиента требуется физическое радио.

Я написал здесь несколько личных рекомендаций по аппаратному обеспечению.

Разработка

Предварительные условия

Этот проект построен в TypeScript Rust и React и управляется с помощью диспетчера пакетов PNPM. Таким образом, этот проект требует, чтобы следующие программы были установлены на вашей машине разработки:

• Rust Language
• Node.js
• PNPM -диспетчер пакетов

Установка

Чтобы запустить этот проект локально, выполните следующие шаги:

1. Убедитесь, что у вас установлены ржавчина, node.js и pnpm (см. Предварительные условия)
2. Убедитесь, что у вас установлены все зависимости таури (зависит от вашей ОС)
3. Клонировать эту репозитию в местный каталог. Это можно сделать с помощью git clone https://github.com/meshtastic/network-management-client.git
4. Рекурсивно клонировать наши подмодулы GIT, запустив git submodule update --init
5. Установите все необходимые пакеты NPM с pnpm i
6. После того, как вы выполните эти шаги, проверьте свою установку с помощью команды pnpm run rust:dev . Приложение должно успешно компилировать, и вы должны успешно увидеть приложение. Если этот процесс не удается для вас, пожалуйста, сообщите нам об этом!

Рекомендованная настройка IDE

Хотя этот проект может быть разработан в любом текстовом редакторе, мы рекомендуем редактор кода Visual Studio. При использовании VSCODE мы настоятельно рекомендуем вам установить следующие расширения кода Visual Studio. Эти расширения обеспечивают соблюдение стиля кода и обеспечивают поддержку языка и фреймворки для нашего технологического стека.

• Кратчее - форматер для нашего кода пользовательского интерфейса
• Eslint - Линтер для нашего кода пользовательского интерфейса
• анализатор Rust -Rust - Rust LSP с кодовым вкладкой, форматированием и качественными предложениями

Некоторые дополнительные расширения, которые не требуются, но мы находим очень полезными:

• Tauri - добавляет командные фрагменты Tauri и конфигурацию JSON Validation
• Gitlens - полезный плагин для работы с Git Histories

Команды разработки

Для стандартизации нашего потока разработки мы используем команды PNPM, определенные в package.json . Эти команды можно запустить с помощью pnpm run NAME ...ARGS . Наши команды разбиты на две основные категории, rust:* Команды и ui:* Команды. Команды rust:* Запускают все настольное приложение, где команды ui:* только запускают слой пользовательского интерфейса.

Примечание: мы настоятельно рекомендуем использовать ui:dev и ui:build вручную. Эти команды используются внутренне из -за rust:dev и rust:build : соответственно. Вы не сможете подключиться к последовательному DEVCE при запуске команды ui:dev , так как эта логика не обрабатывается в слое пользовательского интерфейса.

В настоящее время мы работаем над тем, чтобы добавить поддержку Framework, которая позволит участникам разрабатывать компоненты пользовательского интерфейса без запуска всего настольного приложения.

• pnpm run rust:dev - Запускает настольное приложение в режиме разработки, что позволяет горячая перезагрузка пользовательского интерфейса и кода ржавчины

• pnpm run rust:build - Создает настольное приложение в производственном режиме для вашей системной архитектуры. В настоящее время мы используем эту команду только для тестирования анализатора аргумента нашего приложения.

• pnpm run rust:test - запускает тесты на бэкэнд в каталоге кодовой базы Rust ( /src-tauri ). Эта команда также генерирует клиентские привязки TypeScript в каталоге /src-tauri/bindings . Добавить -- --show-output , чтобы показать Rust println! Макро вызовы в тестовых люксах.

• pnpm run ui:dev - запускает сервер разработки пользовательского интерфейса, позволяя разработать пользовательский интерфейс в среде браузера. Обратите внимание, что любой код, который взаимодействует с бэкэнд Rust, не будет функционировать в этой среде браузера, что означает, что вы не сможете подключиться к последовательным устройствам в этом контексте

• pnpm run ui:build : - Запуск производственной сборки на код пользовательского интерфейса в dist Directory

• pnpm run ui:lint - использует Eslint для проверки ошибок в стиле кода. Обратите внимание, что наш трубопровод CI требует, чтобы эта команда преуспела, прежде чем любые изменения могут быть объединены

• pnpm run ui:format - Форматирует кодовую базу пользовательского интерфейса, используя краситель и Eslint. Мы настоятельно рекомендуем вам запустить это перед созданием PR!

• pnpm run ui:test - Запустит набор для пользовательского интерфейса с использованием Jest. В настоящее время у проекта нет набора тестирования пользовательского интерфейса, но мы очень открыты для вкладов!

• pnpm run ui:preview - запускает встроенный пользовательский интерфейс из dist Directory. Эта команда должна быть запущена после ui:build (устарело)

Примечание. На Linux ваш пользователь может не иметь разрешения на доступ к данному последовательному порту. Если это произойдет, вам, вероятно, потребуется добавить вашего пользователя в группу, которая управляет последовательным портом, к которому вы хотите получить доступ. Вы можете найти группу, которая управляет последовательным портом через команду ls -ld PATH_TO_PORT_HERE . Вы можете добавить своего пользователя в эту группу через команду usermod -a -G GROUP_NAME_HERE $USER .

❤ Вклад

Поскольку мы все еще очень рано в разработке, у нас еще нет стандартизированной основы для принятия взносов. При этом мы очень открыты для предложений и/или изменений кода! Если вы заинтересованы в участии в этом хранилище, мы бы попросили вас сначала проверить нашу доску проблем, чтобы ваша работа не дублировала работу других. Затем, пожалуйста, сделайте проблему на нашем доске, чтобы мы знали, над чем вы заинтересованы в работе. Если у вас есть какие -либо вопросы о проекте, мы хотели бы услышать от вас!