From c52fa4fdbfe87c65cd14568036f0e3f0dbfc3a4a Mon Sep 17 00:00:00 2001 From: Franz Pucher Date: Sun, 20 Mar 2022 22:11:15 +0100 Subject: [PATCH] [#4] Add basic md files for hardware setup --- docs/hardware_setup/3D_print.md | 2 ++ docs/hardware_setup/assembly.md | 1 + docs/hardware_setup/electronics.md | 17 ++++++++++++++++ docs/hardware_setup/overview.md | 31 ++++++++++++++++++++++++++++++ docs/index.md | 2 +- 5 files changed, 52 insertions(+), 1 deletion(-) create mode 100644 docs/hardware_setup/3D_print.md create mode 100644 docs/hardware_setup/assembly.md create mode 100644 docs/hardware_setup/electronics.md create mode 100644 docs/hardware_setup/overview.md diff --git a/docs/hardware_setup/3D_print.md b/docs/hardware_setup/3D_print.md new file mode 100644 index 00000000..f2e684d8 --- /dev/null +++ b/docs/hardware_setup/3D_print.md @@ -0,0 +1,2 @@ +# 3D Printing + diff --git a/docs/hardware_setup/assembly.md b/docs/hardware_setup/assembly.md new file mode 100644 index 00000000..f321e7dd --- /dev/null +++ b/docs/hardware_setup/assembly.md @@ -0,0 +1 @@ +# Assembly \ No newline at end of file diff --git a/docs/hardware_setup/electronics.md b/docs/hardware_setup/electronics.md new file mode 100644 index 00000000..d1bd4d61 --- /dev/null +++ b/docs/hardware_setup/electronics.md @@ -0,0 +1,17 @@ +# Electronics + +The bread board view from [Fritzing](https://fritzing.org/) shows the connection schematic. Both models (DiffBot and Remo) use +slgithly different hardware (e.g. motor driver) which you can see in the following: + +=== "Remo" + + [![Remo Fritzing]][Remo Fritzing] + + [Remo Fritzing]: /fritzing/remo_architecture.svg + + +=== "DiffBot" + + [![DiffBot Fritzing]][DiffBot Fritzing] + + [DiffBot Fritzing]: /fritzing/diffbot_architecture.svg \ No newline at end of file diff --git a/docs/hardware_setup/overview.md b/docs/hardware_setup/overview.md new file mode 100644 index 00000000..19a3a9db --- /dev/null +++ b/docs/hardware_setup/overview.md @@ -0,0 +1,31 @@ +# Hardware Setup Overview + +The following pages guide you on how to setup the hardware of your robot (either DiffBot or Remo). + +- [**3D Printing**](3D_print.md) is only relevant for Remo robot (not DiffBot). + Here you will learn which parts to print and some suggestions to configure your slicer. +- [**Electronics**](electronics.md) provides instructions to connect the single board computer (e.g. Raspberry Pi), microcontroller (e.g. Teensy) as well as + the other components such as the motor driver, motors and laser scanner. + + ??? info "Preview of connection schematic" + The bread board view from [Fritzing](https://fritzing.org/) shows the connection schematic. Both models (DiffBot and Remo) use + slgithly different hardware (e.g. motor driver) which you can see in the following: + + === "Remo" + + [![Remo Fritzing]][Remo Fritzing] + + [Remo Fritzing]: /fritzing/remo_architecture.svg + + + === "DiffBot" + + [![DiffBot Fritzing]][DiffBot Fritzing] + + [DiffBot Fritzing]: /fritzing/diffbot_architecture.svg + + +- [**Assembly**](assembly.md) give instructions to assemble Remo robot. + + + diff --git a/docs/index.md b/docs/index.md index 03782a38..7e96ab7d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -16,7 +16,7 @@ The project is split into multiple parts, to adress the following main aspects o - [Bill of Materials (BOM)](./components.md) and the theory behind the parts. - [Theory of (mobile) robots](./theory/index.md). -- [Assembly](/projects/diffbot/assembly/) of the robot platform and the components. +- [Assembly](./hardware_setup/assembly.md) of the robot platform and the components. - Setup of ROS (Noetic or Melodic) on either Raspberry Pi 4 B or Jetson Nano, which are both [Single Board Computers (SBC)](https://en.wikipedia.org/wiki/Single-board_computer) and are the brain of the robot. - [Modeling the Robot](/projects/diffbot/URDF) in Blender and URDF to simulate it in Gazebo.