modify release procedure to reflect Keith setting version in confgure.ac
[fw/altos] / doc / getting-started.inc
1 == Getting Started
2
3         The first thing to do after you open the box is to hook up a
4         battery and charge it if necessary.
5
6         === Batteries
7
8                 ifdef::telemetrum,telemega,easymega[]
9                 For TeleMetrum, TeleMega and EasyMega, the battery can be charged by plugging it into the
10                 corresponding socket of the device and then using the USB
11                 cable to plug the flight computer into your computer's USB socket. The
12                 on-board circuitry will charge the battery whenever it is plugged
13                 in, because the on-off switch does NOT control the
14                 charging circuitry.
15                 endif::telemetrum,telemega,easymega[]
16                 The Lithium Polymer
17                 ifdef::telemini[TeleMini and]
18                 EasyMini battery can be charged by disconnecting it
19                 from the board and plugging it into a standalone
20                 battery charger such as link:http://altusmetrum.org/LipoCharger[LipoCharger], and
21                 connecting that via a USB cable to a laptop or other
22                 USB power source.
23
24                 You can also choose to use another battery with
25                 ifdef::telemini[TeleMini v2.0 and]
26                 EasyMini, anything supplying between 4 and 12 volts should
27                 work fine (like a standard 9V battery), but if you are planning
28                 to fire pyro charges, ground testing is required to verify that
29                 the battery supplies enough current to fire your chosen e-matches.
30
31                 ifdef::telemetrum,telemega,easymega[]
32                 [NOTE]
33                 ====
34                 On TeleMetrum v1 boards, when the GPS chip is initially
35                 searching for satellites, TeleMetrum will consume more current
36                 than it pulls from the USB port, so the battery must be
37                 attached in order to get satellite lock.  Once GPS is locked,
38                 the current consumption goes back down enough to enable charging
39                 while running. So it's a good idea to fully charge the battery
40                 as your first item of business so there is no issue getting and
41                 maintaining satellite lock.  The yellow charge indicator led
42                 will go out when the battery is nearly full and the charger goes
43                 to trickle charge. It can take several hours to fully recharge a
44                 deeply discharged battery.
45
46                 TeleMetrum v2.0, TeleMega and EasyMega use a higher power battery charger,
47                 allowing them to charge the battery while running the board at
48                 maximum power. When the battery is charging, or when the board
49                 is consuming a lot of power, the red LED will be lit. When the
50                 battery is fully charged, the green LED will be lit. When the
51                 battery is damaged or missing, both LEDs will be lit, which
52                 appears yellow.
53                 ====
54                 endif::telemetrum,telemega,easymega[]
55
56         ifdef::radio[]
57         === Ground Station Hardware
58
59                 There are two ground stations available, the TeleDongle USB to
60                 RF interface and the TeleBT Bluetooth/USB to RF interface.  If
61                 you plug either of these in to your Mac or Linux computer it should
62                 “just work”, showing up as a serial port device.  Windows systems need
63                 driver information that is part of the AltOS download to know that the
64                 existing USB modem driver will work.  We therefore recommend installing
65                 our software before plugging in TeleDongle if you are using a Windows
66                 computer.  If you are using an older version of Linux and are having
67                 problems, try moving to a fresher kernel (2.6.33 or
68                 newer).
69         endif::radio[]
70
71         === Linux/Mac/Windows Ground Station Software
72
73                 Next you should obtain and install the AltOS software.
74                 The AltOS distribution includes the AltosUI ground
75                 station program, current firmware images for all of
76                 the hardware, and a number of standalone utilities
77                 that are rarely needed.  Pre-built binary packages are
78                 available for Linux, Microsoft Windows, Mac OSX. Full
79                 source code and build instructions are also
80                 available. The latest version may always be downloaded
81                 from http://altusmetrum.org/AltOS
82
83         ifdef::radio[]
84         === Android Ground Station Software
85
86                 TeleBT can also connect to an Android device over
87                 BlueTooth or USB. The
88                 link:https://play.google.com/store/apps/details?id=org.altusmetrum.AltosDroid[AltosDroid
89                 Android application] is available from the  
90                 link:https://play.google.com[Google Play system].
91
92                 You don't need a data plan to use AltosDroid, but
93                 without network access, you'll want to download
94                 offline map data before wandering away from the
95                 network.
96         endif::radio[]