Meshtastic.js
![Vercel](https://img.shields.io/static/v1?label=Powered%20by&message=Vercel&style=flat&logo=vercel&color=000000)
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
![Repobeats analytics image Alt](https://repobeats.axiom.co/api/embed/5330641586e92a2ec84676fedb98f6d4a7b25d69.svg)
Installation & Usage
The library is available from NPM and can be installed with:
pnpm config set @buf:registry https://buf.build/gen/npm/v1
Alternatevly, create a .npmrc
file with the following contents:
@buf:registry=https://buf.build/gen/npm/v1
Finally, install the package:
pnpm add @meshtastic/js
Development & Building
The project can be built by running:
pnpm build
Optionally the doccumentation can be built with:
pnpm generate:docs
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.
![Web Serial compatability matrix](https://caniuse.bitsofco.de/image/web-serial.png)