Skip to content

docs: User Manual, Technician Guide and Site Acceptance Test - #11

Merged
agus-darmawan merged 8 commits into
mainfrom
docs/manuals
Nov 1, 2026
Merged

agus-darmawan merged 8 commits into
mainfrom
docs/manuals

Conversation

@agus-darmawan

Copy link
Copy Markdown
Member

What and why

Industrial handover needs documents an operator can follow on a phone during a shift, a technician can tune and maintain from, and a substation representative can sign. Same pipeline as Pashupati (Markdown + YAML front matter → A5 PDF with WeasyPrint, Barlow Semi Condensed, numbered chapters, contents, revision history):

  • User Manual (21 p., docs/HotDog-User-Manual.pdf) — for operators, no robotics needed:
    safety in the substation first (the utility's rules and safe approach distances, switching and maintenance, weather, what the robot does not see: holes, drops, objects under ~15 cm), emergency stops; the system at a glance; start of a shift with hotdog status explained line by line; teaching a route and targets per equipment type; patrols, schedule, pause/stop/return, what the watchdog does on its own; reading the reports, severities and what to do, the last round, Telegram alerts (findings are screening results: confirm on site); daily checklist; troubleshooting; quick card.
  • Technician Guide (32 p.) — configuration layers (package → robot profile → stack → /etc/hotdog/site.yaml → env file), the M20 driver calibration, profile and braking, odometry-only drift and re-anchoring, the Airy merge and the protective field (with its test), speed / stop point / inspection timeouts, the watchdog, the schedule, thermal pod and limits (NETA MTS defaults, regions in inspection.yaml), partial discharge set-up and severities, reports and alerts set-up, addresses and ports, service, time, a maintenance schedule (shift / weekly / monthly / quarterly / yearly), update, backup and restore, symptoms and fixes, and the parameter reference generated from every src/*/config/*.yaml.
  • Site Acceptance Test (12 p.) — pre-checks, safety functions (M20 e-stop, latched e-stop, protective field front/rear/sides, a LiDAR lost, operator return, low battery return, blocked return, no start on low battery, REMOTE never overruled), navigation repeatability, inspection against a reference, reports and alerts incl. offline spool, resilience (power cycle, service restart, missed report), handover items, sign-off.
  • Logo and diagrams (docs/pdf/diagrams.py: system, workflow, a patrol with the watchdog); the system diagram in the README; docs/README.md index.
  • CI docs job builds the PDFs and warns when a committed PDF is older than its sources; prettier stays off the guide sources (it would unindent the admonitions).
  • Small features the guides needed: hotdog aim <yaw> <pitch> [zoom] (point the pod while teaching, tested) and ROBOT_PARAMS in the env file (a robot's own profile).

How it was tested

  • pre-commit run on everything
  • python3 docs/pdf/build.py: 34 / 46 / 12 sections; pages checked visually (cover, contents, tables, admonitions, code blocks, diagrams)
  • Every package's unit + style tests (hotdog 34, base 12, inspection 49, patrol 24, reports 12, alerts 9), scripts/test 5, vermin Python 3.8
  • CI Foxy build — needs DHARMA_TOKEN

Checklist

  • Conventional commit titles
  • CHANGELOG entry
  • Safety-relevant: the safety chapter and the SAT describe the existing behaviour; review them with the substation's safety officer before the first handover

Generated by Claude Code

@agus-darmawan
agus-darmawan merged commit 82face5 into main Nov 1, 2026
3 of 4 checks passed
agus-darmawan added a commit that referenced this pull request Nov 1, 2026
docs: User Manual, Technician Guide and Site Acceptance Test
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant