doc: Switch to asciidoctor to format docs

[fw/altos] / doc / altosui.inc

diff --git a/doc/altosui.inc b/doc/altosui.inc
index 76a24d918960872663d42bfb2d9a869bc762210a..44f77acad47384b667557fc529790ab78cfc4df0 100644 (file)
--- a/doc/altosui.inc
+++ b/doc/altosui.inc
@@ -1,7 +1,7 @@
 == AltosUI
 
        .AltosUI Main Window
 == 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 AltosUI program provides a graphical user interface for
        interacting with the Altus Metrum product family. AltosUI can


@@ -12,10 +12,8 @@
        the tasks provided from the top-level toolbar.
 
        ifdef::radio[]
        the tasks provided from the top-level toolbar.
 
        ifdef::radio[]

+

        === Monitor Flight
        === 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
 
                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
                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
 
                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
                ==== 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
 
                        The 'Launch Pad' tab shows information used to decide when the
                        rocket is ready for flight. The first elements include red/green


@@ -146,7 +144,7 @@
                ==== Ascent
 
                        .Monitor Flight Ascent View
                ==== 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
 
                        This tab is shown during Boost, Fast and Coast
                        phases. The information displayed here helps monitor the


@@ -170,7 +168,7 @@
                ==== Descent
 
                        .Monitor Flight Descent View
                ==== 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
 
                        Once the rocket has reached apogee and (we hope)
                        activated the apogee charge, attention switches to


@@ -209,7 +207,7 @@
                ==== Landed
 
                        .Monitor Flight Landed View
                ==== 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
 
                        Once the rocket is on the ground, attention switches
                        to recovery. While the radio signal is often lost once


@@ -246,7 +244,7 @@
                ==== Table
 
                        .Monitor Flight Table View
                ==== 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
 
                        The table view shows all of the data available from the
                        flight computer. Probably the most useful data on


@@ -257,7 +255,7 @@
                ==== Site Map
 
                        .Monitor Flight Site Map View
                ==== 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
 
                        When the TeleMetrum has a GPS fix, the Site Map tab
                        will map the rocket's position to make it easier for


@@ -291,7 +289,7 @@
                ==== Igniter
 
                        .Monitor Flight Additional Igniter View
                ==== 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
 
                        TeleMega includes four additional programmable pyro
                        channels. The Ignitor tab shows whether each of them has


@@ -299,6 +297,7 @@
                        voltage measured here will be close to the pyro battery
                        voltage. A value greater than 3.2V is required for a 'GO'
                        status.
                        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[]
 
 
        endif::radio[]
 
 


@@ -375,7 +374,7 @@
                ==== Flight Graph
 
                        .Flight Data Graph
                ==== 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).
 
                        By default, the graph contains acceleration (blue),
                        velocity (green) and altitude (red).


@@ -392,16 +391,35 @@
                ==== Configure Graph
 
                        .Flight Graph Configuration
                ==== 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
 
                        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
 
                ==== Flight Statistics
 
                        .Flight Statistics

-                       image::graph-stats.png[width="5.5in"]
+                       image::graph-stats.png[width=400]

 
                        Shows overall data computed from the flight.
 
 
                        Shows overall data computed from the flight.
 


@@ -409,7 +427,7 @@
                ==== Map
 
                        .Flight Map
                ==== 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 red concentric
 
                        Shows a satellite image of the flight area overlaid
                        with the path of the flight. The red concentric


@@ -462,7 +480,7 @@
        === Configure Altimeter
 
                .Altimeter Configuration
        === 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
 
                ifdef::radio[]
                Select this button and then select either an altimeter or


@@ -504,24 +522,25 @@
 
                The rest of the dialog contains the parameters to be configured.
 
 
                The rest of the dialog contains the parameters to be configured.
 

-               include::config-device.raw[]
+               include::config-device.adoc[]

 
 
        === Configure AltosUI
 
                .Configure AltosUI Dialog
 
 
        === 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.
 
 
                This button presents a dialog so that you can
                configure the AltosUI global settings.
 

-               include::config-ui.raw[]
+               include::config-ui.adoc[]

 
        ifdef::radio[]
 
        ifdef::radio[]

+

        === Configure Groundstation
 
                .Configure Groundstation Dialog
        === 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.
 
                Select this button and then select a TeleDongle or
                TeleBT Device from the list provided.


@@ -592,8 +611,8 @@
                This reprograms Altus Metrum devices with new
                firmware.
                ifdef::telemetrum,telemini[]
                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[]
                        similar unit as a programming dongle (pair
                        programming).
                endif::telemetrum,telemini[]


@@ -612,7 +631,7 @@
        === Fire Igniter
 
                .Fire Igniter Window
        === 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
 
                This activates the igniter circuits in the flight
                computer to help test recovery systems


@@ -644,7 +663,7 @@
        === Scan Channels
 
                .Scan Channels Window
        === 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
 
                This listens for telemetry packets on all of the
                configured frequencies, displaying information about


@@ -656,14 +675,14 @@
        endif::radio[]
 
        ifdef::gps[]
        endif::radio[]
 
        ifdef::gps[]

-       include::load-maps.raw[]
+       include::load-maps.adoc[]

        endif::gps[]
 
        ifdef::radio[]
        === Monitor Idle
 
                .Monitor Idle Window
        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
 
                This brings up a dialog similar to the Monitor Flight
                UI, except it works with the altimeter in “idle” mode