-<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="id22
87738"></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="id2569423"></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="id22
45959"></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="id2527643"></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="#id25
55194">1. Overview</a></span></dt><dt><span class="chapter"><a href="#id2579104">2. Programming the 8051 with SDCC</a></span></dt><dd><dl><dt><span class="section"><a href="#id2572549">8051 memory spaces</a></span></dt><dd><dl><dt><span class="section"><a href="#id2587147">__data</a></span></dt><dt><span class="section"><a href="#id2574082">__idata</a></span></dt><dt><span class="section"><a href="#id2585502">__xdata</a></span></dt><dt><span class="section"><a href="#id2568787">__pdata</a></span></dt><dt><span class="section"><a href="#id2564890">__code</a></span></dt><dt><span class="section"><a href="#id2570929">__bit</a></span></dt><dt><span class="section"><a href="#id2558641">__sfr, __sfr16, __sfr32, __sbit</a></span></dt></dl></dd><dt><span class="section"><a href="#id2565185">Function calls on the 8051</a></span></dt><dd><dl><dt><span class="section"><a href="#id2557511">__reentrant functions</a></span></dt><dt><span class="section"><a href="#id2558653">Non __reentrant functions</a></span></dt><dt><span class="section"><a href="#id2587007">__interrupt functions</a></span></dt><dt><span class="section"><a href="#id2570923">__critical functions and statements</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#id2578729">3. Task functions</a></span></dt><dd><dl><dt><span class="section"><a href="#id2566460">ao_add_task</a></span></dt><dt><span class="section"><a href="#id2549662">ao_exit</a></span></dt><dt><span class="section"><a href="#id2588863">ao_sleep</a></span></dt><dt><span class="section"><a href="#id2555754">ao_wakeup</a></span></dt><dt><span class="section"><a href="#id2578893">ao_alarm</a></span></dt><dt><span class="section"><a href="#id2565595">ao_wake_task</a></span></dt><dt><span class="section"><a href="#id2561847">ao_start_scheduler</a></span></dt><dt><span class="section"><a href="#id2571836">ao_clock_init</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id2574991">4. Timer Functions</a></span></dt><dd><dl><dt><span class="section"><a href="#id2568218">ao_time</a></span></dt><dt><span class="section"><a href="#id2581923">ao_delay</a></span></dt><dt><span class="section"><a href="#id2581648">ao_timer_set_adc_interval</a></span></dt><dt><span class="section"><a href="#id2586062">ao_timer_init</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id2589986">5. AltOS Mutexes</a></span></dt><dd><dl><dt><span class="section"><a href="#id2570322">ao_mutex_get</a></span></dt><dt><span class="section"><a href="#id2555486">ao_mutex_put</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id2582719">6. CC1111 DMA engine</a></span></dt><dd><dl><dt><span class="section"><a href="#id2579029">ao_dma_alloc</a></span></dt><dt><span class="section"><a href="#id2568950">ao_dma_set_transfer</a></span></dt><dt><span class="section"><a href="#id2576818">ao_dma_start</a></span></dt><dt><span class="section"><a href="#id2586065">ao_dma_trigger</a></span></dt><dt><span class="section"><a href="#id2570488">ao_dma_abort</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id2571669">7. SDCC Stdio interface</a></span></dt><dd><dl><dt><span class="section"><a href="#id2583460">putchar</a></span></dt><dt><span class="section"><a href="#id2569848">getchar</a></span></dt><dt><span class="section"><a href="#id2584689">flush</a></span></dt><dt><span class="section"><a href="#id2578522">ao_add_stdio</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id2577396">8. Command line interface</a></span></dt><dd><dl><dt><span class="section"><a href="#id2573332">ao_cmd_register</a></span></dt><dt><span class="section"><a href="#id2573326">ao_cmd_lex</a></span></dt><dt><span class="section"><a href="#id2569393">ao_cmd_put16</a></span></dt><dt><span class="section"><a href="#id2565433">ao_cmd_put8</a></span></dt><dt><span class="section"><a href="#id2587125">ao_cmd_white</a></span></dt><dt><span class="section"><a href="#id2583867">ao_cmd_hex</a></span></dt><dt><span class="section"><a href="#id2589264">ao_cmd_decimal</a></span></dt><dt><span class="section"><a href="#id2578518">ao_match_word</a></span></dt><dt><span class="section"><a href="#id2589111">ao_cmd_init</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id2573826">9. CC1111 USB target device</a></span></dt><dd><dl><dt><span class="section"><a href="#id2567131">ao_usb_flush</a></span></dt><dt><span class="section"><a href="#id2582959">ao_usb_putchar</a></span></dt><dt><span class="section"><a href="#id2589206">ao_usb_pollchar</a></span></dt><dt><span class="section"><a href="#id2550786">ao_usb_getchar</a></span></dt><dt><span class="section"><a href="#id2569256">ao_usb_disable</a></span></dt><dt><span class="section"><a href="#id2566705">ao_usb_enable</a></span></dt><dt><span class="section"><a href="#id2566594">ao_usb_init</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id2575764">10. CC1111 Serial peripheral</a></span></dt><dd><dl><dt><span class="section"><a href="#id2576363">ao_serial_getchar</a></span></dt><dt><span class="section"><a href="#id2552673">ao_serial_putchar</a></span></dt><dt><span class="section"><a href="#id2553935">ao_serial_drain</a></span></dt><dt><span class="section"><a href="#id2564334">ao_serial_set_speed</a></span></dt><dt><span class="section"><a href="#id2574349">ao_serial_init</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id2580359">11. CC1111 Radio peripheral</a></span></dt><dd><dl><dt><span class="section"><a href="#id2552360">ao_radio_set_telemetry</a></span></dt><dt><span class="section"><a href="#id2581777">ao_radio_set_packet</a></span></dt><dt><span class="section"><a href="#id2585369">ao_radio_set_rdf</a></span></dt><dt><span class="section"><a href="#id2573544">ao_radio_idle</a></span></dt><dt><span class="section"><a href="#id2551519">ao_radio_get</a></span></dt><dt><span class="section"><a href="#id2586346">ao_radio_put</a></span></dt><dt><span class="section"><a href="#id2590004">ao_radio_abort</a></span></dt><dt><span class="section"><a href="#id2565052">ao_radio_send</a></span></dt><dt><span class="section"><a href="#id2569083">ao_radio_recv</a></span></dt><dt><span class="section"><a href="#id2583861">ao_radio_rdf</a></span></dt><dt><span class="section"><a href="#id2590408">ao_packet_putchar</a></span></dt><dt><span class="section"><a href="#id2587711">ao_packet_pollchar</a></span></dt><dt><span class="section"><a href="#id2590396">ao_packet_slave_start</a></span></dt><dt><span class="section"><a href="#id2563331">ao_packet_slave_stop</a></span></dt><dt><span class="section"><a href="#id2562720">ao_packet_slave_init</a></span></dt><dt><span class="section"><a href="#id2574661">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="id2555194"></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="#id25
13415">1. Overview</a></span></dt><dt><span class="chapter"><a href="#id2537325">2. Programming the 8051 with SDCC</a></span></dt><dd><dl><dt><span class="section"><a href="#id2530770">8051 memory spaces</a></span></dt><dd><dl><dt><span class="section"><a href="#id2545367">__data</a></span></dt><dt><span class="section"><a href="#id2532303">__idata</a></span></dt><dt><span class="section"><a href="#id2543723">__xdata</a></span></dt><dt><span class="section"><a href="#id2527008">__pdata</a></span></dt><dt><span class="section"><a href="#id2523111">__code</a></span></dt><dt><span class="section"><a href="#id2529150">__bit</a></span></dt><dt><span class="section"><a href="#id2516861">__sfr, __sfr16, __sfr32, __sbit</a></span></dt></dl></dd><dt><span class="section"><a href="#id2523406">Function calls on the 8051</a></span></dt><dd><dl><dt><span class="section"><a href="#id2515732">__reentrant functions</a></span></dt><dt><span class="section"><a href="#id2516874">Non __reentrant functions</a></span></dt><dt><span class="section"><a href="#id2545227">__interrupt functions</a></span></dt><dt><span class="section"><a href="#id2529144">__critical functions and statements</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#id2536949">3. Task functions</a></span></dt><dd><dl><dt><span class="section"><a href="#id2524681">ao_add_task</a></span></dt><dt><span class="section"><a href="#id2507882">ao_exit</a></span></dt><dt><span class="section"><a href="#id2547084">ao_sleep</a></span></dt><dt><span class="section"><a href="#id2513975">ao_wakeup</a></span></dt><dt><span class="section"><a href="#id2537114">ao_alarm</a></span></dt><dt><span class="section"><a href="#id2523816">ao_wake_task</a></span></dt><dt><span class="section"><a href="#id2520068">ao_start_scheduler</a></span></dt><dt><span class="section"><a href="#id2530057">ao_clock_init</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id2533212">4. Timer Functions</a></span></dt><dd><dl><dt><span class="section"><a href="#id2526439">ao_time</a></span></dt><dt><span class="section"><a href="#id2540144">ao_delay</a></span></dt><dt><span class="section"><a href="#id2539869">ao_timer_set_adc_interval</a></span></dt><dt><span class="section"><a href="#id2544283">ao_timer_init</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id2548207">5. AltOS Mutexes</a></span></dt><dd><dl><dt><span class="section"><a href="#id2528543">ao_mutex_get</a></span></dt><dt><span class="section"><a href="#id2513707">ao_mutex_put</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id2540940">6. CC1111 DMA engine</a></span></dt><dd><dl><dt><span class="section"><a href="#id2537249">ao_dma_alloc</a></span></dt><dt><span class="section"><a href="#id2527171">ao_dma_set_transfer</a></span></dt><dt><span class="section"><a href="#id2535038">ao_dma_start</a></span></dt><dt><span class="section"><a href="#id2544286">ao_dma_trigger</a></span></dt><dt><span class="section"><a href="#id2528708">ao_dma_abort</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id2529890">7. SDCC Stdio interface</a></span></dt><dd><dl><dt><span class="section"><a href="#id2541680">putchar</a></span></dt><dt><span class="section"><a href="#id2528069">getchar</a></span></dt><dt><span class="section"><a href="#id2542910">flush</a></span></dt><dt><span class="section"><a href="#id2536743">ao_add_stdio</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id2535617">8. Command line interface</a></span></dt><dd><dl><dt><span class="section"><a href="#id2531553">ao_cmd_register</a></span></dt><dt><span class="section"><a href="#id2531547">ao_cmd_lex</a></span></dt><dt><span class="section"><a href="#id2527614">ao_cmd_put16</a></span></dt><dt><span class="section"><a href="#id2523654">ao_cmd_put8</a></span></dt><dt><span class="section"><a href="#id2545346">ao_cmd_white</a></span></dt><dt><span class="section"><a href="#id2542088">ao_cmd_hex</a></span></dt><dt><span class="section"><a href="#id2547485">ao_cmd_decimal</a></span></dt><dt><span class="section"><a href="#id2536739">ao_match_word</a></span></dt><dt><span class="section"><a href="#id2547332">ao_cmd_init</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id2532046">9. CC1111 USB target device</a></span></dt><dd><dl><dt><span class="section"><a href="#id2525352">ao_usb_flush</a></span></dt><dt><span class="section"><a href="#id2541180">ao_usb_putchar</a></span></dt><dt><span class="section"><a href="#id2547427">ao_usb_pollchar</a></span></dt><dt><span class="section"><a href="#id2509007">ao_usb_getchar</a></span></dt><dt><span class="section"><a href="#id2527477">ao_usb_disable</a></span></dt><dt><span class="section"><a href="#id2524926">ao_usb_enable</a></span></dt><dt><span class="section"><a href="#id2524815">ao_usb_init</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id2533985">10. CC1111 Serial peripheral</a></span></dt><dd><dl><dt><span class="section"><a href="#id2534584">ao_serial_getchar</a></span></dt><dt><span class="section"><a href="#id2510894">ao_serial_putchar</a></span></dt><dt><span class="section"><a href="#id2512156">ao_serial_drain</a></span></dt><dt><span class="section"><a href="#id2522554">ao_serial_set_speed</a></span></dt><dt><span class="section"><a href="#id2532570">ao_serial_init</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id2538580">11. CC1111 Radio peripheral</a></span></dt><dd><dl><dt><span class="section"><a href="#id2510581">ao_radio_set_telemetry</a></span></dt><dt><span class="section"><a href="#id2539998">ao_radio_set_packet</a></span></dt><dt><span class="section"><a href="#id2543590">ao_radio_set_rdf</a></span></dt><dt><span class="section"><a href="#id2531765">ao_radio_idle</a></span></dt><dt><span class="section"><a href="#id2509740">ao_radio_get</a></span></dt><dt><span class="section"><a href="#id2544567">ao_radio_put</a></span></dt><dt><span class="section"><a href="#id2548225">ao_radio_abort</a></span></dt><dt><span class="section"><a href="#id2523272">ao_radio_send</a></span></dt><dt><span class="section"><a href="#id2527304">ao_radio_recv</a></span></dt><dt><span class="section"><a href="#id2542081">ao_radio_rdf</a></span></dt><dt><span class="section"><a href="#id2548629">ao_packet_putchar</a></span></dt><dt><span class="section"><a href="#id2545931">ao_packet_pollchar</a></span></dt><dt><span class="section"><a href="#id2548616">ao_packet_slave_start</a></span></dt><dt><span class="section"><a href="#id2521552">ao_packet_slave_stop</a></span></dt><dt><span class="section"><a href="#id2520941">ao_packet_slave_init</a></span></dt><dt><span class="section"><a href="#id2532882">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="id2513415"></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:
</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="id25
79104"></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="#id2572549">8051 memory spaces</a></span></dt><dd><dl><dt><span class="section"><a href="#id2587147">__data</a></span></dt><dt><span class="section"><a href="#id2574082">__idata</a></span></dt><dt><span class="section"><a href="#id2585502">__xdata</a></span></dt><dt><span class="section"><a href="#id2568787">__pdata</a></span></dt><dt><span class="section"><a href="#id2564890">__code</a></span></dt><dt><span class="section"><a href="#id2570929">__bit</a></span></dt><dt><span class="section"><a href="#id2558641">__sfr, __sfr16, __sfr32, __sbit</a></span></dt></dl></dd><dt><span class="section"><a href="#id2565185">Function calls on the 8051</a></span></dt><dd><dl><dt><span class="section"><a href="#id2557511">__reentrant functions</a></span></dt><dt><span class="section"><a href="#id2558653">Non __reentrant functions</a></span></dt><dt><span class="section"><a href="#id2587007">__interrupt functions</a></span></dt><dt><span class="section"><a href="#id2570923">__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="id25
37325"></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="#id2530770">8051 memory spaces</a></span></dt><dd><dl><dt><span class="section"><a href="#id2545367">__data</a></span></dt><dt><span class="section"><a href="#id2532303">__idata</a></span></dt><dt><span class="section"><a href="#id2543723">__xdata</a></span></dt><dt><span class="section"><a href="#id2527008">__pdata</a></span></dt><dt><span class="section"><a href="#id2523111">__code</a></span></dt><dt><span class="section"><a href="#id2529150">__bit</a></span></dt><dt><span class="section"><a href="#id2516861">__sfr, __sfr16, __sfr32, __sbit</a></span></dt></dl></dd><dt><span class="section"><a href="#id2523406">Function calls on the 8051</a></span></dt><dd><dl><dt><span class="section"><a href="#id2515732">__reentrant functions</a></span></dt><dt><span class="section"><a href="#id2516874">Non __reentrant functions</a></span></dt><dt><span class="section"><a href="#id2545227">__interrupt functions</a></span></dt><dt><span class="section"><a href="#id2529144">__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
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="id25
72549"></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="id25
30770"></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
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="id25
87147"></a>__data</h3></div></div></div><p>
+ </p><div class="section" title="__data"><div class="titlepage"><div><div><h3 class="title"><a name="id25
45367"></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
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="id25
74082"></a>__idata</h3></div></div></div><p>
+ </p></div><div class="section" title="__idata"><div class="titlepage"><div><div><h3 class="title"><a name="id25
32303"></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="id25
85502"></a>__xdata</h3></div></div></div><p>
+ </p></div><div class="section" title="__xdata"><div class="titlepage"><div><div><h3 class="title"><a name="id25
43723"></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="id25
68787"></a>__pdata</h3></div></div></div><p>
+ </p></div><div class="section" title="__pdata"><div class="titlepage"><div><div><h3 class="title"><a name="id25
27008"></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="id25
64890"></a>__code</h3></div></div></div><p>
+ </p></div><div class="section" title="__code"><div class="titlepage"><div><div><h3 class="title"><a name="id25
23111"></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="id25
70929"></a>__bit</h3></div></div></div><p>
+ </p></div><div class="section" title="__bit"><div class="titlepage"><div><div><h3 class="title"><a name="id25
29150"></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="id25
58641"></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="id25
16861"></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="id25
65185"></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="id25
23406"></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
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="id25
57511"></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="id25
15732"></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
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="id25
58653"></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="id25
16874"></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
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="id25
87007"></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="id25
45227"></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="id25
70923"></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="id25
29144"></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
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="id25
78729"></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="#id2566460">ao_add_task</a></span></dt><dt><span class="section"><a href="#id2549662">ao_exit</a></span></dt><dt><span class="section"><a href="#id2588863">ao_sleep</a></span></dt><dt><span class="section"><a href="#id2555754">ao_wakeup</a></span></dt><dt><span class="section"><a href="#id2578893">ao_alarm</a></span></dt><dt><span class="section"><a href="#id2565595">ao_wake_task</a></span></dt><dt><span class="section"><a href="#id2561847">ao_start_scheduler</a></span></dt><dt><span class="section"><a href="#id2571836">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="id25
36949"></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="#id2524681">ao_add_task</a></span></dt><dt><span class="section"><a href="#id2507882">ao_exit</a></span></dt><dt><span class="section"><a href="#id2547084">ao_sleep</a></span></dt><dt><span class="section"><a href="#id2513975">ao_wakeup</a></span></dt><dt><span class="section"><a href="#id2537114">ao_alarm</a></span></dt><dt><span class="section"><a href="#id2523816">ao_wake_task</a></span></dt><dt><span class="section"><a href="#id2520068">ao_start_scheduler</a></span></dt><dt><span class="section"><a href="#id2530057">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="id25
66460"></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="id25
24681"></a>ao_add_task</h2></div></div></div><pre class="programlisting">
void
ao_add_task(__xdata struct ao_task * task,
void (*start)(void),
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="id25
49662"></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="id25
07882"></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="id25
88863"></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="id25
47084"></a>ao_sleep</h2></div></div></div><pre class="programlisting">
void
ao_sleep(__xdata void *wchan)
</pre><p>
__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="id25
55754"></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="id25
13975"></a>ao_wakeup</h2></div></div></div><pre class="programlisting">
void
ao_wakeup(__xdata void *wchan)
</pre><p>
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="id25
78893"></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="id25
37114"></a>ao_alarm</h2></div></div></div><pre class="programlisting">
void
ao_alarm(uint16_t delay)
</pre><p>
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_wake_task"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id25
65595"></a>ao_wake_task</h2></div></div></div><pre class="programlisting">
+ </p></div><div class="section" title="ao_wake_task"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id25
23816"></a>ao_wake_task</h2></div></div></div><pre class="programlisting">
void
ao_wake_task(__xdata struct ao_task *task)
</pre><p>
Force a specific task to wake up, independent of which
'wchan' it is waiting for.
- </p></div><div class="section" title="ao_start_scheduler"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id25
61847"></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="id25
20068"></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="id25
71836"></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="id25
30057"></a>ao_clock_init</h2></div></div></div><pre class="programlisting">
void
ao_clock_init(void)
</pre><p>
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="id25
74991"></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="#id2568218">ao_time</a></span></dt><dt><span class="section"><a href="#id2581923">ao_delay</a></span></dt><dt><span class="section"><a href="#id2581648">ao_timer_set_adc_interval</a></span></dt><dt><span class="section"><a href="#id2586062">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="id25
33212"></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="#id2526439">ao_time</a></span></dt><dt><span class="section"><a href="#id2540144">ao_delay</a></span></dt><dt><span class="section"><a href="#id2539869">ao_timer_set_adc_interval</a></span></dt><dt><span class="section"><a href="#id2544283">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
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="id25
68218"></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="id25
26439"></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="id25
81923"></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="id25
40144"></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="id25
81648"></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="id25
39869"></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="id25
86062"></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="id25
44283"></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="id25
89986"></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="#id2570322">ao_mutex_get</a></span></dt><dt><span class="section"><a href="#id2555486">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="id25
48207"></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="#id2528543">ao_mutex_get</a></span></dt><dt><span class="section"><a href="#id2513707">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="id25
70322"></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="id25
28543"></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="id25
55486"></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="id25
13707"></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="id25
82719"></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="#id2579029">ao_dma_alloc</a></span></dt><dt><span class="section"><a href="#id2568950">ao_dma_set_transfer</a></span></dt><dt><span class="section"><a href="#id2576818">ao_dma_start</a></span></dt><dt><span class="section"><a href="#id2586065">ao_dma_trigger</a></span></dt><dt><span class="section"><a href="#id2570488">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="id25
40940"></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="#id2537249">ao_dma_alloc</a></span></dt><dt><span class="section"><a href="#id2527171">ao_dma_set_transfer</a></span></dt><dt><span class="section"><a href="#id2535038">ao_dma_start</a></span></dt><dt><span class="section"><a href="#id2544286">ao_dma_trigger</a></span></dt><dt><span class="section"><a href="#id2528708">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
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="id25
79029"></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="id25
37249"></a>ao_dma_alloc</h2></div></div></div><pre class="programlisting">
uint8_t
ao_dma_alloc(__xdata uint8_t *done)
</pre><p>
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="id25
68950"></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="id25
27171"></a>ao_dma_set_transfer</h2></div></div></div><pre class="programlisting">
void
ao_dma_set_transfer(uint8_t id,
void __xdata *srcaddr,
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="id25
76818"></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="id25
35038"></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="id25
86065"></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="id25
44286"></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="id25
70488"></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="id25
28708"></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="id25
71669"></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="#id2583460">putchar</a></span></dt><dt><span class="section"><a href="#id2569848">getchar</a></span></dt><dt><span class="section"><a href="#id2584689">flush</a></span></dt><dt><span class="section"><a href="#id2578522">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="id25
29890"></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="#id2541680">putchar</a></span></dt><dt><span class="section"><a href="#id2528069">getchar</a></span></dt><dt><span class="section"><a href="#id2542910">flush</a></span></dt><dt><span class="section"><a href="#id2536743">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
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="id25
83460"></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="id25
41680"></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="id25
69848"></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="id25
28069"></a>getchar</h2></div></div></div><pre class="programlisting">
char
getchar(void)
</pre><p>
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="id25
84689"></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="id25
42910"></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="id25
78522"></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="id25
36743"></a>ao_add_stdio</h2></div></div></div><pre class="programlisting">
void
ao_add_stdio(char (*pollchar)(void),
void (*putchar)(char),
'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="id25
77396"></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="#id2573332">ao_cmd_register</a></span></dt><dt><span class="section"><a href="#id2573326">ao_cmd_lex</a></span></dt><dt><span class="section"><a href="#id2569393">ao_cmd_put16</a></span></dt><dt><span class="section"><a href="#id2565433">ao_cmd_put8</a></span></dt><dt><span class="section"><a href="#id2587125">ao_cmd_white</a></span></dt><dt><span class="section"><a href="#id2583867">ao_cmd_hex</a></span></dt><dt><span class="section"><a href="#id2589264">ao_cmd_decimal</a></span></dt><dt><span class="section"><a href="#id2578518">ao_match_word</a></span></dt><dt><span class="section"><a href="#id2589111">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="id25
35617"></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="#id2531553">ao_cmd_register</a></span></dt><dt><span class="section"><a href="#id2531547">ao_cmd_lex</a></span></dt><dt><span class="section"><a href="#id2527614">ao_cmd_put16</a></span></dt><dt><span class="section"><a href="#id2523654">ao_cmd_put8</a></span></dt><dt><span class="section"><a href="#id2545346">ao_cmd_white</a></span></dt><dt><span class="section"><a href="#id2542088">ao_cmd_hex</a></span></dt><dt><span class="section"><a href="#id2547485">ao_cmd_decimal</a></span></dt><dt><span class="section"><a href="#id2536739">ao_match_word</a></span></dt><dt><span class="section"><a href="#id2547332">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="id25
73332"></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="id25
31553"></a>ao_cmd_register</h2></div></div></div><pre class="programlisting">
void
ao_cmd_register(__code struct ao_cmds *cmds)
</pre><p>
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="id25
73326"></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="id25
31547"></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="id25
69393"></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="id25
27614"></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="id25
65433"></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="id25
23654"></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="id25
87125"></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="id25
45346"></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="id25
83867"></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="id25
42088"></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="id25
89264"></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="id25
47485"></a>ao_cmd_decimal</h2></div></div></div><pre class="programlisting">
void
ao_cmd_decimal(void)
</pre><p>
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="id25
78518"></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="id25
36739"></a>ao_match_word</h2></div></div></div><pre class="programlisting">
uint8_t
ao_match_word(__code char *word)
</pre><p>
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="id25
89111"></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="id25
47332"></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="id25
73826"></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="#id2567131">ao_usb_flush</a></span></dt><dt><span class="section"><a href="#id2582959">ao_usb_putchar</a></span></dt><dt><span class="section"><a href="#id2589206">ao_usb_pollchar</a></span></dt><dt><span class="section"><a href="#id2550786">ao_usb_getchar</a></span></dt><dt><span class="section"><a href="#id2569256">ao_usb_disable</a></span></dt><dt><span class="section"><a href="#id2566705">ao_usb_enable</a></span></dt><dt><span class="section"><a href="#id2566594">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="id25
32046"></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="#id2525352">ao_usb_flush</a></span></dt><dt><span class="section"><a href="#id2541180">ao_usb_putchar</a></span></dt><dt><span class="section"><a href="#id2547427">ao_usb_pollchar</a></span></dt><dt><span class="section"><a href="#id2509007">ao_usb_getchar</a></span></dt><dt><span class="section"><a href="#id2527477">ao_usb_disable</a></span></dt><dt><span class="section"><a href="#id2524926">ao_usb_enable</a></span></dt><dt><span class="section"><a href="#id2524815">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
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="id25
67131"></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="id25
25352"></a>ao_usb_flush</h2></div></div></div><pre class="programlisting">
void
ao_usb_flush(void);
</pre><p>
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="id25
82959"></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="id25
41180"></a>ao_usb_putchar</h2></div></div></div><pre class="programlisting">
void
ao_usb_putchar(char c);
</pre><p>
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="id25
89206"></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="id25
47427"></a>ao_usb_pollchar</h2></div></div></div><pre class="programlisting">
char
ao_usb_pollchar(void);
</pre><p>
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="id25
50786"></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="id25
09007"></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="id25
69256"></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="id25
27477"></a>ao_usb_disable</h2></div></div></div><pre class="programlisting">
void
ao_usb_disable(void);
</pre><p>
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="id25
66705"></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="id25
24926"></a>ao_usb_enable</h2></div></div></div><pre class="programlisting">
void
ao_usb_enable(void);
</pre><p>
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="id25
66594"></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="id25
24815"></a>ao_usb_init</h2></div></div></div><pre class="programlisting">
void
ao_usb_init(void);
</pre><p>
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="id25
75764"></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="#id2576363">ao_serial_getchar</a></span></dt><dt><span class="section"><a href="#id2552673">ao_serial_putchar</a></span></dt><dt><span class="section"><a href="#id2553935">ao_serial_drain</a></span></dt><dt><span class="section"><a href="#id2564334">ao_serial_set_speed</a></span></dt><dt><span class="section"><a href="#id2574349">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="id25
33985"></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="#id2534584">ao_serial_getchar</a></span></dt><dt><span class="section"><a href="#id2510894">ao_serial_putchar</a></span></dt><dt><span class="section"><a href="#id2512156">ao_serial_drain</a></span></dt><dt><span class="section"><a href="#id2522554">ao_serial_set_speed</a></span></dt><dt><span class="section"><a href="#id2532570">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
</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="id25
76363"></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="id25
34584"></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="id25
52673"></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="id25
10894"></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="id25
53935"></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="id25
12156"></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="id25
64334"></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="id25
22554"></a>ao_serial_set_speed</h2></div></div></div><pre class="programlisting">
void
ao_serial_set_speed(uint8_t speed);
</pre><p>
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="id25
74349"></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="id25
32570"></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="id25
80359"></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="#id2552360">ao_radio_set_telemetry</a></span></dt><dt><span class="section"><a href="#id2581777">ao_radio_set_packet</a></span></dt><dt><span class="section"><a href="#id2585369">ao_radio_set_rdf</a></span></dt><dt><span class="section"><a href="#id2573544">ao_radio_idle</a></span></dt><dt><span class="section"><a href="#id2551519">ao_radio_get</a></span></dt><dt><span class="section"><a href="#id2586346">ao_radio_put</a></span></dt><dt><span class="section"><a href="#id2590004">ao_radio_abort</a></span></dt><dt><span class="section"><a href="#id2565052">ao_radio_send</a></span></dt><dt><span class="section"><a href="#id2569083">ao_radio_recv</a></span></dt><dt><span class="section"><a href="#id2583861">ao_radio_rdf</a></span></dt><dt><span class="section"><a href="#id2590408">ao_packet_putchar</a></span></dt><dt><span class="section"><a href="#id2587711">ao_packet_pollchar</a></span></dt><dt><span class="section"><a href="#id2590396">ao_packet_slave_start</a></span></dt><dt><span class="section"><a href="#id2563331">ao_packet_slave_stop</a></span></dt><dt><span class="section"><a href="#id2562720">ao_packet_slave_init</a></span></dt><dt><span class="section"><a href="#id2574661">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="id25
38580"></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="#id2510581">ao_radio_set_telemetry</a></span></dt><dt><span class="section"><a href="#id2539998">ao_radio_set_packet</a></span></dt><dt><span class="section"><a href="#id2543590">ao_radio_set_rdf</a></span></dt><dt><span class="section"><a href="#id2531765">ao_radio_idle</a></span></dt><dt><span class="section"><a href="#id2509740">ao_radio_get</a></span></dt><dt><span class="section"><a href="#id2544567">ao_radio_put</a></span></dt><dt><span class="section"><a href="#id2548225">ao_radio_abort</a></span></dt><dt><span class="section"><a href="#id2523272">ao_radio_send</a></span></dt><dt><span class="section"><a href="#id2527304">ao_radio_recv</a></span></dt><dt><span class="section"><a href="#id2542081">ao_radio_rdf</a></span></dt><dt><span class="section"><a href="#id2548629">ao_packet_putchar</a></span></dt><dt><span class="section"><a href="#id2545931">ao_packet_pollchar</a></span></dt><dt><span class="section"><a href="#id2548616">ao_packet_slave_start</a></span></dt><dt><span class="section"><a href="#id2521552">ao_packet_slave_stop</a></span></dt><dt><span class="section"><a href="#id2520941">ao_packet_slave_init</a></span></dt><dt><span class="section"><a href="#id2532882">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
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="id25
52360"></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="id25
10581"></a>ao_radio_set_telemetry</h2></div></div></div><pre class="programlisting">
void
ao_radio_set_telemetry(void);
</pre><p>
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="id25
81777"></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="id25
39998"></a>ao_radio_set_packet</h2></div></div></div><pre class="programlisting">
void
ao_radio_set_packet(void);
</pre><p>
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="id25
85369"></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="id25
43590"></a>ao_radio_set_rdf</h2></div></div></div><pre class="programlisting">
void
ao_radio_set_rdf(void);
</pre><p>
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="id25
73544"></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="id25
31765"></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="id25
51519"></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="id25
09740"></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="id25
86346"></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="id25
44567"></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="id25
90004"></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="id25
48225"></a>ao_radio_abort</h2></div></div></div><pre class="programlisting">
void
ao_radio_abort(void);
</pre><p>
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="id25
65052"></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="id25
23272"></a>ao_radio_send</h2></div></div></div><pre class="programlisting">
void
ao_radio_send(__xdata struct ao_telemetry *telemetry);
</pre><p>
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="id25
69083"></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="id25
27304"></a>ao_radio_recv</h2></div></div></div><pre class="programlisting">
void
ao_radio_recv(__xdata struct ao_radio_recv *radio);
</pre><p>
</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="id25
83861"></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="id25
42081"></a>ao_radio_rdf</h2></div></div></div><pre class="programlisting">
void
ao_radio_rdf(int ms);
</pre><p>
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="id25
90408"></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="id25
48629"></a>ao_packet_putchar</h2></div></div></div><pre class="programlisting">
void
ao_packet_putchar(char c);
</pre><p>
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="id25
87711"></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="id25
45931"></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="id25
90396"></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="id25
48616"></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="id25
63331"></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="id25
21552"></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="id25
62720"></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="id25
20941"></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="id25
74661"></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="id25
32882"></a>ao_packet_master_init</h2></div></div></div><pre class="programlisting">
void
ao_packet_master_init(void);
</pre><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="id2
717824"></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 © 2010 Bdale Garbee and Keith Packard</p></div><div><div class="legalnotice" title="Legal Notice"><a name="id2993323"></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="id2
403729"></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 © 2010 Bdale Garbee and Keith Packard</p></div><div><div class="legalnotice" title="Legal Notice"><a name="id2679228"></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.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="id2984870"></a>Acknowledgements</h2></div></div></div>
+ </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.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="id2670775"></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
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="#id2
988605">1. Introduction and Overview</a></span></dt><dt><span class="chapter"><a href="#id2962381">2. Getting Started</a></span></dt><dd><dl><dt><span class="section"><a href="#id3001412">FAQ</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id2988518">3. Specifications</a></span></dt><dt><span class="chapter"><a href="#id3016372">4. Handling Precautions</a></span></dt><dt><span class="chapter"><a href="#id2988750">5. Hardware Overview</a></span></dt><dt><span class="chapter"><a href="#id2994616">6. System Operation</a></span></dt><dd><dl><dt><span class="section"><a href="#id2997763">Firmware Modes </a></span></dt><dt><span class="section"><a href="#id2999475">GPS </a></span></dt><dt><span class="section"><a href="#id3013879">Ground Testing </a></span></dt><dt><span class="section"><a href="#id3013876">Radio Link </a></span></dt><dt><span class="section"><a href="#id2984597">Configurable Parameters</a></span></dt><dd><dl><dt><span class="section"><a href="#id3004868">Radio Channel</a></span></dt><dt><span class="section"><a href="#id2995782">Apogee Delay</a></span></dt><dt><span class="section"><a href="#id3013588">Main Deployment Altitude</a></span></dt></dl></dd><dt><span class="section"><a href="#id2992217">Calibration</a></span></dt><dd><dl><dt><span class="section"><a href="#id3015940">Radio Frequency</a></span></dt><dt><span class="section"><a href="#id3006050">Accelerometer</a></span></dt></dl></dd><dt><span class="section"><a href="#id3014288">Updating Device Firmware</a></span></dt><dd><dl><dt><span class="section"><a href="#id2987187">Updating TeleMetrum Firmware</a></span></dt><dt><span class="section"><a href="#id3005991">Updating TeleDongle Firmware</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#id3002861">7. AltosUI</a></span></dt><dd><dl><dt><span class="section"><a href="#id3003139">Packet Command Mode</a></span></dt><dt><span class="section"><a href="#id3008185">Monitor Flight</a></span></dt><dd><dl><dt><span class="section"><a href="#id3003203">Launch Pad</a></span></dt><dt><span class="section"><a href="#id2997854">Ascent</a></span></dt><dt><span class="section"><a href="#id3004703">Descent</a></span></dt><dt><span class="section"><a href="#id3013196">Landed</a></span></dt><dt><span class="section"><a href="#id2994529">Site Map</a></span></dt></dl></dd><dt><span class="section"><a href="#id2998813">Save Flight Data</a></span></dt><dt><span class="section"><a href="#id3018998">Replay Flight</a></span></dt><dt><span class="section"><a href="#id3005821">Graph Data</a></span></dt><dt><span class="section"><a href="#id3000821">Export Data</a></span></dt><dd><dl><dt><span class="section"><a href="#id3008023">Comma Separated Value Format</a></span></dt><dt><span class="section"><a href="#id3011584">Keyhole Markup Language (for Google Earth)</a></span></dt></dl></dd><dt><span class="section"><a href="#id3002844">Configure TeleMetrum</a></span></dt><dd><dl><dt><span class="section"><a href="#id2991702">Main Deploy Altitude</a></span></dt><dt><span class="section"><a href="#id2985384">Apogee Delay</a></span></dt><dt><span class="section"><a href="#id3014834">Radio Channel</a></span></dt><dt><span class="section"><a href="#id2996409">Radio Calibration</a></span></dt><dt><span class="section"><a href="#id2994288">Callsign</a></span></dt></dl></dd><dt><span class="section"><a href="#id2994448">Configure AltosUI</a></span></dt><dd><dl><dt><span class="section"><a href="#id2980753">Voice Settings</a></span></dt><dt><span class="section"><a href="#id3019061">Log Directory</a></span></dt><dt><span class="section"><a href="#id2985861">Callsign</a></span></dt></dl></dd><dt><span class="section"><a href="#id3005736">Flash Image</a></span></dt><dt><span class="section"><a href="#id3003508">Fire Igniter</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id3014304">8. Using Altus Metrum Products</a></span></dt><dd><dl><dt><span class="section"><a href="#id3001410">Being Legal</a></span></dt><dt><span class="section"><a href="#id3016224">In the Rocket</a></span></dt><dt><span class="section"><a href="#id3004104">On the Ground</a></span></dt><dt><span class="section"><a href="#id3006076">Data Analysis</a></span></dt><dt><span class="section"><a href="#id3003816">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="id2988605"></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="#id2
674510">1. Introduction and Overview</a></span></dt><dt><span class="chapter"><a href="#id2648286">2. Getting Started</a></span></dt><dd><dl><dt><span class="section"><a href="#id2687317">FAQ</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id2674423">3. Specifications</a></span></dt><dt><span class="chapter"><a href="#id2702277">4. Handling Precautions</a></span></dt><dt><span class="chapter"><a href="#id2674655">5. Hardware Overview</a></span></dt><dt><span class="chapter"><a href="#id2680521">6. System Operation</a></span></dt><dd><dl><dt><span class="section"><a href="#id2683668">Firmware Modes </a></span></dt><dt><span class="section"><a href="#id2685380">GPS </a></span></dt><dt><span class="section"><a href="#id2699784">Ground Testing </a></span></dt><dt><span class="section"><a href="#id2699781">Radio Link </a></span></dt><dt><span class="section"><a href="#id2670502">Configurable Parameters</a></span></dt><dd><dl><dt><span class="section"><a href="#id2690773">Radio Channel</a></span></dt><dt><span class="section"><a href="#id2681687">Apogee Delay</a></span></dt><dt><span class="section"><a href="#id2699494">Main Deployment Altitude</a></span></dt></dl></dd><dt><span class="section"><a href="#id2678122">Calibration</a></span></dt><dd><dl><dt><span class="section"><a href="#id2701845">Radio Frequency</a></span></dt><dt><span class="section"><a href="#id2691955">Accelerometer</a></span></dt></dl></dd><dt><span class="section"><a href="#id2700193">Updating Device Firmware</a></span></dt><dd><dl><dt><span class="section"><a href="#id2673092">Updating TeleMetrum Firmware</a></span></dt><dt><span class="section"><a href="#id2691896">Updating TeleDongle Firmware</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#id2688766">7. AltosUI</a></span></dt><dd><dl><dt><span class="section"><a href="#id2689044">Packet Command Mode</a></span></dt><dt><span class="section"><a href="#id2694090">Monitor Flight</a></span></dt><dd><dl><dt><span class="section"><a href="#id2689108">Launch Pad</a></span></dt><dt><span class="section"><a href="#id2683759">Ascent</a></span></dt><dt><span class="section"><a href="#id2690608">Descent</a></span></dt><dt><span class="section"><a href="#id2699101">Landed</a></span></dt><dt><span class="section"><a href="#id2680434">Site Map</a></span></dt></dl></dd><dt><span class="section"><a href="#id2684718">Save Flight Data</a></span></dt><dt><span class="section"><a href="#id2704903">Replay Flight</a></span></dt><dt><span class="section"><a href="#id2691726">Graph Data</a></span></dt><dt><span class="section"><a href="#id2686726">Export Data</a></span></dt><dd><dl><dt><span class="section"><a href="#id2693928">Comma Separated Value Format</a></span></dt><dt><span class="section"><a href="#id2697489">Keyhole Markup Language (for Google Earth)</a></span></dt></dl></dd><dt><span class="section"><a href="#id2688749">Configure TeleMetrum</a></span></dt><dd><dl><dt><span class="section"><a href="#id2677607">Main Deploy Altitude</a></span></dt><dt><span class="section"><a href="#id2671289">Apogee Delay</a></span></dt><dt><span class="section"><a href="#id2700739">Radio Channel</a></span></dt><dt><span class="section"><a href="#id2682314">Radio Calibration</a></span></dt><dt><span class="section"><a href="#id2680193">Callsign</a></span></dt></dl></dd><dt><span class="section"><a href="#id2680353">Configure AltosUI</a></span></dt><dd><dl><dt><span class="section"><a href="#id2666658">Voice Settings</a></span></dt><dt><span class="section"><a href="#id2704966">Log Directory</a></span></dt><dt><span class="section"><a href="#id2671766">Callsign</a></span></dt></dl></dd><dt><span class="section"><a href="#id2691641">Flash Image</a></span></dt><dt><span class="section"><a href="#id2689413">Fire Igniter</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id2700209">8. Using Altus Metrum Products</a></span></dt><dd><dl><dt><span class="section"><a href="#id2687315">Being Legal</a></span></dt><dt><span class="section"><a href="#id2702129">In the Rocket</a></span></dt><dt><span class="section"><a href="#id2690009">On the Ground</a></span></dt><dt><span class="section"><a href="#id2691981">Data Analysis</a></span></dt><dt><span class="section"><a href="#id2689721">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="id2674510"></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
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="id2
962381"></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="#id3001412">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="id2
648286"></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="#id2687317">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
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="id
3001412"></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="id
2687317"></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
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="id2
988518"></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="id2
674423"></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).
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="id
3016372"></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="id
2702277"></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
</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="id2
988750"></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="id2
674655"></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
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="id2
994616"></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="#id2997763">Firmware Modes </a></span></dt><dt><span class="section"><a href="#id2999475">GPS </a></span></dt><dt><span class="section"><a href="#id3013879">Ground Testing </a></span></dt><dt><span class="section"><a href="#id3013876">Radio Link </a></span></dt><dt><span class="section"><a href="#id2984597">Configurable Parameters</a></span></dt><dd><dl><dt><span class="section"><a href="#id3004868">Radio Channel</a></span></dt><dt><span class="section"><a href="#id2995782">Apogee Delay</a></span></dt><dt><span class="section"><a href="#id3013588">Main Deployment Altitude</a></span></dt></dl></dd><dt><span class="section"><a href="#id2992217">Calibration</a></span></dt><dd><dl><dt><span class="section"><a href="#id3015940">Radio Frequency</a></span></dt><dt><span class="section"><a href="#id3006050">Accelerometer</a></span></dt></dl></dd><dt><span class="section"><a href="#id3014288">Updating Device Firmware</a></span></dt><dd><dl><dt><span class="section"><a href="#id2987187">Updating TeleMetrum Firmware</a></span></dt><dt><span class="section"><a href="#id3005991">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="id2997763"></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="id2
680521"></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="#id2683668">Firmware Modes </a></span></dt><dt><span class="section"><a href="#id2685380">GPS </a></span></dt><dt><span class="section"><a href="#id2699784">Ground Testing </a></span></dt><dt><span class="section"><a href="#id2699781">Radio Link </a></span></dt><dt><span class="section"><a href="#id2670502">Configurable Parameters</a></span></dt><dd><dl><dt><span class="section"><a href="#id2690773">Radio Channel</a></span></dt><dt><span class="section"><a href="#id2681687">Apogee Delay</a></span></dt><dt><span class="section"><a href="#id2699494">Main Deployment Altitude</a></span></dt></dl></dd><dt><span class="section"><a href="#id2678122">Calibration</a></span></dt><dd><dl><dt><span class="section"><a href="#id2701845">Radio Frequency</a></span></dt><dt><span class="section"><a href="#id2691955">Accelerometer</a></span></dt></dl></dd><dt><span class="section"><a href="#id2700193">Updating Device Firmware</a></span></dt><dd><dl><dt><span class="section"><a href="#id2673092">Updating TeleMetrum Firmware</a></span></dt><dt><span class="section"><a href="#id2691896">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="id2683668"></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
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="id2
999475"></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="id2
685380"></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
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="id
3013879"></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="id
2699784"></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,
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="id
3013876"></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="id
2699781"></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
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="id2
984597"></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="id2
670502"></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="id
3004868"></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="id
2690773"></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.
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="id2
995782"></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="id2
681687"></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
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="id
3013588"></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="id
2699494"></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
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="id2
992217"></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="id2
678122"></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="id
3015940"></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="id
2701845"></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
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="id
3006050"></a>Accelerometer</h3></div></div></div><p>
+ </p></div><div class="section" title="Accelerometer"><div class="titlepage"><div><div><h3 class="title"><a name="id
2691955"></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
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="id
3014288"></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="id
2700193"></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
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="id2
987187"></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="id2
673092"></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.
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="id
3005991"></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="id
2691896"></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.
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="id
3002861"></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="#id3003139">Packet Command Mode</a></span></dt><dt><span class="section"><a href="#id3008185">Monitor Flight</a></span></dt><dd><dl><dt><span class="section"><a href="#id3003203">Launch Pad</a></span></dt><dt><span class="section"><a href="#id2997854">Ascent</a></span></dt><dt><span class="section"><a href="#id3004703">Descent</a></span></dt><dt><span class="section"><a href="#id3013196">Landed</a></span></dt><dt><span class="section"><a href="#id2994529">Site Map</a></span></dt></dl></dd><dt><span class="section"><a href="#id2998813">Save Flight Data</a></span></dt><dt><span class="section"><a href="#id3018998">Replay Flight</a></span></dt><dt><span class="section"><a href="#id3005821">Graph Data</a></span></dt><dt><span class="section"><a href="#id3000821">Export Data</a></span></dt><dd><dl><dt><span class="section"><a href="#id3008023">Comma Separated Value Format</a></span></dt><dt><span class="section"><a href="#id3011584">Keyhole Markup Language (for Google Earth)</a></span></dt></dl></dd><dt><span class="section"><a href="#id3002844">Configure TeleMetrum</a></span></dt><dd><dl><dt><span class="section"><a href="#id2991702">Main Deploy Altitude</a></span></dt><dt><span class="section"><a href="#id2985384">Apogee Delay</a></span></dt><dt><span class="section"><a href="#id3014834">Radio Channel</a></span></dt><dt><span class="section"><a href="#id2996409">Radio Calibration</a></span></dt><dt><span class="section"><a href="#id2994288">Callsign</a></span></dt></dl></dd><dt><span class="section"><a href="#id2994448">Configure AltosUI</a></span></dt><dd><dl><dt><span class="section"><a href="#id2980753">Voice Settings</a></span></dt><dt><span class="section"><a href="#id3019061">Log Directory</a></span></dt><dt><span class="section"><a href="#id2985861">Callsign</a></span></dt></dl></dd><dt><span class="section"><a href="#id3005736">Flash Image</a></span></dt><dt><span class="section"><a href="#id3003508">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="id
2688766"></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="#id2689044">Packet Command Mode</a></span></dt><dt><span class="section"><a href="#id2694090">Monitor Flight</a></span></dt><dd><dl><dt><span class="section"><a href="#id2689108">Launch Pad</a></span></dt><dt><span class="section"><a href="#id2683759">Ascent</a></span></dt><dt><span class="section"><a href="#id2690608">Descent</a></span></dt><dt><span class="section"><a href="#id2699101">Landed</a></span></dt><dt><span class="section"><a href="#id2680434">Site Map</a></span></dt></dl></dd><dt><span class="section"><a href="#id2684718">Save Flight Data</a></span></dt><dt><span class="section"><a href="#id2704903">Replay Flight</a></span></dt><dt><span class="section"><a href="#id2691726">Graph Data</a></span></dt><dt><span class="section"><a href="#id2686726">Export Data</a></span></dt><dd><dl><dt><span class="section"><a href="#id2693928">Comma Separated Value Format</a></span></dt><dt><span class="section"><a href="#id2697489">Keyhole Markup Language (for Google Earth)</a></span></dt></dl></dd><dt><span class="section"><a href="#id2688749">Configure TeleMetrum</a></span></dt><dd><dl><dt><span class="section"><a href="#id2677607">Main Deploy Altitude</a></span></dt><dt><span class="section"><a href="#id2671289">Apogee Delay</a></span></dt><dt><span class="section"><a href="#id2700739">Radio Channel</a></span></dt><dt><span class="section"><a href="#id2682314">Radio Calibration</a></span></dt><dt><span class="section"><a href="#id2680193">Callsign</a></span></dt></dl></dd><dt><span class="section"><a href="#id2680353">Configure AltosUI</a></span></dt><dd><dl><dt><span class="section"><a href="#id2666658">Voice Settings</a></span></dt><dt><span class="section"><a href="#id2704966">Log Directory</a></span></dt><dt><span class="section"><a href="#id2671766">Callsign</a></span></dt></dl></dd><dt><span class="section"><a href="#id2691641">Flash Image</a></span></dt><dt><span class="section"><a href="#id2689413">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,
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="id
3003139"></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="id
2689044"></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
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="id
3008185"></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="id
2694090"></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
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="id
3003203"></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="id
2689108"></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
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="id2
997854"></a>Ascent</h3></div></div></div><p>
+ </p></div><div class="section" title="Ascent"><div class="titlepage"><div><div><h3 class="title"><a name="id2
683759"></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.
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="id
3004703"></a>Descent</h3></div></div></div><p>
+ </p></div><div class="section" title="Descent"><div class="titlepage"><div><div><h3 class="title"><a name="id
2690608"></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,
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="id
3013196"></a>Landed</h3></div></div></div><p>
+ </p></div><div class="section" title="Landed"><div class="titlepage"><div><div><h3 class="title"><a name="id
2699101"></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
</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="id2
994529"></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="id2
680434"></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
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="id2
998813"></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="id2
684718"></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
The filename for the data 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="id
3018998"></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="id
2704903"></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
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="id
3005821"></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="id
2691726"></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
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="id
3000821"></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="id
2686726"></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
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="id
3008023"></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="id
2693928"></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
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="id
3011584"></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="id
2697489"></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="id
3002844"></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="id
2688749"></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
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="id2
991702"></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="id2
677607"></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="id2
985384"></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="id2
671289"></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
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="id
3014834"></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="id
2700739"></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="id2
996409"></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="id2
682314"></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="id2
994288"></a>Callsign</h3></div></div></div><p>
+ </p></div><div class="section" title="Callsign"><div class="titlepage"><div><div><h3 class="title"><a name="id2
680193"></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><div class="section" title="Configure AltosUI"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2
994448"></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="id2
680353"></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="id2
980753"></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="id2
666658"></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
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="id
3019061"></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="id
2704966"></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.
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="id2
985861"></a>Callsign</h3></div></div></div><p>
+ </p></div><div class="section" title="Callsign"><div class="titlepage"><div><div><h3 class="title"><a name="id2
671766"></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><div class="section" title="Flash Image"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id
3005736"></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="id
2691641"></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
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="id
3003508"></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="id
2689413"></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
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="id
3014304"></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="#id3001410">Being Legal</a></span></dt><dt><span class="section"><a href="#id3016224">In the Rocket</a></span></dt><dt><span class="section"><a href="#id3004104">On the Ground</a></span></dt><dt><span class="section"><a href="#id3006076">Data Analysis</a></span></dt><dt><span class="section"><a href="#id3003816">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="id3001410"></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="id
2700209"></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="#id2687315">Being Legal</a></span></dt><dt><span class="section"><a href="#id2702129">In the Rocket</a></span></dt><dt><span class="section"><a href="#id2690009">On the Ground</a></span></dt><dt><span class="section"><a href="#id2691981">Data Analysis</a></span></dt><dt><span class="section"><a href="#id2689721">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="id2687315"></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="id
3016224"></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="id
2702129"></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.
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="id
3004104"></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="id
2690009"></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
</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="id
3006076"></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="id
2691981"></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
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="id
3003816"></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="id
2689721"></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
projects / web / altusmetrum / commitdiff