Skip to main content
Home
This package has been archived, and as such it is read-only.
It is unknown whether this package works with Cloudflare Workers, Node.js, Deno, Bun, Browsers
It is unknown whether this package works with Cloudflare Workers
It is unknown whether this package works with Node.js
It is unknown whether this package works with Deno
It is unknown whether this package works with Bun
It is unknown whether this package works with Browsers
JSR Score
47%
Published
a year 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

New Ticket: Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.

Add Package

deno add jsr:@meshtastic/js

Import symbol

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

Import directly with a jsr specifier

import * as js from "jsr:@meshtastic/js";

Add Package

pnpm i jsr:@meshtastic/js
or (using pnpm 10.8 or older)
pnpm dlx jsr add @meshtastic/js

Import symbol

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

Add Package

yarn add jsr:@meshtastic/js
or (using Yarn 4.8 or older)
yarn dlx jsr add @meshtastic/js

Import symbol

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

Add Package

vlt install jsr:@meshtastic/js

Import symbol

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

Add Package

npx jsr add @meshtastic/js

Import symbol

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

Add Package

bunx jsr add @meshtastic/js

Import symbol

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