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