Files
meshcore-bot/README.md
2025-08-30 20:48:31 +02:00

1.4 KiB

🤖 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
Screenshot: Client Screenshot: Bot Log

Installation

  1. 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
    
  2. Clone: Clone this repo:

    git clone "https://github.com/Cyclenerd/meshcore-bot""
    cd "meshcore-bot"
    
  3. 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.