ADD/UPD documentation and MIT license

Dieser Commit ist enthalten in:
tom committed 2026-10-17 12:43:38 +02:00
1 Ursprung 0d6cda8112
Commit 37effba936
6 Dateien geändert
+156 -14

Keine Dateien entsprechen Ihrer Suche

+19 -8
Datei anzeigen
@@ -7,19 +7,30 @@ An open-source, international ARDF (Amateur Radio Direction Finding) timekeeping
FoxMesh is a resilient, off-grid timing infrastructure designed for Radio Orienteering and ARDF events. By placing programmable FoxMesh nodes at the start, finish, and individual fox stations, the system automatically registers, collects, and synchronizes runner timestamps across the entire field using LoRa mesh technology.
### Key Features
* **Automated Checkpoints:** Nodes automatically log runner punch-ins at every station.
* **Mesh Data Sync:** No cellular network required. Timestamps are relayed from node to node back to the finish line.
* **Low Power & Cost-Effective:** Built on accessible ESP32/nRF52 and LoRa hardware (similar to MeshCom/Meshtastic).
* **Real-time Overview:** Provides race organizers with a live status of runners currently out in the field.
* **Automated Checkpoints:** Logs runner punch-ins automatically at every station.
* **Mesh Data Sync:** Operates entirely without cellular networks, relaying timestamps from node to node back to the finish line.
* **Low Power & Cost-Effective:** Built on highly accessible ESP32/nRF52 and LoRa hardware (similar to MeshCom or Meshtastic).
* **Real-Time Overview:** Provides race organizers with a live status monitor of runners currently out in the field.
### Technical Architecture
* **Native ESP-IDF:** Developed using the pure `espressif32` platform (v7.x release branch) without the overhead of the Arduino framework.
* **Event-Driven Multitasking:** Built from the ground up with thread-safe, dynamically expandable libraries. Avoids CPU-heavy polling for subsystems like CLI, GNSS, or I2C.
## Hardware Support
FoxMesh is designed to run on popular LoRa development boards:
* Heltec Automation (e.g., Wireless Stick V3, WiFi LoRa 32 V3)
* LILYGO T-Beam / T-Deck series
* RAK Wireless WisBlock modules
> ⚠️ **Note:** Hardware support is currently limited as the project is under active development.
The firmware is designed to target popular LoRa development ecosystems, with primary testing and core drivers focusing on:
* **Heltec Automation:** Wireless Stick V3, WiFi LoRa 32 V3
* **LILYGO:** T-Beam & T-Deck series
* **RAK Wireless:** WisBlock modules
*Contributions and hardware abstraction layer (HAL) testing for specific boards are highly welcome!*
## Getting Started
*(Coming Soon)* Instructions on how to flash the firmware using PlatformIO and deploy the nodes in the field.
## Developers
Please refer to the documentation pages under `docs/developers/` for architecture deep-dives and contribution guidelines.
---
Project hosted under the [f0x.at](https://f0x.at) ARDF experimentation platform.