Сборка и установка Meshtastic

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

  1. Сборка прошивки Meshtastic
      1. Настройка
      2. Обновите среду
      3. Добавление пользовательского
        1. Сборка с использованием специального оборудования
      4. Политика принятия моделей оборудования
        1. Альтернатива для участников
    1. Руководство по локализации OLED
      1. Обзор этапов
        1. 1. Создайте расширенный пользовательский
        2. 2. Обновите customFontTableLookupфункцию Screen.h
        3. 3. Определите язык и шрифт Screen.cpp
        4. 4. Настройте
        5. Основной метод: определить variant/*/platformio.ini
        6. Альтернатива: Определить userPrefs.h
    2. Номера портов Meshtastic
      1. PortNums следует назначать по следующим диапазонам:
    3. Stacktraces
    4. Декодирование трассировок стека
      2. В реальном времени
      3. Метод прошивки для
  2. Руководство по разработке для nRF52
      1. Использование отладочного USB
        1. Необходимое
        2. Необходимое
        3. Подключение NanoDAP к
        4. по электропроводке
        5. Использование NanoDAP с
  3. Protobufs
      1.  
      2. Meshtastic
        1. Руководство по проектированию LoRa
        2. по проектированию модема LoRa

Сборка прошивки Meshtastic

Meshtastic использует PlatformIO — среду разработки, которая обеспечивает простую многоплатформенную разработку и централизованный инструментарий.

Настройка

  1. Установить PlatformIO
  2. Клонируйте репозиторий прошивки Meshtasticgit clone https://github.com/meshtastic/firmware.git

    Этот репозиторий содержит официальную прошивку для Meshtastic, проекта с открытым исходным кодом для ячеистой сети LoRa, предназначенной для связи на большие расстояния с низким энергопотреблением без использования интернета или сотовой инфраструктуры. Прошивка поддерживает различные аппаратные платформы, включая ESP32, nRF52, RP2040/RP2350 и устройства на базе Linux.

  3. Обновить подмодули репозиторияcd firmware && git submodule update --init
  4. информация
  5. Если вы хотите собрать целевые платформы RP2040 и получаете ошибку «Имя файла слишком длинное» в Windows, обратитесь к документации Platformio по этой цепочке инструментов.

Обновите среду

  1. Изменить на firmwareпапкуcd firmware
  2. Соберите последние изменения в репозитории прошивки Meshtastic и подмодулях.git pull --recurse-submodules
  1. Откройте клонированную папку в Visual Studio Code . Если вы делаете это впервые, это может занять довольно много времени, так как PlatformIO загрузит все необходимые инструменты и библиотеки. Кроме того, если platformio не установлен, VSCode предложит вам установить его, что, возможно, потребует перезапуска программы.
  2. Чтобы выбрать устройство, которое вы хотите построить, откройте палитру команд :
    • Окна:Ctrl + Shift + P
    • Мак:command + Shift + P
  3. Введите: PlatformIO: Pick Project Environmentи выберите цель.
  4. Чтобы собрать прошивку, просто запустите PlatformIO: Buildее из палитры команд.
  5. Наконец, обновите прошивку на вашем устройстве, выполнив командуPlatformIO: Upload

Добавление пользовательского

Система сборки модульная. Добавление нового варианта платы для уже поддерживаемой архитектуры не вызывает никаких сложностей.

Сборка с использованием специального оборудования

  1. Перейдите в папку variants с исходным кодом прошивки и создайте новый каталог для вашего оборудования, назовем его m5stack_atom, и скопируйте существующую конфигурацию, которую вы хотите изменить:

 

cd variants; mkdir m5stack_atom
cp heltec_v1/* m5stack_atom
cd m5stack_atom
  1. Измените platformio.ini в этом подкаталоге каноническое определение варианта оборудования ( HELTEC_V1в данном случае) на PRIVATE_HWи укажите -Iна build_flagsвновь созданный каталог.
[env:m5stack-atom]
extends = esp32_base
board = m5stack-atom
monitor_filters = esp32_exception_decoder
build_flags =
   ${esp32_base.build_flags} -D PRIVATE_HW -I variants/m5stack_atom
lib_deps =
   ${esp32_base.lib_deps}
  1. Отредактируйте variant.hфайл в этом подкаталоге, чтобы он соответствовал настройкам и параметрам вашей платы. Пример очень подробно прокомментирован.
  2. Создавайте, запускайте и отлаживайте, пока не будете удовлетворены результатом.

Политика принятия моделей оборудования

В связи с ограниченной доступностью и текущей поддержкой новые номера моделей оборудования будут добавлены только для спонсоров и партнёров Meshtastic. Команда Meshtastic оставляет за собой право делать исключения из этой политики при необходимости. Если вы хотите получить официальную поддержку своего оборудования, свяжитесь с Meshtastic Solutions .

Альтернатива для участников

Поддерживаемое сообществом оборудование по-прежнему приветствуется, и участники сообщества по-прежнему могут добавлять самостоятельно изготовленное оборудование. Однако обратите внимание:

  • При изготовлении оборудования своими руками следует использовать PRIVATE_HWномер модели.
  • DIY-аппаратура не будет официально поддерживаться основной командой Meshtastic и будет обозначаться как Community Supported.
  • Самодельное оборудование не будет отображаться в ресурсах релиза Web Flasher или GitHub.
  • Вы будете отвечать за текущее обслуживание и поддержку.
  • Модели самодельного оборудования являются экспериментальными и, скорее всего, будут проходить ограниченное тестирование или вообще не будут проходить его.

 

Руководство по локализации OLED

Обзор этапов

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

1. Создайте расширенный пользовательский

Используйте редактор глифов для создания нового файла шрифта. Проще всего воспользоваться онлайн- редактором глифов из библиотеки OLED ( исходный код редактора глифов ).

  1. Скопируйте и вставьте существующий шрифт.
  2. Измените его в соответствии с желаемой кодовой страницей и сохраните новый файл шрифта в graphics/fontпапке.

Примечание: Формат файла шрифта отличается от общепринятого формата Adafruit GFX.

2. Обновите customFontTableLookupфункцию Screen.h

  1. Сопоставьте двухбайтовый код UTF-8 с соответствующим расширенным символом ASCII нужной кодовой страницы, обновив customFontTableLookupфункцию в Screen.hфайле.
  2. Измените switch (last)оператор: используйте левый байт кода UTF-8 в caseметке, чтобы сопоставить правый байт символа с его расширенным кодом ASCII, указав смещение.

3. Определите язык и шрифт Screen.cpp

Добавьте определения шрифтов для конкретного языка, используя условную компиляцию:

#ifdef OLED_{LANG_NAME}
#include "fonts/OLEDDisplayFonts{LANG_NAME}.h"
#endif

...

#ifdef OLED_{LANG_NAME}
#define FONT_SMALL ArialMT_Plain_10_{LANG_NAME}
#else
#define FONT_SMALL ArialMT_Plain_10
#endif

4. Настройте

Основной метод: определить variant/*/platformio.ini

Настройки языка можно определить в platformio.iniфайле в соответствующем каталоге вариантов:

build_flags =
${esp32_base.build_flags}
-D xxxxx
-D OLED_{LANG_NAME}
-I variants/xxxxx

Альтернатива: Определить userPrefs.h

В качестве альтернативы изменению platformio.iniязык можно определить в userPrefs.h.

#define OLED_{LANG_NAME}

Оба метода дают одинаковый результат, и выбор зависит от особенностей конкретного проекта.

Номера портов Meshtastic

Любое новое приложение, работающее на устройстве или через родственные приложения на телефонах/ПК, должно выбрать и использовать уникальный «portnum» для своего приложения.

Текущий список номеров портов можно найти в файле protobufs.

PortNums следует назначать по следующим диапазонам:

ПортнумИспользование
0-63 Используйте Core Meshtastic, не используйте для сторонних приложений.
64-127 Зарегистрированные сторонние приложения, отправьте запрос на извлечение, который добавляет новую запись в portnums.proto для регистрации вашего приложения.
256-511 Используйте один из этих номеров портов для ваших личных приложений, которые вы не хотите регистрировать публично.

Все остальные значения зарезервированы.

Если вы создаете новое приложение с использованием Meshtastic, отправьте запрос на добавление выбранного вами «portnum» в эту основную таблицу.

Stacktraces

Декодирование трассировок стека

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

Этот метод использует символы файла, firmware.elfсгенерированные из вашей последней сборки. Возможно, вы захотите выполнить повторную сборку, чтобы получить актуальные символы.

  1. Сохраните строку обратной трассировки в текстовый файл:
  2. обратная трассировка.txt
    Backtrace: 0x....
     
  3. Запустите декодер исключений: 
    bin/exception_decoder.py backtrace.txt
     

В реальном времени

Чтобы декодировать трассировки стека в режиме реального времени, оставьте следующую команду (заменив DEVICE_PORTпортом вашего устройства) запущенной в терминале с подключенным целевым устройством:

pio device monitor --port DEVICE_PORT -f esp32_exception_decoder

Метод прошивки для

  1. Web Flasher требует наличия браузера Chrome или Edge, но является отличным выбором для быстрой прошивки устройств. Этот метод настоятельно рекомендуется для прошивки, особенно новым пользователям проекта, поскольку он прост в использовании.
  2. Скрипт CLI считается «ручным процессом» прошивки.
  3. Перепрошивку устройства с помощью внешнего последовательного адаптера следует применять только в крайнем случае, если ни один другой метод не увенчался успехом.

примечание

Веб -клиент на meshtastic.local обновляется только после полного стирания данных и переустановки устройства. При переустановке вы получите последнюю версию веб-интерфейса (в комплекте). Чтобы сохранить настройки, вы можете экспортировать конфигурацию перед переустановкой и загрузить её обратно после неё.

Руководство по разработке для nRF52

Этот документ представляет собой сборник советов и рекомендаций по разработке на платформе nRF52. Он постоянно развивается и пополняется актуальной информацией. Мы будем рады вашим предложениям на GitHub.

Использование отладочного USB

Это мини-руководство по установке соответствующей прошивки и программного обеспечения адаптера, оно в общих чертах основано на этом руководстве от RAK .

Необходимое

RAKDAP1 /NanoDAP — это очень доступный ($10) USB-отладочный зонд. Он может использоваться со многими платформами ARM, но особенно хорошо подходит для процессоров nRF52. Похоже, он основан на проекте ARM daplink . Форк этого проекта находится здесь: nanoDAP . Форк довольно старый по сравнению с последними достижениями daplink, но, похоже, работает отлично.

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

Необходимое

Вам потребуется установить приложение pyocd , чтобы VSCode мог взаимодействовать с NanoDAP. Сначала установите сам инструмент, а затем добавьте файлы поддержки для nrf52840:

pip3 install pyocd
pyocd pack --i nrf52840
pyocd pack -s

Если вы разрабатываете в системе Linux, вам потребуется установить правила udev для NanoDAP.

Это делается путем копирования файла правил из дистрибутива pyocd в каталог правил udev согласно этим инструкциям .

Подключение NanoDAP к

NanoDAP имеет 10-контактный разъем, но необходимо подключить только три из этих контактов:

  • Заземление : подключается к заземлению на объекте.
  • TMS-IO : подключается к SWDIO на целевом устройстве.
  • TCK-CK : подключается к SWCLK на цели.

В некоторых веб-инструкциях рекомендуется соединить контакты RESET и 3V3, но обычно это не обязательно.

по электропроводке

На этом изображении показан пример подключения к плате RAK4630:Фото предоставлено RAKwireless .

Использование NanoDAP с

Проект Meshtastic имеет специальную среду сборки/целевую среду, настроенную для работы с NanoDAP. Чтобы использовать её, выберите целевой объект "env :rak3631_dap " на палитре команд или в левом нижнем углу окна VSCode/PlatformIO. Выбор целевой среды меняет два момента:

  • Программирование устройства больше не выполняется через USB-загрузчик. Вместо этого при выборе «Загрузить» устройство будет использовать NanoDAP для программирования.
  • Кнопка «Отладка» в VSCode станет активной. Нажатие на неё запустит отладчик с поддержкой ICE, где можно будет установить точки останова и т. д.

Protobufs

 

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

Protobuf-ы обеспечивают эффективный и простой способ обмена данными, что делает их идеальными для использования в средах с ограниченными ресурсами, таких как сеть Meshtastic. Они обладают рядом преимуществ по сравнению с традиционными форматами данных, такими как XML или JSON, включая:

  • Меньший сериализованный размер: сериализованные данные Protobuf обычно намного меньше, чем XML- или JSON-представления тех же данных.
  • Более быстрая сериализация и десериализация: Protobuf-объекты разработаны для быстрой сериализации и десериализации, что важно для приложений, которым необходимо обрабатывать большие объемы данных.
  • Типобезопасность и самоописание: сообщения Protobuf типобезопасны, а форматы сообщений являются самоописываемыми, что упрощает работу с данными и их поддержку с течением времени.

Meshtastic

Проект Meshtastic определяет собственный набор сообщений Protobuf для различных типов данных, которыми обмениваются приложение-устройство и устройство-устройство. Эти сообщения организованы в различные модули.

Официальную документацию по сообщениям Meshtastic Protobuf можно найти в реестре схем Buf (BSR) . BSR предоставляет централизованное хранилище для управления и документирования схем Protobuf, используемых в проекте.

Руководство по проектированию LoRa

по проектированию модема LoRa

  • Руководство от Semtech, объясняющее ключевые принципы и параметры модуляции LoRa и их модемных чипов LoRa SX1272/3/6/7/8. Полезно для понимания основных концепций LoRa, таких как коэффициент расширения, полоса пропускания, время в эфире, чувствительность и т. д.