Skip to content

Commit

Permalink
Add MWE of hardware documentation (#17)
Browse files Browse the repository at this point in the history
* MWE of feeder assembly doc

* Add tab and carousel samples

* Disable auto-cycle in carousel

* Move carousel controls to the top

* Rearrange References section order

* Add step-by-step images

* Use dropdown in assembly guide

* Add carousel in tab option

* Use `list-table` to list hardware

* Show step-by-step hardware assembly

* Set local toc level to 3

* Remove unused dependency

* Rename assembly instructions dropdown title

* Remove carousel conf

* Add inline attrs
  • Loading branch information
lochhh authored Apr 17, 2024
1 parent 48cbb94 commit 1729375
Show file tree
Hide file tree
Showing 13 changed files with 76 additions and 0 deletions.
Binary file added src/_static/images/feeder-ir-sensor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/_static/images/feeder-ir-sensor1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/_static/images/feeder-ir-sensor2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/_static/images/feeder-main.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/_static/images/feeder-parts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/_static/images/feeder-pellet-hopper.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/_static/images/feeder-pellet-hopper1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/_static/images/feeder-pellet-hopper2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/_static/images/feeder.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions src/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ def get_current_release_tag():
"colon_fence",
"linkify",
"deflist",
"attrs_inline",
]

# Automatically add anchors to markdown headings
Expand Down Expand Up @@ -121,6 +122,7 @@ def get_current_release_tag():
"type": "fontawesome",
}
],
"show_toc_level": 3, # Show the first 3 levels of the local TOC
}
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
Expand Down
24 changes: 24 additions & 0 deletions src/reference/hardware.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
(target-hardware)=
# Hardware Overview

This section describes the hardware components available in Project Aeon.

:::{list-table}
:header-rows: 1
:name: hardware-table

* - Name
- Description
- Unit Cost
* - [Feeder](target-feeder)
- An underground feeder...
- 3.00
* - aa
- bb...
- 3.00
:::

:::{toctree}
:maxdepth: 1
:hidden:
hardware/feeder
49 changes: 49 additions & 0 deletions src/reference/hardware/feeder.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
(target-feeder)=
# Feeder
![Feeder](../../_static/images/feeder.png){align=center}
Insert description of the feeder.

## Parts List
![Parts1](../../_static/images/feeder-main.png)
![Parts2](../../_static/images/feeder-parts.png)

## Assembly Guide
### Pellet Hopper
::::{dropdown} Steps 1-5
:::{figure} ../../_static/images/feeder-pellet-hopper1.png
:alt: step1
1\. Trim slightly the motor metal pin using a grinding wheel or a handheld Dremel. Trim until you create a flat surface on the pin.
:::
:::{figure} ../../_static/images/feeder-pellet-hopper2.png
:alt: step2
2\. Rotate the feeder base and insert the motor. Screw the motor in place from the front using three screws (ID 2).
:::
:::{figure} ../../_static/images/feeder-pellet-hopper1.png
:alt: step3
3\. Carefully handle the track and gently insert it in the feeder making sure of aligning the holes. Rotate the feeder base and hold the track in place by using six screws (ID 5).
:::
:::{figure} ../../_static/images/feeder-pellet-hopper1.png
:alt: step4
4\. Lower the disk into the feeder base making sure to orient the grub screw tapped hole toward the flat surface previously created on the motor metal pin (see step 1). Push down the disk until the top of the pin is flushed to the disk itself and use a grub screw (ID 10) to hold the disk in place. Make sure the grub screw touches the flat surface of the trimmed motor pin.
:::
:::{figure} ../../_static/images/feeder-pellet-hopper1.png
:alt: step5
5\. Insert two short silicon tubes in each pellet stopper pin and screw it in place with two screws (ID 4).
:::
::::

### IR Sensor
::::{dropdown} Steps 6-8
:::{figure} ../../_static/images/feeder-ir-sensor1.png
:alt: step6
6\. Place the wheel frame on the feeder base with 4 screws (ID 4).
:::
:::{figure} ../../_static/images/feeder-ir-sensor2.png
:alt: step7
7\. Carefully insert the beam break PCB board into the beam break holder (ID 12).
:::
:::{figure} ../../_static/images/feeder-ir-sensor1.png
:alt: step8
8\. Slot the beam break holder in the back of the feeder base and screw it in place from the front (ID 1).
:::
::::
1 change: 1 addition & 0 deletions src/reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ This reference manual details all software and hardware components, and a glossa
:::{toctree}
:maxdepth: 2

hardware
api
data_contract
glossary

0 comments on commit 1729375

Please sign in to comment.