Skip to content

Latest commit

 

History

11 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Tock on an M5Stack FIRE: the Arcade timer, with Tock walking toward a cup of coffee

    Tock

A simple pet project of how I'd like to focus.

Tock is a desk pet and focus timer for the M5Stack FIRE. A small pixel creature lives on the screen and keeps you company while you work: it counts down your focus time, has a coffee on your breaks, and cheers when you reach your daily goal.

  • Timer: one countdown, Pomodoro, or intervals, in four looks. The LEDs fill as time runs.
  • Stats: today, the week, and a 16-week heatmap, split by task if you use tasks.
  • Talk: hold a button and talk to Tock (an OpenAI voice model, straight from the FIRE).
  • Saver: your own lines, large, over a slow background.
  • Mac app: Tock in your menu bar, today's goal and progress, and a log of your focus on the Mac.

The FIRE works on its own; the Mac app pairs over Bluetooth for setup (tasks, Wi-Fi, the API key) and for the menu bar.

Note

Tock is a pre-release project, so be kind and patient with it. Things may break or change between versions; if something does, open an issue.

Install

You need an M5Stack FIRE and a Mac with macOS 15 or later.

firmware/flash.sh            # build the firmware and flash it over USB
companion/build.sh install   # build the Mac app and put it in /Applications

Then switch Bluetooth on in the FIRE's Settings and type the code it shows when the Mac asks. After that, updates come through the Mac app, for the app and the FIRE both. Getting started has the details: what to install first, Wi-Fi, and the API key for Talk.

Docs

Layout

firmware/    the FIRE's firmware (Arduino, ESP32) and its build scripts
companion/   the Mac menu bar app (SwiftUI, built without Xcode)
docs/        these docs
.github/     the release workflow (docs/releasing.md)

License

MIT. Changes: CHANGELOG.

About

A simple pet project of how I'd like to focus.

Resources

Contributing

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages