{"id":50235375,"url":"https://github.com/pskillen/meshflow-bot","last_synced_at":"2026-05-26T19:01:07.980Z","repository":{"id":273573647,"uuid":"920167981","full_name":"pskillen/meshflow-bot","owner":"pskillen","description":null,"archived":false,"fork":false,"pushed_at":"2026-05-18T21:55:43.000Z","size":993,"stargazers_count":7,"open_issues_count":12,"forks_count":3,"subscribers_count":3,"default_branch":"main","last_synced_at":"2026-05-18T23:59:59.341Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pskillen.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2025-01-21T17:20:35.000Z","updated_at":"2026-05-17T21:43:40.000Z","dependencies_parsed_at":"2025-01-21T18:34:02.756Z","dependency_job_id":"6d42e019-497b-4588-8d89-490d53565bb8","html_url":"https://github.com/pskillen/meshflow-bot","commit_stats":null,"previous_names":["pskillen/meshtastic-bot","pskillen/meshflow-bot"],"tags_count":24,"template":false,"template_full_name":null,"purl":"pkg:github/pskillen/meshflow-bot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pskillen%2Fmeshflow-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pskillen%2Fmeshflow-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pskillen%2Fmeshflow-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pskillen%2Fmeshflow-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pskillen","download_url":"https://codeload.github.com/pskillen/meshflow-bot/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pskillen%2Fmeshflow-bot/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33534563,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"ssl_error","status_checked_at":"2026-05-26T15:22:15.568Z","response_time":63,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-05-26T19:00:53.099Z","updated_at":"2026-05-26T19:01:07.968Z","avatar_url":"https://github.com/pskillen.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Meshflow Bot\n\nMeshflow Bot is a Python bot that connects to **mesh radios** and integrates with [meshflow-api](https://github.com/pskillen/meshflow-api). It listens for traffic, handles `!` commands, optional responders, and (for Meshtastic) uploads packets to the API.\n\n**Protocols**\n\n- **[Meshtastic](docs/MESHTASTIC.md)** — TCP to a Meshtastic node; full API upload + WebSocket traceroute today.\n- **[MeshCore](docs/MESHCORE.md)** — USB serial or BLE via [`meshcore`](https://github.com/meshcore-dev/meshcore_py); **Phase 0.3** adds capture-only connectivity (JSON dumps under `data/meshcore_packets/`, no API ingest yet).\n\nSelect the radio with `RADIO_PROTOCOL=meshtastic` (default) or `RADIO_PROTOCOL=meshcore`. See the linked docs for environment variables.\n\n## Quick Start: Run with Docker\n\nThe easiest way to run the bot is Docker Compose. Two services are defined: `meshflow-bot-meshtastic` and `meshflow-bot-meshcore` (adjust devices, env, and image tags for your environment).\n\n### 1. Prepare Your Environment\n\n- Ensure you have [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) installed.\n- Create a `.env` file in the project directory (see [`.env.example`](.env.example)).\n\n### 2. Use `docker-compose.yaml`\n\nFrom the repo root:\n\n```sh\ndocker compose up -d meshflow-bot-meshtastic\n# or, for MeshCore over USB (Linux device pass-through):\ndocker compose up -d meshflow-bot-meshcore\n```\n\nImages are published as `ghcr.io/pskillen/meshflow-bot` (the legacy `meshtastic-bot` image name is deprecated).\n\n### 3. Data directories\n\n- Meshtastic service mounts `./data`.\n- MeshCore service mounts `./data-meshcore` so captures do not clash with the MT bot.\n\n---\n\n## Native Installation (Advanced/Development)\n\n1. **Clone the repository:**\n    ```sh\n    git clone https://github.com/pskillen/meshflow-bot.git\n    cd meshflow-bot\n    ```\n2. **Install dependencies:**\n    ```sh\n    pip install -r requirements.txt\n    ```\n3. **(Optional) On Raspberry Pi:**\n    ```sh\n    sudo apt-get install libopenblas-dev\n    ```\n4. **Configure environment:**\n    - Copy `.env.example` to `.env` and fill in the required values (see [Meshtastic](docs/MESHTASTIC.md) / [MeshCore](docs/MESHCORE.md)).\n5. **Run the bot:**\n    ```sh\n    python -m src.main\n    ```\n\n---\n\n## Usage\n\nThe bot listens for traffic and responds to `!` commands where the underlying protocol exposes text (Meshtastic today; MeshCore in capture mode still runs command dispatch for local testing).\n\n### Supported Commands\n\n| Command   | Description                                    |\n|-----------|------------------------------------------------|\n| `!help`   | Displays a list of available commands          |\n| `!hello`  | Displays information about the bot             |\n| `!ping`   | Responds with \"Pong!\"                          |\n| `!nodes`  | Displays a list of connected nodes, stats, etc |\n| `!whoami` | Displays information about the sender          |\n\n---\n\n## Extending the Bot (Development)\n\nIf you want to add new commands or responders, see the `src/commands/` and `src/responders/` directories. The codebase is structured for easy extension, but most users will not need to modify the code to run the bot.\n\n- **Commands:** Add new command classes and register them in the command factory.\n- **Responders:** Inherit from `AbstractResponder` to handle public channel messages.\n\n---\n\n## Contributing\n\nContributions are welcome! Please fork the repository and submit a pull request.\n\n## License\n\nThis project is licensed under the MIT License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpskillen%2Fmeshflow-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpskillen%2Fmeshflow-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpskillen%2Fmeshflow-bot/lists"}