README.md

bitclock

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

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

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/

Enclosure

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

See bitclock-enclosure/

PCB

KiCad schematic, board, and JLCPCB ordering files.

See 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 [email protected]: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