summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBdale Garbee <bdale@gag.com>2011-12-25 19:17:20 -0700
committerBdale Garbee <bdale@gag.com>2011-12-25 19:17:20 -0700
commita0b08b4920d559f998db7608f0362f904d554356 (patch)
treeb04f4e3d91e32097e902fc166b0830a43c3335cc
parent3d94937bd78c01802c266240bb304fa26cd5e856 (diff)
update docs
Diffstat
-rw-r--r--AltOS/doc/altos.html168
-rw-r--r--AltOS/doc/altos.pdfbin107595 -> 107595 bytes
-rw-r--r--AltOS/doc/altusmetrum.html169
-rw-r--r--AltOS/doc/altusmetrum.pdfbin164894 -> 165038 bytes
-rw-r--r--AltOS/doc/release-notes-0.7.1.html2
-rw-r--r--AltOS/doc/release-notes-0.8.html2
-rw-r--r--AltOS/doc/release-notes-0.9.2.html2
-rw-r--r--AltOS/doc/release-notes-0.9.html2
-rw-r--r--AltOS/doc/release-notes-1.0.1.html2
-rw-r--r--AltOS/doc/release-notes-1.0.2.html2
-rw-r--r--AltOS/doc/release-notes-1.0.3.html10
-rw-r--r--AltOS/doc/telemetry.html36
-rw-r--r--AltOS/doc/telemetry.pdfbin34577 -> 34577 bytes
13 files changed, 207 insertions, 188 deletions
diff --git a/AltOS/doc/altos.html b/AltOS/doc/altos.html
index 9c0792b..b534cd9 100644
--- a/AltOS/doc/altos.html
+++ b/AltOS/doc/altos.html
@@ -1,10 +1,10 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>AltOS</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book" title="AltOS"><div class="titlepage"><div><div><h1 class="title"><a name="idm14563456"></a>AltOS</h1></div><div><h2 class="subtitle">Altos Metrum Operating System</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Keith</span> <span class="surname">Packard</span></h3></div></div><div><p class="copyright">Copyright © 2010 Keith Packard</p></div><div><div class="legalnotice" title="Legal Notice"><a name="idp1614752"></a><p>
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>AltOS</title><meta name="generator" content="DocBook XSL Stylesheets V1.76.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book" title="AltOS"><div class="titlepage"><div><div><h1 class="title"><a name="idm14881448"></a>AltOS</h1></div><div><h2 class="subtitle">Altos Metrum Operating System</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Keith</span> <span class="surname">Packard</span></h3></div></div><div><p class="copyright">Copyright © 2010 Keith Packard</p></div><div><div class="legalnotice" title="Legal Notice"><a name="idp1531328"></a><p>
This document is released under the terms of the
<a class="ulink" href="http://creativecommons.org/licenses/by-sa/3.0/" target="_top">
Creative Commons ShareAlike 3.0
</a>
license.
- </p></div></div><div><div class="revhistory"><table border="1" width="100%" summary="Revision history"><tr><th align="left" valign="top" colspan="2"><b>Revision History</b></th></tr><tr><td align="left">Revision 0.1</td><td align="left">22 November 2010</td></tr><tr><td align="left" colspan="2">Initial content</td></tr></table></div></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="#idp2682856">1. Overview</a></span></dt><dt><span class="chapter"><a href="#idp2398120">2. Programming the 8051 with SDCC</a></span></dt><dd><dl><dt><span class="section"><a href="#idp898968">1. 8051 memory spaces</a></span></dt><dd><dl><dt><span class="section"><a href="#idp2023952">1.1. __data</a></span></dt><dt><span class="section"><a href="#idp3558352">1.2. __idata</a></span></dt><dt><span class="section"><a href="#idp2842744">1.3. __xdata</a></span></dt><dt><span class="section"><a href="#idp2384616">1.4. __pdata</a></span></dt><dt><span class="section"><a href="#idp2387640">1.5. __code</a></span></dt><dt><span class="section"><a href="#idp2712072">1.6. __bit</a></span></dt><dt><span class="section"><a href="#idp2470984">1.7. __sfr, __sfr16, __sfr32, __sbit</a></span></dt></dl></dd><dt><span class="section"><a href="#idp3567856">2. Function calls on the 8051</a></span></dt><dd><dl><dt><span class="section"><a href="#idp3012760">2.1. __reentrant functions</a></span></dt><dt><span class="section"><a href="#idp3274328">2.2. Non __reentrant functions</a></span></dt><dt><span class="section"><a href="#idp1868232">2.3. __interrupt functions</a></span></dt><dt><span class="section"><a href="#idp2323224">2.4. __critical functions and statements</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#idp2522240">3. Task functions</a></span></dt><dd><dl><dt><span class="section"><a href="#idp1968112">1. ao_add_task</a></span></dt><dt><span class="section"><a href="#idp3359576">2. ao_exit</a></span></dt><dt><span class="section"><a href="#idp3085968">3. ao_sleep</a></span></dt><dt><span class="section"><a href="#idp3004432">4. ao_wakeup</a></span></dt><dt><span class="section"><a href="#idp2423736">5. ao_alarm</a></span></dt><dt><span class="section"><a href="#idp2605456">6. ao_start_scheduler</a></span></dt><dt><span class="section"><a href="#idp3312896">7. ao_clock_init</a></span></dt></dl></dd><dt><span class="chapter"><a href="#idp2103648">4. Timer Functions</a></span></dt><dd><dl><dt><span class="section"><a href="#idp2407008">1. ao_time</a></span></dt><dt><span class="section"><a href="#idp2512832">2. ao_delay</a></span></dt><dt><span class="section"><a href="#idp2252856">3. ao_timer_set_adc_interval</a></span></dt><dt><span class="section"><a href="#idp3005352">4. ao_timer_init</a></span></dt></dl></dd><dt><span class="chapter"><a href="#idp3256712">5. AltOS Mutexes</a></span></dt><dd><dl><dt><span class="section"><a href="#idp2419784">1. ao_mutex_get</a></span></dt><dt><span class="section"><a href="#idp3558880">2. ao_mutex_put</a></span></dt></dl></dd><dt><span class="chapter"><a href="#idp1927912">6. CC1111 DMA engine</a></span></dt><dd><dl><dt><span class="section"><a href="#idp3033536">1. ao_dma_alloc</a></span></dt><dt><span class="section"><a href="#idp3322920">2. ao_dma_set_transfer</a></span></dt><dt><span class="section"><a href="#idp2415360">3. ao_dma_start</a></span></dt><dt><span class="section"><a href="#idp2383728">4. ao_dma_trigger</a></span></dt><dt><span class="section"><a href="#idp1636944">5. ao_dma_abort</a></span></dt></dl></dd><dt><span class="chapter"><a href="#idp3215304">7. SDCC Stdio interface</a></span></dt><dd><dl><dt><span class="section"><a href="#idp2502672">1. putchar</a></span></dt><dt><span class="section"><a href="#idp2459944">2. getchar</a></span></dt><dt><span class="section"><a href="#idp2914760">3. flush</a></span></dt><dt><span class="section"><a href="#idp2873064">4. ao_add_stdio</a></span></dt></dl></dd><dt><span class="chapter"><a href="#idp2170912">8. Command line interface</a></span></dt><dd><dl><dt><span class="section"><a href="#idp3529992">1. ao_cmd_register</a></span></dt><dt><span class="section"><a href="#idp2645232">2. ao_cmd_lex</a></span></dt><dt><span class="section"><a href="#idp2564824">3. ao_cmd_put16</a></span></dt><dt><span class="section"><a href="#idp3113528">4. ao_cmd_put8</a></span></dt><dt><span class="section"><a href="#idp1935488">5. ao_cmd_white</a></span></dt><dt><span class="section"><a href="#idp1896024">6. ao_cmd_hex</a></span></dt><dt><span class="section"><a href="#idp2433952">7. ao_cmd_decimal</a></span></dt><dt><span class="section"><a href="#idp2883960">8. ao_match_word</a></span></dt><dt><span class="section"><a href="#idp3489544">9. ao_cmd_init</a></span></dt></dl></dd><dt><span class="chapter"><a href="#idp2151344">9. CC1111 USB target device</a></span></dt><dd><dl><dt><span class="section"><a href="#idp2038816">1. ao_usb_flush</a></span></dt><dt><span class="section"><a href="#idp2901984">2. ao_usb_putchar</a></span></dt><dt><span class="section"><a href="#idp1930120">3. ao_usb_pollchar</a></span></dt><dt><span class="section"><a href="#idp2176008">4. ao_usb_getchar</a></span></dt><dt><span class="section"><a href="#idp1694928">5. ao_usb_disable</a></span></dt><dt><span class="section"><a href="#idp2859448">6. ao_usb_enable</a></span></dt><dt><span class="section"><a href="#idp2323496">7. ao_usb_init</a></span></dt></dl></dd><dt><span class="chapter"><a href="#idp3103048">10. CC1111 Serial peripheral</a></span></dt><dd><dl><dt><span class="section"><a href="#idp864464">1. ao_serial_getchar</a></span></dt><dt><span class="section"><a href="#idp2883824">2. ao_serial_putchar</a></span></dt><dt><span class="section"><a href="#idp1519672">3. ao_serial_drain</a></span></dt><dt><span class="section"><a href="#idp2341432">4. ao_serial_set_speed</a></span></dt><dt><span class="section"><a href="#idp1472312">5. ao_serial_init</a></span></dt></dl></dd><dt><span class="chapter"><a href="#idp1597944">11. CC1111 Radio peripheral</a></span></dt><dd><dl><dt><span class="section"><a href="#idp2842880">1. ao_radio_set_telemetry</a></span></dt><dt><span class="section"><a href="#idp2488848">2. ao_radio_set_packet</a></span></dt><dt><span class="section"><a href="#idp3223464">3. ao_radio_set_rdf</a></span></dt><dt><span class="section"><a href="#idp3006000">4. ao_radio_idle</a></span></dt><dt><span class="section"><a href="#idp2577544">5. ao_radio_get</a></span></dt><dt><span class="section"><a href="#idp2990720">6. ao_radio_put</a></span></dt><dt><span class="section"><a href="#idp2892440">7. ao_radio_abort</a></span></dt><dt><span class="section"><a href="#idp2871216">8. ao_radio_send</a></span></dt><dt><span class="section"><a href="#idp2464440">9. ao_radio_recv</a></span></dt><dt><span class="section"><a href="#idp2485328">10. ao_radio_rdf</a></span></dt><dt><span class="section"><a href="#idp2075376">11. ao_packet_putchar</a></span></dt><dt><span class="section"><a href="#idp2237088">12. ao_packet_pollchar</a></span></dt><dt><span class="section"><a href="#idp2384480">13. ao_packet_slave_start</a></span></dt><dt><span class="section"><a href="#idp2780480">14. ao_packet_slave_stop</a></span></dt><dt><span class="section"><a href="#idp2387432">15. ao_packet_slave_init</a></span></dt><dt><span class="section"><a href="#idp2526032">16. ao_packet_master_init</a></span></dt></dl></dd></dl></div><div class="chapter" title="Chapter 1. Overview"><div class="titlepage"><div><div><h2 class="title"><a name="idp2682856"></a>Chapter 1. Overview</h2></div></div></div><p>
+ </p></div></div><div><div class="revhistory"><table border="1" width="100%" summary="Revision history"><tr><th align="left" valign="top" colspan="2"><b>Revision History</b></th></tr><tr><td align="left">Revision 0.1</td><td align="left">22 November 2010</td></tr><tr><td align="left" colspan="2">Initial content</td></tr></table></div></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="#idp2541064">1. Overview</a></span></dt><dt><span class="chapter"><a href="#idp2184760">2. Programming the 8051 with SDCC</a></span></dt><dd><dl><dt><span class="section"><a href="#idp2923776">1. 8051 memory spaces</a></span></dt><dd><dl><dt><span class="section"><a href="#idp2530432">1.1. __data</a></span></dt><dt><span class="section"><a href="#idp2541216">1.2. __idata</a></span></dt><dt><span class="section"><a href="#idp1706256">1.3. __xdata</a></span></dt><dt><span class="section"><a href="#idp2483496">1.4. __pdata</a></span></dt><dt><span class="section"><a href="#idp2405544">1.5. __code</a></span></dt><dt><span class="section"><a href="#idp2009320">1.6. __bit</a></span></dt><dt><span class="section"><a href="#idp1699616">1.7. __sfr, __sfr16, __sfr32, __sbit</a></span></dt></dl></dd><dt><span class="section"><a href="#idp2333480">2. Function calls on the 8051</a></span></dt><dd><dl><dt><span class="section"><a href="#idp2088600">2.1. __reentrant functions</a></span></dt><dt><span class="section"><a href="#idp3083416">2.2. Non __reentrant functions</a></span></dt><dt><span class="section"><a href="#idp2104128">2.3. __interrupt functions</a></span></dt><dt><span class="section"><a href="#idp3241688">2.4. __critical functions and statements</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#idp1985864">3. Task functions</a></span></dt><dd><dl><dt><span class="section"><a href="#idp2174488">1. ao_add_task</a></span></dt><dt><span class="section"><a href="#idp2864400">2. ao_exit</a></span></dt><dt><span class="section"><a href="#idp3396632">3. ao_sleep</a></span></dt><dt><span class="section"><a href="#idp3184328">4. ao_wakeup</a></span></dt><dt><span class="section"><a href="#idp3259984">5. ao_alarm</a></span></dt><dt><span class="section"><a href="#idp2199168">6. ao_start_scheduler</a></span></dt><dt><span class="section"><a href="#idp2195744">7. ao_clock_init</a></span></dt></dl></dd><dt><span class="chapter"><a href="#idp2424776">4. Timer Functions</a></span></dt><dd><dl><dt><span class="section"><a href="#idp2205760">1. ao_time</a></span></dt><dt><span class="section"><a href="#idp3534312">2. ao_delay</a></span></dt><dt><span class="section"><a href="#idp2999280">3. ao_timer_set_adc_interval</a></span></dt><dt><span class="section"><a href="#idp2745080">4. ao_timer_init</a></span></dt></dl></dd><dt><span class="chapter"><a href="#idp3144392">5. AltOS Mutexes</a></span></dt><dd><dl><dt><span class="section"><a href="#idp2328776">1. ao_mutex_get</a></span></dt><dt><span class="section"><a href="#idp2317480">2. ao_mutex_put</a></span></dt></dl></dd><dt><span class="chapter"><a href="#idp1618880">6. CC1111 DMA engine</a></span></dt><dd><dl><dt><span class="section"><a href="#idp1615992">1. ao_dma_alloc</a></span></dt><dt><span class="section"><a href="#idp2240456">2. ao_dma_set_transfer</a></span></dt><dt><span class="section"><a href="#idp3534584">3. ao_dma_start</a></span></dt><dt><span class="section"><a href="#idp2915488">4. ao_dma_trigger</a></span></dt><dt><span class="section"><a href="#idp3341456">5. ao_dma_abort</a></span></dt></dl></dd><dt><span class="chapter"><a href="#idp2847616">7. SDCC Stdio interface</a></span></dt><dd><dl><dt><span class="section"><a href="#idp2019072">1. putchar</a></span></dt><dt><span class="section"><a href="#idp1897520">2. getchar</a></span></dt><dt><span class="section"><a href="#idp2228808">3. flush</a></span></dt><dt><span class="section"><a href="#idp2556232">4. ao_add_stdio</a></span></dt></dl></dd><dt><span class="chapter"><a href="#idp3547824">8. Command line interface</a></span></dt><dd><dl><dt><span class="section"><a href="#idp3082736">1. ao_cmd_register</a></span></dt><dt><span class="section"><a href="#idp3074496">2. ao_cmd_lex</a></span></dt><dt><span class="section"><a href="#idp1391912">3. ao_cmd_put16</a></span></dt><dt><span class="section"><a href="#idp1870472">4. ao_cmd_put8</a></span></dt><dt><span class="section"><a href="#idp3387136">5. ao_cmd_white</a></span></dt><dt><span class="section"><a href="#idp2423424">6. ao_cmd_hex</a></span></dt><dt><span class="section"><a href="#idp3507240">7. ao_cmd_decimal</a></span></dt><dt><span class="section"><a href="#idp2905560">8. ao_match_word</a></span></dt><dt><span class="section"><a href="#idp2254256">9. ao_cmd_init</a></span></dt></dl></dd><dt><span class="chapter"><a href="#idp2515408">9. CC1111 USB target device</a></span></dt><dd><dl><dt><span class="section"><a href="#idp2405816">1. ao_usb_flush</a></span></dt><dt><span class="section"><a href="#idp3103416">2. ao_usb_putchar</a></span></dt><dt><span class="section"><a href="#idp2363712">3. ao_usb_pollchar</a></span></dt><dt><span class="section"><a href="#idp2775744">4. ao_usb_getchar</a></span></dt><dt><span class="section"><a href="#idp2910608">5. ao_usb_disable</a></span></dt><dt><span class="section"><a href="#idp2866200">6. ao_usb_enable</a></span></dt><dt><span class="section"><a href="#idp3079952">7. ao_usb_init</a></span></dt></dl></dd><dt><span class="chapter"><a href="#idp2600312">10. CC1111 Serial peripheral</a></span></dt><dd><dl><dt><span class="section"><a href="#idp2173288">1. ao_serial_getchar</a></span></dt><dt><span class="section"><a href="#idp2723344">2. ao_serial_putchar</a></span></dt><dt><span class="section"><a href="#idp2744704">3. ao_serial_drain</a></span></dt><dt><span class="section"><a href="#idp1337864">4. ao_serial_set_speed</a></span></dt><dt><span class="section"><a href="#idp1403336">5. ao_serial_init</a></span></dt></dl></dd><dt><span class="chapter"><a href="#idp1372064">11. CC1111 Radio peripheral</a></span></dt><dd><dl><dt><span class="section"><a href="#idp3389240">1. ao_radio_set_telemetry</a></span></dt><dt><span class="section"><a href="#idp3464080">2. ao_radio_set_packet</a></span></dt><dt><span class="section"><a href="#idp2729008">3. ao_radio_set_rdf</a></span></dt><dt><span class="section"><a href="#idp3208384">4. ao_radio_idle</a></span></dt><dt><span class="section"><a href="#idp1939952">5. ao_radio_get</a></span></dt><dt><span class="section"><a href="#idp2122544">6. ao_radio_put</a></span></dt><dt><span class="section"><a href="#idp2877608">7. ao_radio_abort</a></span></dt><dt><span class="section"><a href="#idp2776168">8. ao_radio_send</a></span></dt><dt><span class="section"><a href="#idp3257800">9. ao_radio_recv</a></span></dt><dt><span class="section"><a href="#idp3063088">10. ao_radio_rdf</a></span></dt><dt><span class="section"><a href="#idp2493216">11. ao_packet_putchar</a></span></dt><dt><span class="section"><a href="#idp3315344">12. ao_packet_pollchar</a></span></dt><dt><span class="section"><a href="#idp2923640">13. ao_packet_slave_start</a></span></dt><dt><span class="section"><a href="#idp2890520">14. ao_packet_slave_stop</a></span></dt><dt><span class="section"><a href="#idp2676120">15. ao_packet_slave_init</a></span></dt><dt><span class="section"><a href="#idp3431952">16. ao_packet_master_init</a></span></dt></dl></dd></dl></div><div class="chapter" title="Chapter 1. Overview"><div class="titlepage"><div><div><h2 class="title"><a name="idp2541064"></a>Chapter 1. Overview</h2></div></div></div><p>
AltOS is a operating system built for the 8051-compatible
processor found in the TI cc1111 microcontroller. It's designed
to be small and easy to program with. The main features are:
@@ -61,7 +61,7 @@
</pre><p>
As you can see, a long sequence of subsystems are initialized
and then the scheduler is started.
- </p></div><div class="chapter" title="Chapter 2. Programming the 8051 with SDCC"><div class="titlepage"><div><div><h2 class="title"><a name="idp2398120"></a>Chapter 2. Programming the 8051 with SDCC</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#idp898968">1. 8051 memory spaces</a></span></dt><dd><dl><dt><span class="section"><a href="#idp2023952">1.1. __data</a></span></dt><dt><span class="section"><a href="#idp3558352">1.2. __idata</a></span></dt><dt><span class="section"><a href="#idp2842744">1.3. __xdata</a></span></dt><dt><span class="section"><a href="#idp2384616">1.4. __pdata</a></span></dt><dt><span class="section"><a href="#idp2387640">1.5. __code</a></span></dt><dt><span class="section"><a href="#idp2712072">1.6. __bit</a></span></dt><dt><span class="section"><a href="#idp2470984">1.7. __sfr, __sfr16, __sfr32, __sbit</a></span></dt></dl></dd><dt><span class="section"><a href="#idp3567856">2. Function calls on the 8051</a></span></dt><dd><dl><dt><span class="section"><a href="#idp3012760">2.1. __reentrant functions</a></span></dt><dt><span class="section"><a href="#idp3274328">2.2. Non __reentrant functions</a></span></dt><dt><span class="section"><a href="#idp1868232">2.3. __interrupt functions</a></span></dt><dt><span class="section"><a href="#idp2323224">2.4. __critical functions and statements</a></span></dt></dl></dd></dl></div><p>
+ </p></div><div class="chapter" title="Chapter 2. Programming the 8051 with SDCC"><div class="titlepage"><div><div><h2 class="title"><a name="idp2184760"></a>Chapter 2. Programming the 8051 with SDCC</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#idp2923776">1. 8051 memory spaces</a></span></dt><dd><dl><dt><span class="section"><a href="#idp2530432">1.1. __data</a></span></dt><dt><span class="section"><a href="#idp2541216">1.2. __idata</a></span></dt><dt><span class="section"><a href="#idp1706256">1.3. __xdata</a></span></dt><dt><span class="section"><a href="#idp2483496">1.4. __pdata</a></span></dt><dt><span class="section"><a href="#idp2405544">1.5. __code</a></span></dt><dt><span class="section"><a href="#idp2009320">1.6. __bit</a></span></dt><dt><span class="section"><a href="#idp1699616">1.7. __sfr, __sfr16, __sfr32, __sbit</a></span></dt></dl></dd><dt><span class="section"><a href="#idp2333480">2. Function calls on the 8051</a></span></dt><dd><dl><dt><span class="section"><a href="#idp2088600">2.1. __reentrant functions</a></span></dt><dt><span class="section"><a href="#idp3083416">2.2. Non __reentrant functions</a></span></dt><dt><span class="section"><a href="#idp2104128">2.3. __interrupt functions</a></span></dt><dt><span class="section"><a href="#idp3241688">2.4. __critical functions and statements</a></span></dt></dl></dd></dl></div><p>
The 8051 is a primitive 8-bit processor, designed in the mists
of time in as few transistors as possible. The architecture is
highly irregular and includes several separate memory
@@ -69,7 +69,7 @@
stack itself is of limited size. While SDCC papers over the
instruction set, it is not completely able to hide the memory
architecture from the application designer.
- </p><div class="section" title="1. 8051 memory spaces"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp898968"></a>1. 8051 memory spaces</h2></div></div></div><p>
+ </p><div class="section" title="1. 8051 memory spaces"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2923776"></a>1. 8051 memory spaces</h2></div></div></div><p>
The __data/__xdata/__code memory spaces below were completely
separate in the original 8051 design. In the cc1111, this
isn't true&#8212;they all live in a single unified 64kB address
@@ -83,7 +83,7 @@
is decorated with a memory space identifier which clutters the
code but makes the resulting code far smaller and more
efficient.
- </p><div class="section" title="1.1. __data"><div class="titlepage"><div><div><h3 class="title"><a name="idp2023952"></a>1.1. __data</h3></div></div></div><p>
+ </p><div class="section" title="1.1. __data"><div class="titlepage"><div><div><h3 class="title"><a name="idp2530432"></a>1.1. __data</h3></div></div></div><p>
The 8051 can directly address these 128 bytes of
memory. This makes them precious so they should be
reserved for frequently addressed values. Oh, just to
@@ -93,42 +93,42 @@
these registers located at 0x00 - 0x1F. AltOS uses only
the first bank at 0x00 - 0x07, leaving the other 24
bytes available for other data.
- </p></div><div class="section" title="1.2. __idata"><div class="titlepage"><div><div><h3 class="title"><a name="idp3558352"></a>1.2. __idata</h3></div></div></div><p>
+ </p></div><div class="section" title="1.2. __idata"><div class="titlepage"><div><div><h3 class="title"><a name="idp2541216"></a>1.2. __idata</h3></div></div></div><p>
There are an additional 128 bytes of internal memory
that share the same address space as __data but which
cannot be directly addressed. The stack normally
occupies this space and so AltOS doesn't place any
static storage here.
- </p></div><div class="section" title="1.3. __xdata"><div class="titlepage"><div><div><h3 class="title"><a name="idp2842744"></a>1.3. __xdata</h3></div></div></div><p>
+ </p></div><div class="section" title="1.3. __xdata"><div class="titlepage"><div><div><h3 class="title"><a name="idp1706256"></a>1.3. __xdata</h3></div></div></div><p>
This is additional general memory accessed through a
single 16-bit address register. The CC1111F32 has 32kB
of memory available here. Most program data should live
in this memory space.
- </p></div><div class="section" title="1.4. __pdata"><div class="titlepage"><div><div><h3 class="title"><a name="idp2384616"></a>1.4. __pdata</h3></div></div></div><p>
+ </p></div><div class="section" title="1.4. __pdata"><div class="titlepage"><div><div><h3 class="title"><a name="idp2483496"></a>1.4. __pdata</h3></div></div></div><p>
This is an alias for the first 256 bytes of __xdata
memory, but uses a shorter addressing mode with
single global 8-bit value for the high 8 bits of the
address and any of several 8-bit registers for the low 8
bits. AltOS uses a few bits of this memory, it should
probably use more.
- </p></div><div class="section" title="1.5. __code"><div class="titlepage"><div><div><h3 class="title"><a name="idp2387640"></a>1.5. __code</h3></div></div></div><p>
+ </p></div><div class="section" title="1.5. __code"><div class="titlepage"><div><div><h3 class="title"><a name="idp2405544"></a>1.5. __code</h3></div></div></div><p>
All executable code must live in this address space, but
you can stick read-only data here too. It is addressed
using the 16-bit address register and special 'code'
access opcodes. Anything read-only should live in this space.
- </p></div><div class="section" title="1.6. __bit"><div class="titlepage"><div><div><h3 class="title"><a name="idp2712072"></a>1.6. __bit</h3></div></div></div><p>
+ </p></div><div class="section" title="1.6. __bit"><div class="titlepage"><div><div><h3 class="title"><a name="idp2009320"></a>1.6. __bit</h3></div></div></div><p>
The 8051 has 128 bits of bit-addressible memory that
lives in the __data segment from 0x20 through
0x2f. Special instructions access these bits
in a single atomic operation. This isn't so much a
separate address space as a special addressing mode for
a few bytes in the __data segment.
- </p></div><div class="section" title="1.7. __sfr, __sfr16, __sfr32, __sbit"><div class="titlepage"><div><div><h3 class="title"><a name="idp2470984"></a>1.7. __sfr, __sfr16, __sfr32, __sbit</h3></div></div></div><p>
+ </p></div><div class="section" title="1.7. __sfr, __sfr16, __sfr32, __sbit"><div class="titlepage"><div><div><h3 class="title"><a name="idp1699616"></a>1.7. __sfr, __sfr16, __sfr32, __sbit</h3></div></div></div><p>
Access to physical registers in the device use this mode
which declares the variable name, it's type and the
address it lives at. No memory is allocated for these
variables.
- </p></div></div><div class="section" title="2. Function calls on the 8051"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3567856"></a>2. Function calls on the 8051</h2></div></div></div><p>
+ </p></div></div><div class="section" title="2. Function calls on the 8051"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2333480"></a>2. Function calls on the 8051</h2></div></div></div><p>
Because stack addressing is expensive, and stack space
limited, the default function call declaration in SDCC
allocates all parameters and local variables in static global
@@ -136,7 +136,7 @@
non-reentrant, and also consume space for parameters and
locals even when they are not running. The benefit is smaller
code and faster execution.
- </p><div class="section" title="2.1. __reentrant functions"><div class="titlepage"><div><div><h3 class="title"><a name="idp3012760"></a>2.1. __reentrant functions</h3></div></div></div><p>
+ </p><div class="section" title="2.1. __reentrant functions"><div class="titlepage"><div><div><h3 class="title"><a name="idp2088600"></a>2.1. __reentrant functions</h3></div></div></div><p>
All functions which are re-entrant, either due to recursion
or due to a potential context switch while executing, should
be marked as __reentrant so that their parameters and local
@@ -149,7 +149,7 @@
invoked can also be marked as __reentrant. The resulting
code will be larger, but the savings in memory are
frequently worthwhile.
- </p></div><div class="section" title="2.2. Non __reentrant functions"><div class="titlepage"><div><div><h3 class="title"><a name="idp3274328"></a>2.2. Non __reentrant functions</h3></div></div></div><p>
+ </p></div><div class="section" title="2.2. Non __reentrant functions"><div class="titlepage"><div><div><h3 class="title"><a name="idp3083416"></a>2.2. Non __reentrant functions</h3></div></div></div><p>
All parameters and locals in non-reentrant functions can
have data space decoration so that they are allocated in
__xdata, __pdata or __data space as desired. This can avoid
@@ -161,14 +161,14 @@
non-reentrant. Because of this, interrupt handlers must not
invoke any library functions, including the multiply and
divide code.
- </p></div><div class="section" title="2.3. __interrupt functions"><div class="titlepage"><div><div><h3 class="title"><a name="idp1868232"></a>2.3. __interrupt functions</h3></div></div></div><p>
+ </p></div><div class="section" title="2.3. __interrupt functions"><div class="titlepage"><div><div><h3 class="title"><a name="idp2104128"></a>2.3. __interrupt functions</h3></div></div></div><p>
Interrupt functions are declared with with an __interrupt
decoration that includes the interrupt number. SDCC saves
and restores all of the registers in these functions and
uses the 'reti' instruction at the end so that they operate
as stand-alone interrupt handlers. Interrupt functions may
call the ao_wakeup function to wake AltOS tasks.
- </p></div><div class="section" title="2.4. __critical functions and statements"><div class="titlepage"><div><div><h3 class="title"><a name="idp2323224"></a>2.4. __critical functions and statements</h3></div></div></div><p>
+ </p></div><div class="section" title="2.4. __critical functions and statements"><div class="titlepage"><div><div><h3 class="title"><a name="idp3241688"></a>2.4. __critical functions and statements</h3></div></div></div><p>
SDCC has built-in support for suspending interrupts during
critical code. Functions marked as __critical will have
interrupts suspended for the whole period of
@@ -177,9 +177,9 @@
that statement. Keeping critical sections as short as
possible is key to ensuring that interrupts are handled as
quickly as possible.
- </p></div></div></div><div class="chapter" title="Chapter 3. Task functions"><div class="titlepage"><div><div><h2 class="title"><a name="idp2522240"></a>Chapter 3. Task functions</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#idp1968112">1. ao_add_task</a></span></dt><dt><span class="section"><a href="#idp3359576">2. ao_exit</a></span></dt><dt><span class="section"><a href="#idp3085968">3. ao_sleep</a></span></dt><dt><span class="section"><a href="#idp3004432">4. ao_wakeup</a></span></dt><dt><span class="section"><a href="#idp2423736">5. ao_alarm</a></span></dt><dt><span class="section"><a href="#idp2605456">6. ao_start_scheduler</a></span></dt><dt><span class="section"><a href="#idp3312896">7. ao_clock_init</a></span></dt></dl></div><p>
+ </p></div></div></div><div class="chapter" title="Chapter 3. Task functions"><div class="titlepage"><div><div><h2 class="title"><a name="idp1985864"></a>Chapter 3. Task functions</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#idp2174488">1. ao_add_task</a></span></dt><dt><span class="section"><a href="#idp2864400">2. ao_exit</a></span></dt><dt><span class="section"><a href="#idp3396632">3. ao_sleep</a></span></dt><dt><span class="section"><a href="#idp3184328">4. ao_wakeup</a></span></dt><dt><span class="section"><a href="#idp3259984">5. ao_alarm</a></span></dt><dt><span class="section"><a href="#idp2199168">6. ao_start_scheduler</a></span></dt><dt><span class="section"><a href="#idp2195744">7. ao_clock_init</a></span></dt></dl></div><p>
This chapter documents how to create, destroy and schedule AltOS tasks.
- </p><div class="section" title="1. ao_add_task"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp1968112"></a>1. ao_add_task</h2></div></div></div><pre class="programlisting">
+ </p><div class="section" title="1. ao_add_task"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2174488"></a>1. ao_add_task</h2></div></div></div><pre class="programlisting">
void
ao_add_task(__xdata struct ao_task * task,
void (*start)(void),
@@ -190,12 +190,12 @@
display), and the start address. It does not switch to the
new task. 'start' must not ever return; there is no place
to return to.
- </p></div><div class="section" title="2. ao_exit"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3359576"></a>2. ao_exit</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="2. ao_exit"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2864400"></a>2. ao_exit</h2></div></div></div><pre class="programlisting">
void
ao_exit(void)
</pre><p>
This terminates the current task.
- </p></div><div class="section" title="3. ao_sleep"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3085968"></a>3. ao_sleep</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="3. ao_sleep"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3396632"></a>3. ao_sleep</h2></div></div></div><pre class="programlisting">
void
ao_sleep(__xdata void *wchan)
</pre><p>
@@ -215,7 +215,7 @@
__critical while (!ao_radio_done)
ao_sleep(&amp;ao_radio_done);
</pre><p>
- </p></div><div class="section" title="4. ao_wakeup"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3004432"></a>4. ao_wakeup</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="4. ao_wakeup"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3184328"></a>4. ao_wakeup</h2></div></div></div><pre class="programlisting">
void
ao_wakeup(__xdata void *wchan)
</pre><p>
@@ -233,7 +233,7 @@
ao_sleep block can only be run from normal mode, and so
this sequence can never be interrupted with execution of
the other sequence.
- </p></div><div class="section" title="5. ao_alarm"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2423736"></a>5. ao_alarm</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="5. ao_alarm"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3259984"></a>5. ao_alarm</h2></div></div></div><pre class="programlisting">
void
ao_alarm(uint16_t delay)
</pre><p>
@@ -250,13 +250,13 @@
incoming radio data. If no data is received before the
timeout fires, ao_sleep will return 1 and then this code
will abort the radio receive operation.
- </p></div><div class="section" title="6. ao_start_scheduler"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2605456"></a>6. ao_start_scheduler</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="6. ao_start_scheduler"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2199168"></a>6. ao_start_scheduler</h2></div></div></div><pre class="programlisting">
void
ao_start_scheduler(void)
</pre><p>
This is called from 'main' when the system is all
initialized and ready to run. It will not return.
- </p></div><div class="section" title="7. ao_clock_init"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3312896"></a>7. ao_clock_init</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="7. ao_clock_init"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2195744"></a>7. ao_clock_init</h2></div></div></div><pre class="programlisting">
void
ao_clock_init(void)
</pre><p>
@@ -265,7 +265,7 @@
internal devices like USB. It should be called by the
'main' function first, before initializing any of the
other devices in the system.
- </p></div></div><div class="chapter" title="Chapter 4. Timer Functions"><div class="titlepage"><div><div><h2 class="title"><a name="idp2103648"></a>Chapter 4. Timer Functions</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#idp2407008">1. ao_time</a></span></dt><dt><span class="section"><a href="#idp2512832">2. ao_delay</a></span></dt><dt><span class="section"><a href="#idp2252856">3. ao_timer_set_adc_interval</a></span></dt><dt><span class="section"><a href="#idp3005352">4. ao_timer_init</a></span></dt></dl></div><p>
+ </p></div></div><div class="chapter" title="Chapter 4. Timer Functions"><div class="titlepage"><div><div><h2 class="title"><a name="idp2424776"></a>Chapter 4. Timer Functions</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#idp2205760">1. ao_time</a></span></dt><dt><span class="section"><a href="#idp3534312">2. ao_delay</a></span></dt><dt><span class="section"><a href="#idp2999280">3. ao_timer_set_adc_interval</a></span></dt><dt><span class="section"><a href="#idp2745080">4. ao_timer_init</a></span></dt></dl></div><p>
AltOS sets up one of the cc1111 timers to run at 100Hz and
exposes this tick as the fundemental unit of time. At each
interrupt, AltOS increments the counter, and schedules any tasks
@@ -273,51 +273,51 @@
collect current data readings. Doing this from the ISR ensures
that the ADC values are sampled at a regular rate, independent
of any scheduling jitter.
- </p><div class="section" title="1. ao_time"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2407008"></a>1. ao_time</h2></div></div></div><pre class="programlisting">
+ </p><div class="section" title="1. ao_time"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2205760"></a>1. ao_time</h2></div></div></div><pre class="programlisting">
uint16_t
ao_time(void)
</pre><p>
Returns the current system tick count. Note that this is
only a 16 bit value, and so it wraps every 655.36 seconds.
- </p></div><div class="section" title="2. ao_delay"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2512832"></a>2. ao_delay</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="2. ao_delay"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3534312"></a>2. ao_delay</h2></div></div></div><pre class="programlisting">
void
ao_delay(uint16_t ticks);
</pre><p>
Suspend the current task for at least 'ticks' clock units.
- </p></div><div class="section" title="3. ao_timer_set_adc_interval"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2252856"></a>3. ao_timer_set_adc_interval</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="3. ao_timer_set_adc_interval"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2999280"></a>3. ao_timer_set_adc_interval</h2></div></div></div><pre class="programlisting">
void
ao_timer_set_adc_interval(uint8_t interval);
</pre><p>
This sets the number of ticks between ADC samples. If set
to 0, no ADC samples are generated. AltOS uses this to
slow down the ADC sampling rate to save power.
- </p></div><div class="section" title="4. ao_timer_init"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3005352"></a>4. ao_timer_init</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="4. ao_timer_init"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2745080"></a>4. ao_timer_init</h2></div></div></div><pre class="programlisting">
void
ao_timer_init(void)
</pre><p>
This turns on the 100Hz tick using the CC1111 timer 1. It
is required for any of the time-based functions to
work. It should be called by 'main' before ao_start_scheduler.
- </p></div></div><div class="chapter" title="Chapter 5. AltOS Mutexes"><div class="titlepage"><div><div><h2 class="title"><a name="idp3256712"></a>Chapter 5. AltOS Mutexes</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#idp2419784">1. ao_mutex_get</a></span></dt><dt><span class="section"><a href="#idp3558880">2. ao_mutex_put</a></span></dt></dl></div><p>
+ </p></div></div><div class="chapter" title="Chapter 5. AltOS Mutexes"><div class="titlepage"><div><div><h2 class="title"><a name="idp3144392"></a>Chapter 5. AltOS Mutexes</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#idp2328776">1. ao_mutex_get</a></span></dt><dt><span class="section"><a href="#idp2317480">2. ao_mutex_put</a></span></dt></dl></div><p>
AltOS provides mutexes as a basic synchronization primitive. Each
mutexes is simply a byte of memory which holds 0 when the mutex
is free or the task id of the owning task when the mutex is
owned. Mutex calls are checked&#8212;attempting to acquire a mutex
already held by the current task or releasing a mutex not held
by the current task will both cause a panic.
- </p><div class="section" title="1. ao_mutex_get"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2419784"></a>1. ao_mutex_get</h2></div></div></div><pre class="programlisting">
+ </p><div class="section" title="1. ao_mutex_get"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2328776"></a>1. ao_mutex_get</h2></div></div></div><pre class="programlisting">
void
ao_mutex_get(__xdata uint8_t *mutex);
</pre><p>
Acquires the specified mutex, blocking if the mutex is
owned by another task.
- </p></div><div class="section" title="2. ao_mutex_put"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3558880"></a>2. ao_mutex_put</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="2. ao_mutex_put"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2317480"></a>2. ao_mutex_put</h2></div></div></div><pre class="programlisting">
void
ao_mutex_put(__xdata uint8_t *mutex);
</pre><p>
Releases the specified mutex, waking up all tasks waiting
for it.
- </p></div></div><div class="chapter" title="Chapter 6. CC1111 DMA engine"><div class="titlepage"><div><div><h2 class="title"><a name="idp1927912"></a>Chapter 6. CC1111 DMA engine</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#idp3033536">1. ao_dma_alloc</a></span></dt><dt><span class="section"><a href="#idp3322920">2. ao_dma_set_transfer</a></span></dt><dt><span class="section"><a href="#idp2415360">3. ao_dma_start</a></span></dt><dt><span class="section"><a href="#idp2383728">4. ao_dma_trigger</a></span></dt><dt><span class="section"><a href="#idp1636944">5. ao_dma_abort</a></span></dt></dl></div><p>
+ </p></div></div><div class="chapter" title="Chapter 6. CC1111 DMA engine"><div class="titlepage"><div><div><h2 class="title"><a name="idp1618880"></a>Chapter 6. CC1111 DMA engine</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#idp1615992">1. ao_dma_alloc</a></span></dt><dt><span class="section"><a href="#idp2240456">2. ao_dma_set_transfer</a></span></dt><dt><span class="section"><a href="#idp3534584">3. ao_dma_start</a></span></dt><dt><span class="section"><a href="#idp2915488">4. ao_dma_trigger</a></span></dt><dt><span class="section"><a href="#idp3341456">5. ao_dma_abort</a></span></dt></dl></div><p>
The CC1111 contains a useful bit of extra hardware in the form
of five programmable DMA engines. They can be configured to copy
data in memory, or between memory and devices (or even between
@@ -334,7 +334,7 @@
from hardware to memory, that trigger event is supplied by the
hardware device. When copying data from memory to hardware, the
transfer is usually initiated by software.
- </p><div class="section" title="1. ao_dma_alloc"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3033536"></a>1. ao_dma_alloc</h2></div></div></div><pre class="programlisting">
+ </p><div class="section" title="1. ao_dma_alloc"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp1615992"></a>1. ao_dma_alloc</h2></div></div></div><pre class="programlisting">
uint8_t
ao_dma_alloc(__xdata uint8_t *done)
</pre><p>
@@ -345,7 +345,7 @@
AO_DMA_ABORTED bit if ao_dma_abort was called. Note that
it is possible to get both bits if the transfer was
aborted after it had finished.
- </p></div><div class="section" title="2. ao_dma_set_transfer"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3322920"></a>2. ao_dma_set_transfer</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="2. ao_dma_set_transfer"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2240456"></a>2. ao_dma_set_transfer</h2></div></div></div><pre class="programlisting">
void
ao_dma_set_transfer(uint8_t id,
void __xdata *srcaddr,
@@ -359,24 +359,24 @@
cfg1 are values directly out of the CC1111 documentation
and tell the DMA engine what the transfer unit size,
direction and step are.
- </p></div><div class="section" title="3. ao_dma_start"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2415360"></a>3. ao_dma_start</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="3. ao_dma_start"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3534584"></a>3. ao_dma_start</h2></div></div></div><pre class="programlisting">
void
ao_dma_start(uint8_t id);
</pre><p>
Arm the specified DMA engine and await a signal from
either hardware or software to start transferring data.
- </p></div><div class="section" title="4. ao_dma_trigger"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2383728"></a>4. ao_dma_trigger</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="4. ao_dma_trigger"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2915488"></a>4. ao_dma_trigger</h2></div></div></div><pre class="programlisting">
void
ao_dma_trigger(uint8_t id)
</pre><p>
Trigger the specified DMA engine to start copying data.
- </p></div><div class="section" title="5. ao_dma_abort"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp1636944"></a>5. ao_dma_abort</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="5. ao_dma_abort"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3341456"></a>5. ao_dma_abort</h2></div></div></div><pre class="programlisting">
void
ao_dma_abort(uint8_t id)
</pre><p>
Terminate any in-progress DMA transation, marking its
'done' variable with the AO_DMA_ABORTED bit.
- </p></div></div><div class="chapter" title="Chapter 7. SDCC Stdio interface"><div class="titlepage"><div><div><h2 class="title"><a name="idp3215304"></a>Chapter 7. SDCC Stdio interface</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#idp2502672">1. putchar</a></span></dt><dt><span class="section"><a href="#idp2459944">2. getchar</a></span></dt><dt><span class="section"><a href="#idp2914760">3. flush</a></span></dt><dt><span class="section"><a href="#idp2873064">4. ao_add_stdio</a></span></dt></dl></div><p>
+ </p></div></div><div class="chapter" title="Chapter 7. SDCC Stdio interface"><div class="titlepage"><div><div><h2 class="title"><a name="idp2847616"></a>Chapter 7. SDCC Stdio interface</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#idp2019072">1. putchar</a></span></dt><dt><span class="section"><a href="#idp1897520">2. getchar</a></span></dt><dt><span class="section"><a href="#idp2228808">3. flush</a></span></dt><dt><span class="section"><a href="#idp2556232">4. ao_add_stdio</a></span></dt></dl></div><p>
AltOS offers a stdio interface over both USB and the RF packet
link. This provides for control of the device localy or
remotely. This is hooked up to the stdio functions in SDCC by
@@ -384,13 +384,13 @@
automatically multiplex the two available communication
channels; output is always delivered to the channel which
provided the most recent input.
- </p><div class="section" title="1. putchar"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2502672"></a>1. putchar</h2></div></div></div><pre class="programlisting">
+ </p><div class="section" title="1. putchar"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2019072"></a>1. putchar</h2></div></div></div><pre class="programlisting">
void
putchar(char c)
</pre><p>
Delivers a single character to the current console
device.
- </p></div><div class="section" title="2. getchar"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2459944"></a>2. getchar</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="2. getchar"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp1897520"></a>2. getchar</h2></div></div></div><pre class="programlisting">
char
getchar(void)
</pre><p>
@@ -398,13 +398,13 @@
console devices. The current console device is set to
that which delivered this character. This blocks until
a character is available.
- </p></div><div class="section" title="3. flush"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2914760"></a>3. flush</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="3. flush"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2228808"></a>3. flush</h2></div></div></div><pre class="programlisting">
void
flush(void)
</pre><p>
Flushes the current console device output buffer. Any
pending characters will be delivered to the target device.
- xo </p></div><div class="section" title="4. ao_add_stdio"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2873064"></a>4. ao_add_stdio</h2></div></div></div><pre class="programlisting">
+ xo </p></div><div class="section" title="4. ao_add_stdio"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2556232"></a>4. ao_add_stdio</h2></div></div></div><pre class="programlisting">
void
ao_add_stdio(char (*pollchar)(void),
void (*putchar)(char),
@@ -426,13 +426,13 @@
'flush' forces the output buffer to be flushed. It may
block until the buffer is delivered, but it is not
required to do so.
- </p></div></div><div class="chapter" title="Chapter 8. Command line interface"><div class="titlepage"><div><div><h2 class="title"><a name="idp2170912"></a>Chapter 8. Command line interface</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#idp3529992">1. ao_cmd_register</a></span></dt><dt><span class="section"><a href="#idp2645232">2. ao_cmd_lex</a></span></dt><dt><span class="section"><a href="#idp2564824">3. ao_cmd_put16</a></span></dt><dt><span class="section"><a href="#idp3113528">4. ao_cmd_put8</a></span></dt><dt><span class="section"><a href="#idp1935488">5. ao_cmd_white</a></span></dt><dt><span class="section"><a href="#idp1896024">6. ao_cmd_hex</a></span></dt><dt><span class="section"><a href="#idp2433952">7. ao_cmd_decimal</a></span></dt><dt><span class="section"><a href="#idp2883960">8. ao_match_word</a></span></dt><dt><span class="section"><a href="#idp3489544">9. ao_cmd_init</a></span></dt></dl></div><p>
+ </p></div></div><div class="chapter" title="Chapter 8. Command line interface"><div class="titlepage"><div><div><h2 class="title"><a name="idp3547824"></a>Chapter 8. Command line interface</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#idp3082736">1. ao_cmd_register</a></span></dt><dt><span class="section"><a href="#idp3074496">2. ao_cmd_lex</a></span></dt><dt><span class="section"><a href="#idp1391912">3. ao_cmd_put16</a></span></dt><dt><span class="section"><a href="#idp1870472">4. ao_cmd_put8</a></span></dt><dt><span class="section"><a href="#idp3387136">5. ao_cmd_white</a></span></dt><dt><span class="section"><a href="#idp2423424">6. ao_cmd_hex</a></span></dt><dt><span class="section"><a href="#idp3507240">7. ao_cmd_decimal</a></span></dt><dt><span class="section"><a href="#idp2905560">8. ao_match_word</a></span></dt><dt><span class="section"><a href="#idp2254256">9. ao_cmd_init</a></span></dt></dl></div><p>
AltOS includes a simple command line parser which is hooked up
to the stdio interfaces permitting remote control of the device
over USB or the RF link as desired. Each command uses a single
character to invoke it, the remaining characters on the line are
available as parameters to the command.
- </p><div class="section" title="1. ao_cmd_register"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3529992"></a>1. ao_cmd_register</h2></div></div></div><pre class="programlisting">
+ </p><div class="section" title="1. ao_cmd_register"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3082736"></a>1. ao_cmd_register</h2></div></div></div><pre class="programlisting">
void
ao_cmd_register(__code struct ao_cmds *cmds)
</pre><p>
@@ -463,38 +463,38 @@
The command line is invalid for some reason other
than invalid tokens.
</p></dd></dl></div><p>
- </p></div><div class="section" title="2. ao_cmd_lex"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2645232"></a>2. ao_cmd_lex</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="2. ao_cmd_lex"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3074496"></a>2. ao_cmd_lex</h2></div></div></div><pre class="programlisting">
void
ao_cmd_lex(void);
</pre><p>
This gets the next character out of the command line
buffer and sticks it into ao_cmd_lex_c. At the end of the
line, ao_cmd_lex_c will get a newline ('\n') character.
- </p></div><div class="section" title="3. ao_cmd_put16"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2564824"></a>3. ao_cmd_put16</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="3. ao_cmd_put16"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp1391912"></a>3. ao_cmd_put16</h2></div></div></div><pre class="programlisting">
void
ao_cmd_put16(uint16_t v);
</pre><p>
Writes 'v' as four hexadecimal characters.
- </p></div><div class="section" title="4. ao_cmd_put8"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3113528"></a>4. ao_cmd_put8</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="4. ao_cmd_put8"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp1870472"></a>4. ao_cmd_put8</h2></div></div></div><pre class="programlisting">
void
ao_cmd_put8(uint8_t v);
</pre><p>
Writes 'v' as two hexadecimal characters.
- </p></div><div class="section" title="5. ao_cmd_white"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp1935488"></a>5. ao_cmd_white</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="5. ao_cmd_white"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3387136"></a>5. ao_cmd_white</h2></div></div></div><pre class="programlisting">
void
ao_cmd_white(void)
</pre><p>
This skips whitespace by calling ao_cmd_lex while
ao_cmd_lex_c is either a space or tab. It does not skip
any characters if ao_cmd_lex_c already non-white.
- </p></div><div class="section" title="6. ao_cmd_hex"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp1896024"></a>6. ao_cmd_hex</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="6. ao_cmd_hex"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2423424"></a>6. ao_cmd_hex</h2></div></div></div><pre class="programlisting">
void
ao_cmd_hex(void)
</pre><p>
This reads a 16-bit hexadecimal value from the command
line with optional leading whitespace. The resulting value
is stored in ao_cmd_lex_i;
- </p></div><div class="section" title="7. ao_cmd_decimal"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2433952"></a>7. ao_cmd_decimal</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="7. ao_cmd_decimal"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3507240"></a>7. ao_cmd_decimal</h2></div></div></div><pre class="programlisting">
void
ao_cmd_decimal(void)
</pre><p>
@@ -502,7 +502,7 @@
line with optional leading whitespace. The resulting value
is stored in ao_cmd_lex_u32 and the low 16 bits are stored
in ao_cmd_lex_i;
- </p></div><div class="section" title="8. ao_match_word"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2883960"></a>8. ao_match_word</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="8. ao_match_word"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2905560"></a>8. ao_match_word</h2></div></div></div><pre class="programlisting">
uint8_t
ao_match_word(__code char *word)
</pre><p>
@@ -510,14 +510,14 @@
line. It does not skip leading white space. If 'word' is
found, then 1 is returned. Otherwise, ao_cmd_status is set to
ao_cmd_syntax_error and 0 is returned.
- </p></div><div class="section" title="9. ao_cmd_init"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3489544"></a>9. ao_cmd_init</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="9. ao_cmd_init"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2254256"></a>9. ao_cmd_init</h2></div></div></div><pre class="programlisting">
void
ao_cmd_init(void
</pre><p>
Initializes the command system, setting up the built-in
commands and adding a task to run the command processing
loop. It should be called by 'main' before ao_start_scheduler.
- </p></div></div><div class="chapter" title="Chapter 9. CC1111 USB target device"><div class="titlepage"><div><div><h2 class="title"><a name="idp2151344"></a>Chapter 9. CC1111 USB target device</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#idp2038816">1. ao_usb_flush</a></span></dt><dt><span class="section"><a href="#idp2901984">2. ao_usb_putchar</a></span></dt><dt><span class="section"><a href="#idp1930120">3. ao_usb_pollchar</a></span></dt><dt><span class="section"><a href="#idp2176008">4. ao_usb_getchar</a></span></dt><dt><span class="section"><a href="#idp1694928">5. ao_usb_disable</a></span></dt><dt><span class="section"><a href="#idp2859448">6. ao_usb_enable</a></span></dt><dt><span class="section"><a href="#idp2323496">7. ao_usb_init</a></span></dt></dl></div><p>
+ </p></div></div><div class="chapter" title="Chapter 9. CC1111 USB target device"><div class="titlepage"><div><div><h2 class="title"><a name="idp2515408"></a>Chapter 9. CC1111 USB target device</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#idp2405816">1. ao_usb_flush</a></span></dt><dt><span class="section"><a href="#idp3103416">2. ao_usb_putchar</a></span></dt><dt><span class="section"><a href="#idp2363712">3. ao_usb_pollchar</a></span></dt><dt><span class="section"><a href="#idp2775744">4. ao_usb_getchar</a></span></dt><dt><span class="section"><a href="#idp2910608">5. ao_usb_disable</a></span></dt><dt><span class="section"><a href="#idp2866200">6. ao_usb_enable</a></span></dt><dt><span class="section"><a href="#idp3079952">7. ao_usb_init</a></span></dt></dl></div><p>
The CC1111 contains a full-speed USB target device. It can be
programmed to offer any kind of USB target, but to simplify
interactions with a variety of operating systems, AltOS provides
@@ -531,7 +531,7 @@
interface if desired, offering control of the device over the
USB link. Alternatively, the functions can be accessed directly
to provide for USB-specific I/O.
- </p><div class="section" title="1. ao_usb_flush"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2038816"></a>1. ao_usb_flush</h2></div></div></div><pre class="programlisting">
+ </p><div class="section" title="1. ao_usb_flush"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2405816"></a>1. ao_usb_flush</h2></div></div></div><pre class="programlisting">
void
ao_usb_flush(void);
</pre><p>
@@ -539,7 +539,7 @@
to be delivered to the USB host if there is pending data,
or if the last IN packet was full to indicate to the host
that there isn't any more pending data available.
- </p></div><div class="section" title="2. ao_usb_putchar"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2901984"></a>2. ao_usb_putchar</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="2. ao_usb_putchar"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3103416"></a>2. ao_usb_putchar</h2></div></div></div><pre class="programlisting">
void
ao_usb_putchar(char c);
</pre><p>
@@ -548,7 +548,7 @@
adds a byte to the pending IN packet for delivery to the
USB host. If the USB packet is full, this queues the 'IN'
packet for delivery.
- </p></div><div class="section" title="3. ao_usb_pollchar"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp1930120"></a>3. ao_usb_pollchar</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="3. ao_usb_pollchar"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2363712"></a>3. ao_usb_pollchar</h2></div></div></div><pre class="programlisting">
char
ao_usb_pollchar(void);
</pre><p>
@@ -556,13 +556,13 @@
packet received, this returns AO_READ_AGAIN. Otherwise, it
returns the next character, reporting to the host that it
is ready for more data when the last character is gone.
- </p></div><div class="section" title="4. ao_usb_getchar"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2176008"></a>4. ao_usb_getchar</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="4. ao_usb_getchar"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2775744"></a>4. ao_usb_getchar</h2></div></div></div><pre class="programlisting">
char
ao_usb_getchar(void);
</pre><p>
This uses ao_pollchar to receive the next character,
blocking while ao_pollchar returns AO_READ_AGAIN.
- </p></div><div class="section" title="5. ao_usb_disable"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp1694928"></a>5. ao_usb_disable</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="5. ao_usb_disable"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2910608"></a>5. ao_usb_disable</h2></div></div></div><pre class="programlisting">
void
ao_usb_disable(void);
</pre><p>
@@ -577,7 +577,7 @@
after disabling the USB device, it's likely that the cable
will need to be disconnected and reconnected before it
will work again.
- </p></div><div class="section" title="6. ao_usb_enable"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2859448"></a>6. ao_usb_enable</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="6. ao_usb_enable"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2866200"></a>6. ao_usb_enable</h2></div></div></div><pre class="programlisting">
void
ao_usb_enable(void);
</pre><p>
@@ -585,7 +585,7 @@
disabled. See the note above about needing to physically
remove and re-insert the cable to get the host to
re-initialize the USB link.
- </p></div><div class="section" title="7. ao_usb_init"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2323496"></a>7. ao_usb_init</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="7. ao_usb_init"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3079952"></a>7. ao_usb_init</h2></div></div></div><pre class="programlisting">
void
ao_usb_init(void);
</pre><p>
@@ -593,7 +593,7 @@
the control end point and adds the usb I/O functions to
the stdio system. Call this from main before
ao_start_scheduler.
- </p></div></div><div class="chapter" title="Chapter 10. CC1111 Serial peripheral"><div class="titlepage"><div><div><h2 class="title"><a name="idp3103048"></a>Chapter 10. CC1111 Serial peripheral</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#idp864464">1. ao_serial_getchar</a></span></dt><dt><span class="section"><a href="#idp2883824">2. ao_serial_putchar</a></span></dt><dt><span class="section"><a href="#idp1519672">3. ao_serial_drain</a></span></dt><dt><span class="section"><a href="#idp2341432">4. ao_serial_set_speed</a></span></dt><dt><span class="section"><a href="#idp1472312">5. ao_serial_init</a></span></dt></dl></div><p>
+ </p></div></div><div class="chapter" title="Chapter 10. CC1111 Serial peripheral"><div class="titlepage"><div><div><h2 class="title"><a name="idp2600312"></a>Chapter 10. CC1111 Serial peripheral</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#idp2173288">1. ao_serial_getchar</a></span></dt><dt><span class="section"><a href="#idp2723344">2. ao_serial_putchar</a></span></dt><dt><span class="section"><a href="#idp2744704">3. ao_serial_drain</a></span></dt><dt><span class="section"><a href="#idp1337864">4. ao_serial_set_speed</a></span></dt><dt><span class="section"><a href="#idp1403336">5. ao_serial_init</a></span></dt></dl></div><p>
The CC1111 provides two USART peripherals. AltOS uses one for
asynch serial data, generally to communicate with a GPS device,
and the other for a SPI bus. The UART is configured to operate
@@ -604,25 +604,25 @@
</p><p>
To prevent loss of data, AltOS provides receive and transmit
fifos of 32 characters each.
- </p><div class="section" title="1. ao_serial_getchar"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp864464"></a>1. ao_serial_getchar</h2></div></div></div><pre class="programlisting">
+ </p><div class="section" title="1. ao_serial_getchar"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2173288"></a>1. ao_serial_getchar</h2></div></div></div><pre class="programlisting">
char
ao_serial_getchar(void);
</pre><p>
Returns the next character from the receive fifo, blocking
until a character is received if the fifo is empty.
- </p></div><div class="section" title="2. ao_serial_putchar"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2883824"></a>2. ao_serial_putchar</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="2. ao_serial_putchar"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2723344"></a>2. ao_serial_putchar</h2></div></div></div><pre class="programlisting">
void
ao_serial_putchar(char c);
</pre><p>
Adds a character to the transmit fifo, blocking if the
fifo is full. Starts transmitting characters.
- </p></div><div class="section" title="3. ao_serial_drain"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp1519672"></a>3. ao_serial_drain</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="3. ao_serial_drain"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2744704"></a>3. ao_serial_drain</h2></div></div></div><pre class="programlisting">
void
ao_serial_drain(void);
</pre><p>
Blocks until the transmit fifo is empty. Used internally
when changing serial speeds.
- </p></div><div class="section" title="4. ao_serial_set_speed"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2341432"></a>4. ao_serial_set_speed</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="4. ao_serial_set_speed"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp1337864"></a>4. ao_serial_set_speed</h2></div></div></div><pre class="programlisting">
void
ao_serial_set_speed(uint8_t speed);
</pre><p>
@@ -630,14 +630,14 @@
AO_SERIAL_SPEED_4800, AO_SERIAL_SPEED_9600 or
AO_SERIAL_SPEED_57600. This first flushes the transmit
fifo using ao_serial_drain.
- </p></div><div class="section" title="5. ao_serial_init"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp1472312"></a>5. ao_serial_init</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="5. ao_serial_init"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp1403336"></a>5. ao_serial_init</h2></div></div></div><pre class="programlisting">
void
ao_serial_init(void)
</pre><p>
Initializes the serial peripheral. Call this from 'main'
before jumping to ao_start_scheduler. The default speed
setting is AO_SERIAL_SPEED_4800.
- </p></div></div><div class="chapter" title="Chapter 11. CC1111 Radio peripheral"><div class="titlepage"><div><div><h2 class="title"><a name="idp1597944"></a>Chapter 11. CC1111 Radio peripheral</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#idp2842880">1. ao_radio_set_telemetry</a></span></dt><dt><span class="section"><a href="#idp2488848">2. ao_radio_set_packet</a></span></dt><dt><span class="section"><a href="#idp3223464">3. ao_radio_set_rdf</a></span></dt><dt><span class="section"><a href="#idp3006000">4. ao_radio_idle</a></span></dt><dt><span class="section"><a href="#idp2577544">5. ao_radio_get</a></span></dt><dt><span class="section"><a href="#idp2990720">6. ao_radio_put</a></span></dt><dt><span class="section"><a href="#idp2892440">7. ao_radio_abort</a></span></dt><dt><span class="section"><a href="#idp2871216">8. ao_radio_send</a></span></dt><dt><span class="section"><a href="#idp2464440">9. ao_radio_recv</a></span></dt><dt><span class="section"><a href="#idp2485328">10. ao_radio_rdf</a></span></dt><dt><span class="section"><a href="#idp2075376">11. ao_packet_putchar</a></span></dt><dt><span class="section"><a href="#idp2237088">12. ao_packet_pollchar</a></span></dt><dt><span class="section"><a href="#idp2384480">13. ao_packet_slave_start</a></span></dt><dt><span class="section"><a href="#idp2780480">14. ao_packet_slave_stop</a></span></dt><dt><span class="section"><a href="#idp2387432">15. ao_packet_slave_init</a></span></dt><dt><span class="section"><a href="#idp2526032">16. ao_packet_master_init</a></span></dt></dl></div><p>
+ </p></div></div><div class="chapter" title="Chapter 11. CC1111 Radio peripheral"><div class="titlepage"><div><div><h2 class="title"><a name="idp1372064"></a>Chapter 11. CC1111 Radio peripheral</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#idp3389240">1. ao_radio_set_telemetry</a></span></dt><dt><span class="section"><a href="#idp3464080">2. ao_radio_set_packet</a></span></dt><dt><span class="section"><a href="#idp2729008">3. ao_radio_set_rdf</a></span></dt><dt><span class="section"><a href="#idp3208384">4. ao_radio_idle</a></span></dt><dt><span class="section"><a href="#idp1939952">5. ao_radio_get</a></span></dt><dt><span class="section"><a href="#idp2122544">6. ao_radio_put</a></span></dt><dt><span class="section"><a href="#idp2877608">7. ao_radio_abort</a></span></dt><dt><span class="section"><a href="#idp2776168">8. ao_radio_send</a></span></dt><dt><span class="section"><a href="#idp3257800">9. ao_radio_recv</a></span></dt><dt><span class="section"><a href="#idp3063088">10. ao_radio_rdf</a></span></dt><dt><span class="section"><a href="#idp2493216">11. ao_packet_putchar</a></span></dt><dt><span class="section"><a href="#idp3315344">12. ao_packet_pollchar</a></span></dt><dt><span class="section"><a href="#idp2923640">13. ao_packet_slave_start</a></span></dt><dt><span class="section"><a href="#idp2890520">14. ao_packet_slave_stop</a></span></dt><dt><span class="section"><a href="#idp2676120">15. ao_packet_slave_init</a></span></dt><dt><span class="section"><a href="#idp3431952">16. ao_packet_master_init</a></span></dt></dl></div><p>
The CC1111 radio transceiver sends and receives digital packets
with forward error correction and detection. The AltOS driver is
fairly specific to the needs of the TeleMetrum and TeleDongle
@@ -675,7 +675,7 @@
receiver. This is designed to provide a beacon to track
the device when other location mechanisms fail.
</p></li></ol></div><p>
- </p><div class="section" title="1. ao_radio_set_telemetry"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2842880"></a>1. ao_radio_set_telemetry</h2></div></div></div><pre class="programlisting">
+ </p><div class="section" title="1. ao_radio_set_telemetry"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3389240"></a>1. ao_radio_set_telemetry</h2></div></div></div><pre class="programlisting">
void
ao_radio_set_telemetry(void);
</pre><p>
@@ -684,7 +684,7 @@
other RF parameters. It does not include the base frequency
or channel though. Those are set at the time of transmission
or reception, in case the values are changed by the user.
- </p></div><div class="section" title="2. ao_radio_set_packet"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2488848"></a>2. ao_radio_set_packet</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="2. ao_radio_set_packet"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3464080"></a>2. ao_radio_set_packet</h2></div></div></div><pre class="programlisting">
void
ao_radio_set_packet(void);
</pre><p>
@@ -693,7 +693,7 @@
parameters. It does not include the base frequency or
channel though. Those are set at the time of transmission or
reception, in case the values are changed by the user.
- </p></div><div class="section" title="3. ao_radio_set_rdf"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3223464"></a>3. ao_radio_set_rdf</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="3. ao_radio_set_rdf"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2729008"></a>3. ao_radio_set_rdf</h2></div></div></div><pre class="programlisting">
void
ao_radio_set_rdf(void);
</pre><p>
@@ -703,26 +703,26 @@
and data whitening logic is turned off so that the resulting
modulation is received as a 1kHz tone by a conventional 70cm
FM audio receiver.
- </p></div><div class="section" title="4. ao_radio_idle"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3006000"></a>4. ao_radio_idle</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="4. ao_radio_idle"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3208384"></a>4. ao_radio_idle</h2></div></div></div><pre class="programlisting">
void
ao_radio_idle(void);
</pre><p>
Sets the radio device to idle mode, waiting until it reaches
that state. This will terminate any in-progress transmit or
receive operation.
- </p></div><div class="section" title="5. ao_radio_get"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2577544"></a>5. ao_radio_get</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="5. ao_radio_get"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp1939952"></a>5. ao_radio_get</h2></div></div></div><pre class="programlisting">
void
ao_radio_get(void);
</pre><p>
Acquires the radio mutex and then configures the radio
frequency using the global radio calibration and channel
values.
- </p></div><div class="section" title="6. ao_radio_put"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2990720"></a>6. ao_radio_put</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="6. ao_radio_put"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2122544"></a>6. ao_radio_put</h2></div></div></div><pre class="programlisting">
void
ao_radio_put(void);
</pre><p>
Releases the radio mutex.
- </p></div><div class="section" title="7. ao_radio_abort"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2892440"></a>7. ao_radio_abort</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="7. ao_radio_abort"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2877608"></a>7. ao_radio_abort</h2></div></div></div><pre class="programlisting">
void
ao_radio_abort(void);
</pre><p>
@@ -734,7 +734,7 @@
packet. The data from receiving a packet also includes the RSSI
and status values supplied by the receiver. These are added
after the telemetry data.
- </p><div class="section" title="8. ao_radio_send"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2871216"></a>8. ao_radio_send</h2></div></div></div><pre class="programlisting">
+ </p><div class="section" title="8. ao_radio_send"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2776168"></a>8. ao_radio_send</h2></div></div></div><pre class="programlisting">
void
ao_radio_send(__xdata struct ao_telemetry *telemetry);
</pre><p>
@@ -743,7 +743,7 @@
telemetry mode. This function calls ao_radio_get() before
sending, and ao_radio_put() afterwards, to correctly
serialize access to the radio device.
- </p></div><div class="section" title="9. ao_radio_recv"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2464440"></a>9. ao_radio_recv</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="9. ao_radio_recv"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3257800"></a>9. ao_radio_recv</h2></div></div></div><pre class="programlisting">
void
ao_radio_recv(__xdata struct ao_radio_recv *radio);
</pre><p>
@@ -757,7 +757,7 @@
</p></div><p>
In radio direction finding mode, there's just one function to
use
- </p><div class="section" title="10. ao_radio_rdf"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2485328"></a>10. ao_radio_rdf</h2></div></div></div><pre class="programlisting">
+ </p><div class="section" title="10. ao_radio_rdf"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3063088"></a>10. ao_radio_rdf</h2></div></div></div><pre class="programlisting">
void
ao_radio_rdf(int ms);
</pre><p>
@@ -768,7 +768,7 @@
for either master or slave mode (but not both). The basic I/O
functions look the same at both ends, but the internals are
different, along with the initialization steps.
- </p><div class="section" title="11. ao_packet_putchar"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2075376"></a>11. ao_packet_putchar</h2></div></div></div><pre class="programlisting">
+ </p><div class="section" title="11. ao_packet_putchar"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2493216"></a>11. ao_packet_putchar</h2></div></div></div><pre class="programlisting">
void
ao_packet_putchar(char c);
</pre><p>
@@ -778,32 +778,32 @@
transmit a packet if the output buffer is full. On the
slave side, any pending data will be sent the next time
the master polls for data.
- </p></div><div class="section" title="12. ao_packet_pollchar"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2237088"></a>12. ao_packet_pollchar</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="12. ao_packet_pollchar"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3315344"></a>12. ao_packet_pollchar</h2></div></div></div><pre class="programlisting">
char
ao_packet_pollchar(void);
</pre><p>
This returns a pending input character if available,
otherwise returns AO_READ_AGAIN. On the master side, if
this empties the buffer, it triggers a poll for more data.
- </p></div><div class="section" title="13. ao_packet_slave_start"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2384480"></a>13. ao_packet_slave_start</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="13. ao_packet_slave_start"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2923640"></a>13. ao_packet_slave_start</h2></div></div></div><pre class="programlisting">
void
ao_packet_slave_start(void);
</pre><p>
This is available only on the slave side and starts a task
to listen for packet data.
- </p></div><div class="section" title="14. ao_packet_slave_stop"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2780480"></a>14. ao_packet_slave_stop</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="14. ao_packet_slave_stop"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2890520"></a>14. ao_packet_slave_stop</h2></div></div></div><pre class="programlisting">
void
ao_packet_slave_stop(void);
</pre><p>
Disables the packet slave task, stopping the radio receiver.
- </p></div><div class="section" title="15. ao_packet_slave_init"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2387432"></a>15. ao_packet_slave_init</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="15. ao_packet_slave_init"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2676120"></a>15. ao_packet_slave_init</h2></div></div></div><pre class="programlisting">
void
ao_packet_slave_init(void);
</pre><p>
Adds the packet stdio functions to the stdio package so
that when packet slave mode is enabled, characters will
get send and received through the stdio functions.
- </p></div><div class="section" title="16. ao_packet_master_init"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2526032"></a>16. ao_packet_master_init</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="16. ao_packet_master_init"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3431952"></a>16. ao_packet_master_init</h2></div></div></div><pre class="programlisting">
void
ao_packet_master_init(void);
</pre><p>
diff --git a/AltOS/doc/altos.pdf b/AltOS/doc/altos.pdf
index 2a4b501..bd55b6a 100644
--- a/AltOS/doc/altos.pdf
+++ b/AltOS/doc/altos.pdf
Binary files differ
diff --git a/AltOS/doc/altusmetrum.html b/AltOS/doc/altusmetrum.html
index a07755d..45232df 100644
--- a/AltOS/doc/altusmetrum.html
+++ b/AltOS/doc/altusmetrum.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>The Altus Metrum System</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book" title="The Altus Metrum System"><div class="titlepage"><div><div><h1 class="title"><a name="idm14575968"></a>The Altus Metrum System</h1></div><div><h2 class="subtitle">An Owner's Manual for TeleMetrum, TeleMini and TeleDongle Devices</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Bdale</span> <span class="surname">Garbee</span></h3></div></div><div><div class="author"><h3 class="author"><span class="firstname">Keith</span> <span class="surname">Packard</span></h3></div></div><div><div class="author"><h3 class="author"><span class="firstname">Bob</span> <span class="surname">Finch</span></h3></div></div><div><div class="author"><h3 class="author"><span class="firstname">Anthony</span> <span class="surname">Towns</span></h3></div></div><div><p class="copyright">Copyright © 2011 Bdale Garbee and Keith Packard</p></div><div><div class="legalnotice" title="Legal Notice"><a name="idp1689800"></a><p>
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>The Altus Metrum System</title><meta name="generator" content="DocBook XSL Stylesheets V1.76.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book" title="The Altus Metrum System"><div class="titlepage"><div><div><h1 class="title"><a name="idm14881448"></a>The Altus Metrum System</h1></div><div><h2 class="subtitle">An Owner's Manual for TeleMetrum, TeleMini and TeleDongle Devices</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Bdale</span> <span class="surname">Garbee</span></h3></div></div><div><div class="author"><h3 class="author"><span class="firstname">Keith</span> <span class="surname">Packard</span></h3></div></div><div><div class="author"><h3 class="author"><span class="firstname">Bob</span> <span class="surname">Finch</span></h3></div></div><div><div class="author"><h3 class="author"><span class="firstname">Anthony</span> <span class="surname">Towns</span></h3></div></div><div><p class="copyright">Copyright © 2011 Bdale Garbee and Keith Packard</p></div><div><div class="legalnotice" title="Legal Notice"><a name="idp1633264"></a><p>
This document is released under the terms of the
<a class="ulink" href="http://creativecommons.org/licenses/by-sa/3.0/" target="_top">
Creative Commons ShareAlike 3.0
@@ -13,7 +13,7 @@
Updated for software version 0.9. Note that 0.9 represents a
telemetry format change, meaning both ends of a link (TeleMetrum and
TeleDongle) must be updated or communications will fail.
- </td></tr><tr><td align="left">Revision 0.8</td><td align="left">24 November 2010</td></tr><tr><td align="left" colspan="2">Updated for software version 0.8 </td></tr></table></div></div></div><hr></div><div class="acknowledgements" title="Acknowledgements"><div class="titlepage"><div><div><h2 class="title"><a name="idp1374520"></a>Acknowledgements</h2></div></div></div>
+ </td></tr><tr><td align="left">Revision 0.8</td><td align="left">24 November 2010</td></tr><tr><td align="left" colspan="2">Updated for software version 0.8 </td></tr></table></div></div></div><hr></div><div class="acknowledgements" title="Acknowledgements"><div class="titlepage"><div><div><h2 class="title"><a name="idp2861168"></a>Acknowledgements</h2></div></div></div>
<p>
Thanks to Bob Finch, W9YA, NAR 12965, TRA 12350 for writing "The
Mere-Mortals Quick Start/Usage Guide to the Altus Metrum Starter
@@ -40,7 +40,7 @@ Keith Packard, KD7SQG<br>
NAR #88757, TRA #12200<br>
      </p></div><p>
</p>
- </div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="#idp109544">1. Introduction and Overview</a></span></dt><dt><span class="chapter"><a href="#idp112592">2. Getting Started</a></span></dt><dt><span class="chapter"><a href="#idp3558448">3. Handling Precautions</a></span></dt><dt><span class="chapter"><a href="#idp2546632">4. Hardware Overview</a></span></dt><dt><span class="chapter"><a href="#idp1232328">5. System Operation</a></span></dt><dd><dl><dt><span class="section"><a href="#idp2438160">1. Firmware Modes </a></span></dt><dt><span class="section"><a href="#idp3536616">2. GPS </a></span></dt><dt><span class="section"><a href="#idp2995920">3. Controlling An Altimeter Over The Radio Link</a></span></dt><dt><span class="section"><a href="#idp2636120">4. Ground Testing </a></span></dt><dt><span class="section"><a href="#idp2215712">5. Radio Link </a></span></dt><dt><span class="section"><a href="#idp2588328">6. Configurable Parameters</a></span></dt><dd><dl><dt><span class="section"><a href="#idp3166536">6.1. Radio Frequency</a></span></dt><dt><span class="section"><a href="#idp1269376">6.2. Apogee Delay</a></span></dt><dt><span class="section"><a href="#idp1443480">6.3. Main Deployment Altitude</a></span></dt><dt><span class="section"><a href="#idp3505904">6.4. Maximum Flight Log</a></span></dt><dt><span class="section"><a href="#idp3167664">6.5. Ignite Mode</a></span></dt><dt><span class="section"><a href="#idp1494808">6.6. Pad Orientation</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#idp2062320">6. AltosUI</a></span></dt><dd><dl><dt><span class="section"><a href="#idp2011040">1. Monitor Flight</a></span></dt><dd><dl><dt><span class="section"><a href="#idp1611184">1.1. Launch Pad</a></span></dt><dt><span class="section"><a href="#idp2194832">1.2. Ascent</a></span></dt><dt><span class="section"><a href="#idp3351928">1.3. Descent</a></span></dt><dt><span class="section"><a href="#idp1234032">1.4. Landed</a></span></dt><dt><span class="section"><a href="#idp3388472">1.5. Site Map</a></span></dt></dl></dd><dt><span class="section"><a href="#idp1930856">2. Save Flight Data</a></span></dt><dt><span class="section"><a href="#idp3546840">3. Replay Flight</a></span></dt><dt><span class="section"><a href="#idp3331568">4. Graph Data</a></span></dt><dt><span class="section"><a href="#idp1385704">5. Export Data</a></span></dt><dd><dl><dt><span class="section"><a href="#idp3437744">5.1. Comma Separated Value Format</a></span></dt><dt><span class="section"><a href="#idp2912584">5.2. Keyhole Markup Language (for Google Earth)</a></span></dt></dl></dd><dt><span class="section"><a href="#idp2438432">6. Configure Altimeter</a></span></dt><dd><dl><dt><span class="section"><a href="#idp3551544">6.1. Main Deploy Altitude</a></span></dt><dt><span class="section"><a href="#idp2848008">6.2. Apogee Delay</a></span></dt><dt><span class="section"><a href="#idp3459616">6.3. Radio Frequency</a></span></dt><dt><span class="section"><a href="#idp2329488">6.4. Radio Calibration</a></span></dt><dt><span class="section"><a href="#idp3507216">6.5. Callsign</a></span></dt><dt><span class="section"><a href="#idp1223488">6.6. Maximum Flight Log Size</a></span></dt><dt><span class="section"><a href="#idp3489504">6.7. Ignite Mode</a></span></dt><dt><span class="section"><a href="#idp1526824">6.8. Pad Orientation</a></span></dt></dl></dd><dt><span class="section"><a href="#idp2433504">7. Configure AltosUI</a></span></dt><dd><dl><dt><span class="section"><a href="#idp3510984">7.1. Voice Settings</a></span></dt><dt><span class="section"><a href="#idp2029264">7.2. Log Directory</a></span></dt><dt><span class="section"><a href="#idp2350072">7.3. Callsign</a></span></dt><dt><span class="section"><a href="#idp2694528">7.4. Font Size</a></span></dt><dt><span class="section"><a href="#idp1856992">7.5. Serial Debug</a></span></dt><dt><span class="section"><a href="#idp1891664">7.6. Manage Frequencies</a></span></dt></dl></dd><dt><span class="section"><a href="#idp3058032">8. Flash Image</a></span></dt><dt><span class="section"><a href="#idp3184648">9. Fire Igniter</a></span></dt><dt><span class="section"><a href="#idp1519784">10. Scan Channels</a></span></dt><dt><span class="section"><a href="#idp2057448">11. Load Maps</a></span></dt><dt><span class="section"><a href="#idp1472424">12. Monitor Idle</a></span></dt></dl></dd><dt><span class="chapter"><a href="#idp3231728">7. Using Altus Metrum Products</a></span></dt><dd><dl><dt><span class="section"><a href="#idp2024456">1. Being Legal</a></span></dt><dt><span class="section"><a href="#idp2425408">2. In the Rocket</a></span></dt><dt><span class="section"><a href="#idp2236704">3. On the Ground</a></span></dt><dt><span class="section"><a href="#idp2243664">4. Data Analysis</a></span></dt><dt><span class="section"><a href="#idp2104880">5. Future Plans</a></span></dt></dl></dd><dt><span class="chapter"><a href="#idp3340600">8. Altimeter Installation Recommendations</a></span></dt><dd><dl><dt><span class="section"><a href="#idp3522016">1. Mounting the Altimeter</a></span></dt><dt><span class="section"><a href="#idp2062944">2. Dealing with the Antenna</a></span></dt><dt><span class="section"><a href="#idp2075472">3. Preserving GPS Reception</a></span></dt><dt><span class="section"><a href="#idp1887864">4. Radio Frequency Interference</a></span></dt><dt><span class="section"><a href="#idp2902592">5. The Barometric Sensor</a></span></dt><dt><span class="section"><a href="#idp2991488">6. Ground Testing</a></span></dt></dl></dd><dt><span class="chapter"><a href="#idp2336184">9. Updating Device Firmware</a></span></dt><dd><dl><dt><span class="section"><a href="#idp3061016">1. Updating TeleMetrum Firmware</a></span></dt><dt><span class="section"><a href="#idp1980776">2. Updating TeleMini Firmware</a></span></dt><dt><span class="section"><a href="#idp2731488">3. Updating TeleDongle Firmware</a></span></dt></dl></dd><dt><span class="chapter"><a href="#idp2742616">10. Hardware Specifications</a></span></dt><dd><dl><dt><span class="section"><a href="#idp3450088">1. TeleMetrum Specifications</a></span></dt><dt><span class="section"><a href="#idp2397848">2. TeleMini Specifications</a></span></dt></dl></dd><dt><span class="chapter"><a href="#idp3517088">11. FAQ</a></span></dt><dt><span class="appendix"><a href="#idp2358816">A. Notes for Older Software</a></span></dt><dt><span class="appendix"><a href="#idp2555760">B. Calibration</a></span></dt><dd><dl><dt><span class="section"><a href="#idp1119368">1. Radio Frequency</a></span></dt><dt><span class="section"><a href="#idp3257080">2. TeleMetrum Accelerometer</a></span></dt></dl></dd><dt><span class="appendix"><a href="#idp2653672">C. Release Notes</a></span></dt></dl></div><div class="chapter" title="Chapter 1. Introduction and Overview"><div class="titlepage"><div><div><h2 class="title"><a name="idp109544"></a>Chapter 1. Introduction and Overview</h2></div></div></div><p>
+ </div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="#idp127360">1. Introduction and Overview</a></span></dt><dt><span class="chapter"><a href="#idp130344">2. Getting Started</a></span></dt><dt><span class="chapter"><a href="#idp2651808">3. Handling Precautions</a></span></dt><dt><span class="chapter"><a href="#idp3378840">4. Hardware Overview</a></span></dt><dt><span class="chapter"><a href="#idp3276128">5. System Operation</a></span></dt><dd><dl><dt><span class="section"><a href="#idp3062368">1. Firmware Modes </a></span></dt><dt><span class="section"><a href="#idp2460120">2. GPS </a></span></dt><dt><span class="section"><a href="#idp2052200">3. Controlling An Altimeter Over The Radio Link</a></span></dt><dt><span class="section"><a href="#idp2662856">4. Ground Testing </a></span></dt><dt><span class="section"><a href="#idp3396632">5. Radio Link </a></span></dt><dt><span class="section"><a href="#idp2696208">6. Configurable Parameters</a></span></dt><dd><dl><dt><span class="section"><a href="#idp2397232">6.1. Radio Frequency</a></span></dt><dt><span class="section"><a href="#idp2441424">6.2. Apogee Delay</a></span></dt><dt><span class="section"><a href="#idp1908928">6.3. Main Deployment Altitude</a></span></dt><dt><span class="section"><a href="#idp3092808">6.4. Maximum Flight Log</a></span></dt><dt><span class="section"><a href="#idp1888288">6.5. Ignite Mode</a></span></dt><dt><span class="section"><a href="#idp2487664">6.6. Pad Orientation</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#idp3525088">6. AltosUI</a></span></dt><dd><dl><dt><span class="section"><a href="#idp2539464">1. Monitor Flight</a></span></dt><dd><dl><dt><span class="section"><a href="#idp2507712">1.1. Launch Pad</a></span></dt><dt><span class="section"><a href="#idp2116736">1.2. Ascent</a></span></dt><dt><span class="section"><a href="#idp3192912">1.3. Descent</a></span></dt><dt><span class="section"><a href="#idp3341456">1.4. Landed</a></span></dt><dt><span class="section"><a href="#idp2011184">1.5. Site Map</a></span></dt></dl></dd><dt><span class="section"><a href="#idp3564984">2. Save Flight Data</a></span></dt><dt><span class="section"><a href="#idp3039048">3. Replay Flight</a></span></dt><dt><span class="section"><a href="#idp2169992">4. Graph Data</a></span></dt><dt><span class="section"><a href="#idp1875096">5. Export Data</a></span></dt><dd><dl><dt><span class="section"><a href="#idp2578272">5.1. Comma Separated Value Format</a></span></dt><dt><span class="section"><a href="#idp2875944">5.2. Keyhole Markup Language (for Google Earth)</a></span></dt></dl></dd><dt><span class="section"><a href="#idp2810064">6. Configure Altimeter</a></span></dt><dd><dl><dt><span class="section"><a href="#idp1391912">6.1. Main Deploy Altitude</a></span></dt><dt><span class="section"><a href="#idp3569008">6.2. Apogee Delay</a></span></dt><dt><span class="section"><a href="#idp3546448">6.3. Radio Frequency</a></span></dt><dt><span class="section"><a href="#idp2106808">6.4. Radio Calibration</a></span></dt><dt><span class="section"><a href="#idp2727816">6.5. Callsign</a></span></dt><dt><span class="section"><a href="#idp2159880">6.6. Maximum Flight Log Size</a></span></dt><dt><span class="section"><a href="#idp2199304">6.7. Ignite Mode</a></span></dt><dt><span class="section"><a href="#idp3176768">6.8. Pad Orientation</a></span></dt></dl></dd><dt><span class="section"><a href="#idp1614816">7. Configure AltosUI</a></span></dt><dd><dl><dt><span class="section"><a href="#idp1522712">7.1. Voice Settings</a></span></dt><dt><span class="section"><a href="#idp2951344">7.2. Log Directory</a></span></dt><dt><span class="section"><a href="#idp2704448">7.3. Callsign</a></span></dt><dt><span class="section"><a href="#idp2434112">7.4. Font Size</a></span></dt><dt><span class="section"><a href="#idp2866200">7.5. Serial Debug</a></span></dt><dt><span class="section"><a href="#idp2341272">7.6. Manage Frequencies</a></span></dt></dl></dd><dt><span class="section"><a href="#idp2198928">8. Flash Image</a></span></dt><dt><span class="section"><a href="#idp3268008">9. Fire Igniter</a></span></dt><dt><span class="section"><a href="#idp2748912">10. Scan Channels</a></span></dt><dt><span class="section"><a href="#idp2545000">11. Load Maps</a></span></dt><dt><span class="section"><a href="#idp2376832">12. Monitor Idle</a></span></dt></dl></dd><dt><span class="chapter"><a href="#idp1384336">7. Using Altus Metrum Products</a></span></dt><dd><dl><dt><span class="section"><a href="#idp1372064">1. Being Legal</a></span></dt><dt><span class="section"><a href="#idp2120808">2. In the Rocket</a></span></dt><dt><span class="section"><a href="#idp2111736">3. On the Ground</a></span></dt><dt><span class="section"><a href="#idp2590104">4. Data Analysis</a></span></dt><dt><span class="section"><a href="#idp916736">5. Future Plans</a></span></dt></dl></dd><dt><span class="chapter"><a href="#idp1877664">8. Altimeter Installation Recommendations</a></span></dt><dd><dl><dt><span class="section"><a href="#idp2776168">1. Mounting the Altimeter</a></span></dt><dt><span class="section"><a href="#idp3422920">2. Dealing with the Antenna</a></span></dt><dt><span class="section"><a href="#idp2493216">3. Preserving GPS Reception</a></span></dt><dt><span class="section"><a href="#idp2097000">4. Radio Frequency Interference</a></span></dt><dt><span class="section"><a href="#idp3092536">5. The Barometric Sensor</a></span></dt><dt><span class="section"><a href="#idp3323072">6. Ground Testing</a></span></dt></dl></dd><dt><span class="chapter"><a href="#idp2657144">9. Updating Device Firmware</a></span></dt><dd><dl><dt><span class="section"><a href="#idp2722712">1. Updating TeleMetrum Firmware</a></span></dt><dt><span class="section"><a href="#idp1268600">2. Updating TeleMini Firmware</a></span></dt><dt><span class="section"><a href="#idp1444904">3. Updating TeleDongle Firmware</a></span></dt></dl></dd><dt><span class="chapter"><a href="#idp3431816">10. Hardware Specifications</a></span></dt><dd><dl><dt><span class="section"><a href="#idp2831496">1. TeleMetrum Specifications</a></span></dt><dt><span class="section"><a href="#idp3455400">2. TeleMini Specifications</a></span></dt></dl></dd><dt><span class="chapter"><a href="#idp3104824">11. FAQ</a></span></dt><dt><span class="appendix"><a href="#idp2639136">A. Notes for Older Software</a></span></dt><dt><span class="appendix"><a href="#idp2228272">B. Calibration</a></span></dt><dd><dl><dt><span class="section"><a href="#idp1912752">1. Radio Frequency</a></span></dt><dt><span class="section"><a href="#idp2744568">2. TeleMetrum Accelerometer</a></span></dt></dl></dd><dt><span class="appendix"><a href="#idp1711112">C. Release Notes</a></span></dt></dl></div><div class="chapter" title="Chapter 1. Introduction and Overview"><div class="titlepage"><div><div><h2 class="title"><a name="idp127360"></a>Chapter 1. Introduction and Overview</h2></div></div></div><p>
Welcome to the Altus Metrum community! Our circuits and software reflect
our passion for both hobby rocketry and Free Software. We hope their
capabilities and performance will delight you in every way, but by
@@ -69,7 +69,7 @@ NAR #88757, TRA #12200<br>
More products will be added to the Altus Metrum family over time, and
we currently envision that this will be a single, comprehensive manual
for the entire product family.
- </p></div><div class="chapter" title="Chapter 2. Getting Started"><div class="titlepage"><div><div><h2 class="title"><a name="idp112592"></a>Chapter 2. Getting Started</h2></div></div></div><p>
+ </p></div><div class="chapter" title="Chapter 2. Getting Started"><div class="titlepage"><div><div><h2 class="title"><a name="idp130344"></a>Chapter 2. Getting Started</h2></div></div></div><p>
The first thing to do after you check the inventory of parts in your
"starter kit" is to charge the battery.
</p><p>
@@ -115,7 +115,7 @@ NAR #88757, TRA #12200<br>
Full source code and build instructions are also available.
The latest version may always be downloaded from
<a class="ulink" href="http://altusmetrum.org/AltOS" target="_top">http://altusmetrum.org/AltOS</a>.
- </p></div><div class="chapter" title="Chapter 3. Handling Precautions"><div class="titlepage"><div><div><h2 class="title"><a name="idp3558448"></a>Chapter 3. Handling Precautions</h2></div></div></div><p>
+ </p></div><div class="chapter" title="Chapter 3. Handling Precautions"><div class="titlepage"><div><div><h2 class="title"><a name="idp2651808"></a>Chapter 3. Handling Precautions</h2></div></div></div><p>
All Altus Metrum products are sophisticated electronic devices.
When handled gently and properly installed in an air-frame, they
will deliver impressive results. However, as with all electronic
@@ -154,7 +154,7 @@ NAR #88757, TRA #12200<br>
As with all other rocketry electronics, Altus Metrum altimeters must
be protected from exposure to corrosive motor exhaust and ejection
charge gasses.
- </p></div><div class="chapter" title="Chapter 4. Hardware Overview"><div class="titlepage"><div><div><h2 class="title"><a name="idp2546632"></a>Chapter 4. Hardware Overview</h2></div></div></div><p>
+ </p></div><div class="chapter" title="Chapter 4. Hardware Overview"><div class="titlepage"><div><div><h2 class="title"><a name="idp3378840"></a>Chapter 4. Hardware Overview</h2></div></div></div><p>
TeleMetrum is a 1 inch by 2.75 inch circuit board. It was designed to
fit inside coupler for 29mm air-frame tubing, but using it in a tube that
small in diameter may require some creativity in mounting and wiring
@@ -207,7 +207,7 @@ NAR #88757, TRA #12200<br>
connection, and, on TeleMetrum, you can unplug the integrated GPS
antenna and select an appropriate off-board GPS antenna with
cable terminating in a U.FL connector.
- </p></div><div class="chapter" title="Chapter 5. System Operation"><div class="titlepage"><div><div><h2 class="title"><a name="idp1232328"></a>Chapter 5. System Operation</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#idp2438160">1. Firmware Modes </a></span></dt><dt><span class="section"><a href="#idp3536616">2. GPS </a></span></dt><dt><span class="section"><a href="#idp2995920">3. Controlling An Altimeter Over The Radio Link</a></span></dt><dt><span class="section"><a href="#idp2636120">4. Ground Testing </a></span></dt><dt><span class="section"><a href="#idp2215712">5. Radio Link </a></span></dt><dt><span class="section"><a href="#idp2588328">6. Configurable Parameters</a></span></dt><dd><dl><dt><span class="section"><a href="#idp3166536">6.1. Radio Frequency</a></span></dt><dt><span class="section"><a href="#idp1269376">6.2. Apogee Delay</a></span></dt><dt><span class="section"><a href="#idp1443480">6.3. Main Deployment Altitude</a></span></dt><dt><span class="section"><a href="#idp3505904">6.4. Maximum Flight Log</a></span></dt><dt><span class="section"><a href="#idp3167664">6.5. Ignite Mode</a></span></dt><dt><span class="section"><a href="#idp1494808">6.6. Pad Orientation</a></span></dt></dl></dd></dl></div><div class="section" title="1. Firmware Modes"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2438160"></a>1. Firmware Modes </h2></div></div></div><p>
+ </p></div><div class="chapter" title="Chapter 5. System Operation"><div class="titlepage"><div><div><h2 class="title"><a name="idp3276128"></a>Chapter 5. System Operation</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#idp3062368">1. Firmware Modes </a></span></dt><dt><span class="section"><a href="#idp2460120">2. GPS </a></span></dt><dt><span class="section"><a href="#idp2052200">3. Controlling An Altimeter Over The Radio Link</a></span></dt><dt><span class="section"><a href="#idp2662856">4. Ground Testing </a></span></dt><dt><span class="section"><a href="#idp3396632">5. Radio Link </a></span></dt><dt><span class="section"><a href="#idp2696208">6. Configurable Parameters</a></span></dt><dd><dl><dt><span class="section"><a href="#idp2397232">6.1. Radio Frequency</a></span></dt><dt><span class="section"><a href="#idp2441424">6.2. Apogee Delay</a></span></dt><dt><span class="section"><a href="#idp1908928">6.3. Main Deployment Altitude</a></span></dt><dt><span class="section"><a href="#idp3092808">6.4. Maximum Flight Log</a></span></dt><dt><span class="section"><a href="#idp1888288">6.5. Ignite Mode</a></span></dt><dt><span class="section"><a href="#idp2487664">6.6. Pad Orientation</a></span></dt></dl></dd></dl></div><div class="section" title="1. Firmware Modes"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3062368"></a>1. Firmware Modes </h2></div></div></div><p>
The AltOS firmware build for the altimeters has two
fundamental modes, "idle" and "flight". Which of these modes
the firmware operates in is determined at start up time. For
@@ -262,7 +262,7 @@ NAR #88757, TRA #12200<br>
step of a rickety step-ladder or hanging off the side of a launch
tower with a screw-driver trying to turn on your avionics before
installing igniters!
- </p></div><div class="section" title="2. GPS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3536616"></a>2. GPS </h2></div></div></div><p>
+ </p></div><div class="section" title="2. GPS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2460120"></a>2. GPS </h2></div></div></div><p>
TeleMetrum includes a complete GPS receiver. A complete explanation
of how GPS works is beyond the scope of this manual, but the bottom
line is that the TeleMetrum GPS receiver needs to lock onto at least
@@ -280,7 +280,7 @@ NAR #88757, TRA #12200<br>
is turned back on, the GPS system should lock very quickly, typically
long before igniter installation and return to the flight line are
complete.
- </p></div><div class="section" title="3. Controlling An Altimeter Over The Radio Link"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2995920"></a>3. Controlling An Altimeter Over The Radio Link</h2></div></div></div><p>
+ </p></div><div class="section" title="3. Controlling An Altimeter Over The Radio Link"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2052200"></a>3. Controlling An Altimeter Over The Radio Link</h2></div></div></div><p>
One of the unique features of the Altus Metrum system is
the ability to create a two way command link between TeleDongle
and an altimeter using the digital radio transceivers built into
@@ -348,7 +348,7 @@ NAR #88757, TRA #12200<br>
lights on the devices. The red LED will flash each time a packet
is tramsitted, while the green LED will light up on TeleDongle when
it is waiting to receive a packet from the altimeter.
- </p></div><div class="section" title="4. Ground Testing"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2636120"></a>4. Ground Testing </h2></div></div></div><p>
+ </p></div><div class="section" title="4. Ground Testing"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2662856"></a>4. Ground Testing </h2></div></div></div><p>
An important aspect of preparing a rocket using electronic deployment
for flight is ground testing the recovery system. Thanks
to the bi-directional radio link central to the Altus Metrum system,
@@ -364,7 +364,7 @@ NAR #88757, TRA #12200<br>
manual command. You can now command the altimeter to fire the apogee
or main charges from a safe distance using your computer and
TeleDongle and the Fire Igniter tab to complete ejection testing.
- </p></div><div class="section" title="5. Radio Link"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2215712"></a>5. Radio Link </h2></div></div></div><p>
+ </p></div><div class="section" title="5. Radio Link"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3396632"></a>5. Radio Link </h2></div></div></div><p>
The chip our boards are based on incorporates an RF transceiver, but
it's not a full duplex system... each end can only be transmitting or
receiving at any given moment. So we had to decide how to manage the
@@ -395,13 +395,13 @@ NAR #88757, TRA #12200<br>
with a 5-element yagi on the ground. We hope to fly boards to higher
altitudes over time, and would of course appreciate customer feedback
on performance in higher altitude flights!
- </p></div><div class="section" title="6. Configurable Parameters"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2588328"></a>6. Configurable Parameters</h2></div></div></div><p>
+ </p></div><div class="section" title="6. Configurable Parameters"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2696208"></a>6. Configurable Parameters</h2></div></div></div><p>
Configuring an Altus Metrum altimeter for flight is very
simple. Even on our baro-only TeleMini board, the use of a Kalman
filter means there is no need to set a "mach delay". The few
configurable parameters can all be set using AltosUI over USB or
or radio link via TeleDongle.
- </p><div class="section" title="6.1. Radio Frequency"><div class="titlepage"><div><div><h3 class="title"><a name="idp3166536"></a>6.1. Radio Frequency</h3></div></div></div><p>
+ </p><div class="section" title="6.1. Radio Frequency"><div class="titlepage"><div><div><h3 class="title"><a name="idp2397232"></a>6.1. Radio Frequency</h3></div></div></div><p>
Altus Metrum boards support radio frequencies in the 70cm
band. By default, the configuration interface provides a
list of 10 "standard" frequencies in 100kHz channels starting at
@@ -411,7 +411,7 @@ NAR #88757, TRA #12200<br>
frequency will be used to avoid interference. And of course, both
altimeter and TeleDongle must be configured to the same
frequency to successfully communicate with each other.
- </p></div><div class="section" title="6.2. Apogee Delay"><div class="titlepage"><div><div><h3 class="title"><a name="idp1269376"></a>6.2. Apogee Delay</h3></div></div></div><p>
+ </p></div><div class="section" title="6.2. Apogee Delay"><div class="titlepage"><div><div><h3 class="title"><a name="idp2441424"></a>6.2. Apogee Delay</h3></div></div></div><p>
Apogee delay is the number of seconds after the altimeter detects flight
apogee that the drogue charge should be fired. In most cases, this
should be left at the default of 0. However, if you are flying
@@ -427,7 +427,7 @@ NAR #88757, TRA #12200<br>
or 3 seconds later to avoid any chance of both charges
firing simultaneously. We've flown several air-frames this
way quite happily, including Keith's successful L3 cert.
- </p></div><div class="section" title="6.3. Main Deployment Altitude"><div class="titlepage"><div><div><h3 class="title"><a name="idp1443480"></a>6.3. Main Deployment Altitude</h3></div></div></div><p>
+ </p></div><div class="section" title="6.3. Main Deployment Altitude"><div class="titlepage"><div><div><h3 class="title"><a name="idp1908928"></a>6.3. Main Deployment Altitude</h3></div></div></div><p>
By default, the altimeter will fire the main deployment charge at an
elevation of 250 meters (about 820 feet) above ground. We think this
is a good elevation for most air-frames, but feel free to change this
@@ -436,8 +436,8 @@ NAR #88757, TRA #12200<br>
deployment elevation for the backup altimeter to be something lower
than the primary so that both pyrotechnic charges don't fire
simultaneously.
- </p></div><div class="section" title="6.4. Maximum Flight Log"><div class="titlepage"><div><div><h3 class="title"><a name="idp3505904"></a>6.4. Maximum Flight Log</h3></div></div></div><p>
- TeleMetrum version 1.1 has 2MB of on-board flash storage,
+ </p></div><div class="section" title="6.4. Maximum Flight Log"><div class="titlepage"><div><div><h3 class="title"><a name="idp3092808"></a>6.4. Maximum Flight Log</h3></div></div></div><p>
+ TeleMetrum version 1.1 and 1.2 have 2MB of on-board flash storage,
enough to hold over 40 minutes of data at full data rate
(100 samples/second). TeleMetrum 1.0 has 1MB of on-board
storage. As data are stored at a reduced rate during descent
@@ -451,7 +451,7 @@ NAR #88757, TRA #12200<br>
flights.
</p><p>
All of the configuration data is also stored in the flash
- memory, which consumes 64kB on TeleMetrum v1.1 and 256B on
+ memory, which consumes 64kB on TeleMetrum v1.1/v1.2 and 256B on
TeleMetrum v1.0. This configuration space is not available
for storing flight log data.
</p><p>
@@ -466,7 +466,7 @@ NAR #88757, TRA #12200<br>
the on-board flash.
</p><p>
The default size, 192kB, allows for 10 flights of storage on
- TeleMetrum v1.1 and 5 flights on TeleMetrum v1.0. This
+ TeleMetrum v1.1/v1.2 and 5 flights on TeleMetrum v1.0. This
ensures that you won't need to erase the memory before
flying each time while still allowing more than sufficient
storage for each flight.
@@ -480,7 +480,7 @@ NAR #88757, TRA #12200<br>
the limited storage, TeleMini cannot hold data for more than
one flight, and so must be erased after each flight or it
will not capture data for subsequent flights.
- </p></div><div class="section" title="6.5. Ignite Mode"><div class="titlepage"><div><div><h3 class="title"><a name="idp3167664"></a>6.5. Ignite Mode</h3></div></div></div><p>
+ </p></div><div class="section" title="6.5. Ignite Mode"><div class="titlepage"><div><div><h3 class="title"><a name="idp1888288"></a>6.5. Ignite Mode</h3></div></div></div><p>
Instead of firing one charge at apogee and another charge at
a fixed height above the ground, you can configure the
altimeter to fire both at apogee or both during
@@ -492,7 +492,7 @@ NAR #88757, TRA #12200<br>
main allows some level of redundancy without needing two
flight computers. In Redundant Apogee or Redundant Main
mode, the two charges will be fired two seconds apart.
- </p></div><div class="section" title="6.6. Pad Orientation"><div class="titlepage"><div><div><h3 class="title"><a name="idp1494808"></a>6.6. Pad Orientation</h3></div></div></div><p>
+ </p></div><div class="section" title="6.6. Pad Orientation"><div class="titlepage"><div><div><h3 class="title"><a name="idp2487664"></a>6.6. Pad Orientation</h3></div></div></div><p>
TeleMetrum measures acceleration along the axis of the
board. Which way the board is oriented affects the sign of
the acceleration value. Instead of trying to guess which way
@@ -502,7 +502,7 @@ NAR #88757, TRA #12200<br>
TeleMetrum board connected to the 70cm antenna to be nearest
the nose of the rocket, with the end containing the screw
terminals nearest the tail.
- </p></div></div></div><div class="chapter" title="Chapter 6. AltosUI"><div class="titlepage"><div><div><h2 class="title"><a name="idp2062320"></a>Chapter 6. AltosUI</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#idp2011040">1. Monitor Flight</a></span></dt><dd><dl><dt><span class="section"><a href="#idp1611184">1.1. Launch Pad</a></span></dt><dt><span class="section"><a href="#idp2194832">1.2. Ascent</a></span></dt><dt><span class="section"><a href="#idp3351928">1.3. Descent</a></span></dt><dt><span class="section"><a href="#idp1234032">1.4. Landed</a></span></dt><dt><span class="section"><a href="#idp3388472">1.5. Site Map</a></span></dt></dl></dd><dt><span class="section"><a href="#idp1930856">2. Save Flight Data</a></span></dt><dt><span class="section"><a href="#idp3546840">3. Replay Flight</a></span></dt><dt><span class="section"><a href="#idp3331568">4. Graph Data</a></span></dt><dt><span class="section"><a href="#idp1385704">5. Export Data</a></span></dt><dd><dl><dt><span class="section"><a href="#idp3437744">5.1. Comma Separated Value Format</a></span></dt><dt><span class="section"><a href="#idp2912584">5.2. Keyhole Markup Language (for Google Earth)</a></span></dt></dl></dd><dt><span class="section"><a href="#idp2438432">6. Configure Altimeter</a></span></dt><dd><dl><dt><span class="section"><a href="#idp3551544">6.1. Main Deploy Altitude</a></span></dt><dt><span class="section"><a href="#idp2848008">6.2. Apogee Delay</a></span></dt><dt><span class="section"><a href="#idp3459616">6.3. Radio Frequency</a></span></dt><dt><span class="section"><a href="#idp2329488">6.4. Radio Calibration</a></span></dt><dt><span class="section"><a href="#idp3507216">6.5. Callsign</a></span></dt><dt><span class="section"><a href="#idp1223488">6.6. Maximum Flight Log Size</a></span></dt><dt><span class="section"><a href="#idp3489504">6.7. Ignite Mode</a></span></dt><dt><span class="section"><a href="#idp1526824">6.8. Pad Orientation</a></span></dt></dl></dd><dt><span class="section"><a href="#idp2433504">7. Configure AltosUI</a></span></dt><dd><dl><dt><span class="section"><a href="#idp3510984">7.1. Voice Settings</a></span></dt><dt><span class="section"><a href="#idp2029264">7.2. Log Directory</a></span></dt><dt><span class="section"><a href="#idp2350072">7.3. Callsign</a></span></dt><dt><span class="section"><a href="#idp2694528">7.4. Font Size</a></span></dt><dt><span class="section"><a href="#idp1856992">7.5. Serial Debug</a></span></dt><dt><span class="section"><a href="#idp1891664">7.6. Manage Frequencies</a></span></dt></dl></dd><dt><span class="section"><a href="#idp3058032">8. Flash Image</a></span></dt><dt><span class="section"><a href="#idp3184648">9. Fire Igniter</a></span></dt><dt><span class="section"><a href="#idp1519784">10. Scan Channels</a></span></dt><dt><span class="section"><a href="#idp2057448">11. Load Maps</a></span></dt><dt><span class="section"><a href="#idp1472424">12. Monitor Idle</a></span></dt></dl></div><p>
+ </p></div></div></div><div class="chapter" title="Chapter 6. AltosUI"><div class="titlepage"><div><div><h2 class="title"><a name="idp3525088"></a>Chapter 6. AltosUI</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#idp2539464">1. Monitor Flight</a></span></dt><dd><dl><dt><span class="section"><a href="#idp2507712">1.1. Launch Pad</a></span></dt><dt><span class="section"><a href="#idp2116736">1.2. Ascent</a></span></dt><dt><span class="section"><a href="#idp3192912">1.3. Descent</a></span></dt><dt><span class="section"><a href="#idp3341456">1.4. Landed</a></span></dt><dt><span class="section"><a href="#idp2011184">1.5. Site Map</a></span></dt></dl></dd><dt><span class="section"><a href="#idp3564984">2. Save Flight Data</a></span></dt><dt><span class="section"><a href="#idp3039048">3. Replay Flight</a></span></dt><dt><span class="section"><a href="#idp2169992">4. Graph Data</a></span></dt><dt><span class="section"><a href="#idp1875096">5. Export Data</a></span></dt><dd><dl><dt><span class="section"><a href="#idp2578272">5.1. Comma Separated Value Format</a></span></dt><dt><span class="section"><a href="#idp2875944">5.2. Keyhole Markup Language (for Google Earth)</a></span></dt></dl></dd><dt><span class="section"><a href="#idp2810064">6. Configure Altimeter</a></span></dt><dd><dl><dt><span class="section"><a href="#idp1391912">6.1. Main Deploy Altitude</a></span></dt><dt><span class="section"><a href="#idp3569008">6.2. Apogee Delay</a></span></dt><dt><span class="section"><a href="#idp3546448">6.3. Radio Frequency</a></span></dt><dt><span class="section"><a href="#idp2106808">6.4. Radio Calibration</a></span></dt><dt><span class="section"><a href="#idp2727816">6.5. Callsign</a></span></dt><dt><span class="section"><a href="#idp2159880">6.6. Maximum Flight Log Size</a></span></dt><dt><span class="section"><a href="#idp2199304">6.7. Ignite Mode</a></span></dt><dt><span class="section"><a href="#idp3176768">6.8. Pad Orientation</a></span></dt></dl></dd><dt><span class="section"><a href="#idp1614816">7. Configure AltosUI</a></span></dt><dd><dl><dt><span class="section"><a href="#idp1522712">7.1. Voice Settings</a></span></dt><dt><span class="section"><a href="#idp2951344">7.2. Log Directory</a></span></dt><dt><span class="section"><a href="#idp2704448">7.3. Callsign</a></span></dt><dt><span class="section"><a href="#idp2434112">7.4. Font Size</a></span></dt><dt><span class="section"><a href="#idp2866200">7.5. Serial Debug</a></span></dt><dt><span class="section"><a href="#idp2341272">7.6. Manage Frequencies</a></span></dt></dl></dd><dt><span class="section"><a href="#idp2198928">8. Flash Image</a></span></dt><dt><span class="section"><a href="#idp3268008">9. Fire Igniter</a></span></dt><dt><span class="section"><a href="#idp2748912">10. Scan Channels</a></span></dt><dt><span class="section"><a href="#idp2545000">11. Load Maps</a></span></dt><dt><span class="section"><a href="#idp2376832">12. Monitor Idle</a></span></dt></dl></div><p>
The AltosUI program provides a graphical user interface for
interacting with the Altus Metrum product family, including
TeleMetrum, TeleMini and TeleDongle. AltosUI can monitor telemetry data,
@@ -511,7 +511,7 @@ NAR #88757, TRA #12200<br>
buttons, one for each major activity in the system. This manual
is split into chapters, each of which documents one of the tasks
provided from the top-level toolbar.
- </p><div class="section" title="1. Monitor Flight"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2011040"></a>1. Monitor Flight</h2></div><div><h3 class="subtitle">Receive, Record and Display Telemetry Data</h3></div></div></div><p>
+ </p><div class="section" title="1. Monitor Flight"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2539464"></a>1. Monitor Flight</h2></div><div><h3 class="subtitle">Receive, Record and Display Telemetry Data</h3></div></div></div><p>
Selecting this item brings up a dialog box listing all of the
connected TeleDongle devices. When you choose one of these,
AltosUI will create a window to display telemetry data as
@@ -552,7 +552,7 @@ NAR #88757, TRA #12200<br>
data relevant to the current state of the flight. You can select
other tabs at any time. The final 'table' tab displays all of
the raw telemetry values in one place in a spreadsheet-like format.
- </p><div class="section" title="1.1. Launch Pad"><div class="titlepage"><div><div><h3 class="title"><a name="idp1611184"></a>1.1. Launch Pad</h3></div></div></div><p>
+ </p><div class="section" title="1.1. Launch Pad"><div class="titlepage"><div><div><h3 class="title"><a name="idp2507712"></a>1.1. Launch Pad</h3></div></div></div><p>
The 'Launch Pad' tab shows information used to decide when the
rocket is ready for flight. The first elements include red/green
indicators, if any of these is red, you'll want to evaluate
@@ -601,7 +601,7 @@ NAR #88757, TRA #12200<br>
and altitude, averaging many reported positions to improve the
accuracy of the fix.
</p><p>
- </p></div><div class="section" title="1.2. Ascent"><div class="titlepage"><div><div><h3 class="title"><a name="idp2194832"></a>1.2. Ascent</h3></div></div></div><p>
+ </p></div><div class="section" title="1.2. Ascent"><div class="titlepage"><div><div><h3 class="title"><a name="idp2116736"></a>1.2. Ascent</h3></div></div></div><p>
This tab is shown during Boost, Fast and Coast
phases. The information displayed here helps monitor the
rocket as it heads towards apogee.
@@ -620,7 +620,7 @@ NAR #88757, TRA #12200<br>
Finally, the current igniter voltages are reported as in the
Launch Pad tab. This can help diagnose deployment failures
caused by wiring which comes loose under high acceleration.
- </p></div><div class="section" title="1.3. Descent"><div class="titlepage"><div><div><h3 class="title"><a name="idp3351928"></a>1.3. Descent</h3></div></div></div><p>
+ </p></div><div class="section" title="1.3. Descent"><div class="titlepage"><div><div><h3 class="title"><a name="idp3192912"></a>1.3. Descent</h3></div></div></div><p>
Once the rocket has reached apogee and (we hope) activated the
apogee charge, attention switches to tracking the rocket on
the way back to the ground, and for dual-deploy flights,
@@ -647,7 +647,7 @@ NAR #88757, TRA #12200<br>
e-matches are designed to retain continuity even after being
fired, and will continue to show as green or return from red to
green after firing.
- </p></div><div class="section" title="1.4. Landed"><div class="titlepage"><div><div><h3 class="title"><a name="idp1234032"></a>1.4. Landed</h3></div></div></div><p>
+ </p></div><div class="section" title="1.4. Landed"><div class="titlepage"><div><div><h3 class="title"><a name="idp3341456"></a>1.4. Landed</h3></div></div></div><p>
Once the rocket is on the ground, attention switches to
recovery. While the radio signal is often lost once the
rocket is on the ground, the last reported GPS position is
@@ -676,7 +676,7 @@ NAR #88757, TRA #12200<br>
To get more detailed information about the flight, you can
click on the 'Graph Flight' button which will bring up a
graph window for the current flight.
- </p></div><div class="section" title="1.5. Site Map"><div class="titlepage"><div><div><h3 class="title"><a name="idp3388472"></a>1.5. Site Map</h3></div></div></div><p>
+ </p></div><div class="section" title="1.5. Site Map"><div class="titlepage"><div><div><h3 class="title"><a name="idp2011184"></a>1.5. Site Map</h3></div></div></div><p>
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
rocket, both while it is in the air, and when it has landed. The
@@ -695,7 +695,7 @@ NAR #88757, TRA #12200<br>
</p><p>
You can pre-load images for your favorite launch sites
before you leave home; check out the 'Preload Maps' section below.
- </p></div></div><div class="section" title="2. Save Flight Data"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp1930856"></a>2. Save Flight Data</h2></div></div></div><p>
+ </p></div></div><div class="section" title="2. Save Flight Data"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3564984"></a>2. Save Flight Data</h2></div></div></div><p>
The altimeter records flight data to its internal flash memory.
TeleMetrum data is recorded at a much higher rate than the telemetry
system can handle, and is not subject to radio drop-outs. As
@@ -726,7 +726,7 @@ NAR #88757, TRA #12200<br>
The file name for each flight log is computed automatically
from the recorded flight date, altimeter serial number and
flight number information.
- </p></div><div class="section" title="3. Replay Flight"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3546840"></a>3. Replay Flight</h2></div></div></div><p>
+ </p></div><div class="section" title="3. Replay Flight"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3039048"></a>3. Replay Flight</h2></div></div></div><p>
Select this button and you are prompted to select a flight
record file, either a .telem file recording telemetry data or a
.eeprom file containing flight data saved from the altimeter
@@ -735,7 +735,7 @@ NAR #88757, TRA #12200<br>
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.
- </p></div><div class="section" title="4. Graph Data"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3331568"></a>4. Graph Data</h2></div></div></div><p>
+ </p></div><div class="section" title="4. Graph Data"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2169992"></a>4. Graph Data</h2></div></div></div><p>
Select this button and you are prompted to select a flight
record file, either a .telem file recording telemetry data or a
.eeprom file containing flight data saved from
@@ -760,7 +760,7 @@ NAR #88757, TRA #12200<br>
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.
- </p></div><div class="section" title="5. Export Data"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp1385704"></a>5. Export Data</h2></div></div></div><p>
+ </p></div><div class="section" title="5. Export Data"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp1875096"></a>5. Export Data</h2></div></div></div><p>
This tool takes the raw data files and makes them available for
external analysis. When you select this button, you are prompted to
select a flight
@@ -769,7 +769,7 @@ NAR #88757, TRA #12200<br>
data). 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.
- </p><div class="section" title="5.1. Comma Separated Value Format"><div class="titlepage"><div><div><h3 class="title"><a name="idp3437744"></a>5.1. Comma Separated Value Format</h3></div></div></div><p>
+ </p><div class="section" title="5.1. Comma Separated Value Format"><div class="titlepage"><div><div><h3 class="title"><a name="idp2578272"></a>5.1. Comma Separated Value Format</h3></div></div></div><p>
This is a text file containing the data in a form suitable for
import into a spreadsheet or other external data analysis
tool. The first few lines of the file contain the version and
@@ -783,11 +783,11 @@ NAR #88757, TRA #12200<br>
the sensor values are converted to standard units, with the
barometric data reported in both pressure, altitude and
height above pad units.
- </p></div><div class="section" title="5.2. Keyhole Markup Language (for Google Earth)"><div class="titlepage"><div><div><h3 class="title"><a name="idp2912584"></a>5.2. Keyhole Markup Language (for Google Earth)</h3></div></div></div><p>
+ </p></div><div class="section" title="5.2. Keyhole Markup Language (for Google Earth)"><div class="titlepage"><div><div><h3 class="title"><a name="idp2875944"></a>5.2. Keyhole Markup Language (for Google Earth)</h3></div></div></div><p>
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.
- </p></div></div><div class="section" title="6. Configure Altimeter"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2438432"></a>6. Configure Altimeter</h2></div></div></div><p>
+ </p></div></div><div class="section" title="6. Configure Altimeter"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2810064"></a>6. Configure Altimeter</h2></div></div></div><p>
Select this button and then select either a TeleMetrum or
TeleDongle Device from the list provided. Selecting a TeleDongle
device will use the radio link to configure a remote altimeter.
@@ -815,14 +815,14 @@ NAR #88757, TRA #12200<br>
lost.
</p></li></ul></div><p>
The rest of the dialog contains the parameters to be configured.
- </p><div class="section" title="6.1. Main Deploy Altitude"><div class="titlepage"><div><div><h3 class="title"><a name="idp3551544"></a>6.1. Main Deploy Altitude</h3></div></div></div><p>
+ </p><div class="section" title="6.1. Main Deploy Altitude"><div class="titlepage"><div><div><h3 class="title"><a name="idp1391912"></a>6.1. Main Deploy Altitude</h3></div></div></div><p>
This sets the altitude (above the recorded pad altitude) at
which the 'main' igniter will fire. The drop-down menu shows
some common values, but you can edit the text directly and
choose whatever you like. If the apogee charge fires below
this altitude, then the main charge will fire two seconds
after the apogee charge fires.
- </p></div><div class="section" title="6.2. Apogee Delay"><div class="titlepage"><div><div><h3 class="title"><a name="idp2848008"></a>6.2. Apogee Delay</h3></div></div></div><p>
+ </p></div><div class="section" title="6.2. Apogee Delay"><div class="titlepage"><div><div><h3 class="title"><a name="idp3569008"></a>6.2. Apogee Delay</h3></div></div></div><p>
When flying redundant electronics, it's often important to
ensure that multiple apogee charges don't fire at precisely
the same time, as that can over pressurize the apogee deployment
@@ -830,13 +830,13 @@ NAR #88757, TRA #12200<br>
Delay parameter tells the flight computer to fire the apogee
charge a certain number of seconds after apogee has been
detected.
- </p></div><div class="section" title="6.3. Radio Frequency"><div class="titlepage"><div><div><h3 class="title"><a name="idp3459616"></a>6.3. Radio Frequency</h3></div></div></div><p>
+ </p></div><div class="section" title="6.3. Radio Frequency"><div class="titlepage"><div><div><h3 class="title"><a name="idp3546448"></a>6.3. Radio Frequency</h3></div></div></div><p>
This configures which of the configured frequencies to use for both
telemetry and packet command mode. Note that if you set this
value via packet command mode, you will have to reconfigure
the TeleDongle frequency before you will be able to use packet
command mode again.
- </p></div><div class="section" title="6.4. Radio Calibration"><div class="titlepage"><div><div><h3 class="title"><a name="idp2329488"></a>6.4. Radio Calibration</h3></div></div></div><p>
+ </p></div><div class="section" title="6.4. Radio Calibration"><div class="titlepage"><div><div><h3 class="title"><a name="idp2106808"></a>6.4. Radio Calibration</h3></div></div></div><p>
The radios in every Altus Metrum device are calibrated at the
factory to ensure that they transmit and receive on the
specified frequency. If you need to you can adjust the calibration
@@ -844,15 +844,15 @@ NAR #88757, TRA #12200<br>
the value means, read the appendix on calibration and/or the source
code for more information. To change a TeleDongle's calibration,
you must reprogram the unit completely.
- </p></div><div class="section" title="6.5. Callsign"><div class="titlepage"><div><div><h3 class="title"><a name="idp3507216"></a>6.5. Callsign</h3></div></div></div><p>
+ </p></div><div class="section" title="6.5. Callsign"><div class="titlepage"><div><div><h3 class="title"><a name="idp2727816"></a>6.5. Callsign</h3></div></div></div><p>
This sets the call sign included in each telemetry packet. Set this
as needed to conform to your local radio regulations.
- </p></div><div class="section" title="6.6. Maximum Flight Log Size"><div class="titlepage"><div><div><h3 class="title"><a name="idp1223488"></a>6.6. Maximum Flight Log Size</h3></div></div></div><p>
+ </p></div><div class="section" title="6.6. Maximum Flight Log Size"><div class="titlepage"><div><div><h3 class="title"><a name="idp2159880"></a>6.6. Maximum Flight Log Size</h3></div></div></div><p>
This sets the space (in kilobytes) allocated for each flight
log. The available space will be divided into chunks of this
size. A smaller value will allow more flights to be stored,
a larger value will record data from longer flights.
- </p></div><div class="section" title="6.7. Ignite Mode"><div class="titlepage"><div><div><h3 class="title"><a name="idp3489504"></a>6.7. Ignite Mode</h3></div></div></div><p>
+ </p></div><div class="section" title="6.7. Ignite Mode"><div class="titlepage"><div><div><h3 class="title"><a name="idp2199304"></a>6.7. Ignite Mode</h3></div></div></div><p>
TeleMetrum and TeleMini provide two igniter channels as they
were originally designed as dual-deploy flight
computers. This configuration parameter allows the two
@@ -872,7 +872,7 @@ NAR #88757, TRA #12200<br>
Altitude setting during descent. The 'apogee'
channel is fired first, followed after a two second
delay by the 'main' channel.
- </p></li></ul></div></div><div class="section" title="6.8. Pad Orientation"><div class="titlepage"><div><div><h3 class="title"><a name="idp1526824"></a>6.8. Pad Orientation</h3></div></div></div><p>
+ </p></li></ul></div></div><div class="section" title="6.8. Pad Orientation"><div class="titlepage"><div><div><h3 class="title"><a name="idp3176768"></a>6.8. Pad Orientation</h3></div></div></div><p>
Because it includes an accelerometer, TeleMetrum is
sensitive to the orientation of the board. By default, it
expects the antenna end to point forward. This parameter
@@ -886,9 +886,9 @@ NAR #88757, TRA #12200<br>
Antenna Down. In this mode, the antenna end of the
TeleMetrum board must point aft, in line with the
expected flight path.
- </p></li></ul></div></div></div><div class="section" title="7. Configure AltosUI"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2433504"></a>7. Configure AltosUI</h2></div></div></div><p>
+ </p></li></ul></div></div></div><div class="section" title="7. Configure AltosUI"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp1614816"></a>7. Configure AltosUI</h2></div></div></div><p>
This button presents a dialog so that you can configure the AltosUI global settings.
- </p><div class="section" title="7.1. Voice Settings"><div class="titlepage"><div><div><h3 class="title"><a name="idp3510984"></a>7.1. Voice Settings</h3></div></div></div><p>
+ </p><div class="section" title="7.1. Voice Settings"><div class="titlepage"><div><div><h3 class="title"><a name="idp1522712"></a>7.1. Voice Settings</h3></div></div></div><p>
AltosUI provides voice announcements during flight so that you
can keep your eyes on the sky and still get information about
the current flight status. However, sometimes you don't want
@@ -897,7 +897,7 @@ NAR #88757, TRA #12200<br>
Test Voice&#8212;Plays a short message allowing you to verify
that the audio system is working and the volume settings
are reasonable
- </p></li></ul></div></div><div class="section" title="7.2. Log Directory"><div class="titlepage"><div><div><h3 class="title"><a name="idp2029264"></a>7.2. Log Directory</h3></div></div></div><p>
+ </p></li></ul></div></div><div class="section" title="7.2. Log Directory"><div class="titlepage"><div><div><h3 class="title"><a name="idp2951344"></a>7.2. Log Directory</h3></div></div></div><p>
AltosUI logs all telemetry data and saves all TeleMetrum flash
data to this directory. This directory is also used as the
staring point when selecting data files for display or export.
@@ -905,30 +905,30 @@ NAR #88757, TRA #12200<br>
Click on the directory name to bring up a directory choosing
dialog, select a new directory and click 'Select Directory' to
change where AltosUI reads and writes data files.
- </p></div><div class="section" title="7.3. Callsign"><div class="titlepage"><div><div><h3 class="title"><a name="idp2350072"></a>7.3. Callsign</h3></div></div></div><p>
+ </p></div><div class="section" title="7.3. Callsign"><div class="titlepage"><div><div><h3 class="title"><a name="idp2704448"></a>7.3. Callsign</h3></div></div></div><p>
This value is transmitted in each command packet sent from
TeleDongle and received from an altimeter. It is not used in
telemetry mode, as the callsign configured in the altimeter board
is included in all telemetry packets. Configure this
with the AltosUI operators call sign as needed to comply with
your local radio regulations.
- </p></div><div class="section" title="7.4. Font Size"><div class="titlepage"><div><div><h3 class="title"><a name="idp2694528"></a>7.4. Font Size</h3></div></div></div><p>
+ </p></div><div class="section" title="7.4. Font Size"><div class="titlepage"><div><div><h3 class="title"><a name="idp2434112"></a>7.4. Font Size</h3></div></div></div><p>
Selects the set of fonts used in the flight monitor
window. Choose between the small, medium and large sets.
- </p></div><div class="section" title="7.5. Serial Debug"><div class="titlepage"><div><div><h3 class="title"><a name="idp1856992"></a>7.5. Serial Debug</h3></div></div></div><p>
+ </p></div><div class="section" title="7.5. Serial Debug"><div class="titlepage"><div><div><h3 class="title"><a name="idp2866200"></a>7.5. Serial Debug</h3></div></div></div><p>
This causes all communication with a connected device to be
dumped to the console from which AltosUI was started. If
you've started it from an icon or menu entry, the output
will simply be discarded. This mode can be useful to debug
various serial communication issues.
- </p></div><div class="section" title="7.6. Manage Frequencies"><div class="titlepage"><div><div><h3 class="title"><a name="idp1891664"></a>7.6. Manage Frequencies</h3></div></div></div><p>
+ </p></div><div class="section" title="7.6. Manage Frequencies"><div class="titlepage"><div><div><h3 class="title"><a name="idp2341272"></a>7.6. Manage Frequencies</h3></div></div></div><p>
This brings up a dialog where you can configure the set of
frequencies shown in the various frequency menus. You can
add as many as you like, or even reconfigure the default
set. Changing this list does not affect the frequency
settings of any devices, it only changes the set of
frequencies shown in the menus.
- </p></div></div><div class="section" title="8. Flash Image"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3058032"></a>8. Flash Image</h2></div></div></div><p>
+ </p></div></div><div class="section" title="8. Flash Image"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2198928"></a>8. Flash Image</h2></div></div></div><p>
This reprograms any Altus Metrum device by using a TeleMetrum
or TeleDongle as a programming dongle. Please read the
directions for flashing devices in the Updating Device
@@ -958,7 +958,7 @@ NAR #88757, TRA #12200<br>
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.
- </p></div><div class="section" title="9. Fire Igniter"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3184648"></a>9. Fire Igniter</h2></div></div></div><p>
+ </p></div><div class="section" title="9. Fire Igniter"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3268008"></a>9. Fire Igniter</h2></div></div></div><p>
This activates the igniter circuits in TeleMetrum to help test
recovery systems deployment. Because this command can operate
over the Packet Command Link, you can prepare the rocket as
@@ -978,14 +978,14 @@ NAR #88757, TRA #12200<br>
you have 10 seconds to press the 'Fire' button or the system
will deactivate, at which point you start over again at
selecting the desired igniter.
- </p></div><div class="section" title="10. Scan Channels"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp1519784"></a>10. Scan Channels</h2></div></div></div><p>
+ </p></div><div class="section" title="10. Scan Channels"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2748912"></a>10. Scan Channels</h2></div></div></div><p>
This listens for telemetry packets on all of the configured
frequencies, displaying information about each device it
receives a packet from. You can select which of the three
telemetry formats should be tried; by default, it only listens
for the standard telemetry packets used in v1.0 and later
firmware.
- </p></div><div class="section" title="11. Load Maps"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2057448"></a>11. Load Maps</h2></div></div></div><p>
+ </p></div><div class="section" title="11. Load Maps"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2545000"></a>11. Load Maps</h2></div></div></div><p>
Before heading out to a new launch site, you can use this to
load satellite images in case you don't have internet
connectivity at the site. This loads a fairly large area
@@ -1004,16 +1004,16 @@ NAR #88757, TRA #12200<br>
once, so if you load more than one launch site, you may get
some gray areas in the map which indicate that Google is tired
of sending data to you. Try again later.
- </p></div><div class="section" title="12. Monitor Idle"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp1472424"></a>12. Monitor Idle</h2></div></div></div><p>
+ </p></div><div class="section" title="12. Monitor Idle"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2376832"></a>12. Monitor Idle</h2></div></div></div><p>
This brings up a dialog similar to the Monitor Flight UI,
except it works with the altimeter in "idle" mode by sending
query commands to discover the current state rather than
listening for telemetry packets.
- </p></div></div><div class="chapter" title="Chapter 7. Using Altus Metrum Products"><div class="titlepage"><div><div><h2 class="title"><a name="idp3231728"></a>Chapter 7. Using Altus Metrum Products</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#idp2024456">1. Being Legal</a></span></dt><dt><span class="section"><a href="#idp2425408">2. In the Rocket</a></span></dt><dt><span class="section"><a href="#idp2236704">3. On the Ground</a></span></dt><dt><span class="section"><a href="#idp2243664">4. Data Analysis</a></span></dt><dt><span class="section"><a href="#idp2104880">5. Future Plans</a></span></dt></dl></div><div class="section" title="1. Being Legal"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2024456"></a>1. Being Legal</h2></div></div></div><p>
+ </p></div></div><div class="chapter" title="Chapter 7. Using Altus Metrum Products"><div class="titlepage"><div><div><h2 class="title"><a name="idp1384336"></a>Chapter 7. Using Altus Metrum Products</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#idp1372064">1. Being Legal</a></span></dt><dt><span class="section"><a href="#idp2120808">2. In the Rocket</a></span></dt><dt><span class="section"><a href="#idp2111736">3. On the Ground</a></span></dt><dt><span class="section"><a href="#idp2590104">4. Data Analysis</a></span></dt><dt><span class="section"><a href="#idp916736">5. Future Plans</a></span></dt></dl></div><div class="section" title="1. Being Legal"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp1372064"></a>1. Being Legal</h2></div></div></div><p>
First off, in the US, you need an <a class="ulink" href="http://www.altusmetrum.org/Radio/" target="_top">amateur radio license</a> or
other authorization to legally operate the radio transmitters that are part
of our products.
- </p></div><div class="section" title="2. In the Rocket"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2425408"></a>2. In the Rocket</h2></div></div></div><p>
+ </p></div><div class="section" title="2. In the Rocket"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2120808"></a>2. In the Rocket</h2></div></div></div><p>
In the rocket itself, you just need a <a class="ulink" href="http://www.altusmetrum.org/TeleMetrum/" target="_top">TeleMetrum</a> or
<a class="ulink" href="http://www.altusmetrum.org/TeleMini/" target="_top">TeleMini</a> board and
a Li-Po rechargeable battery. An 860mAh battery weighs less than a 9V
@@ -1026,7 +1026,7 @@ NAR #88757, TRA #12200<br>
which is opaque to RF signals, you may choose to have an SMA connector
installed so that you can run a coaxial cable to an antenna mounted
elsewhere in the rocket.
- </p></div><div class="section" title="3. On the Ground"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2236704"></a>3. On the Ground</h2></div></div></div><p>
+ </p></div><div class="section" title="3. On the Ground"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2111736"></a>3. On the Ground</h2></div></div></div><p>
To receive the data stream from the rocket, you need an antenna and short
feed-line connected to one of our <a class="ulink" href="http://www.altusmetrum.org/TeleDongle/" target="_top">TeleDongle</a> units. The
TeleDongle in turn plugs directly into the USB port on a notebook
@@ -1077,7 +1077,7 @@ NAR #88757, TRA #12200<br>
</a>
The 440-3 and 440-5 are both good choices for finding a
TeleMetrum- or TeleMini- equipped rocket when used with a suitable 70cm HT.
- </p></div><div class="section" title="4. Data Analysis"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2243664"></a>4. Data Analysis</h2></div></div></div><p>
+ </p></div><div class="section" title="4. Data Analysis"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2590104"></a>4. Data Analysis</h2></div></div></div><p>
Our software makes it easy to log the data from each flight, both the
telemetry received during the flight itself, and the more
complete data log recorded in the flash memory on the altimeter
@@ -1092,7 +1092,7 @@ NAR #88757, TRA #12200<br>
Our ultimate goal is to emit a set of files for each flight that can be
published as a web page per flight, or just viewed on your local disk with
a web browser.
- </p></div><div class="section" title="5. Future Plans"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2104880"></a>5. Future Plans</h2></div></div></div><p>
+ </p></div><div class="section" title="5. Future Plans"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp916736"></a>5. Future Plans</h2></div></div></div><p>
In the future, we intend to offer "companion boards" for the rocket that will
plug in to TeleMetrum to collect additional data, provide more pyro channels,
and so forth.
@@ -1107,14 +1107,14 @@ NAR #88757, TRA #12200<br>
if you have some great idea for an addition to the current Altus Metrum family,
feel free to dive in and help! Or let us know what you'd like to see that
we aren't already working on, and maybe we'll get excited about it too...
- </p></div></div><div class="chapter" title="Chapter 8. Altimeter Installation Recommendations"><div class="titlepage"><div><div><h2 class="title"><a name="idp3340600"></a>Chapter 8. Altimeter Installation Recommendations</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#idp3522016">1. Mounting the Altimeter</a></span></dt><dt><span class="section"><a href="#idp2062944">2. Dealing with the Antenna</a></span></dt><dt><span class="section"><a href="#idp2075472">3. Preserving GPS Reception</a></span></dt><dt><span class="section"><a href="#idp1887864">4. Radio Frequency Interference</a></span></dt><dt><span class="section"><a href="#idp2902592">5. The Barometric Sensor</a></span></dt><dt><span class="section"><a href="#idp2991488">6. Ground Testing</a></span></dt></dl></div><p>
+ </p></div></div><div class="chapter" title="Chapter 8. Altimeter Installation Recommendations"><div class="titlepage"><div><div><h2 class="title"><a name="idp1877664"></a>Chapter 8. Altimeter Installation Recommendations</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#idp2776168">1. Mounting the Altimeter</a></span></dt><dt><span class="section"><a href="#idp3422920">2. Dealing with the Antenna</a></span></dt><dt><span class="section"><a href="#idp2493216">3. Preserving GPS Reception</a></span></dt><dt><span class="section"><a href="#idp2097000">4. Radio Frequency Interference</a></span></dt><dt><span class="section"><a href="#idp3092536">5. The Barometric Sensor</a></span></dt><dt><span class="section"><a href="#idp3323072">6. Ground Testing</a></span></dt></dl></div><p>
Building high-power rockets that fly safely is hard enough. Mix
in some sophisticated electronics and a bunch of radio energy
and oftentimes you find few perfect solutions. This chapter
contains some suggestions about how to install Altus Metrum
products into the rocket air-frame, including how to safely and
reliably mix a variety of electronics into the same air-frame.
- </p><div class="section" title="1. Mounting the Altimeter"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3522016"></a>1. Mounting the Altimeter</h2></div></div></div><p>
+ </p><div class="section" title="1. Mounting the Altimeter"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2776168"></a>1. Mounting the Altimeter</h2></div></div></div><p>
The first consideration is to ensure that the altimeter is
securely fastened to the air-frame. For TeleMetrum, we use
nylon standoffs and nylon screws; they're good to at least 50G
@@ -1131,7 +1131,7 @@ NAR #88757, TRA #12200<br>
Watch for any metal touching components on the
board. Shorting out connections on the bottom of the board
can cause the altimeter to fail during flight.
- </li></ol></div></div><div class="section" title="2. Dealing with the Antenna"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2062944"></a>2. Dealing with the Antenna</h2></div></div></div><p>
+ </li></ol></div></div><div class="section" title="2. Dealing with the Antenna"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3422920"></a>2. Dealing with the Antenna</h2></div></div></div><p>
The antenna supplied is just a piece of solid, insulated,
wire. If it gets damaged or broken, it can be easily
replaced. It should be kept straight and not cut; bending or
@@ -1174,7 +1174,7 @@ NAR #88757, TRA #12200<br>
SMA connector, and then run 50&#937; coax from the board to the
antenna. Building a remote antenna is beyond the scope of this
manual.
- </p></div><div class="section" title="3. Preserving GPS Reception"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2075472"></a>3. Preserving GPS Reception</h2></div></div></div><p>
+ </p></div><div class="section" title="3. Preserving GPS Reception"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2493216"></a>3. Preserving GPS Reception</h2></div></div></div><p>
The GPS antenna and receiver in TeleMetrum are highly
sensitive and normally have no trouble tracking enough
satellites to provide accurate position information for
@@ -1193,7 +1193,7 @@ NAR #88757, TRA #12200<br>
antenna as that's covered with a ground plane. But, keep
wires and metal out from above the patch antenna.
</li></ol></div><p>
- </p></div><div class="section" title="4. Radio Frequency Interference"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp1887864"></a>4. Radio Frequency Interference</h2></div></div></div><p>
+ </p></div><div class="section" title="4. Radio Frequency Interference"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2097000"></a>4. Radio Frequency Interference</h2></div></div></div><p>
Any altimeter will generate RFI; the digital circuits use
high-frequency clocks that spray radio interference across a
wide band. Altus Metrum altimeters generate intentional radio
@@ -1231,7 +1231,7 @@ NAR #88757, TRA #12200<br>
70cm amateur band, so you should avoid lengths that are a
simple ratio of that length; essentially any multiple of 1/4
of the wavelength (17.5cm).
- </li></ul></div></div><div class="section" title="5. The Barometric Sensor"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2902592"></a>5. The Barometric Sensor</h2></div></div></div><p>
+ </li></ul></div></div><div class="section" title="5. The Barometric Sensor"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3092536"></a>5. The Barometric Sensor</h2></div></div></div><p>
Altusmetrum altimeters measure altitude with a barometric
sensor, essentially measuring the amount of air above the
rocket to figure out how high it is. A large number of
@@ -1249,7 +1249,7 @@ NAR #88757, TRA #12200<br>
chemical damage from the products of APCP or BP combustion, so
make sure the ebay is carefully sealed from any compartment
which contains ejection charges or motors.
- </p></div><div class="section" title="6. Ground Testing"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2991488"></a>6. Ground Testing</h2></div></div></div><p>
+ </p></div><div class="section" title="6. Ground Testing"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3323072"></a>6. Ground Testing</h2></div></div></div><p>
The most important aspect of any installation is careful
ground testing. Bringing an air-frame up to the LCO table which
hasn't been ground tested can lead to delays or ejection
@@ -1271,7 +1271,7 @@ NAR #88757, TRA #12200<br>
interface through a TeleDongle to command each charge to
fire. Make sure the charge is sufficient to robustly separate
the air-frame and deploy the recovery system.
- </p></div></div><div class="chapter" title="Chapter 9. Updating Device Firmware"><div class="titlepage"><div><div><h2 class="title"><a name="idp2336184"></a>Chapter 9. Updating Device Firmware</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#idp3061016">1. Updating TeleMetrum Firmware</a></span></dt><dt><span class="section"><a href="#idp1980776">2. Updating TeleMini Firmware</a></span></dt><dt><span class="section"><a href="#idp2731488">3. Updating TeleDongle Firmware</a></span></dt></dl></div><p>
+ </p></div></div><div class="chapter" title="Chapter 9. Updating Device Firmware"><div class="titlepage"><div><div><h2 class="title"><a name="idp2657144"></a>Chapter 9. Updating Device Firmware</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#idp2722712">1. Updating TeleMetrum Firmware</a></span></dt><dt><span class="section"><a href="#idp1268600">2. Updating TeleMini Firmware</a></span></dt><dt><span class="section"><a href="#idp1444904">3. Updating TeleDongle Firmware</a></span></dt></dl></div><p>
The big concept to understand is that you have to use a
TeleDongle as a programmer to update a TeleMetrum or TeleMini,
and a TeleMetrum or other TeleDongle to program the TeleDongle
@@ -1287,7 +1287,7 @@ NAR #88757, TRA #12200<br>
version from <a class="ulink" href="http://www.altusmetrum.org/AltOS/" target="_top">http://www.altusmetrum.org/AltOS/</a>.
</p><p>
We recommend updating the altimeter first, before updating TeleDongle.
- </p><div class="section" title="1. Updating TeleMetrum Firmware"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3061016"></a>1. Updating TeleMetrum Firmware</h2></div></div></div><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
+ </p><div class="section" title="1. Updating TeleMetrum Firmware"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2722712"></a>1. Updating TeleMetrum Firmware</h2></div></div></div><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
Find the 'programming cable' that you got as part of the starter
kit, that has a red 8-pin MicroMaTch connector on one end and a
red 4-pin MicroMaTch connector on the other end.
@@ -1313,7 +1313,7 @@ NAR #88757, TRA #12200<br>
programming device.
</li><li class="listitem">
Select the image you want put on the TeleMetrum, which should have a
- name in the form telemetrum-v1.1-1.0.0.ihx. It should be visible
+ name in the form telemetrum-v1.2-1.0.0.ihx. It should be visible
in the default directory, if not you may have to poke around
your system to find it.
</li><li class="listitem">
@@ -1330,7 +1330,7 @@ NAR #88757, TRA #12200<br>
the version, etc.
</li><li class="listitem">
If something goes wrong, give it another try.
- </li></ol></div></div><div class="section" title="2. Updating TeleMini Firmware"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp1980776"></a>2. Updating TeleMini Firmware</h2></div></div></div><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
+ </li></ol></div></div><div class="section" title="2. Updating TeleMini Firmware"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp1268600"></a>2. Updating TeleMini Firmware</h2></div></div></div><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
You'll need a special 'programming cable' to reprogram the
TeleMini. It's available on the Altus Metrum web store, or
you can make your own using an 8-pin MicroMaTch connector on
@@ -1374,7 +1374,7 @@ NAR #88757, TRA #12200<br>
letting it come up in "flight" mode and listening for telemetry.
</li><li class="listitem">
If something goes wrong, give it another try.
- </li></ol></div></div><div class="section" title="3. Updating TeleDongle Firmware"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2731488"></a>3. Updating TeleDongle Firmware</h2></div></div></div><p>
+ </li></ol></div></div><div class="section" title="3. Updating TeleDongle Firmware"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp1444904"></a>3. Updating TeleDongle Firmware</h2></div></div></div><p>
Updating TeleDongle's firmware is just like updating TeleMetrum or TeleMini
firmware, but you use either a TeleMetrum or another TeleDongle as the programmer.
</p><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
@@ -1434,7 +1434,7 @@ NAR #88757, TRA #12200<br>
slightly to extract the connector. We used a locking connector on
TeleMetrum to help ensure that the cabling to companion boards
used in a rocket don't ever come loose accidentally in flight.
- </p></div></div><div class="chapter" title="Chapter 10. Hardware Specifications"><div class="titlepage"><div><div><h2 class="title"><a name="idp2742616"></a>Chapter 10. Hardware Specifications</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#idp3450088">1. TeleMetrum Specifications</a></span></dt><dt><span class="section"><a href="#idp2397848">2. TeleMini Specifications</a></span></dt></dl></div><div class="section" title="1. TeleMetrum Specifications"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3450088"></a>1. TeleMetrum Specifications</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
+ </p></div></div><div class="chapter" title="Chapter 10. Hardware Specifications"><div class="titlepage"><div><div><h2 class="title"><a name="idp3431816"></a>Chapter 10. Hardware Specifications</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#idp2831496">1. TeleMetrum Specifications</a></span></dt><dt><span class="section"><a href="#idp3455400">2. TeleMini Specifications</a></span></dt></dl></div><div class="section" title="1. TeleMetrum Specifications"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2831496"></a>1. TeleMetrum Specifications</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
Recording altimeter for model rocketry.
</p></li><li class="listitem"><p>
Supports dual deployment (can fire 2 ejection charges).
@@ -1458,7 +1458,7 @@ NAR #88757, TRA #12200<br>
optional separate pyro battery if needed.
</p></li><li class="listitem"><p>
2.75 x 1 inch board designed to fit inside 29mm air-frame coupler tube.
- </p></li></ul></div></div><div class="section" title="2. TeleMini Specifications"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2397848"></a>2. TeleMini Specifications</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
+ </p></li></ul></div></div><div class="section" title="2. TeleMini Specifications"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3455400"></a>2. TeleMini Specifications</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
Recording altimeter for model rocketry.
</p></li><li class="listitem"><p>
Supports dual deployment (can fire 2 ejection charges).
@@ -1477,7 +1477,7 @@ NAR #88757, TRA #12200<br>
optional separate pyro battery if needed.
</p></li><li class="listitem"><p>
1.5 x .5 inch board designed to fit inside 18mm air-frame coupler tube.
- </p></li></ul></div></div></div><div class="chapter" title="Chapter 11. FAQ"><div class="titlepage"><div><div><h2 class="title"><a name="idp3517088"></a>Chapter 11. FAQ</h2></div></div></div><p>
+ </p></li></ul></div></div></div><div class="chapter" title="Chapter 11. FAQ"><div class="titlepage"><div><div><h2 class="title"><a name="idp3104824"></a>Chapter 11. FAQ</h2></div></div></div><p>
TeleMetrum seems to shut off when disconnected from the
computer. Make sure the battery is adequately charged. Remember the
unit will pull more power than the USB port can deliver before the
@@ -1517,7 +1517,7 @@ NAR #88757, TRA #12200<br>
data after physically retrieving your altimeter. Make sure to save
the on-board data after each flight; while the TeleMetrum can store
multiple flights, you never know when you'll lose the altimeter...
- </p></div><div class="appendix" title="Appendix A. Notes for Older Software"><div class="titlepage"><div><div><h2 class="title"><a name="idp2358816"></a>Appendix A. Notes for Older Software</h2></div></div></div><p>
+ </p></div><div class="appendix" title="Appendix A. Notes for Older Software"><div class="titlepage"><div><div><h2 class="title"><a name="idp2639136"></a>Appendix A. Notes for Older Software</h2></div></div></div><p>
<span class="emphasis"><em>
Before AltosUI was written, using Altus Metrum devices required
some finesse with the Linux command line. There was a limited
@@ -1693,7 +1693,7 @@ NAR #88757, TRA #12200<br>
the Log and Device menus. It has a wonderful display of the incoming
flight data and I am sure you will enjoy what it has to say to you
once you enable the voice output!
- </p></div><div class="appendix" title="Appendix B. Calibration"><div class="titlepage"><div><div><h2 class="title"><a name="idp2555760"></a>Appendix B. Calibration</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#idp1119368">1. Radio Frequency</a></span></dt><dt><span class="section"><a href="#idp3257080">2. TeleMetrum Accelerometer</a></span></dt></dl></div><p>
+ </p></div><div class="appendix" title="Appendix B. Calibration"><div class="titlepage"><div><div><h2 class="title"><a name="idp2228272"></a>Appendix B. Calibration</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#idp1912752">1. Radio Frequency</a></span></dt><dt><span class="section"><a href="#idp2744568">2. TeleMetrum Accelerometer</a></span></dt></dl></div><p>
There are only two calibrations required for a TeleMetrum board, and
only one for TeleDongle and TeleMini. All boards are shipped from
the factory pre-calibrated, but the procedures are documented here
@@ -1701,7 +1701,7 @@ NAR #88757, TRA #12200<br>
AltosUI, you must connect to the board with a serial terminal program
and interact directly with the on-board command interpreter to effect
calibration.
- </p><div class="section" title="1. Radio Frequency"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp1119368"></a>1. Radio Frequency</h2></div></div></div><p>
+ </p><div class="section" title="1. Radio Frequency"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp1912752"></a>1. Radio Frequency</h2></div></div></div><p>
The radio frequency is synthesized from a clock based on the 48 MHz
crystal on the board. The actual frequency of this oscillator
must be measured to generate a calibration constant. While our
@@ -1736,7 +1736,7 @@ NAR #88757, TRA #12200<br>
radio frequency is reset to the default 434.550 Mhz. If you want
to use another frequency, you will have to set that again after
calibration is completed.
- </p></div><div class="section" title="2. TeleMetrum Accelerometer"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp3257080"></a>2. TeleMetrum Accelerometer</h2></div></div></div><p>
+ </p></div><div class="section" title="2. TeleMetrum Accelerometer"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2744568"></a>2. TeleMetrum Accelerometer</h2></div></div></div><p>
The TeleMetrum accelerometer we use has its own 5 volt power
supply and
the output must be passed through a resistive voltage divider to match
@@ -1780,7 +1780,16 @@ NAR #88757, TRA #12200<br>
to the index post on the 4-pin end of the programming cable, and
power up the board. It should come up in 'idle mode' (two beeps),
allowing a re-cal.
- </p></div></div><div class="appendix" title="Appendix C. Release Notes"><div class="titlepage"><div><div><h2 class="title"><a name="idp2653672"></a>Appendix C. Release Notes</h2></div></div></div><p>
+ </p></div></div><div class="appendix" title="Appendix C. Release Notes"><div class="titlepage"><div><div><h2 class="title"><a name="idp1711112"></a>Appendix C. Release Notes</h2></div></div></div><p>
+ Version 1.0.3 is a minor release adding support for TeleMetrum v1.2 boards
+ </p><p>
+ AltOS Firmware Changes
+ </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
+ TeleMetrum version 1.2 is functionally identical to version 1.1, the
+ only change required in the firmware was to adjust the product name reported
+ over the USB link.
+ </li></ul></div><p>
+ </p><p>
Version 1.0.2 is a bugfix release, addressing a minor issue
found in version 1.0.1
</p><p>
diff --git a/AltOS/doc/altusmetrum.pdf b/AltOS/doc/altusmetrum.pdf
index 080517e..cead169 100644
--- a/AltOS/doc/altusmetrum.pdf
+++ b/AltOS/doc/altusmetrum.pdf
Binary files differ
diff --git a/AltOS/doc/release-notes-0.7.1.html b/AltOS/doc/release-notes-0.7.1.html
index 5a4aff2..7012755 100644
--- a/AltOS/doc/release-notes-0.7.1.html
+++ b/AltOS/doc/release-notes-0.7.1.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title></title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="article"><div class="titlepage"><hr></div><p>
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title></title><meta name="generator" content="DocBook XSL Stylesheets V1.76.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="article"><div class="titlepage"><hr></div><p>
Version 0.7.1 is the first release containing our new cross-platform Java-based user interface. AltosUI can:
</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
Receive and log telemetry from a connected TeleDongle
diff --git a/AltOS/doc/release-notes-0.8.html b/AltOS/doc/release-notes-0.8.html
index b5a8a05..ee4943d 100644
--- a/AltOS/doc/release-notes-0.8.html
+++ b/AltOS/doc/release-notes-0.8.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title></title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="article"><div class="titlepage"><hr></div><p>
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title></title><meta name="generator" content="DocBook XSL Stylesheets V1.76.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="article"><div class="titlepage"><hr></div><p>
Version 0.8 offers a major upgrade in the AltosUI
interface. Significant new features include:
</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
diff --git a/AltOS/doc/release-notes-0.9.2.html b/AltOS/doc/release-notes-0.9.2.html
index edc56ee..c4bf75b 100644
--- a/AltOS/doc/release-notes-0.9.2.html
+++ b/AltOS/doc/release-notes-0.9.2.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title></title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="article"><div class="titlepage"><hr></div><p>
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title></title><meta name="generator" content="DocBook XSL Stylesheets V1.76.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="article"><div class="titlepage"><hr></div><p>
Version 0.9.2 is an AltosUI bug-fix release, with no firmware changes.
</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
Fix plotting problems due to missing file in the Mac OS install image.
diff --git a/AltOS/doc/release-notes-0.9.html b/AltOS/doc/release-notes-0.9.html
index 45fa82d..bd17cf4 100644
--- a/AltOS/doc/release-notes-0.9.html
+++ b/AltOS/doc/release-notes-0.9.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title></title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="article"><div class="titlepage"><hr></div><p>
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title></title><meta name="generator" content="DocBook XSL Stylesheets V1.76.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="article"><div class="titlepage"><hr></div><p>
Version 0.9 adds a few new firmware features and accompanying
AltosUI changes, along with new hardware support.
</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
diff --git a/AltOS/doc/release-notes-1.0.1.html b/AltOS/doc/release-notes-1.0.1.html
index 7ef9888..361ad04 100644
--- a/AltOS/doc/release-notes-1.0.1.html
+++ b/AltOS/doc/release-notes-1.0.1.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title></title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="article"><div class="titlepage"><hr></div><p>
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title></title><meta name="generator" content="DocBook XSL Stylesheets V1.76.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="article"><div class="titlepage"><hr></div><p>
Version 1.0.1 is a major release, adding support for the TeleMini
device and lots of new AltosUI features
</p><p>
diff --git a/AltOS/doc/release-notes-1.0.2.html b/AltOS/doc/release-notes-1.0.2.html
index 15045be..9dd0579 100644
--- a/AltOS/doc/release-notes-1.0.2.html
+++ b/AltOS/doc/release-notes-1.0.2.html
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title></title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="article"><div class="titlepage"><hr></div><p>
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title></title><meta name="generator" content="DocBook XSL Stylesheets V1.76.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="article"><div class="titlepage"><hr></div><p>
Version 1.0.2 is a bugfix release, addressing a minor issue
found in version 1.0.1
</p><p>
diff --git a/AltOS/doc/release-notes-1.0.3.html b/AltOS/doc/release-notes-1.0.3.html
new file mode 100644
index 0000000..99d5c8b
--- /dev/null
+++ b/AltOS/doc/release-notes-1.0.3.html
@@ -0,0 +1,10 @@
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title></title><meta name="generator" content="DocBook XSL Stylesheets V1.76.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="article"><div class="titlepage"><hr></div><p>
+ Version 1.0.3 is a minor release adding support for TeleMetrum v1.2 boards
+ </p><p>
+ AltOS Firmware Changes
+ </p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
+ TeleMetrum version 1.2 is functionally identical to version 1.1, the
+ only change required in the firmware was to adjust the product name reported
+ over the USB link.
+ </li></ul></div><p>
+ </p></div></body></html>
diff --git a/AltOS/doc/telemetry.html b/AltOS/doc/telemetry.html
index c639ea0..bf301dc 100644
--- a/AltOS/doc/telemetry.html
+++ b/AltOS/doc/telemetry.html
@@ -1,10 +1,10 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>AltOS Telemetry</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="article" title="AltOS Telemetry"><div class="titlepage"><div><div><h2 class="title"><a name="idm14575968"></a>AltOS Telemetry</h2></div><div><h3 class="subtitle"><i>Packet Definitions</i></h3></div><div><div class="author"><h3 class="author"><span class="firstname">Keith</span> <span class="surname">Packard</span></h3></div></div><div><p class="copyright">Copyright © 2011 Keith Packard</p></div><div><div class="legalnotice" title="Legal Notice"><a name="idp1155048"></a><p>
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>AltOS Telemetry</title><meta name="generator" content="DocBook XSL Stylesheets V1.76.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="article" title="AltOS Telemetry"><div class="titlepage"><div><div><h2 class="title"><a name="idm14881448"></a>AltOS Telemetry</h2></div><div><h3 class="subtitle"><i>Packet Definitions</i></h3></div><div><div class="author"><h3 class="author"><span class="firstname">Keith</span> <span class="surname">Packard</span></h3></div></div><div><p class="copyright">Copyright © 2011 Keith Packard</p></div><div><div class="legalnotice" title="Legal Notice"><a name="idp1531328"></a><p>
This document is released under the terms of the
<a class="ulink" href="http://creativecommons.org/licenses/by-sa/3.0/" target="_top">
Creative Commons ShareAlike 3.0
</a>
license.
- </p></div></div><div><div class="revhistory"><table border="1" width="100%" summary="Revision history"><tr><th align="left" valign="top" colspan="2"><b>Revision History</b></th></tr><tr><td align="left">Revision 0.1</td><td align="left">01 July 2011</td></tr><tr><td align="left" colspan="2">Initial content</td></tr></table></div></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#idp1689800">1. Packet Format Design</a></span></dt><dt><span class="section"><a href="#idp934288">2. Packet Formats</a></span></dt><dd><dl><dt><span class="section"><a href="#idp1355616">2.1. Packet Header</a></span></dt><dt><span class="section"><a href="#idp2907424">2.2. Sensor Data</a></span></dt><dt><span class="section"><a href="#idp1465272">2.3. Configuration Data</a></span></dt><dt><span class="section"><a href="#idp3378728">2.4. GPS Location</a></span></dt><dt><span class="section"><a href="#idp2329008">2.5. GPS Satellite Data</a></span></dt></dl></dd><dt><span class="section"><a href="#idp2437360">3. Data Transmission</a></span></dt><dd><dl><dt><span class="section"><a href="#idp3529568">3.1. Modulation Scheme</a></span></dt><dt><span class="section"><a href="#idp94440">3.2. Error Correction</a></span></dt></dl></dd><dt><span class="section"><a href="#idp101504">4. TeleDongle packet format</a></span></dt><dt><span class="section"><a href="#idp42648">5. History and Motivation</a></span></dt></dl></div><div class="section" title="1. Packet Format Design"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp1689800"></a>1. Packet Format Design</h2></div></div></div><p>
+ </p></div></div><div><div class="revhistory"><table border="1" width="100%" summary="Revision history"><tr><th align="left" valign="top" colspan="2"><b>Revision History</b></th></tr><tr><td align="left">Revision 0.1</td><td align="left">01 July 2011</td></tr><tr><td align="left" colspan="2">Initial content</td></tr></table></div></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#idp1633264">1. Packet Format Design</a></span></dt><dt><span class="section"><a href="#idp1461592">2. Packet Formats</a></span></dt><dd><dl><dt><span class="section"><a href="#idp1280992">2.1. Packet Header</a></span></dt><dt><span class="section"><a href="#idp3564336">2.2. Sensor Data</a></span></dt><dt><span class="section"><a href="#idp3022760">2.3. Configuration Data</a></span></dt><dt><span class="section"><a href="#idp2520544">2.4. GPS Location</a></span></dt><dt><span class="section"><a href="#idp2889936">2.5. GPS Satellite Data</a></span></dt></dl></dd><dt><span class="section"><a href="#idp2304488">3. Data Transmission</a></span></dt><dd><dl><dt><span class="section"><a href="#idp1449480">3.1. Modulation Scheme</a></span></dt><dt><span class="section"><a href="#idp112744">3.2. Error Correction</a></span></dt></dl></dd><dt><span class="section"><a href="#idp119728">4. TeleDongle packet format</a></span></dt><dt><span class="section"><a href="#idp61600">5. History and Motivation</a></span></dt></dl></div><div class="section" title="1. Packet Format Design"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp1633264"></a>1. Packet Format Design</h2></div></div></div><p>
AltOS telemetry data is split into multiple different packets,
all the same size, but each includs an identifier so that the
ground station can distinguish among different types. A single
@@ -22,14 +22,14 @@
All packet types start with a five byte header which encodes the
device serial number, device clock value and the packet
type. The remaining 27 bytes encode type-specific data.
- </p></div><div class="section" title="2. Packet Formats"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp934288"></a>2. Packet Formats</h2></div></div></div>
+ </p></div><div class="section" title="2. Packet Formats"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp1461592"></a>2. Packet Formats</h2></div></div></div>
This section first defines the packet header common to all packets
and then the per-packet data layout.
- <div class="section" title="2.1. Packet Header"><div class="titlepage"><div><div><h3 class="title"><a name="idp1355616"></a>2.1. Packet Header</h3></div></div></div><div class="table"><a name="idp2011688"></a><p class="title"><b>Table 1. Telemetry Packet Header</b></p><div class="table-contents"><table summary="Telemetry Packet Header" border="1"><colgroup><col align="center"><col align="center"><col align="left"><col align="left"></colgroup><thead><tr><th align="center">Offset</th><th align="center">Data Type</th><th align="center">Name</th><th align="center">Description</th></tr></thead><tbody><tr><td align="center">0</td><td align="center">uint16_t</td><td align="left">serial</td><td align="left">Device serial Number</td></tr><tr><td align="center">2</td><td align="center">uint16_t</td><td align="left">tick</td><td align="left">Device time in 100ths of a second</td></tr><tr><td align="center">4</td><td align="center">uint8_t</td><td align="left">type</td><td align="left">Packet type</td></tr><tr><td align="center">5</td><td class="auto-generated"> </td><td class="auto-generated"> </td><td class="auto-generated"> </td></tr></tbody></table></div></div><br class="table-break"><p>
+ <div class="section" title="2.1. Packet Header"><div class="titlepage"><div><div><h3 class="title"><a name="idp1280992"></a>2.1. Packet Header</h3></div></div></div><div class="table"><a name="idp3013000"></a><p class="title"><b>Table 1. Telemetry Packet Header</b></p><div class="table-contents"><table summary="Telemetry Packet Header" border="1"><colgroup><col align="center" class="Offset"><col align="center" class="Data Type"><col align="left" class="Name"><col align="left" class="Description"></colgroup><thead><tr><th align="center">Offset</th><th align="center">Data Type</th><th align="center">Name</th><th align="center">Description</th></tr></thead><tbody><tr><td align="center">0</td><td align="center">uint16_t</td><td align="left">serial</td><td align="left">Device serial Number</td></tr><tr><td align="center">2</td><td align="center">uint16_t</td><td align="left">tick</td><td align="left">Device time in 100ths of a second</td></tr><tr><td align="center">4</td><td align="center">uint8_t</td><td align="left">type</td><td align="left">Packet type</td></tr><tr><td align="center">5</td><td class="auto-generated"> </td><td class="auto-generated"> </td><td class="auto-generated"> </td></tr></tbody></table></div></div><br class="table-break"><p>
Each packet starts with these five bytes which serve to identify
which device has transmitted the packet, when it was transmitted
and what the rest of the packet contains.
- </p></div><div class="section" title="2.2. Sensor Data"><div class="titlepage"><div><div><h3 class="title"><a name="idp2907424"></a>2.2. Sensor Data</h3></div></div></div><div class="informaltable"><table border="0"><colgroup><col align="center"><col align="left"></colgroup><thead><tr><th align="center">Type</th><th align="left">Description</th></tr></thead><tbody><tr><td align="center">0x01</td><td align="left">TeleMetrum Sensor Data</td></tr><tr><td align="center">0x02</td><td align="left">TeleMini Sensor Data</td></tr><tr><td align="center">0x03</td><td align="left">TeleNano Sensor Data</td></tr></tbody></table></div><p>
+ </p></div><div class="section" title="2.2. Sensor Data"><div class="titlepage"><div><div><h3 class="title"><a name="idp3564336"></a>2.2. Sensor Data</h3></div></div></div><div class="informaltable"><table border="0"><colgroup><col align="center" class="Offset"><col align="left" class="Description"></colgroup><thead><tr><th align="center">Type</th><th align="left">Description</th></tr></thead><tbody><tr><td align="center">0x01</td><td align="left">TeleMetrum Sensor Data</td></tr><tr><td align="center">0x02</td><td align="left">TeleMini Sensor Data</td></tr><tr><td align="center">0x03</td><td align="left">TeleNano Sensor Data</td></tr></tbody></table></div><p>
TeleMetrum, TeleMini and TeleNano share this same packet
format for sensor data. Each uses a distinct packet type so
that the receiver knows which data values are valid and which
@@ -38,63 +38,63 @@
Sensor Data packets are transmitted once per second on the
ground, 10 times per second during ascent and once per second
during descent and landing
- </p><div class="table"><a name="idp2513304"></a><p class="title"><b>Table 2. Sensor Packet Contents</b></p><div class="table-contents"><table summary="Sensor Packet Contents" border="1"><colgroup><col align="center"><col align="center"><col align="left"><col align="left"></colgroup><thead><tr><th align="center">Offset</th><th align="center">Data Type</th><th align="center">Name</th><th align="center">Description</th></tr></thead><tbody><tr><td align="center">5</td><td align="center">uint8_t</td><td align="left">state</td><td align="left">Flight state</td></tr><tr><td align="center">6</td><td align="center">int16_t</td><td align="left">accel</td><td align="left">accelerometer (TM only)</td></tr><tr><td align="center">8</td><td align="center">int16_t</td><td align="left">pres</td><td align="left">pressure sensor</td></tr><tr><td align="center">10</td><td align="center">int16_t</td><td align="left">temp</td><td align="left">temperature sensor</td></tr><tr><td align="center">12</td><td align="center">int16_t</td><td align="left">v_batt</td><td align="left">battery voltage</td></tr><tr><td align="center">14</td><td align="center">int16_t</td><td align="left">sense_d</td><td align="left">drogue continuity sense (TM/Tm)</td></tr><tr><td align="center">16</td><td align="center">int16_t</td><td align="left">sense_m</td><td align="left">main continuity sense (TM/Tm)</td></tr><tr><td align="center">18</td><td align="center">int16_t</td><td align="left">acceleration</td><td align="left">m/s² * 16</td></tr><tr><td align="center">20</td><td align="center">int16_t</td><td align="left">speed</td><td align="left">m/s * 16</td></tr><tr><td align="center">22</td><td align="center">int16_t</td><td align="left">height</td><td align="left">m</td></tr><tr><td align="center">24</td><td align="center">int16_t</td><td align="left">ground_pres</td><td align="left">Average barometer reading on ground</td></tr><tr><td align="center">26</td><td align="center">int16_t</td><td align="left">ground_accel</td><td align="left">TM</td></tr><tr><td align="center">28</td><td align="center">int16_t</td><td align="left">accel_plus_g</td><td align="left">TM</td></tr><tr><td align="center">30</td><td align="center">int16_t</td><td align="left">accel_minus_g</td><td align="left">TM</td></tr><tr><td align="center">32</td><td class="auto-generated"> </td><td class="auto-generated"> </td><td class="auto-generated"> </td></tr></tbody></table></div></div><br class="table-break"></div><div class="section" title="2.3. Configuration Data"><div class="titlepage"><div><div><h3 class="title"><a name="idp1465272"></a>2.3. Configuration Data</h3></div></div></div><div class="informaltable"><table border="0"><colgroup><col align="center"><col align="left"></colgroup><thead><tr><th align="center">Type</th><th align="left">Description</th></tr></thead><tbody><tr><td align="center">0x04</td><td align="left">Configuration Data</td></tr></tbody></table></div><p>
+ </p><div class="table"><a name="idp3367096"></a><p class="title"><b>Table 2. Sensor Packet Contents</b></p><div class="table-contents"><table summary="Sensor Packet Contents" border="1"><colgroup><col align="center" class="Offset"><col align="center" class="Data Type"><col align="left" class="Name"><col align="left" class="Description"></colgroup><thead><tr><th align="center">Offset</th><th align="center">Data Type</th><th align="center">Name</th><th align="center">Description</th></tr></thead><tbody><tr><td align="center">5</td><td align="center">uint8_t</td><td align="left">state</td><td align="left">Flight state</td></tr><tr><td align="center">6</td><td align="center">int16_t</td><td align="left">accel</td><td align="left">accelerometer (TM only)</td></tr><tr><td align="center">8</td><td align="center">int16_t</td><td align="left">pres</td><td align="left">pressure sensor</td></tr><tr><td align="center">10</td><td align="center">int16_t</td><td align="left">temp</td><td align="left">temperature sensor</td></tr><tr><td align="center">12</td><td align="center">int16_t</td><td align="left">v_batt</td><td align="left">battery voltage</td></tr><tr><td align="center">14</td><td align="center">int16_t</td><td align="left">sense_d</td><td align="left">drogue continuity sense (TM/Tm)</td></tr><tr><td align="center">16</td><td align="center">int16_t</td><td align="left">sense_m</td><td align="left">main continuity sense (TM/Tm)</td></tr><tr><td align="center">18</td><td align="center">int16_t</td><td align="left">acceleration</td><td align="left">m/s² * 16</td></tr><tr><td align="center">20</td><td align="center">int16_t</td><td align="left">speed</td><td align="left">m/s * 16</td></tr><tr><td align="center">22</td><td align="center">int16_t</td><td align="left">height</td><td align="left">m</td></tr><tr><td align="center">24</td><td align="center">int16_t</td><td align="left">ground_pres</td><td align="left">Average barometer reading on ground</td></tr><tr><td align="center">26</td><td align="center">int16_t</td><td align="left">ground_accel</td><td align="left">TM</td></tr><tr><td align="center">28</td><td align="center">int16_t</td><td align="left">accel_plus_g</td><td align="left">TM</td></tr><tr><td align="center">30</td><td align="center">int16_t</td><td align="left">accel_minus_g</td><td align="left">TM</td></tr><tr><td align="center">32</td><td class="auto-generated"> </td><td class="auto-generated"> </td><td class="auto-generated"> </td></tr></tbody></table></div></div><br class="table-break"></div><div class="section" title="2.3. Configuration Data"><div class="titlepage"><div><div><h3 class="title"><a name="idp3022760"></a>2.3. Configuration Data</h3></div></div></div><div class="informaltable"><table border="0"><colgroup><col align="center" class="Offset"><col align="left" class="Description"></colgroup><thead><tr><th align="center">Type</th><th align="left">Description</th></tr></thead><tbody><tr><td align="center">0x04</td><td align="left">Configuration Data</td></tr></tbody></table></div><p>
This provides a description of the software installed on the
flight computer as well as any user-specified configuration data.
</p><p>
Configuration data packets are transmitted once per second
during all phases of the flight
- </p><div class="table"><a name="idp2211144"></a><p class="title"><b>Table 3. Sensor Packet Contents</b></p><div class="table-contents"><table summary="Sensor Packet Contents" border="1"><colgroup><col align="center"><col align="center"><col align="left"><col align="left"></colgroup><thead><tr><th align="center">Offset</th><th align="center">Data Type</th><th align="center">Name</th><th align="center">Description</th></tr></thead><tbody><tr><td align="center">5</td><td align="center">uint8_t</td><td align="left">type</td><td align="left">Device type</td></tr><tr><td align="center">6</td><td align="center">uint16_t</td><td align="left">flight</td><td align="left">Flight number</td></tr><tr><td align="center">8</td><td align="center">uint8_t</td><td align="left">config_major</td><td align="left">Config major version</td></tr><tr><td align="center">9</td><td align="center">uint8_t</td><td align="left">config_minor</td><td align="left">Config minor version</td></tr><tr><td align="center">10</td><td align="center">uint16_t</td><td align="left">apogee_delay</td><td align="left">Apogee deploy delay in seconds</td></tr><tr><td align="center">12</td><td align="center">uint16_t</td><td align="left">main_deploy</td><td align="left">Main deploy alt in meters</td></tr><tr><td align="center">14</td><td align="center">uint16_t</td><td align="left">flight_log_max</td><td align="left">Maximum flight log size (kB)</td></tr><tr><td align="center">16</td><td align="center">char</td><td align="left">callsign[8]</td><td align="left">Radio operator identifier</td></tr><tr><td align="center">24</td><td align="center">char</td><td align="left">version[8]</td><td align="left">Software version identifier</td></tr><tr><td align="center">32</td><td class="auto-generated"> </td><td class="auto-generated"> </td><td class="auto-generated"> </td></tr></tbody></table></div></div><br class="table-break"></div><div class="section" title="2.4. GPS Location"><div class="titlepage"><div><div><h3 class="title"><a name="idp3378728"></a>2.4. GPS Location</h3></div></div></div><div class="informaltable"><table border="0"><colgroup><col align="center"><col align="left"></colgroup><thead><tr><th align="center">Type</th><th align="left">Description</th></tr></thead><tbody><tr><td align="center">0x05</td><td align="left">GPS Location</td></tr></tbody></table></div><p>
+ </p><div class="table"><a name="idp3564576"></a><p class="title"><b>Table 3. Sensor Packet Contents</b></p><div class="table-contents"><table summary="Sensor Packet Contents" border="1"><colgroup><col align="center" class="Offset"><col align="center" class="Data Type"><col align="left" class="Name"><col align="left" class="Description"></colgroup><thead><tr><th align="center">Offset</th><th align="center">Data Type</th><th align="center">Name</th><th align="center">Description</th></tr></thead><tbody><tr><td align="center">5</td><td align="center">uint8_t</td><td align="left">type</td><td align="left">Device type</td></tr><tr><td align="center">6</td><td align="center">uint16_t</td><td align="left">flight</td><td align="left">Flight number</td></tr><tr><td align="center">8</td><td align="center">uint8_t</td><td align="left">config_major</td><td align="left">Config major version</td></tr><tr><td align="center">9</td><td align="center">uint8_t</td><td align="left">config_minor</td><td align="left">Config minor version</td></tr><tr><td align="center">10</td><td align="center">uint16_t</td><td align="left">apogee_delay</td><td align="left">Apogee deploy delay in seconds</td></tr><tr><td align="center">12</td><td align="center">uint16_t</td><td align="left">main_deploy</td><td align="left">Main deploy alt in meters</td></tr><tr><td align="center">14</td><td align="center">uint16_t</td><td align="left">flight_log_max</td><td align="left">Maximum flight log size (kB)</td></tr><tr><td align="center">16</td><td align="center">char</td><td align="left">callsign[8]</td><td align="left">Radio operator identifier</td></tr><tr><td align="center">24</td><td align="center">char</td><td align="left">version[8]</td><td align="left">Software version identifier</td></tr><tr><td align="center">32</td><td class="auto-generated"> </td><td class="auto-generated"> </td><td class="auto-generated"> </td></tr></tbody></table></div></div><br class="table-break"></div><div class="section" title="2.4. GPS Location"><div class="titlepage"><div><div><h3 class="title"><a name="idp2520544"></a>2.4. GPS Location</h3></div></div></div><div class="informaltable"><table border="0"><colgroup><col align="center" class="Offset"><col align="left" class="Description"></colgroup><thead><tr><th align="center">Type</th><th align="left">Description</th></tr></thead><tbody><tr><td align="center">0x05</td><td align="left">GPS Location</td></tr></tbody></table></div><p>
This packet provides all of the information available from the
Venus SkyTraq GPS receiver&#8212;position, time, speed and precision
estimates.
</p><p>
GPS Location packets are transmitted once per second during
all phases of the flight
- </p><div class="table"><a name="idp2430352"></a><p class="title"><b>Table 4. GPS Location Packet Contents</b></p><div class="table-contents"><table summary="GPS Location Packet Contents" border="1"><colgroup><col align="center"><col align="center"><col align="left"><col align="left"></colgroup><thead><tr><th align="center">Offset</th><th align="center">Data Type</th><th align="center">Name</th><th align="center">Description</th></tr></thead><tbody><tr><td align="center">5</td><td align="center">uint8_t</td><td align="left">flags</td><td align="left">See GPS Flags table below</td></tr><tr><td align="center">6</td><td align="center">int16_t</td><td align="left">altitude</td><td align="left">m</td></tr><tr><td align="center">8</td><td align="center">int32_t</td><td align="left">latitude</td><td align="left">degrees * 10<sup>7</sup></td></tr><tr><td align="center">12</td><td align="center">int32_t</td><td align="left">longitude</td><td align="left">degrees * 10<sup>7</sup></td></tr><tr><td align="center">16</td><td align="center">uint8_t</td><td align="left">year</td><td class="auto-generated"> </td></tr><tr><td align="center">17</td><td align="center">uint8_t</td><td align="left">month</td><td class="auto-generated"> </td></tr><tr><td align="center">18</td><td align="center">uint8_t</td><td align="left">day</td><td class="auto-generated"> </td></tr><tr><td align="center">19</td><td align="center">uint8_t</td><td align="left">hour</td><td class="auto-generated"> </td></tr><tr><td align="center">20</td><td align="center">uint8_t</td><td align="left">minute</td><td class="auto-generated"> </td></tr><tr><td align="center">21</td><td align="center">uint8_t</td><td align="left">second</td><td class="auto-generated"> </td></tr><tr><td align="center">22</td><td align="center">uint8_t</td><td align="left">pdop</td><td align="left">* 5</td></tr><tr><td align="center">23</td><td align="center">uint8_t</td><td align="left">hdop</td><td align="left">* 5</td></tr><tr><td align="center">24</td><td align="center">uint8_t</td><td align="left">vdop</td><td align="left">* 5</td></tr><tr><td align="center">25</td><td align="center">uint8_t</td><td align="left">mode</td><td align="left">See GPS Mode table below</td></tr><tr><td align="center">26</td><td align="center">uint16_t</td><td align="left">ground_speed</td><td align="left">cm/s</td></tr><tr><td align="center">28</td><td align="center">int16_t</td><td align="left">climb_rate</td><td align="left">cm/s</td></tr><tr><td align="center">30</td><td align="center">uint8_t</td><td align="left">course</td><td align="left">/ 2</td></tr><tr><td align="center">31</td><td align="center">uint8_t</td><td align="left">unused[1]</td><td class="auto-generated"> </td></tr><tr><td align="center">32</td><td class="auto-generated"> </td><td class="auto-generated"> </td><td class="auto-generated"> </td></tr></tbody></table></div></div><br class="table-break"><p>
+ </p><div class="table"><a name="idp3259024"></a><p class="title"><b>Table 4. GPS Location Packet Contents</b></p><div class="table-contents"><table summary="GPS Location Packet Contents" border="1"><colgroup><col align="center" class="Offset"><col align="center" class="Data Type"><col align="left" class="Name"><col align="left" class="Description"></colgroup><thead><tr><th align="center">Offset</th><th align="center">Data Type</th><th align="center">Name</th><th align="center">Description</th></tr></thead><tbody><tr><td align="center">5</td><td align="center">uint8_t</td><td align="left">flags</td><td align="left">See GPS Flags table below</td></tr><tr><td align="center">6</td><td align="center">int16_t</td><td align="left">altitude</td><td align="left">m</td></tr><tr><td align="center">8</td><td align="center">int32_t</td><td align="left">latitude</td><td align="left">degrees * 10<sup>7</sup></td></tr><tr><td align="center">12</td><td align="center">int32_t</td><td align="left">longitude</td><td align="left">degrees * 10<sup>7</sup></td></tr><tr><td align="center">16</td><td align="center">uint8_t</td><td align="left">year</td><td class="auto-generated"> </td></tr><tr><td align="center">17</td><td align="center">uint8_t</td><td align="left">month</td><td class="auto-generated"> </td></tr><tr><td align="center">18</td><td align="center">uint8_t</td><td align="left">day</td><td class="auto-generated"> </td></tr><tr><td align="center">19</td><td align="center">uint8_t</td><td align="left">hour</td><td class="auto-generated"> </td></tr><tr><td align="center">20</td><td align="center">uint8_t</td><td align="left">minute</td><td class="auto-generated"> </td></tr><tr><td align="center">21</td><td align="center">uint8_t</td><td align="left">second</td><td class="auto-generated"> </td></tr><tr><td align="center">22</td><td align="center">uint8_t</td><td align="left">pdop</td><td align="left">* 5</td></tr><tr><td align="center">23</td><td align="center">uint8_t</td><td align="left">hdop</td><td align="left">* 5</td></tr><tr><td align="center">24</td><td align="center">uint8_t</td><td align="left">vdop</td><td align="left">* 5</td></tr><tr><td align="center">25</td><td align="center">uint8_t</td><td align="left">mode</td><td align="left">See GPS Mode table below</td></tr><tr><td align="center">26</td><td align="center">uint16_t</td><td align="left">ground_speed</td><td align="left">cm/s</td></tr><tr><td align="center">28</td><td align="center">int16_t</td><td align="left">climb_rate</td><td align="left">cm/s</td></tr><tr><td align="center">30</td><td align="center">uint8_t</td><td align="left">course</td><td align="left">/ 2</td></tr><tr><td align="center">31</td><td align="center">uint8_t</td><td align="left">unused[1]</td><td class="auto-generated"> </td></tr><tr><td align="center">32</td><td class="auto-generated"> </td><td class="auto-generated"> </td><td class="auto-generated"> </td></tr></tbody></table></div></div><br class="table-break"><p>
Packed into a one byte field are status flags and the count of
satellites used to compute the position fix. Note that this
number may be lower than the number of satellites being
tracked; the receiver will not use information from satellites
with weak signals or which are close enough to the horizon to
have significantly degraded position accuracy.
- </p><div class="table"><a name="idp1374792"></a><p class="title"><b>Table 5. GPS Flags</b></p><div class="table-contents"><table summary="GPS Flags" border="1"><colgroup><col align="center"><col align="left"><col align="left"></colgroup><thead><tr><th align="center">Bits</th><th align="center">Name</th><th align="center">Description</th></tr></thead><tbody><tr><td align="center">0-3</td><td align="left">nsats</td><td align="left">Number of satellites in solution</td></tr><tr><td align="center">4</td><td align="left">valid</td><td align="left">GPS solution is valid</td></tr><tr><td align="center">5</td><td align="left">running</td><td align="left">GPS receiver is operational</td></tr><tr><td align="center">6</td><td align="left">date_valid</td><td align="left">Reported date is valid</td></tr><tr><td align="center">7</td><td align="left">course_valid</td><td align="left">ground speed, course and climb rates are valid</td></tr></tbody></table></div></div><br class="table-break"><p>
+ </p><div class="table"><a name="idp3000200"></a><p class="title"><b>Table 5. GPS Flags</b></p><div class="table-contents"><table summary="GPS Flags" border="1"><colgroup><col align="center" class="bits"><col align="left" class="name"><col align="left" class="description"></colgroup><thead><tr><th align="center">Bits</th><th align="center">Name</th><th align="center">Description</th></tr></thead><tbody><tr><td align="center">0-3</td><td align="left">nsats</td><td align="left">Number of satellites in solution</td></tr><tr><td align="center">4</td><td align="left">valid</td><td align="left">GPS solution is valid</td></tr><tr><td align="center">5</td><td align="left">running</td><td align="left">GPS receiver is operational</td></tr><tr><td align="center">6</td><td align="left">date_valid</td><td align="left">Reported date is valid</td></tr><tr><td align="center">7</td><td align="left">course_valid</td><td align="left">ground speed, course and climb rates are valid</td></tr></tbody></table></div></div><br class="table-break"><p>
Here are all of the valid GPS operational modes. Altus Metrum
products will only ever report 'N' (not valid), 'A'
(Autonomous) modes or 'E' (Estimated). The remaining modes
are either testing modes or require additional data.
- </p><div class="table"><a name="idp2336184"></a><p class="title"><b>Table 6. GPS Mode</b></p><div class="table-contents"><table summary="GPS Mode" border="1"><colgroup><col align="center"><col align="center"><col align="left"></colgroup><thead><tr><th align="center">Mode</th><th align="center">Name</th><th align="center">Decsription</th></tr></thead><tbody><tr><td align="center">N</td><td align="center">Not Valid</td><td align="left">All data are invalid</td></tr><tr><td align="center">A</td><td align="center">Autonomous mode</td><td align="left">Data are derived from satellite data</td></tr><tr><td align="center">D</td><td align="center">Differential Mode</td><td align="left">
+ </p><div class="table"><a name="idp2363024"></a><p class="title"><b>Table 6. GPS Mode</b></p><div class="table-contents"><table summary="GPS Mode" border="1"><colgroup><col align="center" class="value"><col align="center" class="name"><col align="left" class="description"></colgroup><thead><tr><th align="center">Mode</th><th align="center">Name</th><th align="center">Decsription</th></tr></thead><tbody><tr><td align="center">N</td><td align="center">Not Valid</td><td align="left">All data are invalid</td></tr><tr><td align="center">A</td><td align="center">Autonomous mode</td><td align="left">Data are derived from satellite data</td></tr><tr><td align="center">D</td><td align="center">Differential Mode</td><td align="left">
Data are augmented with differential data from a
known ground station. The SkyTraq unit in TeleMetrum
does not support this mode
</td></tr><tr><td align="center">E</td><td align="center">Estimated</td><td align="left">
Data are estimated using dead reckoning from the
last known data
- </td></tr><tr><td align="center">M</td><td align="center">Manual</td><td align="left">Data were entered manually</td></tr><tr><td align="center">S</td><td align="center">Simulated</td><td align="left">GPS receiver testing mode</td></tr></tbody></table></div></div><br class="table-break"></div><div class="section" title="2.5. GPS Satellite Data"><div class="titlepage"><div><div><h3 class="title"><a name="idp2329008"></a>2.5. GPS Satellite Data</h3></div></div></div><div class="informaltable"><table border="0"><colgroup><col align="center"><col align="left"></colgroup><thead><tr><th align="center">Type</th><th align="left">Description</th></tr></thead><tbody><tr><td align="center">0x06</td><td align="left">GPS Satellite Data</td></tr></tbody></table></div><p>
+ </td></tr><tr><td align="center">M</td><td align="center">Manual</td><td align="left">Data were entered manually</td></tr><tr><td align="center">S</td><td align="center">Simulated</td><td align="left">GPS receiver testing mode</td></tr></tbody></table></div></div><br class="table-break"></div><div class="section" title="2.5. GPS Satellite Data"><div class="titlepage"><div><div><h3 class="title"><a name="idp2889936"></a>2.5. GPS Satellite Data</h3></div></div></div><div class="informaltable"><table border="0"><colgroup><col align="center" class="Offset"><col align="left" class="Description"></colgroup><thead><tr><th align="center">Type</th><th align="left">Description</th></tr></thead><tbody><tr><td align="center">0x06</td><td align="left">GPS Satellite Data</td></tr></tbody></table></div><p>
This packet provides space vehicle identifiers and signal
quality information in the form of a C/N1 number for up to 12
satellites. The order of the svids is not specified.
</p><p>
GPS Satellite data are transmitted once per second during all
phases of the flight.
- </p><div class="table"><a name="idp1504024"></a><p class="title"><b>Table 7. GPS Satellite Data Contents</b></p><div class="table-contents"><table summary="GPS Satellite Data Contents" border="1"><colgroup><col align="right"><col align="center"><col align="left"><col align="left"></colgroup><thead><tr><th align="center">Offset</th><th align="center">Data Type</th><th align="center">Name</th><th align="center">Description</th></tr></thead><tbody><tr><td align="right">5</td><td align="center">uint8_t</td><td align="left">channels</td><td align="left">Number of reported satellite information</td></tr><tr><td align="right">6</td><td align="center">sat_info_t</td><td align="left">sats[12]</td><td align="left">See Per-Satellite data table below</td></tr><tr><td align="right">30</td><td align="center">uint8_t</td><td align="left">unused[2]</td><td class="auto-generated"> </td></tr><tr><td align="right">32</td><td class="auto-generated"> </td><td class="auto-generated"> </td><td class="auto-generated"> </td></tr></tbody></table></div></div><br class="table-break"><div class="table"><a name="idp1687912"></a><p class="title"><b>Table 8. GPS Per-Satellite data (sat_info_t)</b></p><div class="table-contents"><table summary="GPS Per-Satellite data (sat_info_t)" border="1"><colgroup><col align="right"><col align="center"><col align="left"><col align="left"></colgroup><thead><tr><th align="center">Offset</th><th align="center">Data Type</th><th align="center">Name</th><th align="center">Description</th></tr></thead><tbody><tr><td align="right">0</td><td align="center">uint8_t</td><td align="left">svid</td><td align="left">Space Vehicle Identifier</td></tr><tr><td align="right">1</td><td align="center">uint8_t</td><td align="left">c_n_1</td><td align="left">C/N1 signal quality indicator</td></tr><tr><td align="right">2</td><td class="auto-generated"> </td><td class="auto-generated"> </td><td class="auto-generated"> </td></tr></tbody></table></div></div><br class="table-break"></div></div><div class="section" title="3. Data Transmission"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2437360"></a>3. Data Transmission</h2></div></div></div><p>
+ </p><div class="table"><a name="idp2243816"></a><p class="title"><b>Table 7. GPS Satellite Data Contents</b></p><div class="table-contents"><table summary="GPS Satellite Data Contents" border="1"><colgroup><col align="right" class="Offset"><col align="center" class="Data Type"><col align="left" class="Name"><col align="left" class="Description"></colgroup><thead><tr><th align="center">Offset</th><th align="center">Data Type</th><th align="center">Name</th><th align="center">Description</th></tr></thead><tbody><tr><td align="right">5</td><td align="center">uint8_t</td><td align="left">channels</td><td align="left">Number of reported satellite information</td></tr><tr><td align="right">6</td><td align="center">sat_info_t</td><td align="left">sats[12]</td><td align="left">See Per-Satellite data table below</td></tr><tr><td align="right">30</td><td align="center">uint8_t</td><td align="left">unused[2]</td><td class="auto-generated"> </td></tr><tr><td align="right">32</td><td class="auto-generated"> </td><td class="auto-generated"> </td><td class="auto-generated"> </td></tr></tbody></table></div></div><br class="table-break"><div class="table"><a name="idp3175968"></a><p class="title"><b>Table 8. GPS Per-Satellite data (sat_info_t)</b></p><div class="table-contents"><table summary="GPS Per-Satellite data (sat_info_t)" border="1"><colgroup><col align="right" class="Offset"><col align="center" class="Data Type"><col align="left" class="Name"><col align="left" class="Description"></colgroup><thead><tr><th align="center">Offset</th><th align="center">Data Type</th><th align="center">Name</th><th align="center">Description</th></tr></thead><tbody><tr><td align="right">0</td><td align="center">uint8_t</td><td align="left">svid</td><td align="left">Space Vehicle Identifier</td></tr><tr><td align="right">1</td><td align="center">uint8_t</td><td align="left">c_n_1</td><td align="left">C/N1 signal quality indicator</td></tr><tr><td align="right">2</td><td class="auto-generated"> </td><td class="auto-generated"> </td><td class="auto-generated"> </td></tr></tbody></table></div></div><br class="table-break"></div></div><div class="section" title="3. Data Transmission"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp2304488"></a>3. Data Transmission</h2></div></div></div><p>
Altus Metrum devices use the Texas Instruments CC1111
microcontroller which includes an integrated sub-GHz digital
transceiver. This transceiver is used to both transmit and
receive the telemetry packets. This section discusses what
modulation scheme is used and how this device is configured.
- </p><div class="section" title="3.1. Modulation Scheme"><div class="titlepage"><div><div><h3 class="title"><a name="idp3529568"></a>3.1. Modulation Scheme</h3></div></div></div><p>
+ </p><div class="section" title="3.1. Modulation Scheme"><div class="titlepage"><div><div><h3 class="title"><a name="idp1449480"></a>3.1. Modulation Scheme</h3></div></div></div><p>
Texas Instruments provides a tool for computing modulation
parameters given a desired modulation format and basic bit
rate. For AltOS, the basic bit rate was specified as 38 kBaud,
resulting in the following signal parmeters:
- </p><div class="table"><a name="idp3359296"></a><p class="title"><b>Table 9. </b></p><div class="table-contents"><table border="1"><colgroup><col align="center"><col align="center"><col align="center"></colgroup><thead><tr><th align="center">Parameter</th><th align="center">Value</th><th align="center">Description</th></tr></thead><tbody><tr><td align="center">Modulation</td><td align="center">GFSK</td><td align="center">Gaussian Frequency Shift Keying</td></tr><tr><td align="center">Deviation</td><td align="center">20.507812 kHz</td><td align="center">Frequency modulation</td></tr><tr><td align="center">Data rate</td><td align="center">38.360596 kBaud</td><td align="center">Raw bit rate</td></tr><tr><td align="center">RX Filter Bandwidth</td><td align="center">93.75 kHz</td><td align="center">Receiver Band pass filter bandwidth</td></tr><tr><td align="center">IF Frequency</td><td align="center">140.62 kHz</td><td align="center">Receiver intermediate frequency</td></tr></tbody></table></div></div><br class="table-break"></div><div class="section" title="3.2. Error Correction"><div class="titlepage"><div><div><h3 class="title"><a name="idp94440"></a>3.2. Error Correction</h3></div></div></div><p>
+ </p><div class="table"><a name="idp3553824"></a><p class="title"><b>Table 9. </b></p><div class="table-contents"><table border="1"><colgroup><col align="center" class="parameter"><col align="center" class="value"><col align="center" class="description"></colgroup><thead><tr><th align="center">Parameter</th><th align="center">Value</th><th align="center">Description</th></tr></thead><tbody><tr><td align="center">Modulation</td><td align="center">GFSK</td><td align="center">Gaussian Frequency Shift Keying</td></tr><tr><td align="center">Deviation</td><td align="center">20.507812 kHz</td><td align="center">Frequency modulation</td></tr><tr><td align="center">Data rate</td><td align="center">38.360596 kBaud</td><td align="center">Raw bit rate</td></tr><tr><td align="center">RX Filter Bandwidth</td><td align="center">93.75 kHz</td><td align="center">Receiver Band pass filter bandwidth</td></tr><tr><td align="center">IF Frequency</td><td align="center">140.62 kHz</td><td align="center">Receiver intermediate frequency</td></tr></tbody></table></div></div><br class="table-break"></div><div class="section" title="3.2. Error Correction"><div class="titlepage"><div><div><h3 class="title"><a name="idp112744"></a>3.2. Error Correction</h3></div></div></div><p>
The cc1111 provides forward error correction in hardware,
which AltOS uses to improve reception of weak signals. The
overall effect of this is to halve the available bandwidth for
data from 38 kBaud to 19 kBaud.
- </p><div class="table"><a name="idp95208"></a><p class="title"><b>Table 10. </b></p><div class="table-contents"><table border="1"><colgroup><col align="center"><col align="center"><col align="center"></colgroup><thead><tr><th align="center">Parameter</th><th align="center">Value</th><th align="center">Description</th></tr></thead><tbody><tr><td align="center">Error Correction</td><td align="center">Convolutional coding FEC</td><td align="center">1/2 code, constraint length m=4</td></tr><tr><td align="center">Interleaving</td><td align="center">4 x 4</td><td align="center">Reduce effect of noise burst</td></tr><tr><td align="center">Data Whitening</td><td align="center">XOR with 9-bit PNR</td><td align="center">Rotate right with bit 8 = bit 0 xor bit 5, initial
- value 111111111</td></tr></tbody></table></div></div><br class="table-break"></div></div><div class="section" title="4. TeleDongle packet format"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp101504"></a>4. TeleDongle packet format</h2></div></div></div><p>
+ </p><div class="table"><a name="idp113512"></a><p class="title"><b>Table 10. </b></p><div class="table-contents"><table border="1"><colgroup><col align="center" class="parameter"><col align="center" class="value"><col align="center" class="description"></colgroup><thead><tr><th align="center">Parameter</th><th align="center">Value</th><th align="center">Description</th></tr></thead><tbody><tr><td align="center">Error Correction</td><td align="center">Convolutional coding FEC</td><td align="center">1/2 code, constraint length m=4</td></tr><tr><td align="center">Interleaving</td><td align="center">4 x 4</td><td align="center">Reduce effect of noise burst</td></tr><tr><td align="center">Data Whitening</td><td align="center">XOR with 9-bit PNR</td><td align="center">Rotate right with bit 8 = bit 0 xor bit 5, initial
+ value 111111111</td></tr></tbody></table></div></div><br class="table-break"></div></div><div class="section" title="4. TeleDongle packet format"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp119728"></a>4. TeleDongle packet format</h2></div></div></div><p>
TeleDongle does not do any interpretation of the packet data,
instead it is configured to receive packets of a specified
length (32 bytes in this case). For each received packet,
@@ -106,9 +106,9 @@
the packet data, two bytes added by the cc1111 radio receiver
hardware and finally a checksum so that the host software can
validate that the line was transmitted without any errors.
- </p><div class="table"><a name="idp103288"></a><p class="title"><b>Table 11. </b></p><div class="table-contents"><table border="1"><colgroup><col align="center"><col align="center"><col align="center"><col align="center"></colgroup><thead><tr><th align="center">Offset</th><th align="center">Name</th><th align="center">Example</th><th align="center">Description</th></tr></thead><tbody><tr><td align="center">0</td><td align="center">length</td><td align="center">22</td><td align="center">Total length of data bytes in the line. Note that
+ </p><div class="table"><a name="idp121512"></a><p class="title"><b>Table 11. </b></p><div class="table-contents"><table border="1"><colgroup><col align="center" class="offset"><col align="center" class="name"><col align="center" class="value"><col align="center" class="description"></colgroup><thead><tr><th align="center">Offset</th><th align="center">Name</th><th align="center">Example</th><th align="center">Description</th></tr></thead><tbody><tr><td align="center">0</td><td align="center">length</td><td align="center">22</td><td align="center">Total length of data bytes in the line. Note that
this includes the added RSSI and status bytes</td></tr><tr><td align="center">1 ·· length-3</td><td align="center">packet</td><td align="center">4f ·· 00</td><td align="center">Bytes of actual packet data</td></tr><tr><td align="center">length-2</td><td align="center">rssi</td><td align="center">3f</td><td align="center">Received signal strength. dBm = rssi / 2 - 74</td></tr><tr><td align="center">length-1</td><td align="center">lqi</td><td align="center">a9</td><td align="center">Link Quality Indicator and CRC status. Bit 7
- is set when the CRC is correct</td></tr><tr><td align="center">length</td><td align="center">checksum</td><td align="center">88</td><td align="center">(0x5a + sum(bytes 1 ·· length-1)) % 256</td></tr></tbody></table></div></div><br class="table-break"></div><div class="section" title="5. History and Motivation"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp42648"></a>5. History and Motivation</h2></div></div></div><p>
+ is set when the CRC is correct</td></tr><tr><td align="center">length</td><td align="center">checksum</td><td align="center">88</td><td align="center">(0x5a + sum(bytes 1 ·· length-1)) % 256</td></tr></tbody></table></div></div><br class="table-break"></div><div class="section" title="5. History and Motivation"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="idp61600"></a>5. History and Motivation</h2></div></div></div><p>
The original AltoOS telemetry mechanism encoded everything
available piece of information on the TeleMetrum hardware into a
single unified packet. Initially, the packets contained very
diff --git a/AltOS/doc/telemetry.pdf b/AltOS/doc/telemetry.pdf
index f80106c..5f101bf 100644
--- a/AltOS/doc/telemetry.pdf
+++ b/AltOS/doc/telemetry.pdf
Binary files differ
generated by cgit v1.2.3 (git 2.39.1) at 2025-10-15 23:45:49 +0000