add super short description in title of software
[challenge-bot] / guide / hausner / overview.org
CommitLineData
20b025c5 1#+TITLE:hausner challenge-bot overview
b5091bcd 2#+SETUPFILE: org-html-themes/setup/theme-readtheorg.setup
e1d90ff4 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.
1a35441e 7
e1d90ff4 8 it's also available in source code form, so you can compile it for
9 other platforms.
1a35441e 10
e1d90ff4 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).
2d29b38c 13** robot behavior: arduino
3d74bac6 14 control how the robot gets information from sensors, and moves
15 its motors.
16
17 https://www.arduino.cc/en/Main/Software
2d29b38c 18** 3d modeling: openscad
3d74bac6 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
2d29b38c 26** wiring: fritzing
3d74bac6 27 wire up components!
28
29 http://fritzing.org/download/?donation=0
2d29b38c 30** extract: 7-zip
3d74bac6 31 extract the contents of .tgz files, like the content of this class.
32
33 this is needed on MS Windows(tm) only.
3a70509f 34
3d74bac6 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
3a70509f 38
3d74bac6 39 http://7-zip.org/
e1d90ff4 40* class content
41 all the source code for the class is available here:
3a70509f 42
e1d90ff4 43 http://challenge-bot.com/repos/?p=challenge-bot;a=snapshot;h=232ff7a14f9d8be27362c268c6cdd1b67f59a24a;sf=tgz
ce76be4f 44
e1d90ff4 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.
0d77067a 52
e1d90ff4 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.
ef5f7e4a 61
e1d90ff4 62 first, in =a_serial=, you'll check whether the arduino can
63 communicate over the serial connection with the computer.
ef5f7e4a 64
e1d90ff4 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.
ef5f7e4a 69
e1d90ff4 70 this will help you pinpoint exactly where the problem lies on your
71 robot.