0e553405ba6ad2f3373e2204f911567c3bd38962
[fw/altos] / doc / telelaunch-configuration.inc
1 == Configuration
2
3         There are 3 things you need to configure identically in each unit
4         that is part of a TeleLaunch system for wireless communications to
5         succeed.  Those are the operating frequency, the callsign, and a key
6         for the AES encryption algorithm.  Additionally, each TeleFire unit
7         also needs to be configured with a unique bank number.
8
9         Please note that these values must match exactly, or the system will
10         not operate as expected.  That means the callsign needs to have the
11         same choices of upper or lower case, no trailing spaces, etc.  And
12         the operating frequency and AES key must match.
13
14         === Connecting to a Unit
15
16                 Configuring each unit of a TeleLaunch system requires use of 
17                 a micro USB cable, and a computer with a suitable terminal
18                 emulation program.  Connect a suitable cable, open your
19                 favoriate terminal emulation program, and power up the unit.
20                 By pressing <enter> you should see a command prompt.
21
22                 === TeleLCO
23
24                         The USB connector on TeleLCO is accessible without
25                         opening the lid of the Pelican box.  Look for the
26                         blue dust cap over the connector under the handle.
27
28                 === TeleFireEight
29
30                         The USB connector on TeleFireEight is located on the
31                         circuit board.  To access it, open the box and flip
32                         the lid up.  you should be able to spot a vertical
33                         micro USB connector on the board near the DIP switch.
34
35                         [WARNING]
36                         Please take care when closing the TeleFireEight lid
37                         not to pinch any wires.
38
39         === Operating Frequency
40
41                 The TeleLaunch system supports operation over much of the 
42                 "70cm" Amateur Radio band, with the filters optimized for a
43                 center frequency of 435 MHz.  For each system, a single
44                 operating frequency should be selected and programmed into
45                 each unit.
46
47                 The default frequency for units leaving the factory is 
48                 435.750 MHz.  Since Altus Metrum flight computers operate
49                 by default on 10 100khz channels from 434.550 to 435.450 MHz,
50                 we chose this frequency to be far enough away from flight
51                 computers to avoid any interference, but still close enough
52                 to the radio subsystem design center frequency for great
53                 performance.
54
55                 To configure the frequency, use your terminal emulator to
56                 issue two commands.  First, use 'c F xxxxxx' where the xxxxxx
57                 is replaced with the desired operating frequency in kHz.  Then
58                 use the 'c w' command to save this value into non-volatile
59                 memory.  For example, the default 435.750 MHz would be 
60                 configured using
61
62                         c f 435750 +
63                         c w
64
65
66         === Callsign
67
68                 In the US, you need an
69                 link:http://www.altusmetrum.org/Radio/[amateur radio license]
70                 or other authorization to legally operate the radio
71                 transmitters that are part of TeleLaunch.
72
73                 The default callsign shipped from the factory is "N0CALL",
74                 which is not a valid callsign and meant to humorously point
75                 out that the callsign hasn't been configured yet.
76
77                 Individual owners of a TeleLaunch system should use their
78                 own callsign.  
79
80                 Club owners of a TeleLaunch system should pick the callsign
81                 of one club member who is willing to be designated as the 
82                 control operator of the system.  Under FCC Part 97 rules,
83                 being the control operator does not mean you have to be LCO
84                 all the time, it just means taking responsibility for ensuring
85                 the system is being operated in compliance with the rules.
86
87                 To configure the callsign, use your terminal emulator to 
88                 issue two commands.  First, use 'c c callsign' to set the
89                 callsign, then use 'c w' to write to non-volatile memory.
90                 For example, to set the default N0CALL, the commands would
91                 be
92
93                         c c N0CALL +
94                         c w
95
96         === AES Key
97
98                 For safety, TeleLaunch uses cryptographic checksums to help 
99                 prevent interference, intentional or un-intentional.  This
100                 means each system must have a shared AES encryption key
101                 identically configured into each unit.
102
103                 The key size required is 128 bits, which must be expressed
104                 as a 32-digit hexadecimal number.
105
106                 To configure the AES key, use 'c a key' followed by 'c w'
107                 to write the key to non-volatile memory.  For example, to
108                 configure your system with a key that is the answer to life,
109                 the universe, and everything, the commands would be
110
111                         c a 00000000000000000000000000000042 +
112                         c w
113
114         === Bank Number
115
116                 Each TeleFire unit needs to be configured with a bank number,
117                 and bank numbers should be unique within a given system.  For
118                 most systems with 8 or less banks, just use the DIP switch
119                 on the circuit board inside the TeleFire unit to select the
120                 desired bank.  Only one switch should be turned on.  Switch
121                 one means bank one, etc.
122
123                 To allow systems to have more than 8 banks, if all the DIP
124                 switches are "off", the unit will use the bank configured in 
125                 non-volatile memory.
126
127                 To configure the bank number, use 'c B bank' followed by
128                 'c w' to write to non-volatile memory.  For example, to
129                 set the bank to 42, the commands would be:
130
131                         c B 42 +
132                         c w
133