mesh-api

Files (1)

• SKILL.md

SKILL.md (first lines)

---
name: mesh-api
description: Interact with a Meshtastic LoRa mesh network through MESH-API — list nodes, read messages, send texts, and check connection status.
version: 1.0.0
author: mesh-api community
metadata:
  openclaw:
    required_env:
      - MESH_API_URL
      - MESH_API_KEY
    required_bins:
      - curl
    tags:
      - meshtastic
      - mesh
      - radio
      - iot
      - lora
---

# MESH-API Skill

You can interact with a Meshtastic LoRa mesh network through a running MESH-API instance.
MESH-API exposes a REST API (default port 5000) that lets you list online nodes, read recent messages, send texts to specific nodes or broadcast to channels, and check device connectivity.

## Configuration

- `MESH_API_URL` — Base URL of the MESH-API instance (e.g. `http://192.168.1.50:5000`). **Required.**
- `MESH_API_KEY` — Optional bearer token for future authentication support. If set, include it as `Authorization: Bearer <token>` on every request. If empty or unset, omit the header entirely — MESH-API has no auth by default.

## Available Endpoints

### GET /nodes

List all mesh nodes the MESH-API instance can see.

**Request:**
```
curl -s "$MESH_API_URL/nodes"
```

**Response:** JSON array of node objects.
```json
[
  {"id": "!a1b2c3d4", "shortName": "TBot", "longName": "TBot Base Station"},
  {"id": "!e5f6a7b8", "shortName": "Hike", "longName": "Hiker Node"}
]
```

- `id` is the Meshtastic hex node ID (always starts with `!` followed by 8 hex characters).
- `shortName` is a 4-character display name.
- `longName` is the full node name.

### GET /messages

Retrieve recent messages from the mesh.

**Request:**
```
curl -s "$MESH_API_URL/messages"
```

**Response:** JSON array of message objects. Each message contains sender info, text, timestamp, and channel.

### POST /send

Send a message to a specific node (direct) or broadcast to a channel.

**Direct message to a node:**
```
curl -s -X POST "$MESH_API_URL/send" \
  -H "Content-Type: application/json" \
  -d '{"message": "Hello from OpenClaw", "node_id": "!a1b2c3d4", "direct": true}'
```

**Broadcast to a channel:**
```
curl -s -X POST "$MESH_API_URL/send" \
  -H "Content-Type: application/json" \
  -d '{"message": "Hello mesh!", "channel_index": 0}'
```

**Body parameters:**
- `message` (string, required) — The text to send.
- `node_id` (string, required for direct) — Target node hex ID (e.g. `!a1b2c3d4`).
- `direct` (boolean) — Set `true` for a direct message to `node_id`.
- `channel_index` (integer) — Channel index for broadcast (default `0` = LongFast).

**Response:**
```json
{"status": "sent", "to": "!a1b2c3d4", "direct": true, "message": "Hello from OpenClaw"}
```

### POST /ui_send

Broadcast a message to a channel (form-encoded, primarily used by the web UI).

**Request:**
```
curl -s -X POST "$MESH_API_URL/ui_send" \
  -d "message=Hello+mesh!&channel_index=0"
```

**Parameters (form-encoded):**
- `message` (string, required) — The text to send.
- `channel_index` (integer) — Channel index (default `0`).
- `destination_node` (string, optional) — If provided, sends a direct message instead of broadcast.

For programmatic use, prefer `POST /send` with JSON. Use `/ui_send` only when mimicking the web UI.

### GET /connection_status

Check whether MESH-API is connected to its Meshtastic radio device.

**Request:**
```
curl -s "$MESH_API_URL/connection_status"
```

**Response:**

From mr-tbot/mesh-api, GPL-3.0.

More from mr-tbot/mesh-api