Switch Language

http-api

:::info Это мини-спецификация HTTP API, который может использоваться браузерными клиентами для взаимодействия с устройствами Meshtastic. :::

Почему protobuf'ы

Заголовки запроса

Заголовки ответа

Конечные точки

Указаны две конечные точки:

/api/v1/toradio

Поддерживает запросы PUT и OPTION.

PUT

Запрос PUT к этой конечной точке должен содержать серию полезных нагрузок ToRadio в формате protobuf.

Protobuf'ы передаются в бинарном виде в теле запроса.

Поддерживается только одно сообщение ToRadio на запрос.

OPTIONS

Запрос OPTIONS к этой конечной точке вернёт код статуса ответа 204 и только заголовки.

/api/v1/fromradio

Поддерживает запросы GET.

GET

Запрос GET к этой конечной точке вернёт серию protobuf'ов FromRadio.

Protobuf'ы передаются в бинарном виде в теле запроса.

Параметры

/api/v1/fromradio?all
/api/v1/fromradio?chunked

Аутентификация

Никакой аутентификации пользователей нет. Мы предполагаем, что доступ к HTTP-серверу достаточен для установления доверия.

Клиент

JavaScript

См.: https://github.com/meshtastic/meshtastic.js

Справочный клиент на JavaScript предоставит JavaScript API для использования этого транспорта. Этот клиент будет выполнять HTTP-соединения, использовать сгенерированный код protobuf на JavaScript и предоставит API, скрывающий всю эту REST-разводку. Два ключевых метода: sendToRadio(packet) и onFromRadio(callback).

Protoman

См.: https://github.com/spluxx/Protoman

Protoman способен работать с REST API Meshtastic из коробки. Это полезно для ручного тестирования конечных точек.

Безопасность

На ESP32 поддерживаются как HTTP, так и HTTPS с использованием самоподписанных сертификатов для HTTPS.

Связанные документы