kamilkrzywda
75a10c195f
feat: /api/channels endpoint, /api namespace, Scalar at root (v0.1.0) — closes #1
51 lines
1.7 KiB
Markdown
51 lines
1.7 KiB
Markdown
# mesh-bot
|
|
|
|
Minimal NestJS bot for Meshtastic. Long-running service that TCP-connects to a
|
|
Meshtastic serial bridge (raw socat pipe) at `192.168.1.4:4003`, parses inbound
|
|
protobuf frames, logs received text messages, and exposes HTTP endpoints to send text.
|
|
|
|
## Local run
|
|
|
|
```sh
|
|
npm i
|
|
npm run start:dev
|
|
```
|
|
|
|
## Docker
|
|
|
|
```sh
|
|
docker compose up -d --build
|
|
```
|
|
|
|
Exposed via Traefik only (no published ports) at `http://bot.dev.kkhost.pl`.
|
|
|
|
## Endpoints
|
|
|
|
All API endpoints live under the `/api` prefix:
|
|
|
|
- `GET /api/status` — `{ connected, myNodeNum, host, port }`
|
|
- `POST /api/send` — body `{ "text": "...", "to"?: <node number | "!b" | "broadcast"> }`, returns `{ id }`
|
|
- `GET /api/channels` — the device's Meshtastic channels as `{ index, name, uplinkEnabled, downlinkEnabled }[]` (psk/keys are redacted; empty until the initial sync completes)
|
|
|
|
Interactive API docs (Scalar) are served at `/`, with the OpenAPI JSON at
|
|
`/docs-json`.
|
|
|
|
```sh
|
|
curl http://localhost:3000/api/status
|
|
curl -X POST http://localhost:3000/api/send -H 'content-type: application/json' -d '{"text":"hi"}'
|
|
curl -X POST http://localhost:3000/api/send -H 'content-type: application/json' -d '{"to":123456789,"text":"hello"}'
|
|
curl http://localhost:3000/api/channels
|
|
```
|
|
|
|
`to` omitted, `"!b"`, or `"broadcast"` sends to the broadcast address `0xffffffff`.
|
|
|
|
## Env vars
|
|
|
|
- `MESH_HOST` (default `192.168.1.4`) — bridge host
|
|
- `MESH_PORT` (default `4003`) — bridge port
|
|
- `MESH_RECONNECT_MS` (default `5000`) — reconnect interval in ms
|
|
- `PORT` (default `3000`) — HTTP listen port
|
|
|
|
Note: the serial bridge accepts only ONE client at a time — if another app is
|
|
connected to the radio, this bot will not get a connection.
|