You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Adds a new Tools super-section between Host Protocol and Production
covering the desktop GUIs, external libraries, and calculators that
ship around the cam. Restructures Production -- battery moves into
Tools, romfs-image lands under Shipping the application, and the TLS
toctree is renamed to "Advanced material" so it can host other niche
tutorials. Expands the make-debug-shortcut paragraph in
firmware/debugging.rst into a proper gdbrunner section. Fixes three
display bugs from nested code-inside-bold markup.
Tools chapter
- New tools/index.rst with three captioned groups: Desktop GUIs
(IDE placeholder, Projects Tools), External libraries (openmv-py,
Arduino RPC), Calculators (battery-life-estimator).
- New tools/openmv-py/ covers the host-side openmv PyPI package end
to end: the included CLI viewer (cli.rst), a hello-cam page for
connecting and reading stdout, frame streaming (including the
raw-streaming JPEG-skip path), bidirectional custom channels, and
a new events page covering _handle_event subclassing,
poll_events(), and the cam-side send_event surface. Reference
page documents the full Camera class plus the OMVException
hierarchy; private channel-internals, retry decorator, and
subclassing hooks at the bottom for power users.
- New tools/arduino-rpc/index.rst -- sales-summary page for the
openmv-arduino-rpc library with a transports figure showing
UART / SPI / I2C / CAN between an Arduino and a cam.
- New tools/projects-tools/index.rst -- desktop GUI tools paired
with cam-side scripts (ISP tuner, thermal-overlay calibration,
Prophesee visualiser).
- battery-life.rst moved out of production/ into
tools/battery-life-estimator.rst.
- tools/ide/ is a placeholder for the IDE overview.
Production reorg
- Intro paragraph trimmed -- dropped "on battery" (now Tools) and
the "order is roughly the path of a product" framing paragraph.
- Section order is now Custom firmware builds -> Shipping the
application -> Advanced material.
- romfs-image.rst added under Shipping the application alongside
freezing-scripts.rst.
- TLS toctree caption renamed "Working with TLS certificates" ->
"Advanced material".
firmware/debugging.rst
- Old 11-line "make debug shortcut" paragraph replaced with a full
"Command-line debugging with gdbrunner" section that introduces
the gdbrunner Python package (pip install gdbrunner), shows how
it collapses the manual server+gdb dance into one foreground
process, and lists six features that help command-line users:
clean lifecycle, STM32CubeProgrammer auto-discovery, per-project
.gdbinit honoured, --dryrun, --show-output, and the QEMU backend.
Library index
- omv.protocol.rst moved from "Frozen Python helpers" to "Built
into the firmware on every OpenMV camera board" -- it is
registered via MP_REGISTER_EXTENSIBLE_MODULE in py_protocol.c,
not a frozen script.
Display fixes (nested code-inside-bold)
- formatting.rst: four format-flag bullets used **flag \`\`-\`\`**,
**flag \`\`0\`\`**, etc. -- RST can't nest code inside bold, so
the asterisks and backticks were rendering literally. Reworked
to one-word bold lead-ins (Left-align, Zero pad, Sign, Alternate
form) with the flag character in code form in the body.
- debugging.rst pitfalls: **Everything is \`\`<optimized out>\`\`**
had the same problem. Reworked to **Optimized-out variables.**
lead-in with <optimized out> in the description.
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
0 commit comments