add wiring section for hausner guide
[challenge-bot] / guide / hausner / 2016 / 08 / overview.org
1 #+TITLE:hausner challenge-bot overview
2 #+SETUPFILE: ../../org-html-themes/setup/theme-readtheorg.setup
3 * assembling the hardware
4 first, go to the [[file:0-mechanical-assembly/mechanical-assembly.html][mechanical assembly]] page to see excruciating detail
5 on how to put the mechanical parts together.
6 * wiring
7 after the hardware is assembled, the robot is ready for wiring.
8 see the wiring page for the individual wiring steps.
9 * software
10 software is available as nice neat installable packages for
11 Mac OS X, GNU+Linux, and MS Windows.
12
13 it's also available in source code form, so you can compile it for
14 other platforms.
15
16 all software used in this robot is available for you to use for any
17 purpose, improve, and, share those improvements (if you want).
18 ** robot behavior: arduino
19 control how the robot gets information from sensors, and moves
20 its motors.
21
22 https://www.arduino.cc/en/Main/Software
23 ** part shaping: openscad
24 create robot parts!
25
26 use this program to view parts inside the "3d-printables"
27 directory of the class content.
28 there's a class content section below.
29 write code to modify the parts and create completely new ones.
30
31 http://www.openscad.org/downloads.html
32 ** wiring: fritzing
33 wire up components!
34
35 you can also create your own circuit board layouts and get your
36 design fabricated by fritzing.
37
38 http://fritzing.org/download/?donation=0
39 ** extract: 7-zip
40 extract the contents of .tgz files, like the content of this class.
41
42 this is needed on MS Windows(tm) only.
43
44 if you are on Mac OS X, or GNU (on top of cygwin or linux), then you
45 do not need this.
46 operating systems other than MS Windows can extract class content
47 with no extra software.
48
49 http://7-zip.org/
50 ** class content
51 all the source code for the class is available here:
52
53 http://challenge-bot.com/repos/?p=challenge-bot;a=snapshot;h=232ff7a14f9d8be27362c268c6cdd1b67f59a24a;sf=tgz
54
55 what follows is a high level description of the contents of the most
56 important top level directories in the class content.
57 *** 3d-printables
58 the parts of the robot that are 3d-printed are in this directory.
59 use openscad to open the parts in this directory.
60 *** build-stages
61 all the wiring diagrams and arduino code live in this directory.
62
63 under this directory, there is one subdirectory for each
64 build stage.
65 each build stage is prefixed with a letter to make it appear in
66 order.
67 for example, =a_serial= contains the first build stage.
68 * troubleshooting
69 to troubleshoot a misbehaving robot, go through these stages
70 in order until you find a stage that does not work correctly.
71
72 first, in =a_serial=, you'll check whether the arduino can
73 communicate over the serial connection with the computer.
74
75 in each stage, make sure the wires shown in the fritzing
76 diagram are correctly connected on your robot.
77 then load the corresponding arduino sketch to your robot
78 and either check the serial monitor, or turn on the motor battery.
79
80 this will help you pinpoint exactly where the problem lies on your
81 robot.