Skip to main content
JSR Score
47%
Published
3 weeks ago (2.3.4)

Meshtastic.js

NPM Downloads CI CLA assistant Fiscal Contributors Vercel

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

Alt

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 Bluetooth compatability matrix Web Serial compatability matrix

Add Package

deno add @meshtastic/js

Import symbol

import * as mod from "@meshtastic/js";

Add Package

npx jsr add @meshtastic/js

Import symbol

import * as mod from "@meshtastic/js";

Add Package

yarn dlx jsr add @meshtastic/js

Import symbol

import * as mod from "@meshtastic/js";

Add Package

pnpm dlx jsr add @meshtastic/js

Import symbol

import * as mod from "@meshtastic/js";

Add Package

bunx jsr add @meshtastic/js

Import symbol

import * as mod from "@meshtastic/js";