Skip to content

Commit

Permalink
New Doc - New POC items completed (#71)
Browse files Browse the repository at this point in the history
* docs: adding new doc foundational page.

* docs: first structure nav commit

* docs: proof of concept, using OneDrive to embed images.

* docs: remove asset diagram
  • Loading branch information
jeshernandez authored Mar 7, 2025
1 parent 61c7c8f commit f9a37e0
Show file tree
Hide file tree
Showing 9 changed files with 134 additions and 1 deletion.
9 changes: 9 additions & 0 deletions docs/3dprint/3dprint.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: 3D Print
layout: home
nav_order: 3
---

3D Parent page..

----
10 changes: 10 additions & 0 deletions docs/3dprint/3dprint_base_layer_piside_floor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: 3d Print Base Layer Pi Side Floor
layout: home
parent: 3D Print
nav_order: 3
---

3D Pi Side Floor.. search keyword 123

----
37 changes: 36 additions & 1 deletion docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,39 @@ theme: just-the-docs
url: https://just-the-docs.github.io

aux_links:
Hackaday: https://hackaday.io/project/195042-pitrac-the-diy-golf-launch-monitor
Doc Contribute: https://github.com/jamespilgrim/PiTrac/tree/main/docs

search_enabled: true

nav_enabled: true

heading_anchors: true

favicon_ico: "/assets/images/favicon.ico"

search.button: true
search:
# Split pages into sections that can be searched individually
# Supports 1 - 6, default: 2
heading_level: 6
# Maximum amount of previews per search result
# Default: 3
previews: 3
# Maximum amount of words to display before a matched word in the preview
# Default: 5
preview_words_before: 5
# Maximum amount of words to display after a matched word in the preview
# Default: 10
preview_words_after: 10
# Set the search token separator
# Default: /[\s\-/]+/
# Example: enable support for hyphenated search words
tokenizer_separator: /[\s/]+/
# Display the relative url in search results
# Supports true (default) or false
rel_url: true
# Enable or disable the search button that appears in the bottom right corner of every page
# Supports true or false (default)
button: false
# Focus the search input by pressing `ctrl + focus_shortcut_key` (or `cmd + focus_shortcut_key` on macOS)
focus_shortcut_key: 'k'
Binary file added docs/assets/images/favicon.ico
Binary file not shown.
10 changes: 10 additions & 0 deletions docs/camera/camera_calibration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Calibration
layout: home
parent: Cameras
nav_order: 2
---

Camera Parent page..

----
9 changes: 9 additions & 0 deletions docs/camera/cameras.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: Cameras
layout: home
nav_order: 2
---

Camera Parent page..

----
6 changes: 6 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
---
title: Home
layout: home
nav_order: 1
---

### PiTrac - The DIY Golf Launch Monitor

- As seen on [Hackaday](https://hackaday.io/project/195042-pitrac-the-diy-golf-launch-monitor)
- Also on [Reddit](https://www.reddit.com/r/Golfsimulator/comments/1hnwhx0/introducing_pitrac_the_open_source_launch_monitor/)

The PiTrac project is a fully-functional golf launch monitor that avoids the need for expensive high shutter-speed and high frame-rate cameras. We've developed techniques for high-speed, infrared, strobe-based image capture and processing using cameras such as the Pi Global Shutter camera (~US$50 retail) and Raspberry Pi single board computers.

PiTrac determines ball speed, launch angles, and spin in 3 axes. Its output is accessible on a stand-alone web app. Interfaces to popular golf-course simulators including GsPro and E6 are working. 2k/TopGolf never responded to our requests.
Expand Down
34 changes: 34 additions & 0 deletions docs/terminology.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: Terminology
layout: home
parent: Home
nav_order: 1.2
---

### Terminology

- Top Camera (Position Camera)
Bottom Camera (Flight Camera)

- Core Pi (aka Raspberry Pi 1, Top Pi) // Desc: Where pitrac_lm, Samba would run?
Messaging Pi (aka Raspberry Pi 2, Bottom Pi) // Desc: Where ActiveMQ and Tomee would run?

- Flight Camera - This is the modified camera that will be installed on the first floor of the enclosure.
- This camera is attached to Core Pi.
- Tee Camera - This is an unmodified camera that will be installed on the top floor of the enclosure.
- This camera is installed

- Tee Pi - This Raspberry Pi that is used for the shared directory--Samba Server. It is recommended that you use a faster Pi (e.g. Pi5) for this Pi. Installed on the top floor of the enclosure.
- Connected to the Tee off Camera (The top floor Camera)
- Flight Pi - used for messaging running ActiveMQ and Apache Tomee. Installed on the bottom floor of the enclosure.
- Connected to the Flight camera (the modified camera).

### PiTrac
<a href="https://1drv.ms/i/c/35c1f51c7fbc7aba/IQSr4Eu550wjRoRfLHclEgkAARA1St3Qvlx-dvPuE9Aupqc?width=1024">
<img src="https://1drv.ms/i/c/35c1f51c7fbc7aba/IQSr4Eu550wjRoRfLHclEgkAARA1St3Qvlx-dvPuE9Aupqc?width=1024" alt="PiTrac">
</a>

### Diagram
<a href="https://1drv.ms/i/c/35c1f51c7fbc7aba/IQRJJ03UsL98QbZK4ppRKmdsAQ_Gr50rl9IbFNyvEkk1Wyg?width=1030&height=894">
<img src="https://1drv.ms/i/c/35c1f51c7fbc7aba/IQRJJ03UsL98QbZK4ppRKmdsAQ_Gr50rl9IbFNyvEkk1Wyg?width=1030&height=894" alt="PiTrac Diagram">
</a>
20 changes: 20 additions & 0 deletions docs/thisdoc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: About this Document
layout: home
parent: Home
nav_order: 1.1
---

### About this Document

To contribute to this documentation, please visit [Github Pitrac](https://github.com/jamespilgrim/PiTrac)

To quickly test your documentation locally, please take the following steps:

- Become familiar with `just-the-docs` project [just-the-docs](https://github.com/just-the-docs/just-the-docs)

- Run locally, which is also documented in the above point: `bundle exec jekyll serve.` Of course I am simplifying as you need to install [bundler](https://bundler.io/guides/getting_started.html). You also need to install and configure [jekyll](https://jekyllrb.com/tutorials/using-jekyll-with-bundler/)

- View how this project inside `docs` is configured to get an understanding of the documentation pattern.

- Finally to deploy. Create your peer-review (PR) request. Github Action workflows will automatically deploy your changes once your PR is merged. This may take about 5-8 minutes to appear. Then simply refresh.

0 comments on commit f9a37e0

Please sign in to comment.