Meshtastic.js is a JavaScript library that provides an interface to Meshtastic devices. It can be used to build applications to interface with a Meshtastic networks, via HTTP(S), Web Bluetooth or Web Serial.
Getting Started Guide Documentation/API Reference
The library is available from NPM and can be installed with:
pnpm add @meshtastic/meshtasticjsThe Meshtastic Protobufs submodule must be pulled, this can be done via:
git submodule update --initThen the type definitions need to be generated:
pnpm generate:protobufsFinally the project can be built:
pnpm buildOptionally the doccumentation can be built with:
pnpm generate:docsThe Bluetooth and Serial connections rely on the availability of the Web Bluetooth and Web Serial API's respectively, this is represented in the compatibility matrices below.
