diff --git a/README.md b/README.md index d16936b..bd1b703 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,8 @@
- Real-time telemetry, live probe trend lines, cook ETAs, and temperature alarms for WiFi pellet grills.
- Pull grill & probe temps straight from the cloud ยท analyze your cook right in the terminal.
+ The pitmaster co-pilot for your WiFi pellet grill.
+ Live ETAs, stall detection, a coach that tells you when to wrap, and a report to show off the results โ all from the terminal.
@@ -16,7 +16,13 @@
> [!IMPORTANT] -> **Unofficial project.** Pellet Pilot is an independent, community-built tool. It is **not affiliated with, endorsed by, or sponsored by Traeger Inc.** "Traeger" and "WiFIRE" are trademarks of their respective owner and are used here only to describe compatibility. It talks to the same cloud the mobile app uses via a reverse-engineered protocol, which may break at any time and may be against the vendor's Terms of Service. Use at your own risk. +> **Unofficial project.** Pellet Pilot is an independent, community-built tool. It is **not affiliated with, endorsed by, or sponsored by Traeger Inc.** "Traeger" and "WiFIRE" are trademarks of their respective owner and are used here only to describe compatibility. It talks to the same cloud the mobile app uses via a reverse-engineered protocol, which may break at any time and may be against the vendor's Terms of Service. Use at your own risk. It is also deliberately **read-only** โ it never starts, stops, or changes your grill's temperature. + +```bash +git clone https://github.com/ctopherwilliams/pellet-pilot.git && cd pellet-pilot +python3 -m venv venv && ./venv/bin/pip install -e . # adds the `pellet` command +pellet watch --preset brisket --speak --coach # after setting up credentials, below +``` --- @@ -26,11 +32,30 @@ The mobile app shows you a number. Pellet Pilot gives you the **curve** โ and - **๐ Live probe trend line** โ rate of rise in ยฐ/min, with a sparkline of the climb. - **โฑ Time-to-target ETA** โ "your probe hits 203ยฐ at ~4:45 PM," updated every reading. -- **๐ Temperature alarms** โ desktop notification + spoken alert when the probe crosses your thresholds. -- **๐ Your own cook history** โ every reading logged to CSV, because the cloud keeps none. Query and re-plot past cooks any time. - **๐ง Stall detection** โ flags the classic 150โ170ยฐ brisket/pork-shoulder plateau so you don't panic (or wrap early). +- **๐ A coach, not just a number** โ rule-based advice on whether to hold for bark or wrap, and natural spoken updates that say what actually changed since last time. +- **๐ Temperature alarms** โ desktop notification + spoken alert when the probe crosses your thresholds, by name ("the pork butt," not "probe 1"). +- **๐ Your own cook history** โ every reading logged to CSV, because the cloud keeps none. Query, re-plot, or export a shareable report of any past cook. - **๐ฅ Terminal-native** โ no app, no dashboard server. Pipe it, grep it, graph it. +### vs. the official app + +| | Traeger app | Pellet Pilot | +|------------------------------|:-------------------:|:------------:| +| Start / stop / set temp | โ | โ *(read-only, by design)* | +| Live grill & probe temps | โ | โ | +| Rate-of-rise + time-to-target ETA | โ | โ | +| Stall detection | โ | โ | +| Wrap/hold coaching | โ | โ rule-based | +| Natural spoken updates | โ | โ opt-in, name-your-probes | +| Cook history | โ *(not stored server-side)* | โ every reading, forever, locally | +| Shareable cook report | โ | โ self-contained HTML | +| Grafana / Prometheus export | โ | โ | +| Runs where | phone app | terminal, any OS, or chat via Claude Code | +| Official support | โ | โ unofficial, community-built | + +Pellet Pilot doesn't replace the app โ it's for the parts the app was never built for: predicting, coaching, logging, and sharing. Keep the app for actually starting your cook. + --- ## โก Quickstart @@ -437,17 +462,17 @@ auto-merged; requires an `ANTHROPIC_API_KEY` repo secret. See [SECURITY.md](SECU ## ๐บ Roadmap Pellet Pilot already covers the full loop end to end: multi-probe live tracking, -stage-aware predictions with spoken updates, local + remote alarms, cook -history, charts with projected finish times, and Grafana export. Here's where -it can go next: +stage-aware predictions with spoken updates and rule-based wrap coaching, named +probes, local + remote alarms, cook history, charts with projected finish +times, a shareable Cook Report, a unified CLI with presets, and Grafana +export. Here's where it can go next: -- [ ] **Stage presets** (`--preset brisket`, `pork-shoulder`, `chicken`, ...) โ skip typing `--stage` every cook - [ ] **`history.py compare A B`** โ overlay two past cooks on one chart ("is this brisket tracking like my last one?") -- [ ] **Shareable post-cook report** โ one-page chart + stage times + stats card, for exporting or sharing a finished cook +- [ ] **Publish to PyPI** โ `pellet` already works via `pip install -e .`; a real release would drop the "clone + venv" step for non-developers - [ ] **Interactive Cognito MFA/challenge support at login** โ refresh-token renewal is handled, but accounts with MFA enabled still can't complete the *initial* login - [ ] **Per-grill filtering** (`--grill