Meshtastic.js

Overview

Meshtastic.js is a JavaScript library that provides an interface to Meshtastic devices. It can be used to build applications to interface with Meshtastic networks, via HTTP(S), Web Bluetooth or Web Serial.

Getting Started Guide

Documentation/API Reference

Stats

Installation & Usage

The library is available from NPM and can be installed with:

pnpm config set @buf:registry https://buf.build/gen/npm/v1
Copy

Alternatevly, create a .npmrc file with the following contents:

@buf:registry=https://buf.build/gen/npm/v1
Copy

Finally, install the package:

pnpm add @meshtastic/js
Copy

Development & Building

The project can be built by running:

pnpm build
Copy

Optionally the doccumentation can be built with:

pnpm generate:docs
Copy

Compatibility

The 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.