diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/POWER.md | 12 | ||||
| -rw-r--r-- | docs/README.md | 31 | ||||
| -rw-r--r-- | docs/USER-GUIDE.md | 53 | ||||
| -rw-r--r-- | docs/figures/c1224-board-overview.png | bin | 0 -> 273801 bytes | |||
| -rw-r--r-- | docs/figures/fig-01-pcb-standoffs.png | bin | 0 -> 230546 bytes | |||
| -rw-r--r-- | docs/figures/fig-02-power-section.png | bin | 0 -> 236580 bytes | |||
| -rw-r--r-- | docs/figures/fig-03-modem-crystal.png | bin | 0 -> 242963 bytes | |||
| -rw-r--r-- | docs/figures/fig-04-pico.png | bin | 0 -> 237069 bytes | |||
| -rw-r--r-- | docs/figures/fig-05-display.png | bin | 0 -> 235187 bytes | |||
| -rw-r--r-- | docs/figures/fig-06-leds.png | bin | 0 -> 225222 bytes | |||
| -rw-r--r-- | docs/figures/fig-07-connectors.png | bin | 0 -> 241270 bytes | |||
| -rw-r--r-- | docs/figures/fig-08-final-check.png | bin | 0 -> 243171 bytes |
12 files changed, 96 insertions, 0 deletions
diff --git a/docs/POWER.md b/docs/POWER.md new file mode 100644 index 0000000..78e2f54 --- /dev/null +++ b/docs/POWER.md @@ -0,0 +1,12 @@ +# Power — T-Modem-c1224 + +| Net / path | Role | +|------------|------| +| `VIN_12` | Barrel jack **5.5×2.1** centre-**positive** | +| `U_REG` | Buck **12 V → 5 V** (Mini560 5 V class / MP1584-class on headers) | +| `+5V` / `+5V_REG` | Board rail after buck (+ optional series PTC) | +| `GND` | Common ground | +| USB `VBUS` | **Isolated** — **DNI** OR diode · **no** feed into 5 V rail | +| USB D+/D− / GND | Flash + CDC command path to Pico · LCD service via Pico | + +Pico **VSYS/VBUS pin on headers** is fed from the **board 5 V rail**, not from the Type-A receptacle VBUS. diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..c12f425 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,31 @@ +# Docs — T-Modem-c1224 + +| Doc | Role | +|-----|------| +| [`USER-GUIDE.md`](USER-GUIDE.md) | Anyone — what it is · assemble · flash · terminals · SAVE | +| [`../hardware/BOM.md`](../hardware/BOM.md) | Planning BOM v0.26 (tracked) | +| [`POWER.md`](POWER.md) | 12 V primary · USB data-only | +| [`../firmware/c1224/README.md`](../firmware/c1224/README.md) | Pico service FW (C + Pico SDK) | +| [`figures/`](figures/) | Board overview + assembly steps 1–8 | + +## Operate (standalone) + +**No MAX25-Stack required.** Flash `c1224.uf2` → plug USB → open `/dev/ttyACM*` → KISS (`0xC0`) or ASCII `HELP`. Fixed boot banner prints once. **All matching terminals work** insofar as applicable. Optional: MAX25 device **`tmodem`** / max25-terminal. + +**INI `SAVE`:** last **4 KiB** of Pico flash as a config **blob** — not a filesystem. + +## Figures + +| File | Content | +|------|---------| +| [`figures/c1224-board-overview.png`](figures/c1224-board-overview.png) | Top-down board · major parts | +| [`figures/fig-01-pcb-standoffs.png`](figures/fig-01-pcb-standoffs.png) | Step 1 — PCB + standoffs | +| [`figures/fig-02-power-section.png`](figures/fig-02-power-section.png) | Step 2 — 12 V → buck → 5 V | +| [`figures/fig-03-modem-crystal.png`](figures/fig-03-modem-crystal.png) | Step 3 — socket · single crystal · Pierce | +| [`figures/fig-04-pico.png`](figures/fig-04-pico.png) | Step 4 — Pico H | +| [`figures/fig-05-display.png`](figures/fig-05-display.png) | Step 5 — I²C display | +| [`figures/fig-06-leds.png`](figures/fig-06-leds.png) | Step 6 — indicators | +| [`figures/fig-07-connectors.png`](figures/fig-07-connectors.png) | Step 7 — AF/PTT · USB | +| [`figures/fig-08-final-check.png`](figures/fig-08-final-check.png) | Step 8 — final check | + +**AS-IS** · GPLv3 · non-profit. diff --git a/docs/USER-GUIDE.md b/docs/USER-GUIDE.md new file mode 100644 index 0000000..8b08a48 --- /dev/null +++ b/docs/USER-GUIDE.md @@ -0,0 +1,53 @@ +# T-Modem-c1224 — user guide + +**Audience:** anyone · **Version:** v1.0-prototype · **AS-IS** · GPLv3 · non-profit + +Classic **chip** AFSK modem (TCM3105-class) + Pico as USB **KISS** half-TNC. Power **12 V**; USB = flash + KISS + ASCII service only. + +## What you need + +- Assembled board (one crystal: **Y1 4.4336** → 1200 or **Y2 6.5536** → 2400) +- **12 V** centre-positive supply +- USB host + **any** serial/KISS terminal that speaks the CDC interface below + +## Assemble · flash (overview) + +Figures: [`figures/`](figures/) — steps 1–8 (do not edit PNGs for text-only doc updates). + +1. Power path on board · **no** USB VBUS power. +2. Stuff **one** crystal + both Pierce load caps · insert TCM3105. +3. Flash **`c1224.uf2`** (BOOTSEL) · match `-DC1224_BITRATE` to crystal. +4. Apply **12 V** · plug USB for CDC. + +Build: [`../firmware/c1224/README.md`](../firmware/c1224/README.md). + +## Terminals (all that match) + +USB CDC ACM · raw **8N1**: + +| Path | Use | +|------|-----| +| **KISS** `0xC0` … `0xC0` | Packet (half-TNC) | +| ASCII lines when not mid-frame | `HELP` · `STATUS` · `PTT` · `ID` · INI | + +**All terminals should work insofar as applicable** — serial apps for service ASCII; KISS tools (kissattach, kissutil, Dire Wolf serial, custom, optional max25-terminal) for packet. + +Open `/dev/ttyACM*` → fixed boot banner once → KISS or `HELP`. + +## CDC commands + +`HELP` · `STATUS` · `ID` · `PTT ON`/`OFF` · `QUIET`/`VERBOSE` · `INI`/`GET`/`SET`/`SAVE`/`RELOAD`/`DEFAULTS` + +## INI · SAVE + +`SET key=value` then **`SAVE`**. Persist storage = **last 4 KiB of Pico flash** as a **config blob** — **not** a filesystem. Example: [`../share/c1224.ini.example`](../share/c1224.ini.example). + +## Optional stacks + +Standalone is enough. MAX25 (`tmodem`) is optional. HyBBX is not built into this product. + +## Power + +See [`POWER.md`](POWER.md). + +**AS-IS** · no warranty · no support · standard reference only. diff --git a/docs/figures/c1224-board-overview.png b/docs/figures/c1224-board-overview.png Binary files differnew file mode 100644 index 0000000..0bde70c --- /dev/null +++ b/docs/figures/c1224-board-overview.png diff --git a/docs/figures/fig-01-pcb-standoffs.png b/docs/figures/fig-01-pcb-standoffs.png Binary files differnew file mode 100644 index 0000000..e3fe3b5 --- /dev/null +++ b/docs/figures/fig-01-pcb-standoffs.png diff --git a/docs/figures/fig-02-power-section.png b/docs/figures/fig-02-power-section.png Binary files differnew file mode 100644 index 0000000..f681b4b --- /dev/null +++ b/docs/figures/fig-02-power-section.png diff --git a/docs/figures/fig-03-modem-crystal.png b/docs/figures/fig-03-modem-crystal.png Binary files differnew file mode 100644 index 0000000..f1abb3a --- /dev/null +++ b/docs/figures/fig-03-modem-crystal.png diff --git a/docs/figures/fig-04-pico.png b/docs/figures/fig-04-pico.png Binary files differnew file mode 100644 index 0000000..4bca313 --- /dev/null +++ b/docs/figures/fig-04-pico.png diff --git a/docs/figures/fig-05-display.png b/docs/figures/fig-05-display.png Binary files differnew file mode 100644 index 0000000..beeb6ee --- /dev/null +++ b/docs/figures/fig-05-display.png diff --git a/docs/figures/fig-06-leds.png b/docs/figures/fig-06-leds.png Binary files differnew file mode 100644 index 0000000..668fd95 --- /dev/null +++ b/docs/figures/fig-06-leds.png diff --git a/docs/figures/fig-07-connectors.png b/docs/figures/fig-07-connectors.png Binary files differnew file mode 100644 index 0000000..b0b7fec --- /dev/null +++ b/docs/figures/fig-07-connectors.png diff --git a/docs/figures/fig-08-final-check.png b/docs/figures/fig-08-final-check.png Binary files differnew file mode 100644 index 0000000..c1aba6d --- /dev/null +++ b/docs/figures/fig-08-final-check.png |
