Skip to content

Commit 476fac5

Browse files
kwagyemanclaude
kwagyeman
and
claude
committed
docs: add quick start chapter, framed media, and two product changelogs
Quick start (new tutorial chapter 1): - New quickstart.rst -- install the IDE, connect and flash firmware, run an inline BlazeFace example, then home-page-style next-steps cards (three experience-based tutorial on-ramps + board/library references + the IDE chapter). Replaces the decade-old overview/software_setup/hardware_setup pages, which are deleted. The home-page hero button and the 1/2/3 step cards now deep-link to the quickstart and its sections. Framed media: - A 1px themed rounded border (.framed / .framed-embed) on every raster screenshot, photo, and embedded video in the tutorial; SVG diagrams left unframed. Covers the IDE main-window GIF, the quickstart camera photo (now full width), the IDE and Roboflow screenshots, and the Roboflow / Edge Impulse videos. Changelogs: - New OpenMV Python Package (5 releases) and OpenMV Arduino RPC Library (11 releases) changelogs, structured like the firmware/IDE ones, with two new product cards on the changelog landing (purple/amber card tints added). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent b5de2fa commit 476fac5

43 files changed

Lines changed: 732 additions & 371 deletions

Some content is hidden

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

‎docs/changelog/arduino-rpc/index.rst‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
.. _changelog_arduino_rpc:
2+
3+
OpenMV Arduino RPC Library Changelog
4+
====================================
5+
6+
The OpenMV Arduino RPC library lets an Arduino control an OpenMV Cam — and
7+
stream data from it — over CAN, I²C, SPI, UART (async serial), and USB. It is
8+
robust and fault tolerant, recovering automatically from loose wires, packet
9+
corruption, and timeouts. Here's what changed in each release — newest first.
10+
11+
.. toctree::
12+
:maxdepth: 1
13+
:hidden:
14+
15+
v1.1.1.rst
16+
v1.1.0.rst
17+
v1.0.9.rst
18+
v1.0.8.rst
19+
v1.0.7.rst
20+
v1.0.6.rst
21+
v1.0.5.rst
22+
v1.0.3.rst
23+
v1.0.2.rst
24+
v1.0.1.rst
25+
v1.0.0.rst
26+
27+
.. raw:: html
28+
29+
<details class="changelog-major" open>
30+
<summary>v1 <span class="count">(11 releases)</span></summary>
31+
<ul class="changelog-versions">
32+
<li><a href="v1.1.1.html">v1.1.1</a></li>
33+
<li><a href="v1.1.0.html">v1.1.0</a></li>
34+
<li><a href="v1.0.9.html">v1.0.9</a></li>
35+
<li><a href="v1.0.8.html">v1.0.8</a></li>
36+
<li><a href="v1.0.7.html">v1.0.7</a></li>
37+
<li><a href="v1.0.6.html">v1.0.6</a></li>
38+
<li><a href="v1.0.5.html">v1.0.5</a></li>
39+
<li><a href="v1.0.3.html">v1.0.3</a></li>
40+
<li><a href="v1.0.2.html">v1.0.2</a></li>
41+
<li><a href="v1.0.1.html">v1.0.1</a></li>
42+
<li><a href="v1.0.0.html">v1.0.0</a></li>
43+
</ul>
44+
</details>

‎docs/changelog/arduino-rpc/v1.0.0.rst‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
.. _changelog_arduino_rpc_v1_0_0:
2+
3+
v1.0.0
4+
======
5+
6+
v1.0.0 is the **initial release of the OpenMV Arduino RPC library** — an
7+
Arduino library for controlling an OpenMV Cam (or another Arduino, or a
8+
computer) and streaming data from it over CAN, I²C, SPI, UART (async serial),
9+
and USB. As the first release there is nothing to migrate from; this entry
10+
summarizes what it shipped with.
11+
12+
.. contents:: On this page
13+
:backlinks: none
14+
:local:
15+
:depth: 1
16+
17+
Highlights
18+
----------
19+
20+
- **Remote procedure calls over any bus** — call functions on an OpenMV Cam
21+
from an Arduino over CAN, I²C, SPI, UART, or USB, and stream the results
22+
back.
23+
- **Controller and peripheral roles** — an Arduino can drive a camera as the
24+
controller device, or act as a peripheral that a camera or host calls into.
25+
- **Fault tolerant** — recovers automatically from loose wires, packet
26+
corruption, and timeouts.
27+
- **Data streaming** — a streaming mode for moving large payloads such as JPEG
28+
frames.
29+
30+
New features
31+
------------
32+
33+
- The RPC interface implemented across CAN, I²C, SPI, UART (async serial), and
34+
USB transports, with a common controller / peripheral API under the
35+
``openmv`` namespace.
36+
- A streaming mode for high-throughput transfers such as image transfer.
37+
- Example sketches — popular features as the controller device, JPEG image
38+
transfer, and moving an image.
39+
- Linux / Raspberry Pi support.
40+
41+
Breaking API changes
42+
--------------------
43+
44+
None. v1.0.0 is the initial release — there is no prior version to break
45+
compatibility with.

‎docs/changelog/arduino-rpc/v1.0.1.rst‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
.. _changelog_arduino_rpc_v1_0_1:
2+
3+
v1.0.1
4+
======
5+
6+
v1.0.1 is a compatibility fix.
7+
8+
Bug fixes
9+
---------
10+
11+
- Fixed the Arduino ``Serial`` port defines so the library builds correctly
12+
across Arduino cores.
13+
14+
Breaking API changes
15+
--------------------
16+
17+
None.

‎docs/changelog/arduino-rpc/v1.0.2.rst‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
.. _changelog_arduino_rpc_v1_0_2:
2+
3+
v1.0.2
4+
======
5+
6+
v1.0.2 is a compatibility fix.
7+
8+
Bug fixes
9+
---------
10+
11+
- Fixed compile errors on ESP32 and ESP8266.
12+
13+
Breaking API changes
14+
--------------------
15+
16+
None.

‎docs/changelog/arduino-rpc/v1.0.3.rst‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
.. _changelog_arduino_rpc_v1_0_3:
2+
3+
v1.0.3
4+
======
5+
6+
v1.0.3 is a compatibility fix.
7+
8+
Bug fixes
9+
---------
10+
11+
- Fixed compile errors on the Arduino Nano 33 BLE.
12+
13+
Breaking API changes
14+
--------------------
15+
16+
None.

‎docs/changelog/arduino-rpc/v1.0.5.rst‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
.. _changelog_arduino_rpc_v1_0_5:
2+
3+
v1.0.5
4+
======
5+
6+
v1.0.5 is a compatibility fix. There was no v1.0.4 release.
7+
8+
Bug fixes
9+
---------
10+
11+
- Fixed a permissive-mode compile issue so the library builds under stricter
12+
compiler settings.
13+
14+
Breaking API changes
15+
--------------------
16+
17+
None.

‎docs/changelog/arduino-rpc/v1.0.6.rst‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
.. _changelog_arduino_rpc_v1_0_6:
2+
3+
v1.0.6
4+
======
5+
6+
v1.0.6 adds board support.
7+
8+
New features
9+
------------
10+
11+
- Added serial-port 4–7 support for the Teensy 4.0 and Teensy 4.1.
12+
13+
Breaking API changes
14+
--------------------
15+
16+
None.

‎docs/changelog/arduino-rpc/v1.0.7.rst‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
.. _changelog_arduino_rpc_v1_0_7:
2+
3+
v1.0.7
4+
======
5+
6+
v1.0.7 adds board and bus support.
7+
8+
New features
9+
------------
10+
11+
- Added support for Arm Mbed-based Arduino boards.
12+
- Added support for multiple I²C controller interfaces.
13+
14+
Bug fixes
15+
---------
16+
17+
- Set the I²C ``onRequest`` / ``onReceive`` handlers after ``Wire.begin()`` so
18+
peripheral-mode callbacks register correctly.
19+
20+
Breaking API changes
21+
--------------------
22+
23+
None.

‎docs/changelog/arduino-rpc/v1.0.8.rst‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
.. _changelog_arduino_rpc_v1_0_8:
2+
3+
v1.0.8
4+
======
5+
6+
v1.0.8 is an Arduino Library Manager fix.
7+
8+
Bug fixes
9+
---------
10+
11+
- Removed unavailable entries from the library's ``depends`` field so it
12+
installs cleanly through the Arduino Library Manager.
13+
14+
Breaking API changes
15+
--------------------
16+
17+
None.

‎docs/changelog/arduino-rpc/v1.0.9.rst‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.. _changelog_arduino_rpc_v1_0_9:
2+
3+
v1.0.9
4+
======
5+
6+
v1.0.9 updates the library metadata (``library.properties``); there are no
7+
functional changes.
8+
9+
Breaking API changes
10+
--------------------
11+
12+
None.

0 commit comments

Comments
 (0)