Skip to content

README: move the hardware caveat into a Status section #36

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

Merged
Castor-o7 merged 1 commit into from
Nov 3, 2026
Merged

README: move the hardware caveat into a Status section #36

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
23 changes: 16 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,6 @@ It's one Rust daemon, one PostgreSQL/PostGIS database and one Svelte app: a from
the carputer capstone, built from the stakeholder's original directive
([stakeholder.md](stakeholder.md)). Design: [DESIGN.md](DESIGN.md). Roadmap: [ROADMAP.md](ROADMAP.md).

> [!IMPORTANT]
> **CarChomp hasn't met a real GPS or radio yet.** Everything is developed and tested against
> `tools/sim.py`. GPS, RTL-SDR/Direwolf, chrony and Wi-Fi/hotspot are untested on hardware; a
> bundle upload to the update API has run once on a reTerminal, and the SD-card image build hasn't been run yet. Offline map regions have been
> downloaded and drawn on a development machine with the browser blocked from other hosts, but not
> yet with the network actually off.

## Layout

crates/carchomp-core pure logic: gpsd, SmartBeaconing, KISS, APRS (no I/O)
Expand Down Expand Up @@ -184,6 +177,22 @@ so they're opt-in, and CI always runs them. Some create their own `carchomp_test
DATABASE_URL=postgres://carchomp:carchomp@localhost:5433/carchomp \
cargo test -p carchompd -- --ignored

## Status

Built and tested end to end on simulated sensors: `tools/sim.py` stands in for the GPS and the
radio, and CI runs every test, including the ones against PostGIS. 11 of the 17 stories in
[ROADMAP.md](ROADMAP.md) are done. Of the real hardware, only the web update has been tried so far:
a bundle uploaded to a reTerminal installed and the daemon came back.

Next, on the reTerminal:

- GPS fixes from a real receiver, and the clock set from them through chrony.
- APRS from an RTL-SDR dongle through Direwolf.
- Wi-Fi, and the hotspot coming up when no known network is in range.
- Building the SD-card image and booting it into the kiosk.
- Offline maps with the network actually off. So far a region has been downloaded and drawn with
the browser blocked from other hosts, not with the network down.

## Install on a Pi

On Raspberry Pi OS or Debian (bookworm or newer), from a checkout or a
Expand Down