Skip to content

Add a tagtinker CLI command for USB serial control (#21) #71

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bey0ne wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add a tagtinker CLI command for USB serial control (#21) #71

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,23 @@ The repo holds three build products plus the static web tool. A root `Makefile`

CI ([`build.yml`](.github/workflows/build.yml)) builds all three components — FAP, worker and ESP32 firmware — on every pull request and every push to `main`; the web tool deploys to GitHub Pages from `main`.

## USB serial control

While TagTinker is open, the Flipper CLI gets a `tagtinker` command. Use it from the qFlipper CLI, `ufbt cli`, or any serial terminal on the Flipper's USB port (close qFlipper first if you use another terminal). Sends use the normal transmit screen, so you can watch them on the Flipper and cancel with Back or Ctrl+C.

```text
tagtinker list # saved tags: #, name, barcode, type, size, color
tagtinker led 1 # flash the LED of tag #1
tagtinker page all 2 forever # broadcast: every awake tag shows page 2
tagtinker page "my tag" 1 30 # one tag shows page 1 for 30 s
tagtinker image 1 1 208x112_cat.bmp # BMP from apps_data/tagtinker/dropped/ to page 1
tagtinker text N4000010000213270 2 -a Hello # text in the accent color, tag given by barcode
tagtinker raw -r 200 85 00 00 00 00 06 49 00 00 00 01 # one raw frame, CRC added
tagtinker stop
```

`<tag>` is the number from `list`, the tag name (quoted if it contains spaces) or the 17-character barcode; an unknown barcode is added to the saved tags. Pages use the same numbers as on the Flipper: `image` and `text` take 1-8 like `Set Text`, `page` takes 0-7 like `Broadcast → Change Page`. Each command prints `OK` or `FAILED: <reason>`.

## FAQ

**Does this require a Flipper Zero?**
Expand Down
3 changes: 2 additions & 1 deletion application.fam
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ App(
name="TagTinker",
apptype=FlipperAppType.EXTERNAL,
entry_point="tagtinker_app_main",
requires=["gui", "notification", "dialogs", "storage", "bt", "nfc", "expansion"],
requires=["gui", "notification", "dialogs", "storage", "bt", "nfc", "expansion", "cli"],
stack_size=12 * 1024,
fap_icon="tagtinker_10px.png",
fap_category="Infrared",
Expand Down Expand Up @@ -33,6 +33,7 @@ App(
"scenes/tagtinker_scene_warning.c",
"views/numlock_input.c",
"nfc/tagtinker_nfc.c",
"cli/tagtinker_cli.c",
"scenes/tagtinker_scene_nfc_scan.c",
"scenes/tagtinker_scene_custom_size.c",
"wifi/tagtinker_wifi.c",
Expand Down
Loading