mikkeli
b55ccba268
What crosses between svc-gw and the app: hello, heartbeats both ways, state snapshots of envelopes with mock flagged per message, and commands carrying an idempotency key. TTS utterances are left for when a TTS exists. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01DDwfd6Ki8UfG4hK6W5YpJz
27 lines
1.1 KiB
Markdown
27 lines
1.1 KiB
Markdown
---
|
|
type: reference
|
|
---
|
|
# Contracts
|
|
|
|
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
|
|
|
|
The topic namespace, payload schemas and signal registry that every other repo
|
|
depends on. Rust services, Python tooling and the Dart client all read the same
|
|
definitions from here.
|
|
|
|
| File | Holds |
|
|
|---|---|
|
|
| [`schema/topics.json`](schema/topics.json) | Topic namespace: payload kind, retention, rate, publisher |
|
|
| [`schema/envelope.json`](schema/envelope.json) | JSON Schema for the decoded-signal envelope |
|
|
| [`schema/signals.json`](schema/signals.json) | Signal registry — the single source for name, unit, type and range |
|
|
| [`docs/BOUNDARY.md`](docs/BOUNDARY.md) | Display boundary protocol: what crosses between `svc-gw` and the app |
|
|
|
|
The Z27AG DBC lands here too, once Phase 2 produces one.
|
|
|
|
- For implementation practice guidelines, refer to the [guidelines](docs/GUIDELINES.md);
|
|
- For implementation plans and history, refer to [them](docs/impl/);
|