meshcore.js

Overview

What @meshcorejs/protocol is and what it is not.

Pure codec for the MeshCore Companion Radio protocol. It frames serial and TCP payloads, encodes the commands the app sends to the radio, decodes the responses and pushes the radio sends back, and encodes those same responses for FakeRadio to emulate a firmware.

The package has no I/O and no runtime dependency. Every function takes and returns Uint8Array or plain objects; nothing opens a socket, a serial port or a BLE connection. Every byte layout comes from examples/companion_radio/MyMesh.cpp in meshcore-dev/MeshCore@0679dbe (FIRMWARE_VER_CODE 13), the firmware this library speaks.

Who uses it

Most bot code never imports @meshcorejs/protocol directly. The Client does the encoding and decoding. Reach for it when writing a transport, an emulator, or a test that inspects raw frames.

Reference

On this page