From 1dd420ab103f3f9a5b5febd80466c814ae03c6e0 Mon Sep 17 00:00:00 2001 From: Gustavo <83519205+gustavo-alberto@users.noreply.github.com> Date: Wed, 15 Oct 2025 18:49:23 -0300 Subject: [PATCH] refactor(docs): restructure BOM folder and use relative image paths --- README.md | 2 +- BOM.md => documentation/bom/bom.md | 24 +++++++++--------- .../bom/images}/BallJointMount.png | Bin .../bom/images/BaseBlock.png | Bin .../bom/images/BrassPipe.png | Bin .../bom/images/DC_DC-StepDown.png | Bin .../bom/images}/EndEffector.png | Bin .../bom/images/MT6835.png | Bin .../bom/images}/MotorMount.png | Bin .../bom/images/PU_StretchCord.png | Bin .../bom/images/RaspberryPiPico2.png | Bin .../bom/images}/RubberBandCollet.png | Bin .../bom/images/TB6612FNG.png | Bin .../bom/images}/WireFlexureMount.png | Bin 14 files changed, 13 insertions(+), 13 deletions(-) rename BOM.md => documentation/bom/bom.md (70%) rename {images/BOM => documentation/bom/images}/BallJointMount.png (100%) rename images/BOM/baseblock.png => documentation/bom/images/BaseBlock.png (100%) rename images/BOM/brass-pipe.png => documentation/bom/images/BrassPipe.png (100%) rename images/BOM/DC-DC-step-down.png => documentation/bom/images/DC_DC-StepDown.png (100%) rename {images/BOM => documentation/bom/images}/EndEffector.png (100%) rename images/BOM/MT6835-magnetic-encoder-module.png => documentation/bom/images/MT6835.png (100%) rename {images/BOM => documentation/bom/images}/MotorMount.png (100%) rename images/BOM/PU-stretch-cord.png => documentation/bom/images/PU_StretchCord.png (100%) rename images/BOM/RaspberryPi-Pico-2.png => documentation/bom/images/RaspberryPiPico2.png (100%) rename {images/BOM => documentation/bom/images}/RubberBandCollet.png (100%) rename images/BOM/TB6612FNG-driver.png => documentation/bom/images/TB6612FNG.png (100%) rename {images/BOM => documentation/bom/images}/WireFlexureMount.png (100%) diff --git a/README.md b/README.md index 6864ce3..9718135 100644 --- a/README.md +++ b/README.md @@ -126,7 +126,7 @@ For usual winding resistance of your motors, the device should be powered by $${ ## ⚙ Bill of Materials (BOM) -See the full [BOM here](BOM.md). +See the full [BOM here](documentation/bom/bom.md). ## ⚙ Firmware diff --git a/BOM.md b/documentation/bom/bom.md similarity index 70% rename from BOM.md rename to documentation/bom/bom.md index f6ee9ae..dbf7c78 100644 --- a/BOM.md +++ b/documentation/bom/bom.md @@ -4,20 +4,20 @@ | Name | Qty | Description | Comments | Suggested link | Image | |------|-----|-------------|----------|----------------|-------| | Steel ball | 12 | Ø1.25 mm (0.05") | Precision G10 or better. Can be sourced from small ball bearings | | -| PU stretch cord | 1 m | Ø1mm | e.g. "Stretch Magic" or "Magic String" | [Aliexpress](https://www.aliexpress.us/item/3256805953910514.html)| ![Pu strech cord](images/BOM/PU-stretch-cord.png)| +| PU stretch cord | 1 m | Ø1mm | e.g. "Stretch Magic" or "Magic String" | [Aliexpress](https://www.aliexpress.us/item/3256805953910514.html)| ![Pu strech cord](images/PU_StretchCord.png)| | Neodym Cylinder Magnet | 70 | Ø3mm h=4 mm | N42 Grade | [Ebay Link](https://www.ebay.de/itm/365333642187?var=635110190027)| -| Brass Pipe | 1 m | OD=Ø2mm ID=Ø1 mm | | [Amazon](https://a.co/d/1pRFmtf)| ![Brass Pipe](images/BOM/brass-pipe.png)| +| Brass Pipe | 1 m | OD=Ø2mm ID=Ø1 mm | | [Amazon](https://a.co/d/1pRFmtf)| ![Brass Pipe](images/BrassPipe.png)| | M2 Screw | 12 | M2×12 mm, Countersunk | | | | M3 Grub Screw | 6 | M3×4 | | | ## Electronics | Name | Qty | Description | Comments | Suggested link | Image | |------|-----|-------------|----------|----------------|-------| -| DC-DC Step Down Module | 1 | 4.75–23 V Step-Down Buck Converter | | [Aliexpress](https://www.aliexpress.us/item/3256806752772875.html)| ![DC-DC Step Down](images/BOM/DC-DC-step-down.png)| +| DC-DC Step Down Module | 1 | 4.75–23 V Step-Down Buck Converter | | [Aliexpress](https://www.aliexpress.us/item/3256806752772875.html)| ![DC-DC Step Down](images/DC_DC-StepDown.png)| | (1N5819) OR (PMEG4010) | 1 | Diode (through-hole or SMD) | | | -| Raspberry Pi Pico 2 | 1 | Microcontroller board | | | ![Raspberry Pi Pico 2](images/BOM/RaspberryPi-Pico-2.png)| -| MT6835 Magnetic Encoder Module | 3 | Magnetic encoder | | [Aliexpress](https://www.aliexpress.us/item/3256808005140674.html)| ![MT6835 Magnetic Encoder Module](images/BOM/MT6835-magnetic-encoder-module.png)| -| TB6612FNG Driver | 3 | | | [Aliexpress](https://www.aliexpress.us/item/3256806060073976.html)| ![TB6612FNG Driver](images/BOM/TB6612FNG-driver.png)| +| Raspberry Pi Pico 2 | 1 | Microcontroller board | | | ![Raspberry Pi Pico 2](images/RaspberryPiPico2.png)| +| MT6835 Magnetic Encoder Module | 3 | Magnetic encoder | | [Aliexpress](https://www.aliexpress.us/item/3256808005140674.html)| ![MT6835 Magnetic Encoder Module](images/MT6835.png)| +| TB6612FNG Driver | 3 | | | [Aliexpress](https://www.aliexpress.us/item/3256806060073976.html)| ![TB6612FNG Driver](images/TB6612FNG.png)| | 470 µF Electrolytic Capacitor | 3 | > 100 µF | anything > 100µF will work well | | | 10 µF Ceramic Capacitor 0603 | 3 | Optional | | | | 4.7 k Resistor 0603 | 2 | Optional | | | @@ -29,9 +29,9 @@ ## 3D Printing | Name | Qty | Description | Comments | Image | |------|-----|-------------|----------|-------| -| WireFlexureMount | 3 | | 0.4 mm+ nozzle may require post-processing | ![Wire Flexure Mount](images/BOM/WireFlexureMount.png)| -| RubberBandCollet | 3 | | 0.4 mm+ nozzle may require post-processing | ![Rubber Band Collet](images/BOM/RubberBandCollet.png)| -| BallJointMount | 3 | | 0.4 mm+ nozzle may require post-processing | ![Ball Joint Mount](images/BOM/BallJointMount.png)| -| Motor Mount | 3 | | | ![Motor Mount](images/BOM/MotorMount.png)| -| End Effector | 1 | | | ![End Effector](images/BOM/EndEffector.png)| -| Base Block | 1 | | | ![Base Block](images/BOM/baseblock.png)| +| WireFlexureMount | 3 | | 0.4 mm+ nozzle may require post-processing | ![Wire Flexure Mount](images/WireFlexureMount.png)| +| RubberBandCollet | 3 | | 0.4 mm+ nozzle may require post-processing | ![Rubber Band Collet](images/RubberBandCollet.png)| +| BallJointMount | 3 | | 0.4 mm+ nozzle may require post-processing | ![Ball Joint Mount](images/BallJointMount.png)| +| Motor Mount | 3 | | | ![Motor Mount](images/MotorMount.png)| +| End Effector | 1 | | | ![End Effector](images/EndEffector.png)| +| Base Block | 1 | | | ![Base Block](images/BaseBlock.png)| diff --git a/images/BOM/BallJointMount.png b/documentation/bom/images/BallJointMount.png similarity index 100% rename from images/BOM/BallJointMount.png rename to documentation/bom/images/BallJointMount.png diff --git a/images/BOM/baseblock.png b/documentation/bom/images/BaseBlock.png similarity index 100% rename from images/BOM/baseblock.png rename to documentation/bom/images/BaseBlock.png diff --git a/images/BOM/brass-pipe.png b/documentation/bom/images/BrassPipe.png similarity index 100% rename from images/BOM/brass-pipe.png rename to documentation/bom/images/BrassPipe.png diff --git a/images/BOM/DC-DC-step-down.png b/documentation/bom/images/DC_DC-StepDown.png similarity index 100% rename from images/BOM/DC-DC-step-down.png rename to documentation/bom/images/DC_DC-StepDown.png diff --git a/images/BOM/EndEffector.png b/documentation/bom/images/EndEffector.png similarity index 100% rename from images/BOM/EndEffector.png rename to documentation/bom/images/EndEffector.png diff --git a/images/BOM/MT6835-magnetic-encoder-module.png b/documentation/bom/images/MT6835.png similarity index 100% rename from images/BOM/MT6835-magnetic-encoder-module.png rename to documentation/bom/images/MT6835.png diff --git a/images/BOM/MotorMount.png b/documentation/bom/images/MotorMount.png similarity index 100% rename from images/BOM/MotorMount.png rename to documentation/bom/images/MotorMount.png diff --git a/images/BOM/PU-stretch-cord.png b/documentation/bom/images/PU_StretchCord.png similarity index 100% rename from images/BOM/PU-stretch-cord.png rename to documentation/bom/images/PU_StretchCord.png diff --git a/images/BOM/RaspberryPi-Pico-2.png b/documentation/bom/images/RaspberryPiPico2.png similarity index 100% rename from images/BOM/RaspberryPi-Pico-2.png rename to documentation/bom/images/RaspberryPiPico2.png diff --git a/images/BOM/RubberBandCollet.png b/documentation/bom/images/RubberBandCollet.png similarity index 100% rename from images/BOM/RubberBandCollet.png rename to documentation/bom/images/RubberBandCollet.png diff --git a/images/BOM/TB6612FNG-driver.png b/documentation/bom/images/TB6612FNG.png similarity index 100% rename from images/BOM/TB6612FNG-driver.png rename to documentation/bom/images/TB6612FNG.png diff --git a/images/BOM/WireFlexureMount.png b/documentation/bom/images/WireFlexureMount.png similarity index 100% rename from images/BOM/WireFlexureMount.png rename to documentation/bom/images/WireFlexureMount.png