From 18e0ffef92a3bc197175f96bc4119514f500870a Mon Sep 17 00:00:00 2001 From: Zhengyu Peng Date: Wed, 5 Jan 2022 07:52:07 -0500 Subject: [PATCH] update readme --- README.md | 104 +++++++++++++++++- electronic/README.md | 15 --- {mechanism/imgs => imgs}/M2_10mm.JPG | Bin {mechanism/imgs => imgs}/M2_30mm.JPG | Bin {mechanism/imgs => imgs}/M2_6mm.JPG | Bin {mechanism/imgs => imgs}/M2_nut.JPG | Bin {electronic/imgs => imgs}/PCA9685.jpg | Bin {electronic/imgs => imgs}/XL4005.jpg | Bin {mechanism/imgs => imgs}/battery_box.jpg | Bin {mechanism/imgs => imgs}/battery_holder.jpg | Bin {mechanism/imgs => imgs}/body_back_wall.jpg | Bin {mechanism/imgs => imgs}/body_bottom.jpg | Bin {mechanism/imgs => imgs}/body_side_wall.jpg | Bin {mechanism/imgs => imgs}/body_top.jpg | Bin {electronic/imgs => imgs}/diagram.svg | 0 {mechanism/imgs => imgs}/foot_bottom.jpg | Bin {mechanism/imgs => imgs}/foot_ground.jpg | Bin {mechanism/imgs => imgs}/foot_tip.jpg | Bin {mechanism/imgs => imgs}/foot_top.jpg | Bin {mechanism/imgs => imgs}/joint_bottom.jpg | Bin {mechanism/imgs => imgs}/joint_cross.jpg | Bin {mechanism/imgs => imgs}/joint_top.jpg | Bin {mechanism/imgs => imgs}/leg_bottom.jpg | Bin {mechanism/imgs => imgs}/leg_top.jpg | Bin {mechanism/imgs => imgs}/mech_leg_1.jpg | Bin {mechanism/imgs => imgs}/mech_leg_2.jpg | Bin {mechanism/imgs => imgs}/mech_leg_3.jpg | Bin {mechanism/imgs => imgs}/mech_leg_4.jpg | Bin {mechanism/imgs => imgs}/mech_leg_5.jpg | Bin .../imgs => imgs}/mech_leg_exploded.jpg | Bin {electronic/imgs => imgs}/mini360.jpg | Bin {mechanism/imgs => imgs}/pin_M4_6mm.JPG | Bin {mechanism/imgs => imgs}/servo_horn_j1j2.jpg | Bin {mechanism/imgs => imgs}/servo_horn_j3.jpg | Bin {mechanism/imgs => imgs}/thigh_bottom.jpg | Bin {mechanism/imgs => imgs}/thigh_top.jpg | Bin {electronic/imgs => imgs}/toggle_switch.jpg | Bin {electronic/imgs => imgs}/zero2-close-up.webp | Bin mechanism/README.md | 82 -------------- 39 files changed, 100 insertions(+), 101 deletions(-) delete mode 100644 electronic/README.md rename {mechanism/imgs => imgs}/M2_10mm.JPG (100%) rename {mechanism/imgs => imgs}/M2_30mm.JPG (100%) rename {mechanism/imgs => imgs}/M2_6mm.JPG (100%) rename {mechanism/imgs => imgs}/M2_nut.JPG (100%) rename {electronic/imgs => imgs}/PCA9685.jpg (100%) rename {electronic/imgs => imgs}/XL4005.jpg (100%) rename {mechanism/imgs => imgs}/battery_box.jpg (100%) rename {mechanism/imgs => imgs}/battery_holder.jpg (100%) rename {mechanism/imgs => imgs}/body_back_wall.jpg (100%) rename {mechanism/imgs => imgs}/body_bottom.jpg (100%) rename {mechanism/imgs => imgs}/body_side_wall.jpg (100%) rename {mechanism/imgs => imgs}/body_top.jpg (100%) rename {electronic/imgs => imgs}/diagram.svg (100%) rename {mechanism/imgs => imgs}/foot_bottom.jpg (100%) rename {mechanism/imgs => imgs}/foot_ground.jpg (100%) rename {mechanism/imgs => imgs}/foot_tip.jpg (100%) rename {mechanism/imgs => imgs}/foot_top.jpg (100%) rename {mechanism/imgs => imgs}/joint_bottom.jpg (100%) rename {mechanism/imgs => imgs}/joint_cross.jpg (100%) rename {mechanism/imgs => imgs}/joint_top.jpg (100%) rename {mechanism/imgs => imgs}/leg_bottom.jpg (100%) rename {mechanism/imgs => imgs}/leg_top.jpg (100%) rename {mechanism/imgs => imgs}/mech_leg_1.jpg (100%) rename {mechanism/imgs => imgs}/mech_leg_2.jpg (100%) rename {mechanism/imgs => imgs}/mech_leg_3.jpg (100%) rename {mechanism/imgs => imgs}/mech_leg_4.jpg (100%) rename {mechanism/imgs => imgs}/mech_leg_5.jpg (100%) rename {mechanism/imgs => imgs}/mech_leg_exploded.jpg (100%) rename {electronic/imgs => imgs}/mini360.jpg (100%) rename {mechanism/imgs => imgs}/pin_M4_6mm.JPG (100%) rename {mechanism/imgs => imgs}/servo_horn_j1j2.jpg (100%) rename {mechanism/imgs => imgs}/servo_horn_j3.jpg (100%) rename {mechanism/imgs => imgs}/thigh_bottom.jpg (100%) rename {mechanism/imgs => imgs}/thigh_top.jpg (100%) rename {electronic/imgs => imgs}/toggle_switch.jpg (100%) rename {electronic/imgs => imgs}/zero2-close-up.webp (100%) delete mode 100644 mechanism/README.md diff --git a/README.md b/README.md index ffbfda7..5b4be40 100644 --- a/README.md +++ b/README.md @@ -21,8 +21,104 @@ The table below shows the difference between this project and the original one. ## Gallery -## Instructions +## Mechanism -1. [Mechanism](mechanism/) -1. [Electronic](electronic/) -1. [Software](software/) +### Bill of Materials (BOM) + +#### Servos + +18 TowerPro [MG92B](http://www.towerpro.com.tw/product/mg92b/) are required. + +> The dimension of 3d printed part is highly dependent on the servo's size. Modification is required if you want to use alternative servos. + +#### 3D-Printed Parts + +##### Body x 1 + +| Filename | Thumbnail | Required | +| -------------- | ----------------------------------------------------------------------- | -------- | +| body_top | body_top | 1 | +| body_bottom | body_bottom | 1 | +| body_side_wall | body_side_wall | 2 | +| body_back_wall | body_back_wall | 1 | +| battery_box | battery_box | 1 | +| battery_holder | battery_holder | 2 | + +##### Leg x 6 + +| Filename | Thumbnail | Required | +| --------------- | ------------------------------------------------------------------------- | -------- | +| thigh_top | thigh_top | 1 (x6) | +| thigh_bottom | thigh_bottom | 1 (x6) | +| joint_cross | joint_cross | 1 (x6) | +| joint_top | joint_top | 2 (x6) | +| joint_bottom | joint_bottom | 2 (x6) | +| leg_top | leg_top | 1 (x6) | +| let_bottom | leg_bottom | 1 (x6) | +| foot_top | foot_top | 1 (x6) | +| foot_bottom | foot_bottom | 1 (x6) | +| foot_ground | foot_ground | 1 (x6) | +| foot_tip | foot_tip | 1 (x6) | +| servo_horn_j1j2 | servo_horn_j1j2 | 2 (x6) | +| servo_horn_j3 | servo_horn_j3 | 1 (x6) | + +#### Others + +| Name | Spec | Thumbnail | Required | Note | +| --------- | ------- | ---------------------------- | -------- | ------------------------------------------------- | +| Screw | M2 6mm | ![6mm](imgs/M2_6mm.JPG) | 54 | Servo Arm: 1 x 18
Joint: 4 x 6
Thigh: 2 x 6 | +| Screw | M2 10mm | ![10mm](imgs/M2_10mm.JPG) | 24 | Thigh: 1 x 6
Pin lock: 1 x 18 | +| Screw | M2 30mm | ![30mm](imgs/M2_30mm.JPG) | 36 | Servo: 2 x 18 | +| Nuts | M2 | ![6mm](imgs/M2_nut.JPG) | 36 | Servo: 2 x 18 | +| Pin (304) | M4 6mm | ![pin](imgs/pin_M4_6mm.JPG) | 18 | Servo: 1 x 18 | + +### Leg Assemble + +#### Assembly video + + + +#### Exploded view + +LegAssemble + +#### Detailed steps + +- **Step 1** - Combine `thigh_top`, `MG92B` and `thigh_bottom`, use M2x30mm screw and nut to secure them together. + +LegAssemble1 + +- **Step 2** - Grab one `joint_cross`, `joint_top` and `joint_bottom` and combine them + +LegAssemble2 + +- **Step 3** - First put 2 x `MG92B`, `leg_top` and `leg_bottom` together with M2x30mm screw and nut. Then attach `joint_top` and `joint_bottom` altogether + +LegAssemble3 + +- **Step 4** - Grab `foot_top`, `foot_bottom` and `foot_ground` (and `foot_top`) and assemble them. + +LegAssemble4 + +- **Finish** - Great, you got 1 leg done, 5 more to go :) + +LegAssemble5 + +## Electronics + +### Bill of Materials (BOM) + +| Name | Thumbnail | Required | +| -------------- | ----------------------------------------------------------------------- | -------- | +| Raspberry Pi Zero W or W 2 | raspberry pi | 1 | +| PCA9685 motor driver | PCA9685 | 2 | +| XL4005 DC-DC step down | XL4005 | 2 | +| Mini 360 DC-DC step down | mini360 | 1 | +| Toggle switch | toggle_switch | 1 | + +### Connection Diagram + +diagram + + +## Software diff --git a/electronic/README.md b/electronic/README.md deleted file mode 100644 index ce8ee05..0000000 --- a/electronic/README.md +++ /dev/null @@ -1,15 +0,0 @@ -# Electronics - -## Bill of Materials (BOM) - -| Name | Thumbnail | Required | -| -------------- | ----------------------------------------------------------------------- | -------- | -| Raspberry Pi Zero W or W 2 | raspberry pi | 1 | -| PCA9685 motor driver | PCA9685 | 2 | -| XL4005 DC-DC step down | XL4005 | 2 | -| Mini 360 DC-DC step down | mini360 | 1 | -| Toggle switch | toggle_switch | 1 | - -## Connection Diagram - -diagram diff --git a/mechanism/imgs/M2_10mm.JPG b/imgs/M2_10mm.JPG similarity index 100% rename from mechanism/imgs/M2_10mm.JPG rename to imgs/M2_10mm.JPG diff --git a/mechanism/imgs/M2_30mm.JPG b/imgs/M2_30mm.JPG similarity index 100% rename from mechanism/imgs/M2_30mm.JPG rename to imgs/M2_30mm.JPG diff --git a/mechanism/imgs/M2_6mm.JPG b/imgs/M2_6mm.JPG similarity index 100% rename from mechanism/imgs/M2_6mm.JPG rename to imgs/M2_6mm.JPG diff --git a/mechanism/imgs/M2_nut.JPG b/imgs/M2_nut.JPG similarity index 100% rename from mechanism/imgs/M2_nut.JPG rename to imgs/M2_nut.JPG diff --git a/electronic/imgs/PCA9685.jpg b/imgs/PCA9685.jpg similarity index 100% rename from electronic/imgs/PCA9685.jpg rename to imgs/PCA9685.jpg diff --git a/electronic/imgs/XL4005.jpg b/imgs/XL4005.jpg similarity index 100% rename from electronic/imgs/XL4005.jpg rename to imgs/XL4005.jpg diff --git a/mechanism/imgs/battery_box.jpg b/imgs/battery_box.jpg similarity index 100% rename from mechanism/imgs/battery_box.jpg rename to imgs/battery_box.jpg diff --git a/mechanism/imgs/battery_holder.jpg b/imgs/battery_holder.jpg similarity index 100% rename from mechanism/imgs/battery_holder.jpg rename to imgs/battery_holder.jpg diff --git a/mechanism/imgs/body_back_wall.jpg b/imgs/body_back_wall.jpg similarity index 100% rename from mechanism/imgs/body_back_wall.jpg rename to imgs/body_back_wall.jpg diff --git a/mechanism/imgs/body_bottom.jpg b/imgs/body_bottom.jpg similarity index 100% rename from mechanism/imgs/body_bottom.jpg rename to imgs/body_bottom.jpg diff --git a/mechanism/imgs/body_side_wall.jpg b/imgs/body_side_wall.jpg similarity index 100% rename from mechanism/imgs/body_side_wall.jpg rename to imgs/body_side_wall.jpg diff --git a/mechanism/imgs/body_top.jpg b/imgs/body_top.jpg similarity index 100% rename from mechanism/imgs/body_top.jpg rename to imgs/body_top.jpg diff --git a/electronic/imgs/diagram.svg b/imgs/diagram.svg similarity index 100% rename from electronic/imgs/diagram.svg rename to imgs/diagram.svg diff --git a/mechanism/imgs/foot_bottom.jpg b/imgs/foot_bottom.jpg similarity index 100% rename from mechanism/imgs/foot_bottom.jpg rename to imgs/foot_bottom.jpg diff --git a/mechanism/imgs/foot_ground.jpg b/imgs/foot_ground.jpg similarity index 100% rename from mechanism/imgs/foot_ground.jpg rename to imgs/foot_ground.jpg diff --git a/mechanism/imgs/foot_tip.jpg b/imgs/foot_tip.jpg similarity index 100% rename from mechanism/imgs/foot_tip.jpg rename to imgs/foot_tip.jpg diff --git a/mechanism/imgs/foot_top.jpg b/imgs/foot_top.jpg similarity index 100% rename from mechanism/imgs/foot_top.jpg rename to imgs/foot_top.jpg diff --git a/mechanism/imgs/joint_bottom.jpg b/imgs/joint_bottom.jpg similarity index 100% rename from mechanism/imgs/joint_bottom.jpg rename to imgs/joint_bottom.jpg diff --git a/mechanism/imgs/joint_cross.jpg b/imgs/joint_cross.jpg similarity index 100% rename from mechanism/imgs/joint_cross.jpg rename to imgs/joint_cross.jpg diff --git a/mechanism/imgs/joint_top.jpg b/imgs/joint_top.jpg similarity index 100% rename from mechanism/imgs/joint_top.jpg rename to imgs/joint_top.jpg diff --git a/mechanism/imgs/leg_bottom.jpg b/imgs/leg_bottom.jpg similarity index 100% rename from mechanism/imgs/leg_bottom.jpg rename to imgs/leg_bottom.jpg diff --git a/mechanism/imgs/leg_top.jpg b/imgs/leg_top.jpg similarity index 100% rename from mechanism/imgs/leg_top.jpg rename to imgs/leg_top.jpg diff --git a/mechanism/imgs/mech_leg_1.jpg b/imgs/mech_leg_1.jpg similarity index 100% rename from mechanism/imgs/mech_leg_1.jpg rename to imgs/mech_leg_1.jpg diff --git a/mechanism/imgs/mech_leg_2.jpg b/imgs/mech_leg_2.jpg similarity index 100% rename from mechanism/imgs/mech_leg_2.jpg rename to imgs/mech_leg_2.jpg diff --git a/mechanism/imgs/mech_leg_3.jpg b/imgs/mech_leg_3.jpg similarity index 100% rename from mechanism/imgs/mech_leg_3.jpg rename to imgs/mech_leg_3.jpg diff --git a/mechanism/imgs/mech_leg_4.jpg b/imgs/mech_leg_4.jpg similarity index 100% rename from mechanism/imgs/mech_leg_4.jpg rename to imgs/mech_leg_4.jpg diff --git a/mechanism/imgs/mech_leg_5.jpg b/imgs/mech_leg_5.jpg similarity index 100% rename from mechanism/imgs/mech_leg_5.jpg rename to imgs/mech_leg_5.jpg diff --git a/mechanism/imgs/mech_leg_exploded.jpg b/imgs/mech_leg_exploded.jpg similarity index 100% rename from mechanism/imgs/mech_leg_exploded.jpg rename to imgs/mech_leg_exploded.jpg diff --git a/electronic/imgs/mini360.jpg b/imgs/mini360.jpg similarity index 100% rename from electronic/imgs/mini360.jpg rename to imgs/mini360.jpg diff --git a/mechanism/imgs/pin_M4_6mm.JPG b/imgs/pin_M4_6mm.JPG similarity index 100% rename from mechanism/imgs/pin_M4_6mm.JPG rename to imgs/pin_M4_6mm.JPG diff --git a/mechanism/imgs/servo_horn_j1j2.jpg b/imgs/servo_horn_j1j2.jpg similarity index 100% rename from mechanism/imgs/servo_horn_j1j2.jpg rename to imgs/servo_horn_j1j2.jpg diff --git a/mechanism/imgs/servo_horn_j3.jpg b/imgs/servo_horn_j3.jpg similarity index 100% rename from mechanism/imgs/servo_horn_j3.jpg rename to imgs/servo_horn_j3.jpg diff --git a/mechanism/imgs/thigh_bottom.jpg b/imgs/thigh_bottom.jpg similarity index 100% rename from mechanism/imgs/thigh_bottom.jpg rename to imgs/thigh_bottom.jpg diff --git a/mechanism/imgs/thigh_top.jpg b/imgs/thigh_top.jpg similarity index 100% rename from mechanism/imgs/thigh_top.jpg rename to imgs/thigh_top.jpg diff --git a/electronic/imgs/toggle_switch.jpg b/imgs/toggle_switch.jpg similarity index 100% rename from electronic/imgs/toggle_switch.jpg rename to imgs/toggle_switch.jpg diff --git a/electronic/imgs/zero2-close-up.webp b/imgs/zero2-close-up.webp similarity index 100% rename from electronic/imgs/zero2-close-up.webp rename to imgs/zero2-close-up.webp diff --git a/mechanism/README.md b/mechanism/README.md deleted file mode 100644 index bc068dd..0000000 --- a/mechanism/README.md +++ /dev/null @@ -1,82 +0,0 @@ -# Mechanism - -## Bill of Materials (BOM) - -### Servos - -18 TowerPro [MG92B](http://www.towerpro.com.tw/product/mg92b/) are required. - -> The dimension of 3d printed part is highly dependent on the servo's size. Modification is required if you want to use alternative servos. - -### 3D-Printed Parts - -#### Body x 1 - -| Filename | Thumbnail | Required | -| -------------- | ----------------------------------------------------------------------- | -------- | -| body_top | body_top | 1 | -| body_bottom | body_bottom | 1 | -| body_side_wall | body_side_wall | 2 | -| body_back_wall | body_back_wall | 1 | -| battery_box | battery_box | 1 | -| battery_holder | battery_holder | 2 | - -#### Leg x 6 - -| Filename | Thumbnail | Required | -| --------------- | ------------------------------------------------------------------------- | -------- | -| thigh_top | thigh_top | 1 (x6) | -| thigh_bottom | thigh_bottom | 1 (x6) | -| joint_cross | joint_cross | 1 (x6) | -| joint_top | joint_top | 2 (x6) | -| joint_bottom | joint_bottom | 2 (x6) | -| leg_top | leg_top | 1 (x6) | -| let_bottom | leg_bottom | 1 (x6) | -| foot_top | foot_top | 1 (x6) | -| foot_bottom | foot_bottom | 1 (x6) | -| foot_ground | foot_ground | 1 (x6) | -| foot_tip | foot_tip | 1 (x6) | -| servo_horn_j1j2 | servo_horn_j1j2 | 2 (x6) | -| servo_horn_j3 | servo_horn_j3 | 1 (x6) | - -### Others - -| Name | Spec | Thumbnail | Required | Note | -| --------- | ------- | ---------------------------- | -------- | ------------------------------------------------- | -| Screw | M2 6mm | ![6mm](imgs/M2_6mm.JPG) | 54 | Servo Arm: 1 x 18
Joint: 4 x 6
Thigh: 2 x 6 | -| Screw | M2 10mm | ![10mm](imgs/M2_10mm.JPG) | 24 | Thigh: 1 x 6
Pin lock: 1 x 18 | -| Screw | M2 30mm | ![30mm](imgs/M2_30mm.JPG) | 36 | Servo: 2 x 18 | -| Nuts | M2 | ![6mm](imgs/M2_nut.JPG) | 36 | Servo: 2 x 18 | -| Pin (304) | M4 6mm | ![pin](imgs/pin_M4_6mm.JPG) | 18 | Servo: 1 x 18 | - -## Leg Assemble - -### Assembly video - - - -### Exploded view - -LegAssemble - -### Detailed steps - -- **Step 1** - Combine `thigh_top`, `MG92B` and `thigh_bottom`, use M2x30mm screw and nut to secure them together. - -LegAssemble1 - -- **Step 2** - Grab one `joint_cross`, `joint_top` and `joint_bottom` and combine them - -LegAssemble2 - -- **Step 3** - First put 2 x `MG92B`, `leg_top` and `leg_bottom` together with M2x30mm screw and nut. Then attach `joint_top` and `joint_bottom` altogether - -LegAssemble3 - -- **Step 4** - Grab `foot_top`, `foot_bottom` and `foot_ground` (and `foot_top`) and assemble them. - -LegAssemble4 - -- **Finish** - Great, you got 1 leg done, 5 more to go :) - -LegAssemble5