{"id":30892288,"url":"https://github.com/piersfinlayson/airfrog","last_synced_at":"2026-03-16T05:05:50.445Z","repository":{"id":309536999,"uuid":"1020781558","full_name":"piersfinlayson/airfrog","owner":"piersfinlayson","description":"Tiny wireless co-processor / programmer / debugger for ARM.  Uses $3 WiFi module.  Written in Rust.","archived":false,"fork":false,"pushed_at":"2025-09-07T11:30:50.000Z","size":1745,"stargazers_count":38,"open_issues_count":22,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-11-11T04:27:05.748Z","etag":null,"topics":["embassy-rs","esp32","rust","swd","wifi"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/piersfinlayson.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":null,"dco":null,"cla":null}},"created_at":"2025-07-16T11:39:14.000Z","updated_at":"2025-11-07T09:46:32.000Z","dependencies_parsed_at":"2025-09-06T11:19:22.103Z","dependency_job_id":null,"html_url":"https://github.com/piersfinlayson/airfrog","commit_stats":null,"previous_names":["piersfinlayson/airfrog"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/piersfinlayson/airfrog","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/piersfinlayson%2Fairfrog","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/piersfinlayson%2Fairfrog/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/piersfinlayson%2Fairfrog/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/piersfinlayson%2Fairfrog/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/piersfinlayson","download_url":"https://codeload.github.com/piersfinlayson/airfrog/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/piersfinlayson%2Fairfrog/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30566943,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-16T04:42:47.996Z","status":"ssl_error","status_checked_at":"2026-03-16T04:42:44.668Z","response_time":96,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6: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":["embassy-rs","esp32","rust","swd","wifi"],"created_at":"2025-09-08T19:12:42.232Z","updated_at":"2026-03-16T05:05:50.404Z","avatar_url":"https://github.com/piersfinlayson.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Airfrog\n\n[piers.rocks/u/airfrog](https://piers.rocks/u/airfrog)\n\nTiny wireless co-processor/programmer/debugger for ARM.  Uses $3 WiFi module.  Written in Rust.\n\n* **Tiny**: Coin sized 16×28mm\n* **Wireless**: No cables\n* **Low Cost**: $3 ESP32-C3 module\n* **Open**: Fully open source\n\n## Hardware\n\nThe size of a postage stamp/quarter.  $3 BOM.  Hand solderable.\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"docs/images/airfrog-rev-b-side.png\" alt=\"Airfrog Rev B\" width=\"400\"\u003e\n\u003c/div\u003e\n\n## Use Cases and Features\n\n| Use Case | Description |\n|----------|-------------|\n| **Co-Processing** | Augment MCU with additional processing power - including direct access to the MCU's hardware resources |\n| **Stealth Control**      | Control devices without physical access to the target device or the MCU's knowledge |\n| **Remote Telemetry**     | Transmit flash, RAM and peripheral data from device over WiFi |\n| **Live Re-programming**  | Program devices while they are running, over WiFi |\n| **Wireless Debugging**   | Debug devices over WiFi - no physical access required |\n\n## Key Features\n| Feature | Description |\n|---------|-------------|\n| **Default firmware** | Access ARM MCU's RAM/flash/peripherals via web/REST/binary interfaces over WiFi |\n| **Custom firmware** | Quickly develop custom apps using Airfrog libraries and [examples](examples/README.md) |\n| **Super-fast boot** | Airfrog transmits data from the target device within 5 seconds of power on |\n| **Existing tooling integration** | Compatible with [probe-rs](https://probe.rs/) for programming and debugging. |\n| **STM32 support** | Tested and works with STM32F4 ARM targets. |\n| **Highly controllable** | Erase/reflash firmware while target is running, halt/reset target, read/write RAM/flash/peripherals |\n\n## Quick Start\n\nTo install the default Airfrog firmware:\n\n1. Install the [dependencies](BUILD.md#dependencies)\n\n2. Connect the [Airfrog](pcb/README.md) via USB serial\n\n3. Build and flash the [default firmware](airfrog/README.md)\n    ```bash\n    AF_STA_SSID=your-ssid AF_STA_PASSWORD=your-password cargo run --release -p airfrog\n    ```\n\n4. Point a browser to `http://airfrog-ip/` (IP from DHCP) to access the web interface\n\n## Coming Soon\n\n* [OTA upgrades of Airfrog firmware](https://github.com/piersfinlayson/airfrog/issues/1)\n* [Support for more ARM targets](https://github.com/piersfinlayson/airfrog/issues?q=is%3Aissue%20state%3Aopen%2011%20OR%2012%20OR%2013%20OR%2014)\n* [Memory viewer enhancements](https://github.com/piersfinlayson/airfrog/issues/2)\n* [Run STA and AP modes in parallel](https://github.com/piersfinlayson/airfrog/issues?q=is%3Aissue%20state%3Aopen%20%236%20OR%20%235%20OR%20%234)\n* [Support target RTT logging](https://github.com/piersfinlayson/airfrog/issues/9)\n\n## Technical Summary\n\nFirmware:\n\n* Built from the ground-up in Rust using [embassy](https://embassy.dev/) and [esp-hal](https://github.com/esp-rs/esp-hal) for speed and reliability\n* Web, REST and binary interfaces provided out of the box\n* Supports SWD protocol at configurable speeds between 500KHz - 4MHz\n* Supports controlling [Software Defined Retro ROM](https://piers.rocks/u/sdrr)\n* Default firmware uses IPv4 and DHCP for network configuration and supports captive AP for easy setup\n* Build custom firmware using libraries and [examples](examples/README.md) provided\n* Integration with [probe-rs](https://probe.rs/) for programming and debugging tasks\n* Fully open source, no closed source dependencies\n\nHardware:\n\n* [ESP32-C3-MINI-1](https://www.espressif.com/sites/default/files/documentation/esp32-c3-mini-1_datasheet_en.pdf) RISC-V core with integrated WiFi, RAM and flash\n* 5-pin 0.1\" pitch connector to power Airfrog and connecting to target ARM devices\n* Exposes separate UART for Airfrog firmware programming\n* Powered by 5V, includes on-board 3.3V regulator\n* SWD pins 3.3V\n* All passives 0603 for hand soldering\n* 2-layer PCB, default single sided assembly\n* Fully open-source, no restrictions on commercial use\n\n## Documentation\n\n* [FAQ](docs/FAQ.md) - frequently asked questions\n* [Build Instructions](BUILD.md) - build and flash the default firmware\n* [PCB Designs](pcb/README.md) - design or fab your own Airfrog\n* [Technical Overview](docs/TECHNICAL.md) - how Airfrog works\n* [Examples](examples/README.md) - start here for building custom Airfrog applications\n* [Software](docs/SOFTWARE.md) - start here to use Airfrog with existing SWD tools\n* [REST API](docs/API.md) - to interact with the default Airfrog firmware via web APIs\n* [Binary API](docs/BINARY_API.md) - Airfrog's highest performance network API\n* [SWD Protocol](docs/SWD.md) - to understand the core SWD protocol\n* [Changelog](CHANGELOG.md)\n* [Licence](LICENCE.md)\n\n## Example Use Case - Remote Telemetry\n\nAirfrog is used to add remote telemetry support to the [Software Defined Retro ROM (SDRR) ](https://piers.rocks/u/sdrr) which is based on the STM32F4 ARM MCU.\n\nSDRR has no network interface or spare MCU cycles to transmit data, so Airfrog is installed.  It reads a counter directly from the MCU's RAM and sends it via MQTT over WiFi to be graphed on a remote system.\n\nAirfrog can also be used to dynamically control SDRR during run-time, and reprogram it over WiFi.\n\nThis [demonstration](examples/mqtt.rs) was developed in 2-3 hours with\n- 200 lines of Rust for the Airfrog firmware\n- 90 lines of Python to produce the real-time graph.\n\n![SDRR with Airfrog](docs/images/sdrr-mqtt.png)\n\nIf you are interested in precisely what is being shown here:\n- Three SDRRs are installed in a Commodore 64, operating as Kernal, BASIC and Character ROMs repspectively.\n- SDRR increments a counter in its RAM every time that ROM's chip select line(s) are asserted.\n- Airfrog reads that counter directly from the MCU RAM every second.  It subtracts it from the previous value (to get a 1Hz sample rate) and sends it to an MQTT broker.\n- The Python script subscribes to the appropriate MQTT topics and plots the data in real-time using `matplotlib`.\n\n## Contributing\n\nContributions are welcome!\n* [Report an issue](https://github.com/piersfinlayson/airfrog/issues)\n* [Submit a PR](https://github.com/piersfinlayson/airfrog/pulls)\n\n## Licence\n\n* Software: [MIT Licensed](LICENCE#mit-license)\n* Hardware: [CC-BY-SA-4.0](LICENCE#cc-by-sa-4.0)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpiersfinlayson%2Fairfrog","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpiersfinlayson%2Fairfrog","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpiersfinlayson%2Fairfrog/lists"}