mirror of
https://github.com/Cyclenerd/meshcore-bot.git
synced 2026-06-25 20:31:22 +02:00
dependabot[bot]
374f211cea
Bumps [actions/checkout](https://github.com/actions/checkout) from 4 to 5. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/v4...v5) --- updated-dependencies: - dependency-name: actions/checkout dependency-version: '5' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com>
🤖 MeshCore Bot
This script is a command bot that connects to a MeshCore companion radio device via serial connection and responds to commands received in private channels.
| Client | Bot |
|---|---|
 |
 |
Installation
-
Node.js: Make sure you have Node.js installed. You can download it from https://nodejs.org/ or install it on macOS with Homebrew package manager:
brew install node -
Clone: Clone this repo:
git clone "https://github.com/Cyclenerd/meshcore-bot"" cd "meshcore-bot" -
Dependencies: In the directory run:
npm ci --production
Usage
To run the bot use the following command:
node meshcore-bot.js [SERIAL_PORT]
[SERIAL_PORT]is optional. If not provided, the script will default to/dev/cu.usbmodem1101.
Example
node meshcore-bot.js "/dev/ttyUSB0"
Commands
.ping: The bot will respond with "PONG! 🏓 (hop count)"..date: The bot will respond with the current date and time in ISO format.
License
All files in this repository are under the Apache License, Version 2.0 unless noted otherwise.