diff options
Diffstat (limited to 'AltOS')
| -rw-r--r-- | AltOS/doc/altos.html | 168 | ||||
| -rw-r--r-- | AltOS/doc/altos.pdf | bin | 109278 -> 109278 bytes | |||
| -rw-r--r-- | AltOS/doc/altusmetrum.html | 110 | ||||
| -rw-r--r-- | AltOS/doc/altusmetrum.pdf | bin | 118418 -> 118418 bytes |
4 files changed, 139 insertions, 139 deletions
diff --git a/AltOS/doc/altos.html b/AltOS/doc/altos.html index 330062d..400b81a 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="id2763147"></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="id3044832"></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.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="id2644500"></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="id2926184"></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="#id3030604">1. Overview</a></span></dt><dt><span class="chapter"><a href="#id3054513">2. Programming the 8051 with SDCC</a></span></dt><dd><dl><dt><span class="section"><a href="#id3047958">8051 memory spaces</a></span></dt><dd><dl><dt><span class="section"><a href="#id3062556">__data</a></span></dt><dt><span class="section"><a href="#id3049491">__idata</a></span></dt><dt><span class="section"><a href="#id3060911">__xdata</a></span></dt><dt><span class="section"><a href="#id3044196">__pdata</a></span></dt><dt><span class="section"><a href="#id3040299">__code</a></span></dt><dt><span class="section"><a href="#id3046338">__bit</a></span></dt><dt><span class="section"><a href="#id3034050">__sfr, __sfr16, __sfr32, __sbit</a></span></dt></dl></dd><dt><span class="section"><a href="#id3040594">Function calls on the 8051</a></span></dt><dd><dl><dt><span class="section"><a href="#id3032920">__reentrant functions</a></span></dt><dt><span class="section"><a href="#id3034062">Non __reentrant functions</a></span></dt><dt><span class="section"><a href="#id3062416">__interrupt functions</a></span></dt><dt><span class="section"><a href="#id3046332">__critical functions and statements</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#id3054138">3. Task functions</a></span></dt><dd><dl><dt><span class="section"><a href="#id3041869">ao_add_task</a></span></dt><dt><span class="section"><a href="#id3025071">ao_exit</a></span></dt><dt><span class="section"><a href="#id3064272">ao_sleep</a></span></dt><dt><span class="section"><a href="#id3031163">ao_wakeup</a></span></dt><dt><span class="section"><a href="#id3054302">ao_alarm</a></span></dt><dt><span class="section"><a href="#id3041004">ao_start_scheduler</a></span></dt><dt><span class="section"><a href="#id3041141">ao_clock_init</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id3047245">4. Timer Functions</a></span></dt><dd><dl><dt><span class="section"><a href="#id3039685">ao_time</a></span></dt><dt><span class="section"><a href="#id3050410">ao_delay</a></span></dt><dt><span class="section"><a href="#id3059966">ao_timer_set_adc_interval</a></span></dt><dt><span class="section"><a href="#id3061599">ao_timer_init</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id3044596">5. AltOS Mutexes</a></span></dt><dd><dl><dt><span class="section"><a href="#id3039368">ao_mutex_get</a></span></dt><dt><span class="section"><a href="#id3040371">ao_mutex_put</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id3060632">6. CC1111 DMA engine</a></span></dt><dd><dl><dt><span class="section"><a href="#id3063758">ao_dma_alloc</a></span></dt><dt><span class="section"><a href="#id3025329">ao_dma_set_transfer</a></span></dt><dt><span class="section"><a href="#id3042097">ao_dma_start</a></span></dt><dt><span class="section"><a href="#id3043596">ao_dma_trigger</a></span></dt><dt><span class="section"><a href="#id3045403">ao_dma_abort</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id3041296">7. SDCC Stdio interface</a></span></dt><dd><dl><dt><span class="section"><a href="#id3058213">putchar</a></span></dt><dt><span class="section"><a href="#id3037886">getchar</a></span></dt><dt><span class="section"><a href="#id3054987">flush</a></span></dt><dt><span class="section"><a href="#id3038148">ao_add_stdio</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id3037036">8. Command line interface</a></span></dt><dd><dl><dt><span class="section"><a href="#id3065531">ao_cmd_register</a></span></dt><dt><span class="section"><a href="#id3055128">ao_cmd_lex</a></span></dt><dt><span class="section"><a href="#id3053545">ao_cmd_put16</a></span></dt><dt><span class="section"><a href="#id3064891">ao_cmd_put8</a></span></dt><dt><span class="section"><a href="#id3064532">ao_cmd_white</a></span></dt><dt><span class="section"><a href="#id3052996">ao_cmd_hex</a></span></dt><dt><span class="section"><a href="#id3062825">ao_cmd_decimal</a></span></dt><dt><span class="section"><a href="#id3061588">ao_match_word</a></span></dt><dt><span class="section"><a href="#id3058728">ao_cmd_init</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id3040060">9. CC1111 USB target device</a></span></dt><dd><dl><dt><span class="section"><a href="#id3057328">ao_usb_flush</a></span></dt><dt><span class="section"><a href="#id3048197">ao_usb_putchar</a></span></dt><dt><span class="section"><a href="#id3039899">ao_usb_pollchar</a></span></dt><dt><span class="section"><a href="#id3047580">ao_usb_getchar</a></span></dt><dt><span class="section"><a href="#id3064438">ao_usb_disable</a></span></dt><dt><span class="section"><a href="#id3044805">ao_usb_enable</a></span></dt><dt><span class="section"><a href="#id3048376">ao_usb_init</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id3059404">10. CC1111 Serial peripheral</a></span></dt><dd><dl><dt><span class="section"><a href="#id3054144">ao_serial_getchar</a></span></dt><dt><span class="section"><a href="#id3046497">ao_serial_putchar</a></span></dt><dt><span class="section"><a href="#id3058428">ao_serial_drain</a></span></dt><dt><span class="section"><a href="#id3053712">ao_serial_set_speed</a></span></dt><dt><span class="section"><a href="#id3029354">ao_serial_init</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id3039979">11. CC1111 Radio peripheral</a></span></dt><dd><dl><dt><span class="section"><a href="#id3061300">ao_radio_set_telemetry</a></span></dt><dt><span class="section"><a href="#id3051516">ao_radio_set_packet</a></span></dt><dt><span class="section"><a href="#id3043098">ao_radio_set_rdf</a></span></dt><dt><span class="section"><a href="#id3048048">ao_radio_idle</a></span></dt><dt><span class="section"><a href="#id3058592">ao_radio_get</a></span></dt><dt><span class="section"><a href="#id3063918">ao_radio_put</a></span></dt><dt><span class="section"><a href="#id3058709">ao_radio_abort</a></span></dt><dt><span class="section"><a href="#id3054135">ao_radio_send</a></span></dt><dt><span class="section"><a href="#id3051851">ao_radio_recv</a></span></dt><dt><span class="section"><a href="#id3040906">ao_radio_rdf</a></span></dt><dt><span class="section"><a href="#id3052434">ao_packet_putchar</a></span></dt><dt><span class="section"><a href="#id3019821">ao_packet_pollchar</a></span></dt><dt><span class="section"><a href="#id3042277">ao_packet_slave_start</a></span></dt><dt><span class="section"><a href="#id3043113">ao_packet_slave_stop</a></span></dt><dt><span class="section"><a href="#id3048649">ao_packet_slave_init</a></span></dt><dt><span class="section"><a href="#id3047717">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="id3030604"></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="#id2911956">1. Overview</a></span></dt><dt><span class="chapter"><a href="#id2935866">2. Programming the 8051 with SDCC</a></span></dt><dd><dl><dt><span class="section"><a href="#id2929311">8051 memory spaces</a></span></dt><dd><dl><dt><span class="section"><a href="#id2943908">__data</a></span></dt><dt><span class="section"><a href="#id2930844">__idata</a></span></dt><dt><span class="section"><a href="#id2942263">__xdata</a></span></dt><dt><span class="section"><a href="#id2925549">__pdata</a></span></dt><dt><span class="section"><a href="#id2921651">__code</a></span></dt><dt><span class="section"><a href="#id2927691">__bit</a></span></dt><dt><span class="section"><a href="#id2915402">__sfr, __sfr16, __sfr32, __sbit</a></span></dt></dl></dd><dt><span class="section"><a href="#id2921946">Function calls on the 8051</a></span></dt><dd><dl><dt><span class="section"><a href="#id2914273">__reentrant functions</a></span></dt><dt><span class="section"><a href="#id2915415">Non __reentrant functions</a></span></dt><dt><span class="section"><a href="#id2943768">__interrupt functions</a></span></dt><dt><span class="section"><a href="#id2927684">__critical functions and statements</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#id2935490">3. Task functions</a></span></dt><dd><dl><dt><span class="section"><a href="#id2923222">ao_add_task</a></span></dt><dt><span class="section"><a href="#id2906423">ao_exit</a></span></dt><dt><span class="section"><a href="#id2945624">ao_sleep</a></span></dt><dt><span class="section"><a href="#id2912516">ao_wakeup</a></span></dt><dt><span class="section"><a href="#id2935655">ao_alarm</a></span></dt><dt><span class="section"><a href="#id2922357">ao_start_scheduler</a></span></dt><dt><span class="section"><a href="#id2922493">ao_clock_init</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id2928598">4. Timer Functions</a></span></dt><dd><dl><dt><span class="section"><a href="#id2921037">ao_time</a></span></dt><dt><span class="section"><a href="#id2931762">ao_delay</a></span></dt><dt><span class="section"><a href="#id2941318">ao_timer_set_adc_interval</a></span></dt><dt><span class="section"><a href="#id2942951">ao_timer_init</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id2925949">5. AltOS Mutexes</a></span></dt><dd><dl><dt><span class="section"><a href="#id2920720">ao_mutex_get</a></span></dt><dt><span class="section"><a href="#id2921724">ao_mutex_put</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id2941985">6. CC1111 DMA engine</a></span></dt><dd><dl><dt><span class="section"><a href="#id2945111">ao_dma_alloc</a></span></dt><dt><span class="section"><a href="#id2906682">ao_dma_set_transfer</a></span></dt><dt><span class="section"><a href="#id2923449">ao_dma_start</a></span></dt><dt><span class="section"><a href="#id2924948">ao_dma_trigger</a></span></dt><dt><span class="section"><a href="#id2926755">ao_dma_abort</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id2922649">7. SDCC Stdio interface</a></span></dt><dd><dl><dt><span class="section"><a href="#id2939565">putchar</a></span></dt><dt><span class="section"><a href="#id2919239">getchar</a></span></dt><dt><span class="section"><a href="#id2936340">flush</a></span></dt><dt><span class="section"><a href="#id2919501">ao_add_stdio</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id2918389">8. Command line interface</a></span></dt><dd><dl><dt><span class="section"><a href="#id2946883">ao_cmd_register</a></span></dt><dt><span class="section"><a href="#id2936480">ao_cmd_lex</a></span></dt><dt><span class="section"><a href="#id2934898">ao_cmd_put16</a></span></dt><dt><span class="section"><a href="#id2946243">ao_cmd_put8</a></span></dt><dt><span class="section"><a href="#id2945885">ao_cmd_white</a></span></dt><dt><span class="section"><a href="#id2934349">ao_cmd_hex</a></span></dt><dt><span class="section"><a href="#id2944178">ao_cmd_decimal</a></span></dt><dt><span class="section"><a href="#id2942940">ao_match_word</a></span></dt><dt><span class="section"><a href="#id2940080">ao_cmd_init</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id2921413">9. CC1111 USB target device</a></span></dt><dd><dl><dt><span class="section"><a href="#id2938680">ao_usb_flush</a></span></dt><dt><span class="section"><a href="#id2929550">ao_usb_putchar</a></span></dt><dt><span class="section"><a href="#id2921252">ao_usb_pollchar</a></span></dt><dt><span class="section"><a href="#id2928933">ao_usb_getchar</a></span></dt><dt><span class="section"><a href="#id2945790">ao_usb_disable</a></span></dt><dt><span class="section"><a href="#id2926157">ao_usb_enable</a></span></dt><dt><span class="section"><a href="#id2929728">ao_usb_init</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id2940757">10. CC1111 Serial peripheral</a></span></dt><dd><dl><dt><span class="section"><a href="#id2935496">ao_serial_getchar</a></span></dt><dt><span class="section"><a href="#id2927850">ao_serial_putchar</a></span></dt><dt><span class="section"><a href="#id2939780">ao_serial_drain</a></span></dt><dt><span class="section"><a href="#id2935064">ao_serial_set_speed</a></span></dt><dt><span class="section"><a href="#id2910707">ao_serial_init</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id2921332">11. CC1111 Radio peripheral</a></span></dt><dd><dl><dt><span class="section"><a href="#id2942652">ao_radio_set_telemetry</a></span></dt><dt><span class="section"><a href="#id2932868">ao_radio_set_packet</a></span></dt><dt><span class="section"><a href="#id2924450">ao_radio_set_rdf</a></span></dt><dt><span class="section"><a href="#id2929401">ao_radio_idle</a></span></dt><dt><span class="section"><a href="#id2939945">ao_radio_get</a></span></dt><dt><span class="section"><a href="#id2945270">ao_radio_put</a></span></dt><dt><span class="section"><a href="#id2940062">ao_radio_abort</a></span></dt><dt><span class="section"><a href="#id2935488">ao_radio_send</a></span></dt><dt><span class="section"><a href="#id2933204">ao_radio_recv</a></span></dt><dt><span class="section"><a href="#id2922259">ao_radio_rdf</a></span></dt><dt><span class="section"><a href="#id2933786">ao_packet_putchar</a></span></dt><dt><span class="section"><a href="#id2901174">ao_packet_pollchar</a></span></dt><dt><span class="section"><a href="#id2923629">ao_packet_slave_start</a></span></dt><dt><span class="section"><a href="#id2924465">ao_packet_slave_stop</a></span></dt><dt><span class="section"><a href="#id2930002">ao_packet_slave_init</a></span></dt><dt><span class="section"><a href="#id2929069">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="id2911956"></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="id3054513"></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="#id3047958">8051 memory spaces</a></span></dt><dd><dl><dt><span class="section"><a href="#id3062556">__data</a></span></dt><dt><span class="section"><a href="#id3049491">__idata</a></span></dt><dt><span class="section"><a href="#id3060911">__xdata</a></span></dt><dt><span class="section"><a href="#id3044196">__pdata</a></span></dt><dt><span class="section"><a href="#id3040299">__code</a></span></dt><dt><span class="section"><a href="#id3046338">__bit</a></span></dt><dt><span class="section"><a href="#id3034050">__sfr, __sfr16, __sfr32, __sbit</a></span></dt></dl></dd><dt><span class="section"><a href="#id3040594">Function calls on the 8051</a></span></dt><dd><dl><dt><span class="section"><a href="#id3032920">__reentrant functions</a></span></dt><dt><span class="section"><a href="#id3034062">Non __reentrant functions</a></span></dt><dt><span class="section"><a href="#id3062416">__interrupt functions</a></span></dt><dt><span class="section"><a href="#id3046332">__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="id2935866"></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="#id2929311">8051 memory spaces</a></span></dt><dd><dl><dt><span class="section"><a href="#id2943908">__data</a></span></dt><dt><span class="section"><a href="#id2930844">__idata</a></span></dt><dt><span class="section"><a href="#id2942263">__xdata</a></span></dt><dt><span class="section"><a href="#id2925549">__pdata</a></span></dt><dt><span class="section"><a href="#id2921651">__code</a></span></dt><dt><span class="section"><a href="#id2927691">__bit</a></span></dt><dt><span class="section"><a href="#id2915402">__sfr, __sfr16, __sfr32, __sbit</a></span></dt></dl></dd><dt><span class="section"><a href="#id2921946">Function calls on the 8051</a></span></dt><dd><dl><dt><span class="section"><a href="#id2914273">__reentrant functions</a></span></dt><dt><span class="section"><a href="#id2915415">Non __reentrant functions</a></span></dt><dt><span class="section"><a href="#id2943768">__interrupt functions</a></span></dt><dt><span class="section"><a href="#id2927684">__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="8051 memory spaces"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3047958"></a>8051 memory spaces</h2></div></div></div><p> + </p><div class="section" title="8051 memory spaces"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2929311"></a>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—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="__data"><div class="titlepage"><div><div><h3 class="title"><a name="id3062556"></a>__data</h3></div></div></div><p> + </p><div class="section" title="__data"><div class="titlepage"><div><div><h3 class="title"><a name="id2943908"></a>__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="__idata"><div class="titlepage"><div><div><h3 class="title"><a name="id3049491"></a>__idata</h3></div></div></div><p> + </p></div><div class="section" title="__idata"><div class="titlepage"><div><div><h3 class="title"><a name="id2930844"></a>__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="__xdata"><div class="titlepage"><div><div><h3 class="title"><a name="id3060911"></a>__xdata</h3></div></div></div><p> + </p></div><div class="section" title="__xdata"><div class="titlepage"><div><div><h3 class="title"><a name="id2942263"></a>__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="__pdata"><div class="titlepage"><div><div><h3 class="title"><a name="id3044196"></a>__pdata</h3></div></div></div><p> + </p></div><div class="section" title="__pdata"><div class="titlepage"><div><div><h3 class="title"><a name="id2925549"></a>__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="__code"><div class="titlepage"><div><div><h3 class="title"><a name="id3040299"></a>__code</h3></div></div></div><p> + </p></div><div class="section" title="__code"><div class="titlepage"><div><div><h3 class="title"><a name="id2921651"></a>__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="__bit"><div class="titlepage"><div><div><h3 class="title"><a name="id3046338"></a>__bit</h3></div></div></div><p> + </p></div><div class="section" title="__bit"><div class="titlepage"><div><div><h3 class="title"><a name="id2927691"></a>__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="__sfr, __sfr16, __sfr32, __sbit"><div class="titlepage"><div><div><h3 class="title"><a name="id3034050"></a>__sfr, __sfr16, __sfr32, __sbit</h3></div></div></div><p> + </p></div><div class="section" title="__sfr, __sfr16, __sfr32, __sbit"><div class="titlepage"><div><div><h3 class="title"><a name="id2915402"></a>__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="Function calls on the 8051"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3040594"></a>Function calls on the 8051</h2></div></div></div><p> + </p></div></div><div class="section" title="Function calls on the 8051"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2921946"></a>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="__reentrant functions"><div class="titlepage"><div><div><h3 class="title"><a name="id3032920"></a>__reentrant functions</h3></div></div></div><p> + </p><div class="section" title="__reentrant functions"><div class="titlepage"><div><div><h3 class="title"><a name="id2914273"></a>__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="Non __reentrant functions"><div class="titlepage"><div><div><h3 class="title"><a name="id3034062"></a>Non __reentrant functions</h3></div></div></div><p> + </p></div><div class="section" title="Non __reentrant functions"><div class="titlepage"><div><div><h3 class="title"><a name="id2915415"></a>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="__interrupt functions"><div class="titlepage"><div><div><h3 class="title"><a name="id3062416"></a>__interrupt functions</h3></div></div></div><p> + </p></div><div class="section" title="__interrupt functions"><div class="titlepage"><div><div><h3 class="title"><a name="id2943768"></a>__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="__critical functions and statements"><div class="titlepage"><div><div><h3 class="title"><a name="id3046332"></a>__critical functions and statements</h3></div></div></div><p> + </p></div><div class="section" title="__critical functions and statements"><div class="titlepage"><div><div><h3 class="title"><a name="id2927684"></a>__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="id3054138"></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="#id3041869">ao_add_task</a></span></dt><dt><span class="section"><a href="#id3025071">ao_exit</a></span></dt><dt><span class="section"><a href="#id3064272">ao_sleep</a></span></dt><dt><span class="section"><a href="#id3031163">ao_wakeup</a></span></dt><dt><span class="section"><a href="#id3054302">ao_alarm</a></span></dt><dt><span class="section"><a href="#id3041004">ao_start_scheduler</a></span></dt><dt><span class="section"><a href="#id3041141">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="id2935490"></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="#id2923222">ao_add_task</a></span></dt><dt><span class="section"><a href="#id2906423">ao_exit</a></span></dt><dt><span class="section"><a href="#id2945624">ao_sleep</a></span></dt><dt><span class="section"><a href="#id2912516">ao_wakeup</a></span></dt><dt><span class="section"><a href="#id2935655">ao_alarm</a></span></dt><dt><span class="section"><a href="#id2922357">ao_start_scheduler</a></span></dt><dt><span class="section"><a href="#id2922493">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="ao_add_task"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3041869"></a>ao_add_task</h2></div></div></div><pre class="programlisting"> + </p><div class="section" title="ao_add_task"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2923222"></a>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="ao_exit"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3025071"></a>ao_exit</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_exit"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2906423"></a>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="ao_sleep"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3064272"></a>ao_sleep</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_sleep"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2945624"></a>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(&ao_radio_done); </pre><p> - </p></div><div class="section" title="ao_wakeup"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3031163"></a>ao_wakeup</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_wakeup"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2912516"></a>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="ao_alarm"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3054302"></a>ao_alarm</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_alarm"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2935655"></a>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="ao_start_scheduler"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3041004"></a>ao_start_scheduler</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_start_scheduler"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2922357"></a>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="ao_clock_init"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3041141"></a>ao_clock_init</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_clock_init"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2922493"></a>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="id3047245"></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="#id3039685">ao_time</a></span></dt><dt><span class="section"><a href="#id3050410">ao_delay</a></span></dt><dt><span class="section"><a href="#id3059966">ao_timer_set_adc_interval</a></span></dt><dt><span class="section"><a href="#id3061599">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="id2928598"></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="#id2921037">ao_time</a></span></dt><dt><span class="section"><a href="#id2931762">ao_delay</a></span></dt><dt><span class="section"><a href="#id2941318">ao_timer_set_adc_interval</a></span></dt><dt><span class="section"><a href="#id2942951">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="ao_time"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3039685"></a>ao_time</h2></div></div></div><pre class="programlisting"> + </p><div class="section" title="ao_time"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2921037"></a>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="ao_delay"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3050410"></a>ao_delay</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_delay"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2931762"></a>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="ao_timer_set_adc_interval"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3059966"></a>ao_timer_set_adc_interval</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_timer_set_adc_interval"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2941318"></a>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="ao_timer_init"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3061599"></a>ao_timer_init</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_timer_init"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2942951"></a>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="id3044596"></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="#id3039368">ao_mutex_get</a></span></dt><dt><span class="section"><a href="#id3040371">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="id2925949"></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="#id2920720">ao_mutex_get</a></span></dt><dt><span class="section"><a href="#id2921724">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—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="ao_mutex_get"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3039368"></a>ao_mutex_get</h2></div></div></div><pre class="programlisting"> + </p><div class="section" title="ao_mutex_get"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2920720"></a>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="ao_mutex_put"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3040371"></a>ao_mutex_put</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_mutex_put"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2921724"></a>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="id3060632"></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="#id3063758">ao_dma_alloc</a></span></dt><dt><span class="section"><a href="#id3025329">ao_dma_set_transfer</a></span></dt><dt><span class="section"><a href="#id3042097">ao_dma_start</a></span></dt><dt><span class="section"><a href="#id3043596">ao_dma_trigger</a></span></dt><dt><span class="section"><a href="#id3045403">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="id2941985"></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="#id2945111">ao_dma_alloc</a></span></dt><dt><span class="section"><a href="#id2906682">ao_dma_set_transfer</a></span></dt><dt><span class="section"><a href="#id2923449">ao_dma_start</a></span></dt><dt><span class="section"><a href="#id2924948">ao_dma_trigger</a></span></dt><dt><span class="section"><a href="#id2926755">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="ao_dma_alloc"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3063758"></a>ao_dma_alloc</h2></div></div></div><pre class="programlisting"> + </p><div class="section" title="ao_dma_alloc"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2945111"></a>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="ao_dma_set_transfer"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3025329"></a>ao_dma_set_transfer</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_dma_set_transfer"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2906682"></a>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="ao_dma_start"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3042097"></a>ao_dma_start</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_dma_start"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2923449"></a>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="ao_dma_trigger"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3043596"></a>ao_dma_trigger</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_dma_trigger"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2924948"></a>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="ao_dma_abort"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3045403"></a>ao_dma_abort</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_dma_abort"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2926755"></a>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="id3041296"></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="#id3058213">putchar</a></span></dt><dt><span class="section"><a href="#id3037886">getchar</a></span></dt><dt><span class="section"><a href="#id3054987">flush</a></span></dt><dt><span class="section"><a href="#id3038148">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="id2922649"></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="#id2939565">putchar</a></span></dt><dt><span class="section"><a href="#id2919239">getchar</a></span></dt><dt><span class="section"><a href="#id2936340">flush</a></span></dt><dt><span class="section"><a href="#id2919501">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="putchar"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3058213"></a>putchar</h2></div></div></div><pre class="programlisting"> + </p><div class="section" title="putchar"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2939565"></a>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="getchar"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3037886"></a>getchar</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="getchar"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2919239"></a>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="flush"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3054987"></a>flush</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="flush"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2936340"></a>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="ao_add_stdio"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3038148"></a>ao_add_stdio</h2></div></div></div><pre class="programlisting"> + xo </p></div><div class="section" title="ao_add_stdio"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2919501"></a>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="id3037036"></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="#id3065531">ao_cmd_register</a></span></dt><dt><span class="section"><a href="#id3055128">ao_cmd_lex</a></span></dt><dt><span class="section"><a href="#id3053545">ao_cmd_put16</a></span></dt><dt><span class="section"><a href="#id3064891">ao_cmd_put8</a></span></dt><dt><span class="section"><a href="#id3064532">ao_cmd_white</a></span></dt><dt><span class="section"><a href="#id3052996">ao_cmd_hex</a></span></dt><dt><span class="section"><a href="#id3062825">ao_cmd_decimal</a></span></dt><dt><span class="section"><a href="#id3061588">ao_match_word</a></span></dt><dt><span class="section"><a href="#id3058728">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="id2918389"></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="#id2946883">ao_cmd_register</a></span></dt><dt><span class="section"><a href="#id2936480">ao_cmd_lex</a></span></dt><dt><span class="section"><a href="#id2934898">ao_cmd_put16</a></span></dt><dt><span class="section"><a href="#id2946243">ao_cmd_put8</a></span></dt><dt><span class="section"><a href="#id2945885">ao_cmd_white</a></span></dt><dt><span class="section"><a href="#id2934349">ao_cmd_hex</a></span></dt><dt><span class="section"><a href="#id2944178">ao_cmd_decimal</a></span></dt><dt><span class="section"><a href="#id2942940">ao_match_word</a></span></dt><dt><span class="section"><a href="#id2940080">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="ao_cmd_register"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3065531"></a>ao_cmd_register</h2></div></div></div><pre class="programlisting"> + </p><div class="section" title="ao_cmd_register"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2946883"></a>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="ao_cmd_lex"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3055128"></a>ao_cmd_lex</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_cmd_lex"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2936480"></a>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="ao_cmd_put16"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3053545"></a>ao_cmd_put16</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_cmd_put16"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2934898"></a>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="ao_cmd_put8"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3064891"></a>ao_cmd_put8</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_cmd_put8"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2946243"></a>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="ao_cmd_white"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3064532"></a>ao_cmd_white</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_cmd_white"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2945885"></a>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="ao_cmd_hex"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3052996"></a>ao_cmd_hex</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_cmd_hex"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2934349"></a>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="ao_cmd_decimal"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3062825"></a>ao_cmd_decimal</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_cmd_decimal"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2944178"></a>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="ao_match_word"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3061588"></a>ao_match_word</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_match_word"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2942940"></a>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="ao_cmd_init"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3058728"></a>ao_cmd_init</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_cmd_init"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2940080"></a>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="id3040060"></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="#id3057328">ao_usb_flush</a></span></dt><dt><span class="section"><a href="#id3048197">ao_usb_putchar</a></span></dt><dt><span class="section"><a href="#id3039899">ao_usb_pollchar</a></span></dt><dt><span class="section"><a href="#id3047580">ao_usb_getchar</a></span></dt><dt><span class="section"><a href="#id3064438">ao_usb_disable</a></span></dt><dt><span class="section"><a href="#id3044805">ao_usb_enable</a></span></dt><dt><span class="section"><a href="#id3048376">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="id2921413"></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="#id2938680">ao_usb_flush</a></span></dt><dt><span class="section"><a href="#id2929550">ao_usb_putchar</a></span></dt><dt><span class="section"><a href="#id2921252">ao_usb_pollchar</a></span></dt><dt><span class="section"><a href="#id2928933">ao_usb_getchar</a></span></dt><dt><span class="section"><a href="#id2945790">ao_usb_disable</a></span></dt><dt><span class="section"><a href="#id2926157">ao_usb_enable</a></span></dt><dt><span class="section"><a href="#id2929728">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="ao_usb_flush"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3057328"></a>ao_usb_flush</h2></div></div></div><pre class="programlisting"> + </p><div class="section" title="ao_usb_flush"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2938680"></a>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="ao_usb_putchar"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3048197"></a>ao_usb_putchar</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_usb_putchar"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2929550"></a>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="ao_usb_pollchar"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3039899"></a>ao_usb_pollchar</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_usb_pollchar"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2921252"></a>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="ao_usb_getchar"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3047580"></a>ao_usb_getchar</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_usb_getchar"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2928933"></a>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="ao_usb_disable"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3064438"></a>ao_usb_disable</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_usb_disable"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2945790"></a>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="ao_usb_enable"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3044805"></a>ao_usb_enable</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_usb_enable"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2926157"></a>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="ao_usb_init"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3048376"></a>ao_usb_init</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_usb_init"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2929728"></a>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="id3059404"></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="#id3054144">ao_serial_getchar</a></span></dt><dt><span class="section"><a href="#id3046497">ao_serial_putchar</a></span></dt><dt><span class="section"><a href="#id3058428">ao_serial_drain</a></span></dt><dt><span class="section"><a href="#id3053712">ao_serial_set_speed</a></span></dt><dt><span class="section"><a href="#id3029354">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="id2940757"></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="#id2935496">ao_serial_getchar</a></span></dt><dt><span class="section"><a href="#id2927850">ao_serial_putchar</a></span></dt><dt><span class="section"><a href="#id2939780">ao_serial_drain</a></span></dt><dt><span class="section"><a href="#id2935064">ao_serial_set_speed</a></span></dt><dt><span class="section"><a href="#id2910707">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="ao_serial_getchar"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3054144"></a>ao_serial_getchar</h2></div></div></div><pre class="programlisting"> + </p><div class="section" title="ao_serial_getchar"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2935496"></a>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="ao_serial_putchar"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3046497"></a>ao_serial_putchar</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_serial_putchar"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2927850"></a>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="ao_serial_drain"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3058428"></a>ao_serial_drain</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_serial_drain"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2939780"></a>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="ao_serial_set_speed"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3053712"></a>ao_serial_set_speed</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_serial_set_speed"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2935064"></a>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="ao_serial_init"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3029354"></a>ao_serial_init</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_serial_init"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2910707"></a>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="id3039979"></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="#id3061300">ao_radio_set_telemetry</a></span></dt><dt><span class="section"><a href="#id3051516">ao_radio_set_packet</a></span></dt><dt><span class="section"><a href="#id3043098">ao_radio_set_rdf</a></span></dt><dt><span class="section"><a href="#id3048048">ao_radio_idle</a></span></dt><dt><span class="section"><a href="#id3058592">ao_radio_get</a></span></dt><dt><span class="section"><a href="#id3063918">ao_radio_put</a></span></dt><dt><span class="section"><a href="#id3058709">ao_radio_abort</a></span></dt><dt><span class="section"><a href="#id3054135">ao_radio_send</a></span></dt><dt><span class="section"><a href="#id3051851">ao_radio_recv</a></span></dt><dt><span class="section"><a href="#id3040906">ao_radio_rdf</a></span></dt><dt><span class="section"><a href="#id3052434">ao_packet_putchar</a></span></dt><dt><span class="section"><a href="#id3019821">ao_packet_pollchar</a></span></dt><dt><span class="section"><a href="#id3042277">ao_packet_slave_start</a></span></dt><dt><span class="section"><a href="#id3043113">ao_packet_slave_stop</a></span></dt><dt><span class="section"><a href="#id3048649">ao_packet_slave_init</a></span></dt><dt><span class="section"><a href="#id3047717">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="id2921332"></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="#id2942652">ao_radio_set_telemetry</a></span></dt><dt><span class="section"><a href="#id2932868">ao_radio_set_packet</a></span></dt><dt><span class="section"><a href="#id2924450">ao_radio_set_rdf</a></span></dt><dt><span class="section"><a href="#id2929401">ao_radio_idle</a></span></dt><dt><span class="section"><a href="#id2939945">ao_radio_get</a></span></dt><dt><span class="section"><a href="#id2945270">ao_radio_put</a></span></dt><dt><span class="section"><a href="#id2940062">ao_radio_abort</a></span></dt><dt><span class="section"><a href="#id2935488">ao_radio_send</a></span></dt><dt><span class="section"><a href="#id2933204">ao_radio_recv</a></span></dt><dt><span class="section"><a href="#id2922259">ao_radio_rdf</a></span></dt><dt><span class="section"><a href="#id2933786">ao_packet_putchar</a></span></dt><dt><span class="section"><a href="#id2901174">ao_packet_pollchar</a></span></dt><dt><span class="section"><a href="#id2923629">ao_packet_slave_start</a></span></dt><dt><span class="section"><a href="#id2924465">ao_packet_slave_stop</a></span></dt><dt><span class="section"><a href="#id2930002">ao_packet_slave_init</a></span></dt><dt><span class="section"><a href="#id2929069">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="ao_radio_set_telemetry"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3061300"></a>ao_radio_set_telemetry</h2></div></div></div><pre class="programlisting"> + </p><div class="section" title="ao_radio_set_telemetry"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2942652"></a>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="ao_radio_set_packet"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3051516"></a>ao_radio_set_packet</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_radio_set_packet"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2932868"></a>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="ao_radio_set_rdf"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3043098"></a>ao_radio_set_rdf</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_radio_set_rdf"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2924450"></a>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="ao_radio_idle"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3048048"></a>ao_radio_idle</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_radio_idle"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2929401"></a>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="ao_radio_get"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3058592"></a>ao_radio_get</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_radio_get"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2939945"></a>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="ao_radio_put"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3063918"></a>ao_radio_put</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_radio_put"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2945270"></a>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="ao_radio_abort"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3058709"></a>ao_radio_abort</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_radio_abort"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2940062"></a>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="ao_radio_send"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3054135"></a>ao_radio_send</h2></div></div></div><pre class="programlisting"> + </p><div class="section" title="ao_radio_send"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2935488"></a>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="ao_radio_recv"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3051851"></a>ao_radio_recv</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_radio_recv"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2933204"></a>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="ao_radio_rdf"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3040906"></a>ao_radio_rdf</h2></div></div></div><pre class="programlisting"> + </p><div class="section" title="ao_radio_rdf"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2922259"></a>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="ao_packet_putchar"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3052434"></a>ao_packet_putchar</h2></div></div></div><pre class="programlisting"> + </p><div class="section" title="ao_packet_putchar"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2933786"></a>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="ao_packet_pollchar"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3019821"></a>ao_packet_pollchar</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_packet_pollchar"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2901174"></a>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="ao_packet_slave_start"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3042277"></a>ao_packet_slave_start</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_packet_slave_start"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2923629"></a>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="ao_packet_slave_stop"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3043113"></a>ao_packet_slave_stop</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_packet_slave_stop"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2924465"></a>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="ao_packet_slave_init"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3048649"></a>ao_packet_slave_init</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_packet_slave_init"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2930002"></a>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="ao_packet_master_init"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id3047717"></a>ao_packet_master_init</h2></div></div></div><pre class="programlisting"> + </p></div><div class="section" title="ao_packet_master_init"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2929069"></a>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 Binary files differindex 8554684..046c406 100644 --- a/AltOS/doc/altos.pdf +++ b/AltOS/doc/altos.pdf diff --git a/AltOS/doc/altusmetrum.html b/AltOS/doc/altusmetrum.html index 95925a9..226ea3b 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="id2530705"></a>The Altus Metrum System</h1></div><div><h2 class="subtitle">An Owner's Manual for TeleMetrum 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="id2806204"></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.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="id2360926"></a>The Altus Metrum System</h1></div><div><h2 class="subtitle">An Owner's Manual for TeleMetrum 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="id2636425"></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 @@ -8,7 +8,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></table></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.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="id2798131"></a>Acknowledgements</h2></div></div></div> + </td></tr></table></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.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="id2628351"></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 @@ -35,7 +35,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="#id2775241">1. Introduction and Overview</a></span></dt><dt><span class="chapter"><a href="#id2775282">2. Getting Started</a></span></dt><dd><dl><dt><span class="section"><a href="#id2814293">FAQ</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id2801399">3. Specifications</a></span></dt><dt><span class="chapter"><a href="#id2829253">4. Handling Precautions</a></span></dt><dt><span class="chapter"><a href="#id2801631">5. Hardware Overview</a></span></dt><dt><span class="chapter"><a href="#id2807497">6. System Operation</a></span></dt><dd><dl><dt><span class="section"><a href="#id2810644">Firmware Modes </a></span></dt><dt><span class="section"><a href="#id2812356">GPS </a></span></dt><dt><span class="section"><a href="#id2826760">Ground Testing </a></span></dt><dt><span class="section"><a href="#id2826757">Radio Link </a></span></dt><dt><span class="section"><a href="#id2797478">Configurable Parameters</a></span></dt><dd><dl><dt><span class="section"><a href="#id2817749">Radio Channel</a></span></dt><dt><span class="section"><a href="#id2808663">Apogee Delay</a></span></dt><dt><span class="section"><a href="#id2826470">Main Deployment Altitude</a></span></dt></dl></dd><dt><span class="section"><a href="#id2805098">Calibration</a></span></dt><dd><dl><dt><span class="section"><a href="#id2828821">Radio Frequency</a></span></dt><dt><span class="section"><a href="#id2818931">Accelerometer</a></span></dt></dl></dd><dt><span class="section"><a href="#id2827169">Updating Device Firmware</a></span></dt><dd><dl><dt><span class="section"><a href="#id2800068">Updating TeleMetrum Firmware</a></span></dt><dt><span class="section"><a href="#id2809460">Updating TeleDongle Firmware</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#id2807412">7. AltosUI</a></span></dt><dd><dl><dt><span class="section"><a href="#id2823783">Packet Command Mode</a></span></dt><dt><span class="section"><a href="#id2817651">Monitor Flight</a></span></dt><dd><dl><dt><span class="section"><a href="#id2800268">Launch Pad</a></span></dt><dt><span class="section"><a href="#id2820346">Ascent</a></span></dt><dt><span class="section"><a href="#id2821559">Descent</a></span></dt><dt><span class="section"><a href="#id2806862">Landed</a></span></dt><dt><span class="section"><a href="#id2832376">Site Map</a></span></dt></dl></dd><dt><span class="section"><a href="#id2821796">Save Flight Data</a></span></dt><dt><span class="section"><a href="#id2831879">Replay Flight</a></span></dt><dt><span class="section"><a href="#id2818702">Graph Data</a></span></dt><dt><span class="section"><a href="#id2813702">Export Data</a></span></dt><dd><dl><dt><span class="section"><a href="#id2820904">Comma Separated Value Format</a></span></dt><dt><span class="section"><a href="#id2824465">Keyhole Markup Language (for Google Earth)</a></span></dt></dl></dd><dt><span class="section"><a href="#id2815725">Configure TeleMetrum</a></span></dt><dd><dl><dt><span class="section"><a href="#id2804583">Main Deploy Altitude</a></span></dt><dt><span class="section"><a href="#id2798265">Apogee Delay</a></span></dt><dt><span class="section"><a href="#id2827715">Radio Channel</a></span></dt><dt><span class="section"><a href="#id2809290">Radio Calibration</a></span></dt><dt><span class="section"><a href="#id2807169">Callsign</a></span></dt><dt><span class="section"><a href="#id2817821">Maximum Flight Log Size</a></span></dt></dl></dd><dt><span class="section"><a href="#id2809528">Configure AltosUI</a></span></dt><dd><dl><dt><span class="section"><a href="#id2820811">Voice Settings</a></span></dt><dt><span class="section"><a href="#id2818865">Log Directory</a></span></dt><dt><span class="section"><a href="#id2810448">Callsign</a></span></dt><dt><span class="section"><a href="#id2791745">Serial Debug</a></span></dt></dl></dd><dt><span class="section"><a href="#id2821072">Flash Image</a></span></dt><dt><span class="section"><a href="#id2821637">Fire Igniter</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id2815889">8. Using Altus Metrum Products</a></span></dt><dd><dl><dt><span class="section"><a href="#id2821485">Being Legal</a></span></dt><dt><span class="section"><a href="#id2819201">In the Rocket</a></span></dt><dt><span class="section"><a href="#id2818044">On the Ground</a></span></dt><dt><span class="section"><a href="#id2824675">Data Analysis</a></span></dt><dt><span class="section"><a href="#id2831249">Future Plans</a></span></dt></dl></dd></dl></div><div class="chapter" title="Chapter 1. Introduction and Overview"><div class="titlepage"><div><div><h2 class="title"><a name="id2775241"></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="#id2605461">1. Introduction and Overview</a></span></dt><dt><span class="chapter"><a href="#id2605503">2. Getting Started</a></span></dt><dd><dl><dt><span class="section"><a href="#id2644514">FAQ</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id2631620">3. Specifications</a></span></dt><dt><span class="chapter"><a href="#id2659474">4. Handling Precautions</a></span></dt><dt><span class="chapter"><a href="#id2631852">5. Hardware Overview</a></span></dt><dt><span class="chapter"><a href="#id2637717">6. System Operation</a></span></dt><dd><dl><dt><span class="section"><a href="#id2640865">Firmware Modes </a></span></dt><dt><span class="section"><a href="#id2642576">GPS </a></span></dt><dt><span class="section"><a href="#id2656980">Ground Testing </a></span></dt><dt><span class="section"><a href="#id2656978">Radio Link </a></span></dt><dt><span class="section"><a href="#id2627699">Configurable Parameters</a></span></dt><dd><dl><dt><span class="section"><a href="#id2647970">Radio Channel</a></span></dt><dt><span class="section"><a href="#id2638884">Apogee Delay</a></span></dt><dt><span class="section"><a href="#id2656690">Main Deployment Altitude</a></span></dt></dl></dd><dt><span class="section"><a href="#id2635319">Calibration</a></span></dt><dd><dl><dt><span class="section"><a href="#id2659041">Radio Frequency</a></span></dt><dt><span class="section"><a href="#id2649152">Accelerometer</a></span></dt></dl></dd><dt><span class="section"><a href="#id2657390">Updating Device Firmware</a></span></dt><dd><dl><dt><span class="section"><a href="#id2630289">Updating TeleMetrum Firmware</a></span></dt><dt><span class="section"><a href="#id2639681">Updating TeleDongle Firmware</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#id2637633">7. AltosUI</a></span></dt><dd><dl><dt><span class="section"><a href="#id2654003">Packet Command Mode</a></span></dt><dt><span class="section"><a href="#id2647872">Monitor Flight</a></span></dt><dd><dl><dt><span class="section"><a href="#id2630489">Launch Pad</a></span></dt><dt><span class="section"><a href="#id2650566">Ascent</a></span></dt><dt><span class="section"><a href="#id2651780">Descent</a></span></dt><dt><span class="section"><a href="#id2637083">Landed</a></span></dt><dt><span class="section"><a href="#id2662597">Site Map</a></span></dt></dl></dd><dt><span class="section"><a href="#id2652017">Save Flight Data</a></span></dt><dt><span class="section"><a href="#id2662100">Replay Flight</a></span></dt><dt><span class="section"><a href="#id2648922">Graph Data</a></span></dt><dt><span class="section"><a href="#id2643923">Export Data</a></span></dt><dd><dl><dt><span class="section"><a href="#id2651125">Comma Separated Value Format</a></span></dt><dt><span class="section"><a href="#id2654686">Keyhole Markup Language (for Google Earth)</a></span></dt></dl></dd><dt><span class="section"><a href="#id2645946">Configure TeleMetrum</a></span></dt><dd><dl><dt><span class="section"><a href="#id2634804">Main Deploy Altitude</a></span></dt><dt><span class="section"><a href="#id2628486">Apogee Delay</a></span></dt><dt><span class="section"><a href="#id2657936">Radio Channel</a></span></dt><dt><span class="section"><a href="#id2639511">Radio Calibration</a></span></dt><dt><span class="section"><a href="#id2637390">Callsign</a></span></dt><dt><span class="section"><a href="#id2648042">Maximum Flight Log Size</a></span></dt></dl></dd><dt><span class="section"><a href="#id2639748">Configure AltosUI</a></span></dt><dd><dl><dt><span class="section"><a href="#id2651032">Voice Settings</a></span></dt><dt><span class="section"><a href="#id2649086">Log Directory</a></span></dt><dt><span class="section"><a href="#id2640668">Callsign</a></span></dt><dt><span class="section"><a href="#id2621966">Serial Debug</a></span></dt></dl></dd><dt><span class="section"><a href="#id2651293">Flash Image</a></span></dt><dt><span class="section"><a href="#id2651858">Fire Igniter</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id2646109">8. Using Altus Metrum Products</a></span></dt><dd><dl><dt><span class="section"><a href="#id2651706">Being Legal</a></span></dt><dt><span class="section"><a href="#id2649421">In the Rocket</a></span></dt><dt><span class="section"><a href="#id2648265">On the Ground</a></span></dt><dt><span class="section"><a href="#id2654896">Data Analysis</a></span></dt><dt><span class="section"><a href="#id2661470">Future Plans</a></span></dt></dl></dd></dl></div><div class="chapter" title="Chapter 1. Introduction and Overview"><div class="titlepage"><div><div><h2 class="title"><a name="id2605461"></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 @@ -58,7 +58,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="id2775282"></a>Chapter 2. Getting Started</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id2814293">FAQ</a></span></dt></dl></div><p> + </p></div><div class="chapter" title="Chapter 2. Getting Started"><div class="titlepage"><div><div><h2 class="title"><a name="id2605503"></a>Chapter 2. Getting Started</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id2644514">FAQ</a></span></dt></dl></div><p> The first thing to do after you check the inventory of parts in your "starter kit" is to charge the battery by plugging it into the corresponding socket of the TeleMetrum and then using the USB A to @@ -207,7 +207,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 class="section" title="FAQ"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2814293"></a>FAQ</h2></div></div></div><p> + </p><div class="section" title="FAQ"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2644514"></a>FAQ</h2></div></div></div><p> The altimeter (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 @@ -252,7 +252,7 @@ NAR #88757, TRA #12200<br> data after physically retrieving your TeleMetrum. Make sure to save the on-board data after each flight, as the current firmware will over-write any previous flight data during a new flight. - </p></div></div><div class="chapter" title="Chapter 3. Specifications"><div class="titlepage"><div><div><h2 class="title"><a name="id2801399"></a>Chapter 3. 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 3. Specifications"><div class="titlepage"><div><div><h2 class="title"><a name="id2631620"></a>Chapter 3. 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). @@ -276,7 +276,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 airframe coupler tube. - </p></li></ul></div></div><div class="chapter" title="Chapter 4. Handling Precautions"><div class="titlepage"><div><div><h2 class="title"><a name="id2829253"></a>Chapter 4. Handling Precautions</h2></div></div></div><p> + </p></li></ul></div></div><div class="chapter" title="Chapter 4. Handling Precautions"><div class="titlepage"><div><div><h2 class="title"><a name="id2659474"></a>Chapter 4. Handling Precautions</h2></div></div></div><p> TeleMetrum is a sophisticated electronic device. When handled gently and properly installed in an airframe, it will deliver impressive results. However, like all electronic devices, there are some precautions you @@ -308,7 +308,7 @@ NAR #88757, TRA #12200<br> </p><p> As with all other rocketry electronics, TeleMetrum must be protected from exposure to corrosive motor exhaust and ejection charge gasses. - </p></div><div class="chapter" title="Chapter 5. Hardware Overview"><div class="titlepage"><div><div><h2 class="title"><a name="id2801631"></a>Chapter 5. Hardware Overview</h2></div></div></div><p> + </p></div><div class="chapter" title="Chapter 5. Hardware Overview"><div class="titlepage"><div><div><h2 class="title"><a name="id2631852"></a>Chapter 5. 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 airframe tubing, but using it in a tube that small in diameter may require some creativity in mounting and wiring @@ -359,7 +359,7 @@ NAR #88757, TRA #12200<br> TeleMetrum with an SMA connector for the UHF antenna connection, and 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 6. System Operation"><div class="titlepage"><div><div><h2 class="title"><a name="id2807497"></a>Chapter 6. System Operation</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id2810644">Firmware Modes </a></span></dt><dt><span class="section"><a href="#id2812356">GPS </a></span></dt><dt><span class="section"><a href="#id2826760">Ground Testing </a></span></dt><dt><span class="section"><a href="#id2826757">Radio Link </a></span></dt><dt><span class="section"><a href="#id2797478">Configurable Parameters</a></span></dt><dd><dl><dt><span class="section"><a href="#id2817749">Radio Channel</a></span></dt><dt><span class="section"><a href="#id2808663">Apogee Delay</a></span></dt><dt><span class="section"><a href="#id2826470">Main Deployment Altitude</a></span></dt></dl></dd><dt><span class="section"><a href="#id2805098">Calibration</a></span></dt><dd><dl><dt><span class="section"><a href="#id2828821">Radio Frequency</a></span></dt><dt><span class="section"><a href="#id2818931">Accelerometer</a></span></dt></dl></dd><dt><span class="section"><a href="#id2827169">Updating Device Firmware</a></span></dt><dd><dl><dt><span class="section"><a href="#id2800068">Updating TeleMetrum Firmware</a></span></dt><dt><span class="section"><a href="#id2809460">Updating TeleDongle Firmware</a></span></dt></dl></dd></dl></div><div class="section" title="Firmware Modes"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2810644"></a>Firmware Modes </h2></div></div></div><p> + </p></div><div class="chapter" title="Chapter 6. System Operation"><div class="titlepage"><div><div><h2 class="title"><a name="id2637717"></a>Chapter 6. System Operation</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id2640865">Firmware Modes </a></span></dt><dt><span class="section"><a href="#id2642576">GPS </a></span></dt><dt><span class="section"><a href="#id2656980">Ground Testing </a></span></dt><dt><span class="section"><a href="#id2656978">Radio Link </a></span></dt><dt><span class="section"><a href="#id2627699">Configurable Parameters</a></span></dt><dd><dl><dt><span class="section"><a href="#id2647970">Radio Channel</a></span></dt><dt><span class="section"><a href="#id2638884">Apogee Delay</a></span></dt><dt><span class="section"><a href="#id2656690">Main Deployment Altitude</a></span></dt></dl></dd><dt><span class="section"><a href="#id2635319">Calibration</a></span></dt><dd><dl><dt><span class="section"><a href="#id2659041">Radio Frequency</a></span></dt><dt><span class="section"><a href="#id2649152">Accelerometer</a></span></dt></dl></dd><dt><span class="section"><a href="#id2657390">Updating Device Firmware</a></span></dt><dd><dl><dt><span class="section"><a href="#id2630289">Updating TeleMetrum Firmware</a></span></dt><dt><span class="section"><a href="#id2639681">Updating TeleDongle Firmware</a></span></dt></dl></dd></dl></div><div class="section" title="Firmware Modes"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2640865"></a>Firmware Modes </h2></div></div></div><p> The AltOS firmware build for TeleMetrum has two fundamental modes, "idle" and "flight". Which of these modes the firmware operates in is determined by the orientation of the rocket (well, actually the @@ -407,7 +407,7 @@ NAR #88757, TRA #12200<br> 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="GPS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2812356"></a>GPS </h2></div></div></div><p> + </p></div><div class="section" title="GPS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2642576"></a>GPS </h2></div></div></div><p> TeleMetrum includes a complete GPS receiver. See a later section for a brief explanation of how GPS works that will help you understand the information in the telemetry stream. The bottom line is that @@ -426,7 +426,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="Ground Testing"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2826760"></a>Ground Testing </h2></div></div></div><p> + </p></div><div class="section" title="Ground Testing"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2656980"></a>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 RF link central to the Altus Metrum system, @@ -449,7 +449,7 @@ NAR #88757, TRA #12200<br> the board from firing a charge. The command to fire the apogee drogue charge is 'i DoIt drogue' and the command to fire the main charge is 'i DoIt main'. - </p></div><div class="section" title="Radio Link"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2826757"></a>Radio Link </h2></div></div></div><p> + </p></div><div class="section" title="Radio Link"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2656978"></a>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 @@ -480,13 +480,13 @@ NAR #88757, TRA #12200<br> the ground. We hope to fly boards to higher altitudes soon, and would of course appreciate customer feedback on performance in higher altitude flights! - </p></div><div class="section" title="Configurable Parameters"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2797478"></a>Configurable Parameters</h2></div></div></div><p> + </p></div><div class="section" title="Configurable Parameters"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2627699"></a>Configurable Parameters</h2></div></div></div><p> Configuring a TeleMetrum board for flight is very simple. Because we have both acceleration and pressure sensors, there is no need to set a "mach delay", for example. The few configurable parameters can all be set using a simple terminal program over the USB port or RF link via TeleDongle. - </p><div class="section" title="Radio Channel"><div class="titlepage"><div><div><h3 class="title"><a name="id2817749"></a>Radio Channel</h3></div></div></div><p> + </p><div class="section" title="Radio Channel"><div class="titlepage"><div><div><h3 class="title"><a name="id2647970"></a>Radio Channel</h3></div></div></div><p> Our firmware supports 10 channels. The default channel 0 corresponds to a center frequency of 434.550 Mhz, and channels are spaced every 100 khz. Thus, channel 1 is 434.650 Mhz, and channel 9 is 435.550 Mhz. @@ -500,7 +500,7 @@ NAR #88757, TRA #12200<br> As with all 'c' sub-commands, follow this with a 'c w' to write the change to the parameter block in the on-board DataFlash chip on your TeleMetrum board if you want the change to stay in place across reboots. - </p></div><div class="section" title="Apogee Delay"><div class="titlepage"><div><div><h3 class="title"><a name="id2808663"></a>Apogee Delay</h3></div></div></div><p> + </p></div><div class="section" title="Apogee Delay"><div class="titlepage"><div><div><h3 class="title"><a name="id2638884"></a>Apogee Delay</h3></div></div></div><p> Apogee delay is the number of seconds after TeleMetrum 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 @@ -520,7 +520,7 @@ NAR #88757, TRA #12200<br> seconds later to avoid any chance of both charges firing simultaneously. We've flown several airframes this way quite happily, including Keith's successful L3 cert. - </p></div><div class="section" title="Main Deployment Altitude"><div class="titlepage"><div><div><h3 class="title"><a name="id2826470"></a>Main Deployment Altitude</h3></div></div></div><p> + </p></div><div class="section" title="Main Deployment Altitude"><div class="titlepage"><div><div><h3 class="title"><a name="id2656690"></a>Main Deployment Altitude</h3></div></div></div><p> By default, TeleMetrum 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 airframes, but feel free to change this @@ -533,10 +533,10 @@ NAR #88757, TRA #12200<br> To set the main deployment altitude, use the 'c m' command. As with all 'c' sub-commands, follow this with a 'c w' to write the change to the parameter block in the on-board DataFlash chip. - </p></div></div><div class="section" title="Calibration"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2805098"></a>Calibration</h2></div></div></div><p> + </p></div></div><div class="section" title="Calibration"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2635319"></a>Calibration</h2></div></div></div><p> There are only two calibrations required for a TeleMetrum board, and only one for TeleDongle. - </p><div class="section" title="Radio Frequency"><div class="titlepage"><div><div><h3 class="title"><a name="id2828821"></a>Radio Frequency</h3></div></div></div><p> + </p><div class="section" title="Radio Frequency"><div class="titlepage"><div><div><h3 class="title"><a name="id2659041"></a>Radio Frequency</h3></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 GFSK modulation @@ -560,7 +560,7 @@ NAR #88757, TRA #12200<br> within a few tens of Hertz of the intended frequency. As with all 'c' sub-commands, follow this with a 'c w' to write the change to the parameter block in the on-board DataFlash chip. - </p></div><div class="section" title="Accelerometer"><div class="titlepage"><div><div><h3 class="title"><a name="id2818931"></a>Accelerometer</h3></div></div></div><p> + </p></div><div class="section" title="Accelerometer"><div class="titlepage"><div><div><h3 class="title"><a name="id2649152"></a>Accelerometer</h3></div></div></div><p> The accelerometer we use has its own 5 volt power supply and the output must be passed through a resistive voltage divider to match the input of our 3.3 volt ADC. This means that unlike the barometric @@ -599,7 +599,7 @@ NAR #88757, TRA #12200<br> and use a small screwdriver or similar to short the two pins closest 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). - </p></div></div><div class="section" title="Updating Device Firmware"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2827169"></a>Updating Device Firmware</h2></div></div></div><p> + </p></div></div><div class="section" title="Updating Device Firmware"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2657390"></a>Updating Device Firmware</h2></div></div></div><p> The big conceptual thing to realize is that you have to use a TeleDongle as a programmer to update a TeleMetrum, and vice versa. Due to limited memory resources in the cc1111, we don't support @@ -614,7 +614,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 TeleMetrum first, before updating TeleDongle. - </p><div class="section" title="Updating TeleMetrum Firmware"><div class="titlepage"><div><div><h3 class="title"><a name="id2800068"></a>Updating TeleMetrum Firmware</h3></div></div></div><div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> + </p><div class="section" title="Updating TeleMetrum Firmware"><div class="titlepage"><div><div><h3 class="title"><a name="id2630289"></a>Updating TeleMetrum Firmware</h3></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. @@ -657,7 +657,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="Updating TeleDongle Firmware"><div class="titlepage"><div><div><h3 class="title"><a name="id2809460"></a>Updating TeleDongle Firmware</h3></div></div></div><p> + </li></ol></div></div><div class="section" title="Updating TeleDongle Firmware"><div class="titlepage"><div><div><h3 class="title"><a name="id2639681"></a>Updating TeleDongle Firmware</h3></div></div></div><p> Updating TeleDongle's firmware is just like updating TeleMetrum firmware, but you switch which board is the programmer and which is the programming target. @@ -718,7 +718,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><div class="chapter" title="Chapter 7. AltosUI"><div class="titlepage"><div><div><h2 class="title"><a name="id2807412"></a>Chapter 7. AltosUI</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id2823783">Packet Command Mode</a></span></dt><dt><span class="section"><a href="#id2817651">Monitor Flight</a></span></dt><dd><dl><dt><span class="section"><a href="#id2800268">Launch Pad</a></span></dt><dt><span class="section"><a href="#id2820346">Ascent</a></span></dt><dt><span class="section"><a href="#id2821559">Descent</a></span></dt><dt><span class="section"><a href="#id2806862">Landed</a></span></dt><dt><span class="section"><a href="#id2832376">Site Map</a></span></dt></dl></dd><dt><span class="section"><a href="#id2821796">Save Flight Data</a></span></dt><dt><span class="section"><a href="#id2831879">Replay Flight</a></span></dt><dt><span class="section"><a href="#id2818702">Graph Data</a></span></dt><dt><span class="section"><a href="#id2813702">Export Data</a></span></dt><dd><dl><dt><span class="section"><a href="#id2820904">Comma Separated Value Format</a></span></dt><dt><span class="section"><a href="#id2824465">Keyhole Markup Language (for Google Earth)</a></span></dt></dl></dd><dt><span class="section"><a href="#id2815725">Configure TeleMetrum</a></span></dt><dd><dl><dt><span class="section"><a href="#id2804583">Main Deploy Altitude</a></span></dt><dt><span class="section"><a href="#id2798265">Apogee Delay</a></span></dt><dt><span class="section"><a href="#id2827715">Radio Channel</a></span></dt><dt><span class="section"><a href="#id2809290">Radio Calibration</a></span></dt><dt><span class="section"><a href="#id2807169">Callsign</a></span></dt><dt><span class="section"><a href="#id2817821">Maximum Flight Log Size</a></span></dt></dl></dd><dt><span class="section"><a href="#id2809528">Configure AltosUI</a></span></dt><dd><dl><dt><span class="section"><a href="#id2820811">Voice Settings</a></span></dt><dt><span class="section"><a href="#id2818865">Log Directory</a></span></dt><dt><span class="section"><a href="#id2810448">Callsign</a></span></dt><dt><span class="section"><a href="#id2791745">Serial Debug</a></span></dt></dl></dd><dt><span class="section"><a href="#id2821072">Flash Image</a></span></dt><dt><span class="section"><a href="#id2821637">Fire Igniter</a></span></dt></dl></div><p> + </p></div></div></div><div class="chapter" title="Chapter 7. AltosUI"><div class="titlepage"><div><div><h2 class="title"><a name="id2637633"></a>Chapter 7. AltosUI</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id2654003">Packet Command Mode</a></span></dt><dt><span class="section"><a href="#id2647872">Monitor Flight</a></span></dt><dd><dl><dt><span class="section"><a href="#id2630489">Launch Pad</a></span></dt><dt><span class="section"><a href="#id2650566">Ascent</a></span></dt><dt><span class="section"><a href="#id2651780">Descent</a></span></dt><dt><span class="section"><a href="#id2637083">Landed</a></span></dt><dt><span class="section"><a href="#id2662597">Site Map</a></span></dt></dl></dd><dt><span class="section"><a href="#id2652017">Save Flight Data</a></span></dt><dt><span class="section"><a href="#id2662100">Replay Flight</a></span></dt><dt><span class="section"><a href="#id2648922">Graph Data</a></span></dt><dt><span class="section"><a href="#id2643923">Export Data</a></span></dt><dd><dl><dt><span class="section"><a href="#id2651125">Comma Separated Value Format</a></span></dt><dt><span class="section"><a href="#id2654686">Keyhole Markup Language (for Google Earth)</a></span></dt></dl></dd><dt><span class="section"><a href="#id2645946">Configure TeleMetrum</a></span></dt><dd><dl><dt><span class="section"><a href="#id2634804">Main Deploy Altitude</a></span></dt><dt><span class="section"><a href="#id2628486">Apogee Delay</a></span></dt><dt><span class="section"><a href="#id2657936">Radio Channel</a></span></dt><dt><span class="section"><a href="#id2639511">Radio Calibration</a></span></dt><dt><span class="section"><a href="#id2637390">Callsign</a></span></dt><dt><span class="section"><a href="#id2648042">Maximum Flight Log Size</a></span></dt></dl></dd><dt><span class="section"><a href="#id2639748">Configure AltosUI</a></span></dt><dd><dl><dt><span class="section"><a href="#id2651032">Voice Settings</a></span></dt><dt><span class="section"><a href="#id2649086">Log Directory</a></span></dt><dt><span class="section"><a href="#id2640668">Callsign</a></span></dt><dt><span class="section"><a href="#id2621966">Serial Debug</a></span></dt></dl></dd><dt><span class="section"><a href="#id2651293">Flash Image</a></span></dt><dt><span class="section"><a href="#id2651858">Fire Igniter</a></span></dt></dl></div><p> The AltosUI program provides a graphical user interface for interacting with the Altus Metrum product family, including TeleMetrum and TeleDongle. AltosUI can monitor telemetry data, @@ -727,7 +727,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="Packet Command Mode"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2823783"></a>Packet Command Mode</h2></div><div><h3 class="subtitle">Controlling TeleMetrum Over The Radio Link</h3></div></div></div><p> + </p><div class="section" title="Packet Command Mode"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2654003"></a>Packet Command Mode</h2></div><div><h3 class="subtitle">Controlling TeleMetrum Over The Radio Link</h3></div></div></div><p> One of the unique features of the Altus Metrum environment is the ability to create a two way command link between TeleDongle and TeleMetrum using the digital radio transceivers built into @@ -786,7 +786,7 @@ NAR #88757, TRA #12200<br> TeleMetrum transmit a packet while the green LED will light up on TeleDongle while it is waiting to receive a packet from TeleMetrum. - </p></div><div class="section" title="Monitor Flight"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2817651"></a>Monitor Flight</h2></div><div><h3 class="subtitle">Receive, Record and Display Telemetry Data</h3></div></div></div><p> + </p></div><div class="section" title="Monitor Flight"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2647872"></a>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 @@ -827,7 +827,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 contains all of the telemetry data in one place. - </p><div class="section" title="Launch Pad"><div class="titlepage"><div><div><h3 class="title"><a name="id2800268"></a>Launch Pad</h3></div></div></div><p> + </p><div class="section" title="Launch Pad"><div class="titlepage"><div><div><h3 class="title"><a name="id2630489"></a>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 @@ -864,7 +864,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="Ascent"><div class="titlepage"><div><div><h3 class="title"><a name="id2820346"></a>Ascent</h3></div></div></div><p> + </p></div><div class="section" title="Ascent"><div class="titlepage"><div><div><h3 class="title"><a name="id2650566"></a>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. @@ -883,7 +883,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="Descent"><div class="titlepage"><div><div><h3 class="title"><a name="id2821559"></a>Descent</h3></div></div></div><p> + </p></div><div class="section" title="Descent"><div class="titlepage"><div><div><h3 class="title"><a name="id2651780"></a>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, @@ -904,7 +904,7 @@ NAR #88757, TRA #12200<br> Finally, the igniter voltages are reported in this tab as well, both to monitor the main charge as well as to see what the status of the apogee charge is. - </p></div><div class="section" title="Landed"><div class="titlepage"><div><div><h3 class="title"><a name="id2806862"></a>Landed</h3></div></div></div><p> + </p></div><div class="section" title="Landed"><div class="titlepage"><div><div><h3 class="title"><a name="id2637083"></a>Landed</h3></div></div></div><p> Once the rocket is on the ground, attention switches to recovery. While the radio signal is generally lost once the rocket is on the ground, the last reported GPS position is @@ -919,7 +919,7 @@ NAR #88757, TRA #12200<br> </p><p> Finally, the maximum height, speed and acceleration reported during the flight are displayed for your admiring observers. - </p></div><div class="section" title="Site Map"><div class="titlepage"><div><div><h3 class="title"><a name="id2832376"></a>Site Map</h3></div></div></div><p> + </p></div><div class="section" title="Site Map"><div class="titlepage"><div><div><h3 class="title"><a name="id2662597"></a>Site Map</h3></div></div></div><p> When the rocket gets 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 @@ -935,7 +935,7 @@ NAR #88757, TRA #12200<br> and are cached for reuse. If map images cannot be downloaded, the rocket's path will be traced on a dark grey background instead. - </p></div></div><div class="section" title="Save Flight Data"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2821796"></a>Save Flight Data</h2></div></div></div><p> + </p></div></div><div class="section" title="Save Flight Data"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2652017"></a>Save Flight Data</h2></div></div></div><p> TeleMetrum records flight data to its internal flash memory. This data is recorded at a much higher rate than the telemetry system can handle, and is not subject to radio drop-outs. As @@ -964,7 +964,7 @@ NAR #88757, TRA #12200<br> The filename for each flight log is computed automatically from the recorded flight date, TeleMetrum serial number and flight number information. - </p></div><div class="section" title="Replay Flight"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2831879"></a>Replay Flight</h2></div></div></div><p> + </p></div><div class="section" title="Replay Flight"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2662100"></a>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 TeleMetrum @@ -973,7 +973,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="Graph Data"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2818702"></a>Graph Data</h2></div></div></div><p> + </p></div><div class="section" title="Graph Data"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2648922"></a>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 the TeleMetrum @@ -995,7 +995,7 @@ NAR #88757, TRA #12200<br> and will also often have significant amounts of data received while the rocket was waiting on the pad. Use saved flight data for graphing where possible. - </p></div><div class="section" title="Export Data"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2813702"></a>Export Data</h2></div></div></div><p> + </p></div><div class="section" title="Export Data"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2643923"></a>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 data file (either .eeprom or .telem will do, remember that @@ -1003,7 +1003,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="Comma Separated Value Format"><div class="titlepage"><div><div><h3 class="title"><a name="id2820904"></a>Comma Separated Value Format</h3></div></div></div><p> + </p><div class="section" title="Comma Separated Value Format"><div class="titlepage"><div><div><h3 class="title"><a name="id2651125"></a>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 @@ -1017,12 +1017,12 @@ 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="Keyhole Markup Language (for Google Earth)"><div class="titlepage"><div><div><h3 class="title"><a name="id2824465"></a>Keyhole Markup Language (for Google Earth)</h3></div></div></div><p> + </p></div><div class="section" title="Keyhole Markup Language (for Google Earth)"><div class="titlepage"><div><div><h3 class="title"><a name="id2654686"></a>Keyhole Markup Language (for Google Earth)</h3></div></div></div><p> This is the format used by Googleearth to provide an overlay within that application. With this, you can use Googleearth to see the whole flight path in 3D. - </p></div></div><div class="section" title="Configure TeleMetrum"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2815725"></a>Configure TeleMetrum</h2></div></div></div><p> + </p></div></div><div class="section" title="Configure TeleMetrum"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2645946"></a>Configure TeleMetrum</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 Packet Comamnd Mode to configure remote @@ -1051,14 +1051,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="Main Deploy Altitude"><div class="titlepage"><div><div><h3 class="title"><a name="id2804583"></a>Main Deploy Altitude</h3></div></div></div><p> + </p><div class="section" title="Main Deploy Altitude"><div class="titlepage"><div><div><h3 class="title"><a name="id2634804"></a>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="Apogee Delay"><div class="titlepage"><div><div><h3 class="title"><a name="id2798265"></a>Apogee Delay</h3></div></div></div><p> + </p></div><div class="section" title="Apogee Delay"><div class="titlepage"><div><div><h3 class="title"><a name="id2628486"></a>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 overpressurize the apogee deployment @@ -1066,22 +1066,22 @@ 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="Radio Channel"><div class="titlepage"><div><div><h3 class="title"><a name="id2827715"></a>Radio Channel</h3></div></div></div><p> + </p></div><div class="section" title="Radio Channel"><div class="titlepage"><div><div><h3 class="title"><a name="id2657936"></a>Radio Channel</h3></div></div></div><p> This configures which of the 10 radio channels 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 channel before you will be able to use packet command mode again. - </p></div><div class="section" title="Radio Calibration"><div class="titlepage"><div><div><h3 class="title"><a name="id2809290"></a>Radio Calibration</h3></div></div></div><p> + </p></div><div class="section" title="Radio Calibration"><div class="titlepage"><div><div><h3 class="title"><a name="id2639511"></a>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 for each channel. You can adjust that calibration by changing this value. To change the TeleDongle's calibration, you must reprogram the unit completely. - </p></div><div class="section" title="Callsign"><div class="titlepage"><div><div><h3 class="title"><a name="id2807169"></a>Callsign</h3></div></div></div><p> + </p></div><div class="section" title="Callsign"><div class="titlepage"><div><div><h3 class="title"><a name="id2637390"></a>Callsign</h3></div></div></div><p> This sets the callsign included in each telemetry packet. Set this as needed to conform to your local radio regulations. - </p></div><div class="section" title="Maximum Flight Log Size"><div class="titlepage"><div><div><h3 class="title"><a name="id2817821"></a>Maximum Flight Log Size</h3></div></div></div><p> + </p></div><div class="section" title="Maximum Flight Log Size"><div class="titlepage"><div><div><h3 class="title"><a name="id2648042"></a>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, @@ -1103,9 +1103,9 @@ NAR #88757, TRA #12200<br> The configuration block takes the last available block of memory, on v1.0 boards that's just 256 bytes. However, the flash part on the v1.1 boards uses 64kB for each block. - </p></div></div><div class="section" title="Configure AltosUI"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2809528"></a>Configure AltosUI</h2></div></div></div><p> + </p></div></div><div class="section" title="Configure AltosUI"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2639748"></a>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="Voice Settings"><div class="titlepage"><div><div><h3 class="title"><a name="id2820811"></a>Voice Settings</h3></div></div></div><p> + </p><div class="section" title="Voice Settings"><div class="titlepage"><div><div><h3 class="title"><a name="id2651032"></a>Voice Settings</h3></div></div></div><p> AltosUI provides voice annoucements 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 @@ -1114,7 +1114,7 @@ NAR #88757, TRA #12200<br> Test Voice—Plays a short message allowing you to verify that the audio systme is working and the volume settings are reasonable - </p></li></ul></div></div><div class="section" title="Log Directory"><div class="titlepage"><div><div><h3 class="title"><a name="id2818865"></a>Log Directory</h3></div></div></div><p> + </p></li></ul></div></div><div class="section" title="Log Directory"><div class="titlepage"><div><div><h3 class="title"><a name="id2649086"></a>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. @@ -1122,20 +1122,20 @@ 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="Callsign"><div class="titlepage"><div><div><h3 class="title"><a name="id2810448"></a>Callsign</h3></div></div></div><p> + </p></div><div class="section" title="Callsign"><div class="titlepage"><div><div><h3 class="title"><a name="id2640668"></a>Callsign</h3></div></div></div><p> This value is used in command packet mode and is transmitted in each packet sent from TeleDongle and received from TeleMetrum. It is not used in telemetry mode as that transmits packets only from TeleMetrum to TeleDongle. Configure this with the AltosUI operators callsign as needed to comply with your local radio regulations. - </p></div><div class="section" title="Serial Debug"><div class="titlepage"><div><div><h3 class="title"><a name="id2791745"></a>Serial Debug</h3></div></div></div><p> + </p></div><div class="section" title="Serial Debug"><div class="titlepage"><div><div><h3 class="title"><a name="id2621966"></a>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><div class="section" title="Flash Image"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2821072"></a>Flash Image</h2></div></div></div><p> + </p></div></div><div class="section" title="Flash Image"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2651293"></a>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 connecting the programming cable in the main TeleMetrum @@ -1165,7 +1165,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="Fire Igniter"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2821637"></a>Fire Igniter</h2></div></div></div><p> + </p></div><div class="section" title="Fire Igniter"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2651858"></a>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 @@ -1185,11 +1185,11 @@ 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><div class="chapter" title="Chapter 8. Using Altus Metrum Products"><div class="titlepage"><div><div><h2 class="title"><a name="id2815889"></a>Chapter 8. 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="#id2821485">Being Legal</a></span></dt><dt><span class="section"><a href="#id2819201">In the Rocket</a></span></dt><dt><span class="section"><a href="#id2818044">On the Ground</a></span></dt><dt><span class="section"><a href="#id2824675">Data Analysis</a></span></dt><dt><span class="section"><a href="#id2831249">Future Plans</a></span></dt></dl></div><div class="section" title="Being Legal"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2821485"></a>Being Legal</h2></div></div></div><p> + </p></div></div><div class="chapter" title="Chapter 8. Using Altus Metrum Products"><div class="titlepage"><div><div><h2 class="title"><a name="id2646109"></a>Chapter 8. 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="#id2651706">Being Legal</a></span></dt><dt><span class="section"><a href="#id2649421">In the Rocket</a></span></dt><dt><span class="section"><a href="#id2648265">On the Ground</a></span></dt><dt><span class="section"><a href="#id2654896">Data Analysis</a></span></dt><dt><span class="section"><a href="#id2661470">Future Plans</a></span></dt></dl></div><div class="section" title="Being Legal"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2651706"></a>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="In the Rocket"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2819201"></a>In the Rocket</h2></div></div></div><p> + </p></div><div class="section" title="In the Rocket"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2649421"></a>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> board and a LiPo rechargeable battery. An 860mAh battery weighs less than a 9V alkaline battery, and will run a <a class="ulink" href="http://www.altusmetrum.org/TeleMetrum/" target="_top">TeleMetrum</a> for hours. @@ -1199,7 +1199,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="On the Ground"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2818044"></a>On the Ground</h2></div></div></div><p> + </p></div><div class="section" title="On the Ground"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2648265"></a>On the Ground</h2></div></div></div><p> To receive the data stream from the rocket, you need an antenna and short feedline 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 @@ -1250,7 +1250,7 @@ NAR #88757, TRA #12200<br> </a> The 440-3 and 440-5 are both good choices for finding a TeleMetrum-equipped rocket when used with a suitable 70cm HT. - </p></div><div class="section" title="Data Analysis"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2824675"></a>Data Analysis</h2></div></div></div><p> + </p></div><div class="section" title="Data Analysis"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2654896"></a>Data Analysis</h2></div></div></div><p> Our software makes it easy to log the data from each flight, both the telemetry received over the RF link during the flight itself, and the more complete data log recorded in the DataFlash memory on the TeleMetrum @@ -1265,7 +1265,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="Future Plans"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2831249"></a>Future Plans</h2></div></div></div><p> + </p></div><div class="section" title="Future Plans"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2661470"></a>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. A reference design for a companion board will be documented diff --git a/AltOS/doc/altusmetrum.pdf b/AltOS/doc/altusmetrum.pdf Binary files differindex 6ac4dd7..e90f4a1 100644 --- a/AltOS/doc/altusmetrum.pdf +++ b/AltOS/doc/altusmetrum.pdf |