https://github.com/meshtastic/js

JS/TS library for interfacing with Meshtastic devices
https://github.com/meshtastic/js

library meshtastic typescript

Last synced: 1 day ago
JSON representation

JS/TS library for interfacing with Meshtastic devices

• Host: GitHub
• URL: https://github.com/meshtastic/js
• Owner: meshtastic
• License: gpl-3.0
• Created: 2020-09-25T11:10:59.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-11-22T18:00:49.000Z (about 2 months ago)
• Last Synced: 2025-01-01T01:12:43.189Z (9 days ago)
• Topics: library, meshtastic, typescript
• Language: TypeScript
• Homepage: https://meshtastic.org
• Size: 2.44 MB
• Stars: 82
• Watchers: 20
• Forks: 39
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Meshtastic.js

[![NPM](https://badgen.net/npm/v/@meshtastic/js)](https://www.npmjs.com/package/@meshtastic/js)

[![Downloads](https://badgen.net/npm/dt/@meshtastic/js)](https://www.npmjs.com/package/@meshtastic/js)

[![CI](https://img.shields.io/github/actions/workflow/status/meshtastic/js/ci.yml?branch=master&label=actions&logo=github&color=yellow)](https://github.com/meshtastic/js/actions/workflows/ci.yml)

[![CLA assistant](https://cla-assistant.io/readme/badge/meshtastic/meshtastic.js)](https://cla-assistant.io/meshtastic/meshtastic.js)

[![Fiscal Contributors](https://opencollective.com/meshtastic/tiers/badge.svg?label=Fiscal%20Contributors&color=deeppink)](https://opencollective.com/meshtastic/)

[![Vercel](https://img.shields.io/static/v1?label=Powered%20by&message=Vercel&style=flat&logo=vercel&color=000000)](https://vercel.com?utm_source=meshtastic&utm_campaign=oss)

## Overview

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

**[Getting Started Guide](https://meshtastic.org/docs/development/js)**

**[Documentation/API Reference](https://js.meshtastic.org)**

## Stats

![Alt](https://repobeats.axiom.co/api/embed/5330641586e92a2ec84676fedb98f6d4a7b25d69.svg "Repobeats analytics image")

## Installation & Usage

The library is available from [NPM](https://www.npmjs.com/package/@meshtastic/js) and can be installed with:

```bash

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

```

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

```conf

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

```

Finally, install the package:

```bash

pnpm add @meshtastic/js

```

## Development & Building

The project can be built by running:

```bash

pnpm build

```

Optionally the doccumentation can be built with:

```bash

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](https://caniuse.bitsofco.de/image/web-bluetooth.png)

![Web Serial compatability matrix](https://caniuse.bitsofco.de/image/web-serial.png)