Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
DeDiamondPro committed Mar 15, 2024
1 parent 4d7199b commit 4dba678
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
14 changes: 14 additions & 0 deletions documentation/src/ch01-01-design-principles.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Design Principles
AQLARP stands for **A**ffordable **Q**uadruped **L**earning **A**nd **R**esearch **P**latform. These are the principles AQLARP is based on.
## Platform
This is the most important principle for AQLARP. AQLARP should be a solid, extendable platform, which you can use as starting point to build on and create your own amazing projects.
Here are some of the design decisions to make AQLARP a platform:
1. Extendibility: the top, front and back are easily replaceable with your own components that suit the needs of what you are trying to create.
2. Interoperability: AQLARP makes use of [ROS2](https://ros.org) so you can easily write your own code, in any programming language you chose, that can effortlessly interact with other parts of AQLARP's codebase.
3. Well Documented: AQLARP has a good documentation to learn about AQLARP and how to extend it. Additionally AQLARP's code has clear comments to help you understand it.
## Affordable
AQLARP is relatively affordable. The parts chosen are a balance of price and how suitable they are to build a platform. Affordability does not come before making AQLARP a stable and extendable platform.
## Learning
AQLARP can be used as a learning tool. To aid in this AQLARP is well documented and extendable. Additionally AQLARP uses [ROS2](https://ros.org) which is commonly used in the robotics industry and is a valuable skill to learn.
## Research
AQLARP is extendable and it is easy to add extra sensors to measure the influence of a variety of factors. Additionally AQLARP is open source so you can change anything you want to aid in your research.
12 changes: 12 additions & 0 deletions documentation/src/ch02-01-required-materials.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Required Materials

AQLARP's bill of materials is available [here](https://docs.google.com/spreadsheets/d/e/2PACX-1vRbQA3j36Z8nV3XLGrAlESTOF5qkMQ1r0tQvmaywV8VTpTOwY9WorlNrphstLwu9Ot1-xkpC_Ci4Gyd/pubhtml). ([download](https://docs.google.com/spreadsheets/d/e/2PACX-1vRbQA3j36Z8nV3XLGrAlESTOF5qkMQ1r0tQvmaywV8VTpTOwY9WorlNrphstLwu9Ot1-xkpC_Ci4Gyd/pub?output=xlsx))

<iframe src="https://docs.google.com/spreadsheets/d/e/2PACX-1vRbQA3j36Z8nV3XLGrAlESTOF5qkMQ1r0tQvmaywV8VTpTOwY9WorlNrphstLwu9Ot1-xkpC_Ci4Gyd/pubhtml?widget=true&amp;headers=false", width = 100% height = 560px></iframe>

I would encourage you to look around and see if you can find parts for cheaper since these prices will change with time and depending on your area they may also vary.

Additionally you will have to have the following tools:
- Screw driver for the type of screws you chose
- Sottering iron
- 3D printer

0 comments on commit 4dba678

Please sign in to comment.