X-Git-Url: https://git.gag.com/?p=fw%2Faltos;a=blobdiff_plain;f=doc%2Faltosui.inc;h=44f77acad47384b667557fc529790ab78cfc4df0;hp=df5a3ceea99cdee8090a1e97134a2aff29165d9d;hb=6d80b89c0bd82133dd5c93df8604f562ac49c19a;hpb=4c1206a47431c7d873228fdd7328e1b9ac93a390 diff --git a/doc/altosui.inc b/doc/altosui.inc index df5a3cee..44f77aca 100644 --- a/doc/altosui.inc +++ b/doc/altosui.inc @@ -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 @@ -11,10 +11,9 @@ chapter is split into sections, each of which documents one of the tasks provided from the top-level toolbar. + ifdef::radio[] + === Monitor Flight - //// - Receive, Record and Display Telemetry Data - //// Selecting this item brings up a dialog box listing all of the connected TeleDongle devices. When you choose @@ -23,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 @@ -83,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 @@ -145,7 +144,7 @@ ==== 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 @@ -169,7 +168,7 @@ ==== 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 @@ -208,7 +207,7 @@ ==== 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 @@ -245,7 +244,7 @@ ==== 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 @@ -256,7 +255,7 @@ ==== 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 @@ -290,7 +289,7 @@ ==== 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 @@ -299,25 +298,34 @@ voltage. A value greater than 3.2V is required for a 'GO' status. + endif::radio[] + + === Save Flight Data The altimeter records flight data to its internal - flash memory. TeleMetrum data is recorded at a much + flash memory. + ifdef::radio[] + Data logged on board is recorded at a much higher rate than the telemetry system can handle, and is not subject to radio drop-outs. As such, it provides a more complete and precise record of the - flight. The 'Save Flight Data' button allows you to + flight. + endif::radio[] + The 'Save Flight Data' button allows you to read the flash memory and write it to disk. Clicking on the 'Save Flight Data' button brings up a list of connected flight computers and TeleDongle devices. If you select a flight computer, the flight - data will be downloaded from that device directly. If - you select a TeleDongle device, flight data will be + data will be downloaded from that device directly. + ifdef::radio[] + If you select a TeleDongle device, flight data will be downloaded from a flight computer over radio link via - the specified TeleDongle. See the chapter on - Controlling An Altimeter Over The Radio Link for more - information. + the specified TeleDongle. See + <<_controlling_an_altimeter_over_the_radio_link>> for + more information. + endif::radio[] After the device has been selected, a dialog showing the flight data saved in the device will be shown @@ -342,8 +350,12 @@ flash memory. Once a flight record is selected, the flight monitor interface - is displayed and the flight is re-enacted in real time. Check - the Monitor Flight chapter above to learn how this window operates. + is displayed and the flight is re-enacted in real + time. + ifdef::radio[] + Check + <<_monitor_flight>> to learn how this window operates. + endif::radio[] === Graph Data @@ -362,7 +374,7 @@ ==== 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). @@ -379,28 +391,49 @@ ==== 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. + ifdef::gps[] ==== 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 circles mark the launch pad, the black concentric circles mark the landing location. + endif::gps[] === Export Data @@ -412,8 +445,11 @@ data, while .telem files contain receiver signal strength information. Next, a second dialog appears which is used to select where to write the resulting - file. It has a selector to choose between CSV and KML - file formats. + file. + ifdef::gps[] + It has a selector to choose between CSV and KML + file formats. + endif::gps[] ==== Comma Separated Value Format @@ -432,20 +468,29 @@ standard units, with the barometric data reported in both pressure, altitude and height above pad units. - ==== Keyhole Markup Language (for Google Earth) + ifdef::gps[] + ==== Keyhole Markup Language (for Google Earth) - This is the format used by Google Earth to provide an - overlay within that application. With this, you can - use Google Earth to see the whole flight path in 3D. + This is the format used by Google Earth to provide an + overlay within that application. With this, you can + use Google Earth to see the whole flight path + in 3D. + endif::gps[] === 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 TeleDongle Device from the list provided. Selecting a TeleDongle - device will use the radio link to configure a remote altimeter. + device will use the radio link to configure a remote + altimeter. + endif::radio[] + ifndef::radio[] + Select this button and then select an altimeter. + endif::radio[] The first few lines of the dialog provide information about the connected device, including the product name, @@ -477,23 +522,25 @@ 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. @@ -557,30 +604,44 @@ This lets you match the telemetry and packet link rate from the transmitter. If they don't match, the device won't receive any data. + endif::radio[] === Flash Image This reprograms Altus Metrum devices with new - firmware. TeleMetrum v1.x, TeleDongle v0.2, TeleMini - and TeleBT are all reprogrammed by using another - similar unit as a programming dongle (pair - programming). TeleMega, EasyMega, TeleMetrum v2, - EasyMini and TeleDongle v3 are all programmed directly - over their USB ports (self programming). Please read - the directions for flashing devices in the Updating - Device Firmware chapter below. + firmware. + ifdef::telemetrum,telemini[] + 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[] + EasyMini is + endif::telemega,easymega,telemetrum[] + programmed directly + over USB (self programming). Please read + the directions for flashing devices in + <<_updating_device_firmware>>. === 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 - deployment. Because this command can operate over the + deployment. + ifdef::radio[] + Because this command can operate over the Packet Command Link, you can prepare the rocket as for flight and then test the recovery system without needing to snake wires inside the air-frame. + endif::radio[] Selecting the 'Fire Igniter' button brings up the usual device selection dialog. Pick the desired @@ -598,10 +659,11 @@ point you start over again at selecting the desired igniter. + ifdef::radio[] === 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 @@ -610,13 +672,17 @@ be tried; by default, it only listens at 38400 baud with the standard telemetry format used in v1.0 and later firmware. + endif::radio[] - include::load-maps.raw[] + ifdef::gps[] + 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 @@ -632,3 +698,4 @@ communicate with the flight computer; they must both match the configuration in the flight computer exactly. + endif::radio[]