@meshtastic/meshtasticjs
    TypeScript icon, indicating that this package has built-in type declarations

    0.6.17 • Public • Published

    Meshtastic.js

    Open in Visual Studio Code NPM Downloads

    Overview

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

    Getting Started Guide Documentation/API Reference

    Installation & Usage

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

    yarn add @meshtastic/meshtasticjs
    npm install @meshtastic/meshtasticjs

    Development & Building

    The Meshtastic Protobufs submodule must be pulled, this can be done via:

    git submodule update --init

    Then the type definitions need to be generated:

    yarn generate:protobufs

    Finally the project can be built:

    yarn build

    Optionally the doccumentation can be built with:

    yarn 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

    Install

    npm i @meshtastic/meshtasticjs

    DownloadsWeekly Downloads

    22

    Version

    0.6.17

    License

    GPL-3.0-only

    Unpacked Size

    317 kB

    Total Files

    69

    Last publish

    Collaborators

    • sachaw