Docs: correct stale feature claims and the worker URL instructions

- README: the IR engine allocates heap for payloads, so drop
  "zero-allocation"; the drop folder takes the 1-bit and two-plane BMPs
  the image preparer exports, not any BMP, and type 1626 targets cap
  files at 24 KB; NFC scan only fills the barcode when the tag's NFC
  data decodes; there is no test-pattern feature; the FAQ now says this
  app needs a Flipper even though the protocol does not.
- CONTRIBUTING: the Android companion app was removed in d608afb.
- wrangler.toml pointed users at a "WiFi Setup -> Server URL" field that
  never existed. Say how the URL is actually set today.
- cloud_client.h described a runtime override through
  cloud_client_set_url(), which nothing calls.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
Hoggormino
2026-09-16 17:10:59 +02:00
co-authored by Claude Opus 5
parent b6ebe46d0f
commit 53ede949b8
4 changed files with 12 additions and 10 deletions
-1
View File
@@ -24,7 +24,6 @@ Thanks for wanting to help out! Here's how to get involved.
- Support for new ESL tag sizes and models
- NFC tag support for additional ESL formats
- UI/UX improvements
- Android companion app improvements
## Pull Request Guidelines
+5 -5
View File
@@ -31,14 +31,14 @@ This tool is built for IoT security curiosity, learning about obscure protocols,
## Features
- **TagTinker Flipper App:** High-performance, zero-allocation RLE streaming IR engine.
- **TagTinker Flipper App:** High-performance RLE streaming IR engine.
- **TagTinker Image Prep (web):** Single-file, dependency-free HTML page that lists every supported tag profile, runs a full image pipeline (tone, contrast, detail, sharpen, dither, photo-grade Oklab 3-colour quantisation) and exports a Flipper-ready BMP. Hosted at **[i12bp8.github.io/TagTinker](https://i12bp8.github.io/TagTinker/)** (source: `web-image-prep/`).
- **Drop-folder image flow:** Drop a prepared BMP into `apps_data/tagtinker/dropped/` on the Flipper SD card, then open `Targeted Payloads → <tag> → Set Image` and pick it. The Flipper rescales any BMP on the fly so a single file can target any tag and any page.
- **NFC Tag Scan:** Instantly identify ESL targets by scanning their NFC tag — no manual barcode entry needed.
- **Drop-folder image flow:** Drop a prepared BMP into `apps_data/tagtinker/dropped/` on the Flipper SD card, then open `Targeted Payloads → <tag> → Set Image` and pick it. The Flipper rescales the 1-bit and two-plane BMPs that the image preparer exports, so one file can be sent to graphics tags of other sizes and to any page. Type 1626 (SmartTAG Color 2.6) targets only accept files up to 24 KB.
- **NFC Tag Scan:** Add a target by scanning the tag's NFC chip instead of typing its barcode. This works when the tag's NFC data carries an ID TagTinker can decode; otherwise use `+ Type Barcode`.
- **WiFi Plugins (optional):** Plug a Flipper WiFi Dev Board (ESP32-S2) into the GPIO header to unlock live, network-rendered tag designs — crypto price cards, weather tiles, identicons, and more — auto-discovered by the FAP. New plugins live entirely on the cloud worker; the Flipper firmware never has to be re-flashed to add one.
<img alt="image" src="https://raw.githubusercontent.com/i12bp8/TagTinker/refs/heads/main/PXL_20260427_092219442.jpg" />
- Display text, custom images, and test-patterns.
- Display text and custom images.
- Support for monochrome and accent-color (red/yellow) graphics tags.
## Getting Started
@@ -52,7 +52,7 @@ This tool is built for IoT security curiosity, learning about obscure protocols,
**Does this require a Flipper Zero?**
No, not at all! You can do this with less than $5 worth of microcontroller hardware (like an ESP32 and an IR LED). The Flipper Zero just happens to be my favorite security research tool, which is why I built the app for this platform.
This app does. The IR protocol itself is simple enough to drive from other cheap microcontroller hardware, such as an ESP32 and an IR LED, but this repository only contains the Flipper implementation. The Flipper Zero just happens to be my favorite security research tool, which is why I built the app for this platform.
**Where is the `.fap` release?**
+3 -2
View File
@@ -3,5 +3,6 @@ main = "src/index.ts"
compatibility_date = "2024-09-23"
# `npm run deploy` will publish to <name>.<account-subdomain>.workers.dev.
# Once deployed, point the ESP firmware at the resulting URL via
# the FAP "WiFi Setup -> Server URL" field.
# The dev board firmware has no runtime URL setting yet. To use your own
# deployment, set TT_CLOUD_DEFAULT_URL in esp32-wifi-fw/main/cloud_client.h,
# then rebuild and reflash the ESP32-S2.
+4 -2
View File
@@ -2,8 +2,10 @@
* Cloud plugin client.
*
* Talks to the TagTinker Cloudflare Worker that hosts plugin manifests
* and renders. Default URL is hard-coded below; override at runtime by
* calling cloud_client_set_url() (the value is persisted in NVS).
* and renders. The base URL is TT_CLOUD_DEFAULT_URL below unless NVS
* already holds one. cloud_client_set_url() can store a different URL, but
* nothing calls it yet, so pointing the board at another worker currently
* means editing TT_CLOUD_DEFAULT_URL and reflashing.
*
* GET <base>/plugins -> JSON manifest list
* GET <base>/render/<id>?...-> binary framebuffer (see worker docs)