svc-gw/README.md

---
type: reference
---
# Telemetry gateway

Part of **Project Yukart**, making an old 2008 Mitsubishi Z27AG a bit smarter with modern technologies.  
This file serves as the minimalist portal to other docs


## What this repo is about

Runs on the Orin. The network-facing surface for external display clients:
aggregates and rate-limits bus traffic on their behalf, and fronts the navigation
HTTP API so a display has one address to talk to.

It is a bus subscriber. It never touches hardware and never transmits on CAN.

```bash
cargo run -- --mock                 # on a workstation: mock state, flagged as mock
scripts/deploy.sh                   # build, glibc check, install yukart-gw on the car Orin
```

Needs [contracts](gitea:yukart/contracts) checked out beside this repo.

- For implementation practice guidelines, refer to the [guidelines](docs/GUIDELINES.md);  
- For implementation plans and history, refer to [them](docs/impl/);