<img src="https://github.com/goat-hill/bitclock/assets/220799/5121ca8b-19c7-4db0-9a81-38fae36ac5df" width="250" alt="bitclock" />

bitclock

Open source e-ink desk companion, clock, and air quality monitor.

Available for purchase in USA @ https://bitclock.io

<img src="https://github.com/user-attachments/assets/a1be3895-0399-4e95-8b5f-d52c59792a22" width="500" alt="Bitclock photo" />

Visit https://bitclock.io/connect to configure your existing device

Firmware

Source code for ESP32 using the ESP-IDF development framework.

See bitclock-fw/

Website

Next.js web app for homepage and device configurator.

See bitclock-web/

<img src="https://github.com/goat-hill/bitclock/assets/220799/9b72ab4b-d259-4e13-9049-c8f1ba85664d" width="500" alt="Web configurator screenshot" />

Enclosure

OnShape design, STEP files, and instructions for 3D printing.

See bitclock-enclosure/

<img src="https://github.com/goat-hill/bitclock/assets/220799/b83af06f-92e7-4f3a-9e44-477fad33d226" width="500" alt="Device CAD screenshot" />

PCB

KiCad schematic, board, and JLCPCB ordering files.

See bitclock-pcb/

<img src="https://github.com/user-attachments/assets/40ddb658-e42d-4617-83b4-a5637c75a250" width="500" alt="Bitclock PCB" />

Blog posts

• Advanced ESP32 development with ESP-IDF

Contributing

Cloning the repo

This repo uses git submodules. Make sure to use git clone --recursive.

git clone --recursive git@github.com:goat-hill/bitclock.git

If the repo was previously checked out without --recursive, initialize the submodules.

git submodule init
git submodule update

Pre-commit linting

A single pre-commit config is created for this monorepo. Set up the hooks to get linting on every commit.

brew install pre-commit
pre-commit install