Skip to content

Commit 23892b5

Browse files
kwagyemanclaude
andcommitted
docs: add OpenMV Viewer changelog and tutorial
Add OpenMV Viewer as a new product in the docs: - Changelog: viewer/ section starting at v5.0.0, registered on the changelog index with its own coral eye icon (new .changelog-product-card color in custom.css). - Tutorial: openmvcam/tutorial/tools/viewer/ chapter (connecting, running scripts, frame buffer, histogram, serial terminal, firmware, wrap-up), reusing the IDE figures for the shared panes plus one new main-window screenshot. - De-version the IDE connecting/frame-buffer tutorial pages so they no longer name a specific firmware version. - Translate all new and changed strings across 26 languages. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 0b94364 commit 23892b5

381 files changed

Lines changed: 30166 additions & 873 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/changelog/index.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ matters) exactly how to migrate.
1313

1414
OpenMV Firmware <firmware/index.rst>
1515
OpenMV IDE <ide/index.rst>
16+
OpenMV Viewer <viewer/index.rst>
1617
OpenMV Python Package <openmv-py/index.rst>
1718
OpenMV Arduino RPC Library <arduino-rpc/index.rst>
1819

@@ -35,6 +36,14 @@ matters) exactly how to migrate.
3536
tooling features, bug fixes, and platform support.</p>
3637
<span class="card-arrow">View releases →</span>
3738
</a>
39+
<a class="changelog-product-card icon-coral" href="viewer/index.html">
40+
<div class="card-icon"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round"><path d="M1 12s4-8 11-8 11 8 11 8-4 8-11 8-11-8-11-8z"/><circle cx="12" cy="12" r="3"/></svg></div>
41+
<h4>OpenMV Viewer</h4>
42+
<p>The read-only companion to OpenMV IDE for showing off a finished
43+
product. It streams a connected camera's frame buffer, terminal, and
44+
histogram and runs a script, with the development tools removed.</p>
45+
<span class="card-arrow">View releases →</span>
46+
</a>
3847
<a class="changelog-product-card icon-purple" href="openmv-py/index.html">
3948
<div class="card-icon"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round"><polyline points="4 17 10 11 4 5"/><line x1="12" y1="19" x2="20" y2="19"/></svg></div>
4049
<h4>OpenMV Python Package</h4>

docs/changelog/viewer/index.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
.. _changelog_viewer:
2+
3+
OpenMV Viewer Changelog
4+
=======================
5+
6+
OpenMV Viewer is the read-only companion to OpenMV IDE, built for showing off a
7+
finished product rather than developing one. Here's what's new in each release
8+
— feature changes, fixes, and platform support. Releases are grouped by major
9+
version, newest first. Click a version to expand its releases.
10+
11+
OpenMV Viewer shares its codebase and Qt Creator base with :doc:`OpenMV IDE
12+
<../ide/index>`; each release notes the Qt Creator base version it was built
13+
from. Only OpenMV's own changes are documented here.
14+
15+
.. toctree::
16+
:maxdepth: 2
17+
:hidden:
18+
19+
v5.rst
20+
21+
.. raw:: html
22+
23+
<details class="changelog-major" open>
24+
<summary>v5 <span class="count">(1 release)</span></summary>
25+
<ul class="changelog-versions">
26+
<li><a href="v5.0.0.html">v5.0.0</a></li>
27+
</ul>
28+
</details>

docs/changelog/viewer/v5.0.0.rst

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
.. _changelog_viewer_v5_0_0:
2+
3+
v5.0.0
4+
======
5+
6+
v5.0.0 is the first OpenMV Viewer release. OpenMV Viewer is a separate,
7+
read-only build of OpenMV IDE for showing off a finished product built on an
8+
OpenMV Cam: it streams the camera's live output and runs a script, but the
9+
development tools are removed, so a customer or an end user can see what a
10+
product does without the full development environment. It installs and runs
11+
independently of OpenMV IDE.
12+
13+
.. contents:: On this page
14+
:backlinks: none
15+
:local:
16+
:depth: 1
17+
18+
Highlights
19+
----------
20+
21+
- **A read-only telemetry viewer** — the frame buffer, serial terminal, and
22+
histogram work exactly as they do in OpenMV IDE, so you can watch what the
23+
camera captures and what its script prints live.
24+
- **Runs a product's script** — Run and Stop work and run a script from disk,
25+
and the running script can be stopped when the viewer connects or
26+
disconnects, so a device is always in a known state.
27+
- **Authoring tools removed** — the editor's development features, the machine
28+
vision authoring tools, the AI and model tools, and the developer settings
29+
are all stripped out, leaving a focused viewing application.
30+
- **Installs on its own** — the viewer is branded and installed as *OpenMV
31+
Viewer*, with its own application name, settings, and identity, so it
32+
coexists with a full OpenMV IDE installation.
33+
34+
What's included
35+
---------------
36+
37+
- **Live camera output** — the frame buffer viewer, the serial terminal, and
38+
the histogram, with the same controls as OpenMV IDE.
39+
- **Run / Stop and stop-on-connect** — run the product's script from disk, and
40+
halt it when the viewer attaches or detaches.
41+
- **File and Edit menus and Preferences** — kept so the viewer stays usable
42+
(open a file, adjust the interface), while the developer-only categories are
43+
hidden.
44+
- **Firmware update and recovery** — the firmware manager, bootloader recovery,
45+
and loading a ROM file system onto the camera are kept, so the viewer can
46+
still recover or re-provision a device in the field.
47+
- **Fiducial generators** — the AprilTag, DataMatrix, QR, and barcode
48+
generators are kept, since they are useful outside development too.
49+
50+
What's removed
51+
--------------
52+
53+
- The script-authoring editor features, the machine vision tuning tools
54+
(threshold editor, keypoints editor, and the like), the AI and model-training
55+
tools, the model zoo and dataset editor, and the developer settings
56+
categories. Firmware-upgrade and onboarding prompts are suppressed so a demo
57+
never interrupts to change the device.
58+
59+
Platform and tool support
60+
-------------------------
61+
62+
- **Qt Creator base:** 14.0.2 (shared with OpenMV IDE).
63+
- **Availability:** Windows, macOS, and Linux, installed separately from OpenMV
64+
IDE.
65+
66+
Breaking changes
67+
----------------
68+
69+
None — this is the first release.

docs/changelog/viewer/v5.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
.. _changelog_viewer_v5:
2+
3+
Changelog — v5
4+
==============================
5+
6+
Every OpenMV Viewer v5.x.x release brings new features and improvements.
7+
Here's what changed in each one. Releases are listed newest first; click a
8+
version to open its changelog.
9+
10+
.. toctree::
11+
:maxdepth: 1
12+
:hidden:
13+
14+
v5.0.0.rst
15+
16+
.. raw:: html
17+
18+
<details class="changelog-major" open>
19+
<summary>v5 <span class="count">(1 release)</span></summary>
20+
<ul class="changelog-versions">
21+
<li><a href="v5.0.0.html">v5.0.0</a></li>
22+
</ul>
23+
</details>

docs/locale/ar/LC_MESSAGES/changelog/index.po

Lines changed: 33 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ msgid ""
1010
msgstr ""
1111
"Project-Id-Version: OpenMV MicroPython 1.28\n"
1212
"Report-Msgid-Bugs-To: \n"
13-
"POT-Creation-Date: 2026-06-17 11:51-0700\n"
13+
"POT-Creation-Date: 2026-07-06 12:35-0700\n"
1414
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
1515
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
1616
"Language-Team: ar <LL@li.org>\n"
@@ -29,6 +29,10 @@ msgstr "OpenMV Firmware"
2929
msgid "OpenMV IDE"
3030
msgstr "OpenMV IDE"
3131

32+
#: ../../changelog/index.rst:10
33+
msgid "OpenMV Viewer"
34+
msgstr "OpenMV Viewer"
35+
3236
#: ../../changelog/index.rst:10
3337
msgid "OpenMV Python Package"
3438
msgstr "OpenMV Python Package"
@@ -50,7 +54,7 @@ msgstr ""
5054
"يحتفظ كل منتج من OpenMV بسجل إصداراته الخاص. اختر ما يهمك منها — يصف كل مدخل"
5155
" ما هو جديد، وما الذي تغيّر، و(حيثما كان مهماً) كيفية الترحيل بالضبط."
5256

53-
#: ../../changelog/index.rst:19
57+
#: ../../changelog/index.rst:20
5458
msgid ""
5559
"<div class=\"changelog-products\">\n"
5660
" <a class=\"changelog-product-card icon-green\" href=\"firmware/index.html\">\n"
@@ -69,6 +73,14 @@ msgid ""
6973
" tooling features, bug fixes, and platform support.</p>\n"
7074
" <span class=\"card-arrow\">View releases →</span>\n"
7175
" </a>\n"
76+
" <a class=\"changelog-product-card icon-coral\" href=\"viewer/index.html\">\n"
77+
" <div class=\"card-icon\"><svg viewBox=\"0 0 24 24\" fill=\"none\" stroke=\"currentColor\" stroke-width=\"2\" stroke-linecap=\"round\"><path d=\"M1 12s4-8 11-8 11 8 11 8-4 8-11 8-11-8-11-8z\"/><circle cx=\"12\" cy=\"12\" r=\"3\"/></svg></div>\n"
78+
" <h4>OpenMV Viewer</h4>\n"
79+
" <p>The read-only companion to OpenMV IDE for showing off a finished\n"
80+
" product. It streams a connected camera's frame buffer, terminal, and\n"
81+
" histogram and runs a script, with the development tools removed.</p>\n"
82+
" <span class=\"card-arrow\">View releases →</span>\n"
83+
" </a>\n"
7284
" <a class=\"changelog-product-card icon-purple\" href=\"openmv-py/index.html\">\n"
7385
" <div class=\"card-icon\"><svg viewBox=\"0 0 24 24\" fill=\"none\" stroke=\"currentColor\" stroke-width=\"2\" stroke-linecap=\"round\"><polyline points=\"4 17 10 11 4 5\"/><line x1=\"12\" y1=\"19\" x2=\"20\" y2=\"19\"/></svg></div>\n"
7486
" <h4>OpenMV Python Package</h4>\n"
@@ -91,25 +103,40 @@ msgstr ""
91103
" <a class=\"changelog-product-card icon-green\" href=\"firmware/index.html\">\n"
92104
" <div class=\"card-icon\"><svg viewBox=\"0 0 24 24\" fill=\"none\" stroke=\"currentColor\" stroke-width=\"2\" stroke-linecap=\"round\"><rect x=\"4\" y=\"4\" width=\"16\" height=\"16\" rx=\"2\"/><path d=\"M9 9h6v6H9z\"/><path d=\"M9 2v2M15 2v2M9 20v2M15 20v2M2 9h2M2 15h2M20 9h2M20 15h2\"/></svg></div>\n"
93105
" <h4>OpenMV Firmware</h4>\n"
94-
" <p>الكود القابل للتشغيل على الكاميرا OpenMV Cam الخاص بـ MicroPython للرؤية الآلية. ميزات كاميرا ومعالجة صور ودعم لوحات جديدة، بالإضافة إلى تغييرات API العاجلة وخطوات الترحيل للبرامج النصية.</p>\n"
106+
" <p>البرنامج الثابت للرؤية الآلية المبني على MicroPython والذي يعمل على OpenMV\n"
107+
" Cam. ميزات جديدة للكاميرا ومعالجة الصور ودعم اللوحات، إضافةً إلى\n"
108+
" تغييرات جذرية في واجهة البرمجة وخطوات ترحيل لنصوصك البرمجية.</p>\n"
95109
" <span class=\"card-arrow\">عرض الإصدارات →</span>\n"
96110
" </a>\n"
97111
" <a class=\"changelog-product-card icon-blue\" href=\"ide/index.html\">\n"
98112
" <div class=\"card-icon\"><svg viewBox=\"0 0 24 24\" fill=\"none\" stroke=\"currentColor\" stroke-width=\"2\" stroke-linecap=\"round\"><rect x=\"2\" y=\"3\" width=\"20\" height=\"14\" rx=\"2\"/><path d=\"M8 21h8M12 17v4\"/></svg></div>\n"
99113
" <h4>OpenMV IDE</h4>\n"
100-
" <p>بيئة التطوير المكتبية لكتابة البرامج النصية وتشغيلها وتصحيحها على الكاميرا OpenMV Cam. ميزات محرر وكاميرا وأدوات جديدة، وإصلاحات أخطاء ودعم المنصات.</p>\n"
114+
" <p>بيئة التطوير المكتبية لكتابة النصوص البرمجية وتشغيلها\n"
115+
" وتصحيحها على OpenMV Cam. ميزات جديدة للمحرر والكاميرا\n"
116+
" والأدوات، وإصلاحات للأخطاء، ودعم للمنصات.</p>\n"
117+
" <span class=\"card-arrow\">عرض الإصدارات →</span>\n"
118+
" </a>\n"
119+
" <a class=\"changelog-product-card icon-coral\" href=\"viewer/index.html\">\n"
120+
" <div class=\"card-icon\"><svg viewBox=\"0 0 24 24\" fill=\"none\" stroke=\"currentColor\" stroke-width=\"2\" stroke-linecap=\"round\"><path d=\"M1 12s4-8 11-8 11 8 11 8-4 8-11 8-11-8-11-8z\"/><circle cx=\"12\" cy=\"12\" r=\"3\"/></svg></div>\n"
121+
" <h4>OpenMV Viewer</h4>\n"
122+
" <p>الرفيق للقراءة فقط لـ OpenMV IDE لعرض منتج\n"
123+
" نهائي. يبث مخزن إطارات الكاميرا المتصلة وطرفيتها\n"
124+
" ومدرجها التكراري ويشغّل نصاً برمجياً، مع إزالة أدوات التطوير.</p>\n"
101125
" <span class=\"card-arrow\">عرض الإصدارات →</span>\n"
102126
" </a>\n"
103127
" <a class=\"changelog-product-card icon-purple\" href=\"openmv-py/index.html\">\n"
104128
" <div class=\"card-icon\"><svg viewBox=\"0 0 24 24\" fill=\"none\" stroke=\"currentColor\" stroke-width=\"2\" stroke-linecap=\"round\"><polyline points=\"4 17 10 11 4 5\"/><line x1=\"12\" y1=\"19\" x2=\"20\" y2=\"19\"/></svg></div>\n"
105129
" <h4>OpenMV Python Package</h4>\n"
106-
" <p>مكتبة Python من جانب المضيف وأداة سطر الأوامر <code>openmv</code> للتواصل مع الكاميرا OpenMV Cam من حاسوبك عبر بروتوكول الكاميرا V2 — البث والبرمجة النصية والقياس المعياري.</p>\n"
130+
" <p>مكتبة Python على جانب المضيف وأداة سطر الأوامر <code>openmv</code> للتواصل مع OpenMV Cam من حاسوبك عبر بروتوكول الكاميرا\n"
131+
" الإصدار الثاني (Camera Protocol V2) — البث والبرمجة النصية وقياس الأداء.</p>\n"
107132
" <span class=\"card-arrow\">عرض الإصدارات →</span>\n"
108133
" </a>\n"
109134
" <a class=\"changelog-product-card icon-amber\" href=\"arduino-rpc/index.html\">\n"
110135
" <div class=\"card-icon\"><svg viewBox=\"0 0 24 24\" fill=\"none\" stroke=\"currentColor\" stroke-width=\"2\" stroke-linecap=\"round\"><path d=\"M10 13a5 5 0 007.54.54l3-3a5 5 0 00-7.07-7.07l-1.72 1.71\"/><path d=\"M14 11a5 5 0 00-7.54-.54l-3 3a5 5 0 007.07 7.07l1.71-1.71\"/></svg></div>\n"
111136
" <h4>OpenMV Arduino RPC Library</h4>\n"
112-
" <p>مكتبة Arduino للتحكم في الكاميرا OpenMV Cam عبر CAN وI²C وSPI وUART وUSB. دعم لوحات جديد وواجهات حافلات وإصلاحات موثوقية.</p>\n"
137+
" <p>مكتبة Arduino للتحكم في OpenMV Cam عبر CAN وI²C\n"
138+
" وSPI وUART وUSB. دعم جديد للوحات، وواجهات ناقل،\n"
139+
" وإصلاحات للموثوقية.</p>\n"
113140
" <span class=\"card-arrow\">عرض الإصدارات →</span>\n"
114141
" </a>\n"
115142
"</div>"
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# SOME DESCRIPTIVE TITLE.
2+
# Copyright (C) The OpenMV MicroPython Documentation is Copyright ©
3+
# 2014-2026 by OpenMV, Damien P. George, and others.
4+
# This file is distributed under the same license as the OpenMV MicroPython
5+
# package.
6+
# FIRST AUTHOR <EMAIL@ADDRESS>, 2026.
7+
#
8+
#, fuzzy
9+
msgid ""
10+
msgstr ""
11+
"Project-Id-Version: OpenMV MicroPython 1.28\n"
12+
"Report-Msgid-Bugs-To: \n"
13+
"POT-Creation-Date: 2026-07-06 12:35-0700\n"
14+
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
15+
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
16+
"Language-Team: ar <LL@li.org>\n"
17+
"Language: ar\n"
18+
"MIME-Version: 1.0\n"
19+
"Content-Type: text/plain; charset=utf-8\n"
20+
"Content-Transfer-Encoding: 8bit\n"
21+
"Plural-Forms: nplurals=6; plural=(n==0 ? 0 : n==1 ? 1 : n==2 ? 2 : n%100>=3 && n%100<=10 ? 3 : n%100>=0 && n%100<=2 ? 4 : 5);\n"
22+
"Generated-By: Babel 2.17.0\n"
23+
24+
#: ../../changelog/viewer/index.rst:4
25+
msgid "OpenMV Viewer Changelog"
26+
msgstr "سجل تغييرات OpenMV Viewer"
27+
28+
#: ../../changelog/viewer/index.rst:6
29+
msgid ""
30+
"OpenMV Viewer is the read-only companion to OpenMV IDE, built for showing "
31+
"off a finished product rather than developing one. Here's what's new in each"
32+
" release — feature changes, fixes, and platform support. Releases are "
33+
"grouped by major version, newest first. Click a version to expand its "
34+
"releases."
35+
msgstr ""
36+
"OpenMV Viewer هو الرفيق للقراءة فقط لـ OpenMV IDE، مصمم لعرض منتج نهائي "
37+
"بدلاً من تطويره. إليك ما هو جديد في كل إصدار — تغييرات الميزات والإصلاحات "
38+
"ودعم المنصات. تُجمَّع الإصدارات حسب الإصدار الرئيسي، الأحدث أولاً. انقر على "
39+
"إصدار لتوسيع إصداراته."
40+
41+
#: ../../changelog/viewer/index.rst:11
42+
msgid ""
43+
"OpenMV Viewer shares its codebase and Qt Creator base with :doc:`OpenMV IDE "
44+
"<../ide/index>`; each release notes the Qt Creator base version it was built"
45+
" from. Only OpenMV's own changes are documented here."
46+
msgstr ""
47+
"يشترك OpenMV Viewer في قاعدة الشيفرة وأساس Qt Creator مع :doc:`OpenMV IDE "
48+
"<../ide/index>`؛ يذكر كل إصدار نسخة أساس Qt Creator التي بُني منها. لا "
49+
"يُوثَّق هنا سوى تغييرات OpenMV الخاصة."
50+
51+
#: ../../changelog/viewer/index.rst:21
52+
msgid ""
53+
"<details class=\"changelog-major\" open>\n"
54+
" <summary>v5 <span class=\"count\">(1 release)</span></summary>\n"
55+
" <ul class=\"changelog-versions\">\n"
56+
" <li><a href=\"v5.0.0.html\">v5.0.0</a></li>\n"
57+
" </ul>\n"
58+
"</details>"
59+
msgstr ""
60+
"<details class=\"changelog-major\" open>\n"
61+
" <summary>v5 <span class=\"count\">(إصدار واحد)</span></summary>\n"
62+
" <ul class=\"changelog-versions\">\n"
63+
" <li><a href=\"v5.0.0.html\">v5.0.0</a></li>\n"
64+
" </ul>\n"
65+
"</details>"

0 commit comments

Comments
 (0)