No description
Find a file
2026-05-22 00:18:14 -06:00
.github/workflows release: bump Ratcom to v1.9.2 2026-05-22 00:18:14 -06:00
assets Rewrite README, add product photos 2026-03-08 04:37:36 -06:00
lib/Crypto Reduce supply chain risk 2026-04-07 15:11:48 -06:00
src release: bump Ratcom to v1.9.2 2026-05-22 00:18:14 -06:00
tools tools: add announce validator 2026-05-05 18:03:11 -06:00
.gitignore Region UX 2026-04-04 23:09:13 -06:00
LICENSE license: adopt AGPLv3 2026-05-05 18:30:39 -06:00
merge_firmware.py radio: fix SX126x LoRa mode assertion 2026-05-21 19:48:15 -06:00
partitions_8MB_ota.csv Initial release: Ratputer v1.0.0 2026-03-06 12:43:26 -07:00
platformio.ini radio: harden Cardputer SX1262 link 2026-05-21 23:11:23 -06:00
README.md license: adopt AGPLv3 2026-05-05 18:30:39 -06:00

Ratcom

Standalone Reticulum for the M5Stack Cardputer

Ratcom turns an M5Stack Cardputer Adv into a full standalone Reticulum node. It's not just an RNode which requires another device — it's the complete setup.

End-to-end encrypted LXMF messaging over LoRa, TCP over WiFi for bridging to the wider Reticulum network, node discovery, identity management, GPS time sync, and more.

Installing

The easiest way is the web flasher — enable download mode (hold G0 while plugging it in), select the USB, click flash, done.

To build from source:

git clone https://github.com/ratspeak/ratcom
cd ratcom
pip install platformio
python3 -m platformio run -e ratcom_915 -t upload

Usage

On first boot, Ratcom asks you to pick a timezone and set a display name. Your LXMF address (what you share with contacts) is shown on the Home tab.

Tabs: Home, Msgs, Nodes, Settings — navigate with , and / keys.

Manually announce: Press Enter on the Home tab to broadcast your identity to the network.

Add/delete contacts/messages: Hold Enter on a conversation to add contact or delete history.

Sending a message: Find someone in the Nodes tab, press Enter, type your message, hit Enter to send. Messages are encrypted end-to-end with Ed25519 signatures.

Radio presets (Settings → Radio):

  • Long Range — SF12, 62.5 kHz, 22 dBm. Longest distance, slow.
  • Balanced — SF9, 125 kHz, 17 dBm. Medium distance, medium.
  • Fast — SF7, 250 kHz, 14 dBm. Shortest distance, fast.

All radio parameters are individually tunable. Changes apply immediately, no reboot. Please operate in accordance with local laws, as you are solely responsible for knowing which regulations and requirements apply to your jurisdiction.

WiFi Bridging (Alpha)

Use STA mode to connect to existing WiFi and reach remote nodes like rns.ratspeak.org:4242.

To bridge LoRa with Reticulum on your computer:

  1. Set WiFi to AP mode in Settings → WiFi (creates ratcom-XXXX, password: ratspeak)
  2. Connect your computer to that network
  3. Add to your Reticulum config:
[[ratcom]]
  type = TCPClientInterface
  target_host = 192.168.4.1
  target_port = 4242

Note: WiFi bridging methods and interfaces will be revamped with Ratspeak's client release, therefore, it's unlikely AP mode works at all currently.

License

GNU Affero General Public License v3.0 or later. See LICENSE.

Vendored third-party code keeps its own license notices, including lib/Crypto under MIT. Radio-driver excerpts attributed in source remain under their original MIT notice.