Overview
What @meshcorejs/client is and where to start.
@meshcorejs/client is the bot framework for MeshCore radios
running the Companion Radio firmware. A Client logs into the radio and keeps its contacts and channels
in cache. Everything the bot does is declared with builders, the way discord.js
bots are. It is the only package a bot installs.
Requirements
- A MeshCore node running the Companion Radio firmware, protocol version 3 or newer.
- Node.js 20 or newer to run bots.
- Serial needs
serialport. BLE needs@abandonware/noble. TCP needs nothing.
Where to start
Getting started
Install the package and run a first bot on a radio plugged over USB.
Guides
One task per page, code first. Answer a command, post on a channel, restrict, translate, test.
Client
Options, login, bricks, radio settings, messages, errors.
Reference
Every class, interface and function, generated from the sources.
The other packages
@meshcorejs/protocol
Companion Radio protocol codec, no I/O.
@meshcorejs/transports
TCP, serial and BLE transports, plus a fake radio.
@meshcorejs/testing
Test bots without a radio, with simulated time.
To contribute, read CONTRIBUTING.md on GitHub.