Switch Language

index

Пакет python pip устанавливает исполняемый файл командной строки «meshtastic», который отображает пакеты, отправленные по сети, в формате JSON, и позволяет просматривать информацию отладки по последовательному порту от устройств meshtastic. Эта команда не запускается внутри python, вы запускаете её напрямую из приглашения оболочки вашей операционной системы. Если при вводе «meshtastic» команда не найдена и вы используете Windows: Проверьте, что директория «scripts» python находится в вашем PATH.

:::tip Для получения более полного списка опций выполните:

meshtastic --help

:::

Аргументы подключения

--port PORT

Порт, к которому подключено устройство Meshtastic, например /dev/ttyUSB0, /dev/cu.wchusbserial, COM4 и т.д. Если не указан, meshtastic попытается найти его. Важно использовать при подключении нескольких устройств, чтобы убедиться, что команда вызывается для правильного устройства.

Этот аргумент также можно указать как --serial или -s.

```shell title="Usage" meshtastic --port /dev/ttyUSB0 --info meshtastic --port COM4 --info meshtastic -s --info


### --host HOST

Имя хоста/IP-адрес устройства для подключения (по TCP). Если хост не указан, CLI попытается подключиться к `localhost`.

Этот аргумент также можно указать как `--tcp` или `-t`.

```shell title="Usage"
meshtastic --host meshtastic.local --info
meshtastic --host --info

--ble BLE

Подключение к устройству Meshtastic с использованием его BLE-адреса или имени. Эта опция позволяет осуществлять беспроводную связь с устройством, аналогично тому, как опция --host используется для TCP-подключений. Если адрес не указан, meshtastic попытается найти совместимое спаренное устройство.

Этот аргумент также можно указать как -b.

```shell title="Usage" meshtastic --ble "device_name_or_address" --info meshtastic -b --info


## Аргументы справки и поддержки

### -h или --help

Показывает сообщение справки, описывающее аргументы.

```shell title="Usage"
meshtastic -h

--version

Показывает номер версии программы и завершает работу.

```shell title="Usage" meshtastic --version


### --support

Выводит информацию, полезную для поддержки при любых проблемах.

```shell title="Usage"
meshtastic --support

Необязательные аргументы

--export-config

Экспортирует конфигурацию устройства (для использования командой '--configure').

Чтобы создать файл с конфигурацией подключённого устройства, вывод этой команды необходимо направить в YAML-файл.

```shell title="Usage" meshtastic --export-config > example_config.yaml


### --configure

Настраивает радио с использованием YAML-файла.

```shell title="Usage"
meshtastic --configure example_config.yaml

--seriallog SERIALLOG

Записывает вывод последовательного порта устройства в 'stdout', 'none' или имя файла для добавления. По умолчанию 'stdout', если имя файла не указано.

```shell title="Usage" meshtastic --port /dev/ttyUSB0 --seriallog meshtastic -t meshtastic.local --seriallog log.txt


### --info

Считывает и отображает информацию о конфигурации радио.

```shell title="Usage"
meshtastic --port /dev/ttyUSB0 --info

--set-canned-message

Устанавливает сообщения плагина canned message, разделённые символом | (до 200 символов).

```shell title="Usage" meshtastic --set-canned-message "I need an alpinist!|Call Me|Roger Roger|Keep Calm|On my way"


### --get-canned-message

Показывает сообщение плагина canned message.

```shell title="Usage"
meshtastic --get-canned-message

--set-ringtone RINGTONE

Устанавливает рингтон уведомлений (до 230 символов).

```shell title="Usage" meshtastic --set-ringtone "LeisureSuit:d=16,o=6,b=56:f.5,f#.5,g.5,g#5,32a#5,f5,g#.5,a#.5,32f5,g#5,32a#5,g#5,8c#.,a#5,32c#,a5,a#.5,c#.,32a5,a#5,32c#,d#,8e,c#.,f.,f.,f.,f.,f,32e,d#,8d,a#.5,e,32f,e,32f,c#,d#.,c#"


### --get-ringtone

Показывает сохранённый рингтон.

```shell title="Usage"
meshtastic --get-ringtone

--nodes

Выводит список узлов в удобной отформатированной таблице.

```shell title="Usage" meshtastic --nodes


### --qr[^1]

Отображает URL и QR-код, соответствующие текущему основному каналу.

```shell title="Usage"
meshtastic --qr

[^1]:

--qr-all

Отображает URL и QR-коды, соответствующие всем настроенным каналам на узле.

```shell title="Usage" meshtastic --qr-all


### --get [config_section]

Получает значение поля настроек.

Значения конфигурации описаны в: [Configuration](https://meshtastic.org/docs/configuration).

```shell title="Usage"
meshtastic --get lora
meshtastic --get lora.region

Чтобы увидеть все допустимые значения, передайте недопустимое значение, например 0:

```shell title="Usage" meshtastic --get 0


### --set [config_section].[option]  [value]

Устанавливает значение поля настроек.

Значения конфигурации описаны в: [Configuration](https://meshtastic.org/docs/configuration).

```shell title="Usage"
meshtastic --set lora.region Unset

--seturl SETURL

Устанавливает URL канала, который содержит конфигурацию LoRa плюс конфигурацию каналов. Полностью заменяет вашу текущую конфигурацию и каналы.

```shell title="Usage" meshtastic --seturl https://www.meshtastic.org/c/GAMiIE67C6zsNmlWQ-KE1tKt0fRKFciHka-DShI6G7ElvGOiKgZzaGFyZWQ=


### --pos-fields POS_FIELDS

Настраивает поля позиции для отправки с позициями; можно передать несколько значений. При 0 значениях выводит текущие настройки.

```shell title="Usage"
meshtastic --pos-fields
meshtastic --pos-fields ALTITUDE HEADING SPEED

--ch-index CH_INDEX

Действует на указанный индекс канала. Применяется к опциям, настраивающим каналы (таким как --ch-set и --ch-del), а также к опциям, отправляющим сообщения в mesh (таким как --sendtext и --traceroute).

```shell title="Usage" meshtastic --ch-index 1 --ch-disable


### --ch-add CH_ADD

Добавляет вторичный канал, необходимо указать имя канала.

Несовместимо с `--ch-index`. Если передан `--ch-add`, последующие `--ch-set` и другие команды, использующие канал, будут использовать индекс newly-added канала.

```shell title="Usage"
meshtastic --ch-add testing-channel

--ch-del

Удаляет канал, указанный в --ch-index.

```shell title="Usage" meshtastic --ch-index 1 --ch-del


### --ch-enable (устарело)

Эта опция устарела. Предпочтительно использовать `--ch-add`, чтобы избежать пробелов в списке каналов.

Включает канал, указанный в `--ch-index`.

```shell title="Usage"
meshtastic --ch-index 1 --ch-enable

--ch-disable (устарело)

Эта опция устарела. Предпочтительно использовать --ch-del, чтобы избежать пробелов в списке каналов.

Отключает канал, указанный в --ch-index.

```shell title="Usage" meshtastic --ch-index 1 --ch-disable


### --ch-set CH_SET CH_SET

Устанавливает параметр канала для канала, указанного в `--ch-index`.

```shell title="Usage"
meshtastic --ch-set id 1234 --ch-index 0

--ch-vlongslow

Изменяет пресет модема на VERY_LONG_SLOW.

```shell title="Usage" meshtastic --ch-vlongslow


### --ch-longslow

Изменяет пресет модема на `LONG_SLOW`.

```shell title="Usage"
meshtastic --ch-longslow

--ch-longfast

Изменяет пресет модема на (по умолчанию) LONG_FAST.

```shell title="Usage" meshtastic --ch-longfast


### --ch-medslow

Изменяет пресет модема на `MEDIUM_SLOW`.

```shell title="Usage"
meshtastic --ch-medslow

--ch-medfast

Изменяет пресет модема на MEDIUM_FAST.

```shell title="Usage" meshtastic --ch-medfast


### --ch-shortslow

Изменяет пресет модема на `SHORT_SLOW`.

```shell title="Usage"
meshtastic --ch-shortslow

--ch-shortfast

Изменяет пресет модема на SHORT_FAST.

```shell title="Usage" meshtastic --ch-shortfast


### --set-owner SET_OWNER

Устанавливает имя владельца устройства, иногда называемое длинным именем.

```shell title="Usage"
meshtastic --set-owner "MeshyJohn"

--set-owner-short SET_OWNER_SHORT

Устанавливает короткое имя владельца устройства (максимум 4 символа).

```shell title="Usage" meshtastic --set-owner-short "MJ"


### --set-ham SET_HAM

Устанавливает лицензионный Ham ID (устанавливая имя владельца) и отключает шифрование на основном канале.

Чтобы отключить режим Ham, используйте `--set-owner` и `--set-owner-short` для сброса имён владельца, а также команды `--seturl` или `--ch-set` для настройки каналов с желаемым именем и шифрованием. Или используйте `--factory-reset` для сброса к настройкам по умолчанию.

```shell title="Usage"
meshtastic --set-ham KI1345

--dest DEST

ID узла назначения для любых отправляемых команд, если не передано иным способом. Используется для Remote Node Administration.

В многих оболочках восклицательные знаки вызывают специальное поведение, если они не заключены в одинарные кавычки.

```shell title="Usage" meshtastic --dest '!28979058' --set-owner "MeshyJohn"


### --sendtext SENDTEXT

Отправляет текстовое сообщение. Можно указать индекс канала (`--ch-index`) и/или назначение (`--dest`).

```shell title="Usage"
meshtastic --sendtext 'Hello Mesh!'
meshtastic --ch-index 1 --sendtext 'Hello secondary channel!'

--traceroute TRACEROUTE

Traceroute от подключённого узла к назначению. Необходимо передать ID назначения как аргумент и можно передать --ch-index для указания канала. Узел, по которому выполняется трассировка, должен иметь настроенный тот же канал, и только узлы, разделяющие канал, идентифицируют себя в ответе. При достаточно свежем firmware другие узлы могут быть включены как !ffffffff, но не с их реальным ID.

```shell title="Usage" meshtastic --traceroute '!ba4bf9d0'


### --request-telemetry

Запрашивает телеметрию у узла. Необходимо передать ID назначения как аргумент с `--dest`. Для репитеров использование десятичного ID узла может быть эффективнее, но шестнадцатеричный ID тоже должен работать.

```shell title="Usage"
meshtastic --request-telemetry --dest '!ba4bf9d0'
meshtastic --request-telemetry --dest 1828779180

--request-position

Запрашивает позицию у узла. Необходимо передать ID назначения как аргумент с --dest.

```shell title="Usage" meshtastic --request-position --dest '!ba4bf9d0' --ch-index 1


### --ack
Используется в сочетании с `--sendtext` и другими командами для ожидания подтверждения. Не все команды смогут вернуть подтверждение. Наилучшим образом подходит для команд, которые указывают один узел назначения.

```shell title="Usage"
meshtastic --sendtext 'Hello Mesh!' --dest '!28979058' --ack

--reboot

Прикажите узлу перезагрузиться.

```shell title="Usage" meshtastic --reboot


### --shutdown

Прикажите узлу выключиться.

```shell title="Usage"
meshtastic --shutdown

--factory-reset

Прикажите узлу установить конфигурацию по умолчанию.

```shell title="Usage" meshtastic --factory-reset


### --reset-nodedb

Прикажите узлу очистить список узлов.

```shell title="Usage"
meshtastic --reset-nodedb

--remove-node NODE

Прикажите узлу удалить указанный узел из NodeDB.

```shell title="Usage" meshtastic --remove-node '!48759737'


### --reply

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

```shell title="Usage"
meshtastic --reply

--no-time

Подавляйте отправку текущего времени в mesh при запуске. Это может улучшить надежность и время запуска.

```shell title="Usage" meshtastic --port /dev/ttyUSB0 --no-time


### --no-nodes

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

```shell title="Usage"
meshtastic --no-nodes --no-time --sendtext "Firing off a quick message"

--wait-to-disconnect WAIT_TO_DISCONNECT

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

```shell title="Usage" meshtastic --set lora.channel_num 20 --wait-to-disconnect 10


### --setalt SETALT

Установите высоту устройства (позволяет использовать без GPS) и включите режим фиксированной позиции.

Можно использовать только на локально подключенных узлах и не вместе с `--dest`.

```shell title="Usage"
meshtastic --setalt 120

--setlat SETLAT

Установите широту устройства (позволяет использовать без GPS) и включите режим фиксированной позиции.

Можно использовать только на локально подключенных узлах и не вместе с --dest.

```shell title="Usage" meshtastic --setlat 25.2


### --setlon SETLON

Установите долготу устройства (позволяет использовать без GPS) и включите режим фиксированной позиции.

Можно использовать только на локально подключенных узлах и не вместе с `--dest`.

```shell title="Usage"
meshtastic --setlon -16.8

--remove-position

Очистите текущую установленную фиксированную позицию узла и отключите режим фиксированной позиции.

Можно использовать только на локально подключенных узлах и не вместе с --dest.

```shell title="Usage" meshtastic --remove-position


### --debug

Показывайте отладочные сообщения журнала библиотеки API.

```shell title="Usage"
meshtastic --debug --info

--listen

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

```shell title="Usage" meshtastic --listen


### --test

Запустите стресс-тест против всех подключенных устройств Meshtastic.

```shell title="Usage"
meshtastic --test

--ble-scan

Сканируйте доступные устройства Meshtastic с помощью BLE. Эта команда перечисляет обнаруживаемые устройства, предоставляя удобный способ идентифицировать устройства для подключения через BLE.

```shell title="Usage" meshtastic --ble-scan


### --noproto

Не запускайте API, просто работайте как простой последовательный терминал. Полезно для отладки, поскольку не считается клиентом. Зависит от физического кабельного последовательного соединения. Подключится, но не отобразит информацию по сети (--host) или Bluetooth (--ble).

```shell title="Usage"
meshtastic --noproto

Аргументы для удаленного оборудования

--gpio-wrb GPIO_WRB GPIO_WRB

Установите конкретный GPIO # в 1 или 0.

```shell title="Usage" meshtastic --port /dev/ttyUSB0 --gpio-wrb 4 1 --dest '!28979058'


### --gpio-rd GPIO_RD

Прочитайте из маски GPIO.

```shell title="Usage"
meshtastic --port /dev/ttyUSB0 --gpio-rd 0x10 --dest '!28979058'

--gpio-watch GPIO_WATCH

Начните наблюдение за маской GPIO на предмет изменений.

shell title="Usage" meshtastic --port /dev/ttyUSB0 --gpio-watch 0x10 --dest '!28979058'

Аргументы туннеля

--tunnel

Только для Linux, очень экспериментально. Низкая пропускная способность и низкая надежность.

Создайте устройство TUN-туннеля для пересылки IP-пакетов через mesh.

--subnet TUNNEL_NET

Установите подсеть для локального конца туннеля, созданного с помощью --tunnel.