From 25f9152a8d3f942362599677ca45e2227ec96a0f Mon Sep 17 00:00:00 2001 From: Lloyd Date: Tue, 24 Feb 2026 14:15:57 +0000 Subject: [PATCH] Update README to include compatibility details for supported radio interfaces and installation instructions for Proxmox --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4f02cd0..e11fa8c 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,25 @@ The repeater daemon runs continuously as a background process, forwarding LoRa p ## Supported Hardware (Out of the Box) +> [!CAUTION] +> ## Compatibility +> +> ### Supported Radio Interfaces +> +> | Interface | Supported | +> |------------|------------| +> | Native SPI radio SX1262 | ✅ Yes | +> | USB–SPI bridge (CH341F) | ✅ Yes | +> | UART-based HATs | ❌ No | +> | SX1302 concentrator boards | ❌ No | +> | SX1303 concentrator boards | ❌ No | +> +> This project supports **single-radio SPI transceivers only**, either: +> - Connected directly via SPI +> - Connected via a CH341F USB–SPI adapter +> - Connected using hardware that supports Meshcore Kiss Modem firmware + + The following hardware is currently supported out-of-the-box: Waveshare LoRaWAN/GNSS HAT (SPI Version Only) @@ -212,9 +231,11 @@ pyMC Repeater can run inside a Proxmox LXC container using a **CH341 USB-to-SPI Run this on the **Proxmox host** (not inside a container): ```bash -bash -c "$(curl -fsSL https://raw.githubusercontent.com/rightup/pyMC_Repeater/main/scripts/proxmox-install.sh)" +bash -c "$(curl -fsSL https://raw.githubusercontent.com/rightup/pyMC_Repeater/feat/newRadios/scripts/proxmox-install.sh)" ``` +> **Tip:** Replace `feat/newRadios` in the URL with whichever branch you want to install. + The installer will interactively prompt you for container settings (hostname, RAM, disk, bridge, etc.) and then: 1. Download a Debian 12 LXC template