Skip to content

Commit d8f918a

Browse files
committed
Final review updates
Final review changes and adding GitHub pages build files.
1 parent eff25f9 commit d8f918a

File tree

9 files changed

+136
-20
lines changed

9 files changed

+136
-20
lines changed
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: Build Documentation
2+
3+
on:
4+
# Runs on pushes targeting the default branch
5+
push:
6+
branches: ["main"]
7+
8+
# Allows you to run this workflow manually from the Actions tab
9+
workflow_dispatch:
10+
11+
# Sets permissions of the GITHUB_TOKEN to allow files to be committed to gh-pages branch
12+
permissions:
13+
contents: write
14+
15+
16+
jobs:
17+
deploy:
18+
runs-on: ubuntu-latest
19+
20+
steps:
21+
- name: Checkout repository
22+
uses: actions/checkout@v4
23+
with:
24+
fetch-depth: 0
25+
26+
- name: Instal pgnquant for optimize plugin
27+
run: sudo apt-get install pngquant
28+
29+
- name: Set up Python runtime
30+
uses: actions/setup-python@v5
31+
with:
32+
python-version: 3.x
33+
34+
- name: Install Python dependencies
35+
run: pip install mkdocs-monorepo-plugin mkdocs-redirects mkdocs-git-authors-plugin mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2 Pillow 'mkdocs-material[imaging]'
36+
37+
- name: Set up build cache
38+
run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
39+
- uses: actions/cache@v4
40+
with:
41+
key: mkdocs-material-${{ env.cache_id }}
42+
path: .cache
43+
restore-keys: |
44+
mkdocs-material-
45+
46+
- name: Install Insiders build
47+
env:
48+
MKDOCS_TOKEN: ${{ secrets.MKDOCS_SECRET }}
49+
run: pip install git+https://${MKDOCS_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
50+
- run: mkdocs gh-deploy --clean
271 KB
Loading
-239 KB
Binary file not shown.

docs/camera_board.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@ Let's take a closer look at the Camera Board - HM0B10 and the hardware on it.
22

33
## Himax HM0B10 Camera Module (Color)
44

5-
The HM0B10 camera module from Himax<sup>&reg;</sup> has a 320 x 320 pixel resolution that supports frame rates of up to 51FPS in full resolution (320x320) and up to 60FPS in windowed/QVGA (320x240) operation. The camera module also has a 2x2 monochrome binning mode that supports up to 120FPS if you're looking to maximize frame rate over resolution and color. The HM01B0 also has a motion detect feature tied to an interrupt output so you can program it to wake up your camera project whenever it senses motion. The video data interface communicates over a configurable 1, 4 or 8bit interface that features both video frame for synchronizing multiple cameras and line sync for creating a composite image from two cameras. The HM01B0 operates over a I<sup>2</sup>C serial interface with an address of <b>0x24</b>. For complete information on the HM0B10, refer to the [datasheet]().
5+
The HM0B10 camera module from Himax<sup>&reg;</sup> has a 320 x 320 pixel resolution that supports frame rates of up to 51FPS in full resolution (320x320) and up to 60FPS in windowed/QVGA (320x240) operation. The camera module also has a 2x2 monochrome binning mode that supports up to 120FPS if you're looking to maximize frame rate over resolution and color. The HM01B0 also has a motion detect feature tied to an interrupt output so you can program it to wake up your camera project whenever it senses motion. The video data interface communicates over a configurable 1, 4 or 8bit interface that features both video frame for synchronizing multiple cameras and line sync for creating a composite image from two cameras. The HM01B0 operates over a I<sup>2</sup>C serial interface with an address of <b>0x24</b>. For complete information on the HM0B10, refer to the [datasheet](https://cdn.sparkfun.com/assets/7/f/c/8/3/HM01B0-MNA-Datasheet.pdf).
66

77
## Pinout
88

9-
The Camera Board breaks out all of the HM0B10's pins to three 9 pin, 0.1"-spaced plated through hole headers. The three headers are split into a single "top" header and a pair of "bottom" headers and we'll refer to them as "Top" and "Bottom" for the descriptions and tables below. Several pins are shared between the two sets. The Top header breaks out the minimum pins needed for basic use of the camera module and the Bottom header pair breaks out all the pins. This bottom pair connects directly to the 2x10 connector on the [SparkFun Pico Touch Display for XRP]().
9+
The Camera Board breaks out all of the HM0B10's pins to three 9 pin, 0.1"-spaced plated through hole headers. The three headers are split into a single "top" header and a pair of "bottom" headers and we'll refer to them as "Top" and "Bottom" for the descriptions and tables below. Several pins are shared between the two sets. The Top header breaks out the minimum pins needed for basic use of the camera module and the Bottom header pair breaks out all the pins. This bottom pair connects directly to the 2x10 connector on the Red Vision Touch Display.
1010

1111
The tables below outline the pin name, type and function of the pins broken out to each header:
1212

@@ -169,14 +169,14 @@ The sole LED on this board is a red Power LED to indicate whenever the board has
169169

170170
## Solder Jumpers
171171

172-
The Camera Board has six solder jumpers labeled: <b>OSC</b>, <b>GND</b>, <b>PAD</b>, <b>OSC_DIS</b>, <b>LED</b> and <b>I2C</b>. The lists below outlines each solder jumper's function, default state and any notes on their use.
172+
The Camera Board has six solder jumpers labeled: <b>OSC</b>, <b>GND</b>, <b>PAD</b>, <b>OSC_DIS</b>, <b>LED</b> and <b>I2C</b>. The lists below outlines each solder jumper's function, default state and any notes on their use. Note, manipulating these solder jumpers is only recommended for *advanced users* as they alter the functionality of the board, change the pins used by it and require knowledge of [working with jumper pads and PCB traces](https://learn.sparkfun.com/tutorials/how-to-work-with-jumper-pads-and-pcb-traces).
173173

174174
**Oscillator Jumpers:**
175175

176176
These solder jumpers all adjust which oscillator source connects to the camera's external clock (XCLK) pin or to use the camera's internal oscillator. The board defaults to run at 24MHz with an on board oscillator. Make sure to only connect XCLK to a **single** source at a time otherwise unexpected behavior or damage may occur.
177177

178178
* <b>OSC</b>: This solder jumper enables the on board 24MHz oscillator by connecting it to the HM01B0's XCLK pin. It is CLOSED by default. Sever the trace in between the solder jumpers to open the jumper and disable the 24MHz clock source.
179-
* <b>PAD</b>: This solder jumper connects the HM0B10's XCLK pin to the PTH pads on the board labeled <b>XC</b> so users can connect an external clock source of their choosing. The jumper is OPEN by default. Close the jumper to enable the <b>XC</b> pin. Make sure both the <b>OSC</b> and <b>GND</b> jumpers are OPEN when connecting a clock source to the <b>XC</b> pin.
179+
* <b>PAD</b>: This solder jumper connects the HM0B10's XCLK pin to the PTH pads on the board labeled <b>XC</b> so users can connect an external clock source. The jumper is OPEN by default. Close the jumper to enable the <b>XC</b> pin. Make sure both the <b>OSC</b> and <b>GND</b> jumpers are OPEN when connecting a clock source to the <b>XC</b> pin. **Note:** When connected to the Red Vision Touch Display, this signal connects to GPIO3 on the XRP Control Board (or Pico).
180180
* <b>GND</b>: This solder jumper pulls the HM0B10's XCLK pin to ground to enable the camera's internal 48MHz oscillator. It is OPEN by default. Close the jumper to enable the internal oscillator. Make sure both the <b>OSC</b> and <b>PAD</b> jumpers are OPEN before closing this jumper.
181181
* <b>OSC_DIS</b>: This solder jumper controls whether the 28MHz oscillator on the board is on or off. It is OPEN by default and enables the crystal. Close the jumper to disable the 28MHz oscillator.
182182

docs/firmware.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
The SparkFun Red Vision Kit for XRP requires updated firmware to run proplerly. This firmware updates the XRP Control Board with the right drivers to work with the Vision Kit and also includes all of the MicroPython OpenCV examples included in the package. In this section we'll go over where to find this firmware to download, how to upload it to your XRP Control Board and where to open the examples once you've assembled the Vision Kit onto your XRP Kit.
1+
The SparkFun Red Vision Kit for XRP requires updated firmware to run properly. This firmware updates the XRP Control Board with the right drivers to work with the Vision Kit and also includes all of the MicroPython OpenCV examples included in the package. In this section we'll go over where to find this firmware to download, how to upload it to your XRP Control Board and where to open the examples once you've assembled the Vision Kit onto your XRP Kit.
22

33
!!! Note
44
We recommend updating the firmware on the XRP Control Board prior to installing the Vision Kit boards onto it as the Touch Display makes it difficult to reach the RESET and BOOT buttons.

docs/quickstart.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,16 @@ Now that we've got the proper firmware installed and the Red Vision Kit connecte
4646
* Open the [XRP Code Editor](https://xrpcode.wpi.edu/) in a Chromium<sup>&trade;</sup>C based browser (Chrome, Edge, etc.)
4747
* If you have not already, set the main power switch on the XRP Control Board to "On". The XRP Code Editor has a pop-up for this as well if you try and run code without the board powered on fully.
4848
* Connect the XRP to the Code Editor. The window may open a pop-up asking to update the firmware. Click "Cancel" as updating the firmware will overwrite the MicroPython OpenCV firmware. A second pop-up may open asking to update libraries, click "Ok" to update the libraries. This will *not* affect the behavior or examples and is necessary to run other XRP examples.
49-
* Open the XRPExamples folder
50-
49+
* Open the folder named "red_vision_examples" and double click the file named "ex06_detect_sfe_logo.py" to open the code.
50+
* Next, click the green "RUN" button in the top-right of the XRP Code Editor window.
5151
* With the code running, we've printed out a black and white image with three objects on it; a star, the SparkFun flame and a heart. When holding it in front of the camera it should outline it and give information on the size and location of the logo. If you'd like to replicate this at home, just hold up your SparkFun red box or another SparkFun board point the logo on it at the camera. It should identify it; outline it and give information on the size and location of the logo similarly to the photo below:
5252

5353
<figure markdown>
5454
[![Photo showing the SparkFun logo detected and displayed on the Touch Screen display](./assets/img/Logo-Example-2.jpg){ width="600"}](./assets/img/Logo-Example-2.jpg "Click to enlarge")
55+
</figure>
56+
57+
This close-up photo offers a better view of what the Touch Screen Display shows when the SparkFun logo is detected in camera frame. You can see in the top left what contour the code is looking for, the bounding box and outline of the logo along with information on the position of the logo's center on the screen (green numbers) and the size of the bounding box (white numbers).
58+
59+
<figure markdown>
60+
[![Close up photo showing the SparkFun logo detected and outlined on the Touch Screen display](./assets/img/Logo-Example-1.jpg){ width="600"}](./assets/img/Logo-Example-1.jpg "Click to enlarge")
5561
</figure>

0 commit comments

Comments
 (0)