From: Keith Packard Date: Wed, 18 Dec 2013 04:05:12 +0000 (-0800) Subject: doc: Add screen shots everywhere X-Git-Tag: 1.3~34 X-Git-Url: https://git.gag.com/?p=fw%2Faltos;a=commitdiff_plain;h=e44ce127ece149e7b07be49142bc0f9d50bbe97d doc: Add screen shots everywhere This has screen shots of every dialog in altosui Signed-off-by: Keith Packard --- diff --git a/doc/Makefile b/doc/Makefile index c45e084b..f586ad17 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -14,6 +14,37 @@ RELNOTES=\ release-notes-1.2.1.html \ release-notes-1.3.html +PICTURES=\ + altosui.png \ + ascent.png \ + configure-altimeter.png \ + configure-altosui.png \ + configure-groundstation.png \ + configure-pyro.png \ + descent.png \ + device-selection.png \ + easymini-top.jpg \ + fire-igniter.png \ + graph-configure.png \ + graph-map.png \ + graph.png \ + graph-stats.png \ + landed.png \ + launch-pad.png \ + load-maps.png \ + scan-channels.png \ + site-map.png \ + table.png \ + telemega-v1.0-top.jpg \ + telemetrum-v1.1-thside.jpg \ + telemini-v1-top.jpg \ + telemini-v2-top.jpg +SVG=\ + easymini-outline.svg \ + telemega-outline.svg \ + telemetrum.svg \ + telemini.svg + RELNOTES_XSL=$(RELNOTES:.html=.xsl) HTML=altusmetrum.html altos.html telemetry.html companion.html micropeak.html $(RELNOTES) PDF=altusmetrum.pdf altos.pdf telemetry.pdf companion.pdf micropeak.pdf @@ -21,7 +52,7 @@ DOC=$(HTML) $(PDF) HTMLSTYLE=/usr/share/xml/docbook/stylesheet/docbook-xsl/html/docbook.xsl FOSTYLE=xorg-fo.xsl PDFSTYLE= -IMAGES=telemetrum.svg telemini.svg +IMAGES=$(PICTURES) $(SVG) .SUFFIXES: .xsl .html .pdf diff --git a/doc/altosui.png b/doc/altosui.png new file mode 100644 index 00000000..3dd28de4 Binary files /dev/null and b/doc/altosui.png differ diff --git a/doc/altusmetrum.xsl b/doc/altusmetrum.xsl index 8725da04..dfe89438 100644 --- a/doc/altusmetrum.xsl +++ b/doc/altusmetrum.xsl @@ -5,11 +5,6 @@ The Altus Metrum System An Owner's Manual for Altus Metrum Rocketry Electronics - - - - - Bdale Garbee @@ -551,11 +546,13 @@ NAR #88757, TRA #12200
TeleMetrum - - - - - + + + + + + + TeleMetrum is a 1 inch by 2¾ inch circuit board. It was designed to fit inside coupler for 29mm air-frame tubing, but using it in a tube that @@ -571,11 +568,13 @@ NAR #88757, TRA #12200
TeleMini - - - - - + + + + + + + TeleMini v1.0 is ½ inches by 1½ inches. It was designed to fit inside an 18mm air-frame tube, but using it in @@ -590,11 +589,13 @@ NAR #88757, TRA #12200 the board, meaning an ideal “simple” avionics bay for TeleMini should have at least 9 inches of interior length. - - - - - + + + + + + + TeleMini v2.0 is 0.8 inches by 1½ inches. It adds more on-board data logging memory, a built-in USB connector and @@ -605,11 +606,13 @@ NAR #88757, TRA #12200
EasyMini - - - - - + + + + + + + EasyMini is built on a 0.8 inch by 1½ inch circuit board. It's designed to fit in a 24mm coupler tube. The connectors and @@ -619,11 +622,13 @@ NAR #88757, TRA #12200
TeleMega - - - - - + + + + + + + TeleMega is a 1¼ inch by 3¼ inch circuit board. It was designed to easily fit in a 38mm coupler. Like TeleMetrum, @@ -1356,6 +1361,13 @@ NAR #88757, TRA #12200 AltosUI + + + + + + + The AltosUI program provides a graphical user interface for interacting with the Altus Metrum product family. AltosUI can @@ -1365,11 +1377,6 @@ NAR #88757, TRA #12200 is split into sections, each of which documents one of the tasks provided from the top-level toolbar. - - - - -
Monitor Flight Receive, Record and Display Telemetry Data @@ -1379,6 +1386,13 @@ NAR #88757, TRA #12200 AltosUI will create a window to display telemetry data as received by the selected TeleDongle device. + + + + + + + All telemetry data received are automatically recorded in suitable log files. The name of the files includes the current @@ -1447,6 +1461,13 @@ NAR #88757, TRA #12200
Launch Pad + + + + + + + The 'Launch Pad' tab shows information used to decide when the rocket is ready for flight. The first elements include red/green @@ -1539,6 +1560,13 @@ NAR #88757, TRA #12200
Ascent + + + + + + + This tab is shown during Boost, Fast and Coast phases. The information displayed here helps monitor the @@ -1565,6 +1593,13 @@ NAR #88757, TRA #12200
Descent + + + + + + + Once the rocket has reached apogee and (we hope) activated the apogee charge, attention switches to tracking the rocket on @@ -1601,6 +1636,13 @@ NAR #88757, TRA #12200
Landed + + + + + + + Once the rocket is on the ground, attention switches to recovery. While the radio signal is often lost once the @@ -1636,8 +1678,32 @@ NAR #88757, TRA #12200 graph window for the current flight.
+
+ Table + + + + + + + + + The table view shows all of the data available from the + flight computer. Probably the most useful data on + this tab is the detailed GPS information, which includes + horizontal dilution of precision information, and + information about the signal being received from the satellites. + +
Site Map + + + + + + + When the TeleMetrum has a GPS fix, the Site Map tab will map the rocket's position to make it easier for you to locate the @@ -1721,50 +1787,28 @@ NAR #88757, TRA #12200 .eeprom file containing flight data saved from flash memory. + + Note that telemetry files will generally produce poor graphs + due to the lower sampling rate and missed telemetry packets. + Use saved flight data in .eeprom files for graphing where possible. + Once a flight record is selected, a window with multiple tabs is opened. - - - Flight Graph - - - By default, the graph contains acceleration (blue), - velocity (green) and altitude (red). - - - - - Configure Graph - - - This selects which graph elements to show, and, at the - very bottom, lets you switch between metric and - imperial units - - - - - Flight Statistics - - - Shows overall data computed from the flight. - - - - - Map - - - Shows a satellite image of the flight area overlaid - with the path of the flight. The red concentric - circles mark the launch pad, the black concentric - circles mark the landing location. - - - - +
+ Flight Graph + + + + + + + + + By default, the graph contains acceleration (blue), + velocity (green) and altitude (red). + The graph can be zoomed into a particular area by clicking and dragging down and to the right. Once zoomed, the graph can be @@ -1773,11 +1817,51 @@ NAR #88757, TRA #12200 The right mouse button causes a pop-up menu to be displayed, giving you the option save or print the plot. - - Note that telemetry files will generally produce poor graphs - due to the lower sampling rate and missed telemetry packets. - Use saved flight data in .eeprom files for graphing where possible. - +
+
+ Configure Graph + + + + + + + + + This selects which graph elements to show, and, at the + very bottom, lets you switch between metric and + imperial units + +
+
+ Flight Statistics + + + + + + + + + Shows overall data computed from the flight. + +
+
+ Map + + + + + + + + + Shows a satellite image of the flight area overlaid + with the path of the flight. The red concentric + circles mark the launch pad, the black concentric + circles mark the landing location. + +
Export Data @@ -1821,6 +1905,13 @@ NAR #88757, TRA #12200
Configure Altimeter + + + + + + + Select this button and then select either an altimeter or TeleDongle Device from the list provided. Selecting a TeleDongle @@ -2037,6 +2128,13 @@ NAR #88757, TRA #12200
Configure Pyro Channels + + + + + + + This opens a separate window to configure the additional pyro channels available on TeleMega. One column is @@ -2064,6 +2162,13 @@ NAR #88757, TRA #12200
Configure AltosUI + + + + + + + This button presents a dialog so that you can configure the AltosUI global settings. @@ -2075,18 +2180,24 @@ NAR #88757, TRA #12200 the current flight status. However, sometimes you don't want to hear them. - - - Enable—turns all voice announcements on and off - - - - Test Voice—Plays a short message allowing you to verify - that the audio system is working and the volume settings - are reasonable - - - + + + Enable + + Turns all voice announcements on and off + + + + Test Voice + + + Plays a short message allowing you to verify + that the audio system is working and the volume settings + are reasonable + + + +
Log Directory @@ -2161,6 +2272,13 @@ NAR #88757, TRA #12200
Configure Groundstation + + + + + + + Select this button and then select a TeleDongle Device from the list provided. @@ -2246,46 +2364,16 @@ NAR #88757, TRA #12200 (self programming). Please read the directions for flashing devices in the Updating Device Firmware chapter below. - - For “self programming”, connect USB to the device to be - programmed and push the 'Flash Image' button. That will - present a dialog box listing all of the connected - devices. Carefully select the device to be programmed. - - - For “pair programming”, once you have the programmer and - target devices connected, push the 'Flash Image' button. That - will present a dialog box listing all of the connected - devices. Carefully select the programmer device, not the - device to be programmed. - - - Next, select the image to flash to the device. These are named - with the product name and firmware version. The file selector - will start in the directory containing the firmware included - with the AltosUI package. Navigate to the directory containing - the desired firmware if it isn't there. - - - Next, a small dialog containing the device serial number and - RF calibration values should appear. If these values are - incorrect (possibly due to a corrupted image in the device), - enter the correct values here. - - - Finally, a dialog containing a progress bar will follow the - programming process. - - - When programming is complete, the target device will - reboot. Note that if a pair programmed target device is - connected via USB, you will have to unplug it and then plug it - back in for the USB connection to reset so that you can - communicate with the device again. -
Fire Igniter + + + + + + + This activates the igniter circuits in the flight computer to help test recovery systems deployment. Because this command can operate @@ -2313,6 +2401,13 @@ NAR #88757, TRA #12200
Scan Channels + + + + + + + This listens for telemetry packets on all of the configured frequencies, displaying information about each device it @@ -2324,6 +2419,13 @@ NAR #88757, TRA #12200
Load Maps + + + + + + + Before heading out to a new launch site, you can use this to load satellite images in case you don't have internet @@ -3978,11 +4080,13 @@ NAR #88757, TRA #12200 TeleMega has overall dimensions of 1.250 x 3.250 inches, and the mounting holes are sized for use with 4-40 or M3 screws. - - - - - + + + + + + +
TeleMetrum template @@ -3990,11 +4094,13 @@ NAR #88757, TRA #12200 TeleMetrum has overall dimensions of 1.000 x 2.750 inches, and the mounting holes are sized for use with 4-40 or M3 screws. - - - - - + + + + + + +
TeleMini v2/EasyMini template @@ -4002,11 +4108,13 @@ NAR #88757, TRA #12200 TeleMini v2 and EasyMini have overall dimensions of 0.800 x 1.500 inches, and the mounting holes are sized for use with 4-40 or M3 screws. - - - - - + + + + + + +
TeleMini v1 template @@ -4014,11 +4122,13 @@ NAR #88757, TRA #12200 TeleMini has overall dimensions of 0.500 x 1.500 inches, and the mounting holes are sized for use with 2-56 or M2 screws. - - - - - + + + + + + +
diff --git a/doc/ascent.png b/doc/ascent.png new file mode 100644 index 00000000..fd1cd09a Binary files /dev/null and b/doc/ascent.png differ diff --git a/doc/configure-altimeter.png b/doc/configure-altimeter.png new file mode 100644 index 00000000..afb19325 Binary files /dev/null and b/doc/configure-altimeter.png differ diff --git a/doc/configure-altosui.png b/doc/configure-altosui.png new file mode 100644 index 00000000..43fd400f Binary files /dev/null and b/doc/configure-altosui.png differ diff --git a/doc/configure-groundstation.png b/doc/configure-groundstation.png new file mode 100644 index 00000000..9f836e71 Binary files /dev/null and b/doc/configure-groundstation.png differ diff --git a/doc/configure-pyro.png b/doc/configure-pyro.png new file mode 100644 index 00000000..4f03c0a5 Binary files /dev/null and b/doc/configure-pyro.png differ diff --git a/doc/descent.png b/doc/descent.png new file mode 100644 index 00000000..0c479e72 Binary files /dev/null and b/doc/descent.png differ diff --git a/doc/device-selection.png b/doc/device-selection.png new file mode 100644 index 00000000..ffd067d7 Binary files /dev/null and b/doc/device-selection.png differ diff --git a/doc/fire-igniter.png b/doc/fire-igniter.png new file mode 100644 index 00000000..85804573 Binary files /dev/null and b/doc/fire-igniter.png differ diff --git a/doc/graph-configure.png b/doc/graph-configure.png new file mode 100644 index 00000000..b5888338 Binary files /dev/null and b/doc/graph-configure.png differ diff --git a/doc/graph-map.png b/doc/graph-map.png new file mode 100644 index 00000000..fd0fb134 Binary files /dev/null and b/doc/graph-map.png differ diff --git a/doc/graph-stats.png b/doc/graph-stats.png new file mode 100644 index 00000000..6f5c9791 Binary files /dev/null and b/doc/graph-stats.png differ diff --git a/doc/graph.png b/doc/graph.png new file mode 100644 index 00000000..c7c7b7d7 Binary files /dev/null and b/doc/graph.png differ diff --git a/doc/landed.png b/doc/landed.png new file mode 100644 index 00000000..7b4f3177 Binary files /dev/null and b/doc/landed.png differ diff --git a/doc/launch-pad.png b/doc/launch-pad.png new file mode 100644 index 00000000..a6f142dd Binary files /dev/null and b/doc/launch-pad.png differ diff --git a/doc/load-maps.png b/doc/load-maps.png new file mode 100644 index 00000000..dc7ea64c Binary files /dev/null and b/doc/load-maps.png differ diff --git a/doc/scan-channels.png b/doc/scan-channels.png new file mode 100644 index 00000000..bf6b6e53 Binary files /dev/null and b/doc/scan-channels.png differ diff --git a/doc/site-map.png b/doc/site-map.png new file mode 100644 index 00000000..a6d3f78b Binary files /dev/null and b/doc/site-map.png differ diff --git a/doc/table.png b/doc/table.png new file mode 100644 index 00000000..86cb9881 Binary files /dev/null and b/doc/table.png differ diff --git a/doc/xorg-fo.xsl b/doc/xorg-fo.xsl index 075a2d98..a36b88f3 100644 --- a/doc/xorg-fo.xsl +++ b/doc/xorg-fo.xsl @@ -113,4 +113,8 @@ + + center + +