altos/test: Adjust CRC error rate after FEC fix
[fw/altos] / doc / altosui.inc
index 76a24d918960872663d42bfb2d9a869bc762210a..a0aab0bd5edac392a25312fda90e1d5834f213be 100644 (file)
@@ -1,7 +1,7 @@
 == AltosUI
 
        .AltosUI Main Window
-       image::altosui.png[width="4.6in"]
+       image::altosui.png[width=450]
 
        The AltosUI program provides a graphical user interface for
        interacting with the Altus Metrum product family. AltosUI can
        the tasks provided from the top-level toolbar.
 
        ifdef::radio[]
+
        === Monitor Flight
-       ////
-             <subtitle>Receive, Record and Display Telemetry Data</subtitle>
-       ////
 
                Selecting this item brings up a dialog box listing all
                of the connected TeleDongle devices. When you choose
@@ -24,7 +22,7 @@
                device.
 
                .Device Selection Dialog
-               image::device-selection.png[width="3.1in"]
+               image::device-selection.png[width=300]
 
                All telemetry data received are automatically recorded
                in suitable log files. The name of the files includes
@@ -84,7 +82,7 @@
                ==== Launch Pad
 
                        .Monitor Flight Launch Pad View
-                       image::launch-pad.png[width="5.5in"]
+                       image::launch-pad.png[width=400]
 
                        The 'Launch Pad' tab shows information used to decide when the
                        rocket is ready for flight. The first elements include red/green
                ==== Ascent
 
                        .Monitor Flight Ascent View
-                       image::ascent.png[width="5.5in"]
+                       image::ascent.png[width=400]
 
                        This tab is shown during Boost, Fast and Coast
                        phases. The information displayed here helps monitor the
                ==== Descent
 
                        .Monitor Flight Descent View
-                       image::descent.png[width="5.5in"]
+                       image::descent.png[width=400]
 
                        Once the rocket has reached apogee and (we hope)
                        activated the apogee charge, attention switches to
                ==== Landed
 
                        .Monitor Flight Landed View
-                       image::landed.png[width="5.5in"]
+                       image::landed.png[width=400]
 
                        Once the rocket is on the ground, attention switches
                        to recovery. While the radio signal is often lost once
                ==== Table
 
                        .Monitor Flight Table View
-                       image::table.png[width="5.5in"]
+                       image::table.png[width=400]
 
                        The table view shows all of the data available from the
                        flight computer. Probably the most useful data on
                ==== Site Map
 
                        .Monitor Flight Site Map View
-                       image::site-map.png[width="5.5in"]
+                       image::site-map.png[width=400]
 
                        When the TeleMetrum has a GPS fix, the Site Map tab
                        will map the rocket's position to make it easier for
                ==== Igniter
 
                        .Monitor Flight Additional Igniter View
-                       image::ignitor.png[width="5.5in"]
+                       image::ignitor.png[width=400]
 
                        TeleMega includes four additional programmable pyro
                        channels. The Ignitor tab shows whether each of them has
                        voltage measured here will be close to the pyro battery
                        voltage. A value greater than 3.2V is required for a 'GO'
                        status.
+
        endif::radio[]
 
 
                ==== Flight Graph
 
                        .Flight Data Graph
-                       image::graph.png[width="5.5in"]
+                       image::graph.png[width=400]
 
                        By default, the graph contains acceleration (blue),
                        velocity (green) and altitude (red).
                ==== Configure Graph
 
                        .Flight Graph Configuration
-                       image::graph-configure.png[width="5.5in"]
+                       image::graph-configure.png[width=400]
 
                        This selects which graph elements to show, and, at the
-                       very bottom, lets you switch between metric and
-                       imperial units
+                       very bottom. It also lets you configure how
+                       the graph is drawn:
+
+                       * Whether to use metric or imperial units
+
+                       * Whether to show a marker at each data
+                          point. When displaying a small section of
+                          the graph, these can be useful to know what
+                          data values were recorded.
+
+                       * How wide to draw the lines in the graph
+
+                       * How to filter speed and acceleration data
+                          computed from barometric data. Flight
+                          computers with accelerometers never display
+                          computed acceleration data, and only use
+                          barometric data to compute speed during
+                          descent. Flight computers without
+                          accelerometers always compute both speed and
+                          acceleration from barometric data. A larger
+                          value smooths the data more.
 
                ==== Flight Statistics
 
                        .Flight Statistics
-                       image::graph-stats.png[width="5.5in"]
+                       image::graph-stats.png[width=400]
 
                        Shows overall data computed from the flight.
 
                ==== Map
 
                        .Flight Map
-                       image::graph-map.png[width="5.5in"]
+                       image::graph-map.png[width=400]
+
+                       Shows a satellite image of the flight area
+                       overlaid with the path of the flight. The
+                       flight path will have different colored
+                       sections for each state of the flight (just
+                       like the Site Map in Monitor Flight mode):
+                       white for pad, red for boost, pink for fast,
+                       yellow for coast, light blue for drogue, dark
+                       blue for main, and black for landed.
+
+                       The red concentric circles mark the launch
+                       pad, the black concentric circles mark the
+                       landing location. Data for the point along the
+                       along the flight path nearest the cursor will
+                       be displayed at the bottom of the window. This
+                       data includes flight time (so you can
+                       correlate data in the graph window), latitude,
+                       longitude, height above ground and vertical
+                       speed. The selected point will be highlighted
+                       with concentric circles in the same color as
+                       the flight path at that point.
 
-                       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.
                endif::gps[]
 
        === Export Data
        === Configure Altimeter
 
                .Altimeter Configuration
-               image::configure-altimeter.png[width="3.6in"]
+               image::configure-altimeter.png[width=350]
 
                ifdef::radio[]
                Select this button and then select either an altimeter or
 
                The rest of the dialog contains the parameters to be configured.
 
-               include::config-device.raw[]
+               include::config-device.adoc[]
 
 
        === Configure AltosUI
 
                .Configure AltosUI Dialog
-               image::configure-altosui.png[width="2.4in"]
+               image::configure-altosui.png[width=230]
 
                This button presents a dialog so that you can
                configure the AltosUI global settings.
 
-               include::config-ui.raw[]
+               include::config-ui.adoc[]
 
        ifdef::radio[]
+
        === Configure Groundstation
 
                .Configure Groundstation Dialog
-               image::configure-groundstation.png[width="3.1in"]
+               image::configure-groundstation.png[width=300]
 
                Select this button and then select a TeleDongle or
                TeleBT Device from the list provided.
                This reprograms Altus Metrum devices with new
                firmware.
                ifdef::telemetrum,telemini[]
-                       TeleMetrum v1.x, TeleDongle v0.2, TeleMini
-                       and TeleBT are all reprogrammed by using another
+                       TeleMetrum v1.x, TeleDongle v0.2, TeleMini v1.0
+                       and TeleBT v1.0 are all reprogrammed by using another
                        similar unit as a programming dongle (pair
                        programming).
                endif::telemetrum,telemini[]
-               ifdef::telemega,easymega,telemetrum[]
-                       TeleMega, EasyMega, TeleMetrum v2,
-                       EasyMini and TeleDongle v3 are all
-               endif::telemega,easymega,telemetrum[]
-               ifndef::telemega,easymega,telemetrum[]
+               ifdef::telemega,easymega,easytimer,telemetrum[]
+                       TeleMega, EasyMega, TeleMetrum v2 or newer,
+                       EasyMini, EasyTimer, TeleBT v3 or newer and TeleDongle v3
+                       or newer are all
+               endif::telemega,easymega,easytimer,telemetrum[]
+               ifndef::telemega,easymega,easytimer,telemetrum[]
                        EasyMini is
-               endif::telemega,easymega,telemetrum[]
+               endif::telemega,easymega,easytimer,telemetrum[]
                programmed directly
                over USB (self programming). Please read
                the directions for flashing devices in
        === Fire Igniter
 
                .Fire Igniter Window
-               image::fire-igniter.png[width="1.2in"]
+               image::fire-igniter.png[width=120]
 
                This activates the igniter circuits in the flight
                computer to help test recovery systems
        === Scan Channels
 
                .Scan Channels Window
-               image::scan-channels.png[width="3.2in"]
+               image::scan-channels.png[width=300]
 
                This listens for telemetry packets on all of the
                configured frequencies, displaying information about
        endif::radio[]
 
        ifdef::gps[]
-       include::load-maps.raw[]
+       include::load-maps.adoc[]
        endif::gps[]
 
        ifdef::radio[]
        === Monitor Idle
 
                .Monitor Idle Window
-               image::monitor-idle.png[width="5.2in"]
+               image::monitor-idle.png[width=500]
 
                This brings up a dialog similar to the Monitor Flight
                UI, except it works with the altimeter in “idle” mode