summaryrefslogtreecommitdiff
path: root/doc/telemetry.xsl
blob: e410150742b5caf9d6935e8b17de69885a3b2bfc (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"/usr/share/xml/docbook/schema/dtd/4.5/docbookx.dtd">

<article>
  <articleinfo>
    <title>AltOS Telemetry</title>
    <subtitle>Packet Definitions</subtitle>
    <author>
      <firstname>Keith</firstname>
      <surname>Packard</surname>
    </author>
    <copyright>
      <year>2011</year>
      <holder>Keith Packard</holder>
    </copyright>
    <legalnotice>
      <para>
	This document is released under the terms of the
	<ulink url="http://creativecommons.org/licenses/by-sa/3.0/">
	  Creative Commons ShareAlike 3.0
	</ulink>
	license.
      </para>
    </legalnotice>
    <revhistory>
      <revision>
	<revnumber>0.1</revnumber>
	<date>01 July 2011</date>
	<revremark>Initial content</revremark>
      </revision>
    </revhistory>
  </articleinfo>
  <section>
    <title>Packet Format Design</title>
    <para>
      AltOS telemetry data is split into multiple different packets,
      all the same size, but each includs an identifier so that the
      ground station can distinguish among different types. A single
      flight board will transmit multiple packet types, each type on a
      different schedule. The ground software need look for only a
      single packet size, and then decode the information within the
      packet and merge data from multiple packets to construct the
      full flight computer state.
    </para>
    <para>
      Each AltOS packet is 32 bytes long. This size was chosen based
      on the known telemetry data requirements. The power of two size
      allows them to be stored easily in flash memory without having
      them split across blocks or leaving gaps at the end.
    </para>
    <para>
      All packet types start with a five byte header which encodes the
      device serial number, device clock value and the packet
      type. The remaining 27 bytes encode type-specific data.
    </para>
  </section>
  <section>
    <title>Packet Formats</title>
    <para>
      This section first defines the packet header common to all packets
      and then the per-packet data layout.
    </para>
    <section>
      <title>Packet Header</title>
      <table frame='all'>
	<title>Telemetry Packet Header</title>
	<tgroup cols='4' align='center' colsep='1' rowsep='1'>
	  <colspec align='center' colwidth='*' colname='Offset'/>
	  <colspec align='center' colwidth='3*' colname='Data Type'/>
	  <colspec align='left' colwidth='3*' colname='Name'/>
	  <colspec align='left' colwidth='9*' colname='Description'/>
	  <thead>
	    <row>
	      <entry align='center'>Offset</entry>
	      <entry align='center'>Data Type</entry>
	      <entry align='center'>Name</entry>
	      <entry align='center'>Description</entry>
	    </row>
	  </thead>
	  <tbody>
	    <row>
	      <entry>0</entry>
	      <entry>uint16_t</entry>
	      <entry>serial</entry>
	      <entry>Device serial Number</entry>
	    </row>
	    <row>
	      <entry>2</entry>
	      <entry>uint16_t</entry>
	      <entry>tick</entry>
	      <entry>Device time in 100ths of a second</entry>
	    </row>
	    <row>
	      <entry>4</entry>
	      <entry>uint8_t</entry>
	      <entry>type</entry>
	      <entry>Packet type</entry>
	    </row>
	    <row>
	      <entry>5</entry>
	    </row>
	  </tbody>
	</tgroup>
      </table>
      <para>
      Each packet starts with these five bytes which serve to identify
      which device has transmitted the packet, when it was transmitted
      and what the rest of the packet contains.
      </para>
    </section>
    <section>
      <title>Sensor Data</title>
      <informaltable frame='none' label='' tocentry='0'>
	<tgroup cols='2' align='center' colsep='1' rowsep='1'>
	  <colspec align='center' colwidth='*' colname='Offset'/>
	  <colspec align='left' colwidth='3*' colname='Description'/>
	  <thead>
	    <row>
	      <entry>Type</entry>
	      <entry>Description</entry>
	    </row>
	  </thead>
	  <tbody>
	    <row>
	      <entry>0x01</entry>
	      <entry>TeleMetrum Sensor Data</entry>
	    </row>
	    <row>
	      <entry>0x02</entry>
	      <entry>TeleMini Sensor Data</entry>
	    </row>
	    <row>
	      <entry>0x03</entry>
	      <entry>TeleNano Sensor Data</entry>
	    </row>
	  </tbody>
	</tgroup>
      </informaltable>
      <para>
	TeleMetrum, TeleMini and TeleNano share this same packet
	format for sensor data. Each uses a distinct packet type so
	that the receiver knows which data values are valid and which
	are undefined.
      </para>
      <para>
	Sensor Data packets are transmitted once per second on the
	ground, 10 times per second during ascent and once per second
	during descent and landing
      </para>
      <table frame='all'>
	<title>Sensor Packet Contents</title>
	<tgroup cols='4' align='center' colsep='1' rowsep='1'>
	  <colspec align='center' colwidth='*' colname='Offset'/>
	  <colspec align='center' colwidth='3*' colname='Data Type'/>
	  <colspec align='left' colwidth='3*' colname='Name'/>
	  <colspec align='left' colwidth='9*' colname='Description'/>
	  <thead>
	    <row>
	      <entry align='center'>Offset</entry>
	      <entry align='center'>Data Type</entry>
	      <entry align='center'>Name</entry>
	      <entry align='center'>Description</entry>
	    </row>
	  </thead>
	  <tbody>
	    <row>
	      <entry>5</entry><entry>uint8_t</entry><entry>state</entry><entry>Flight state</entry>
	    </row>
	    <row>
	      <entry>6</entry><entry>int16_t</entry><entry>accel</entry><entry>accelerometer (TM only)</entry>
	    </row>
	    <row>
	      <entry>8</entry><entry>int16_t</entry><entry>pres</entry><entry>pressure sensor</entry>
	    </row>
	    <row>
	      <entry>10</entry><entry>int16_t</entry><entry>temp</entry><entry>temperature sensor</entry>
	    </row>
	    <row>
	      <entry>12</entry><entry>int16_t</entry><entry>v_batt</entry><entry>battery voltage</entry>
	    </row>
	    <row>
	      <entry>14</entry><entry>int16_t</entry><entry>sense_d</entry><entry>drogue continuity sense (TM/Tm)</entry>
	    </row>
	    <row>
	      <entry>16</entry><entry>int16_t</entry><entry>sense_m</entry><entry>main continuity sense (TM/Tm)</entry>
	    </row>
	    <row>
	      <entry>18</entry><entry>int16_t</entry><entry>acceleration</entry><entry>m/s² * 16</entry>
	    </row>
	    <row>
	      <entry>20</entry><entry>int16_t</entry><entry>speed</entry><entry>m/s * 16</entry>
	    </row>
	    <row>
	      <entry>22</entry><entry>int16_t</entry><entry>height</entry><entry>m</entry>
	    </row>
	    <row>
	      <entry>24</entry><entry>int16_t</entry><entry>ground_pres</entry><entry>Average barometer reading on ground</entry>
	    </row>
	    <row>
	      <entry>26</entry><entry>int16_t</entry><entry>ground_accel</entry><entry>TM</entry>
	    </row>
	    <row>
	      <entry>28</entry><entry>int16_t</entry><entry>accel_plus_g</entry><entry>TM</entry>
	    </row>
	    <row>
	      <entry>30</entry><entry>int16_t</entry><entry>accel_minus_g</entry><entry>TM</entry>
	    </row>
	    <row>
	      <entry>32</entry>
	    </row>
	  </tbody>
	</tgroup>
      </table>
    </section>
    <section>
      <title>Configuration Data</title>
      <informaltable frame='none' label='' tocentry='0'>
	<tgroup cols='2' align='center' colsep='1' rowsep='1'>
	  <colspec align='center' colwidth='*' colname='Offset'/>
	  <colspec align='left' colwidth='3*' colname='Description'/>
	  <thead>
	    <row>
	      <entry>Type</entry>
	      <entry>Description</entry>
	    </row>
	  </thead>
	  <tbody>
	    <row>
	      <entry>0x04</entry>
	      <entry>Configuration Data</entry>
	    </row>
	  </tbody>
	</tgroup>
      </informaltable>
      <para>
	This provides a description of the software installed on the
	flight computer as well as any user-specified configuration data.
      </para>
      <para>
	Configuration data packets are transmitted once per second
	during all phases of the flight
      </para>
      <table frame='all'>
	<title>Sensor Packet Contents</title>
	<tgroup cols='4' align='center' colsep='1' rowsep='1'>
	  <colspec align='center' colwidth='*' colname='Offset'/>
	  <colspec align='center' colwidth='3*' colname='Data Type'/>
	  <colspec align='left' colwidth='3*' colname='Name'/>
	  <colspec align='left' colwidth='9*' colname='Description'/>
	  <thead>
	    <row>
	      <entry align='center'>Offset</entry>
	      <entry align='center'>Data Type</entry>
	      <entry align='center'>Name</entry>
	      <entry align='center'>Description</entry>
	    </row>
	  </thead>
	  <tbody>
	    <row>
	      <entry>5</entry><entry>uint8_t</entry><entry>type</entry><entry>Device type</entry>
	    </row>
	    <row>
	      <entry>6</entry><entry>uint16_t</entry><entry>flight</entry><entry>Flight number</entry>
	    </row>
	    <row>
	      <entry>8</entry><entry>uint8_t</entry><entry>config_major</entry><entry>Config major version</entry>
	    </row>
	    <row>
	      <entry>9</entry><entry>uint8_t</entry><entry>config_minor</entry><entry>Config minor version</entry>
	    </row>
	    <row>
	      <entry>10</entry><entry>uint16_t</entry><entry>apogee_delay</entry>
	      <entry>Apogee deploy delay in seconds</entry>
	    </row>
	    <row>
	      <entry>12</entry><entry>uint16_t</entry><entry>main_deploy</entry><entry>Main deploy alt in meters</entry>
	    </row>
	    <row>
	      <entry>14</entry><entry>uint16_t</entry><entry>flight_log_max</entry>
	      <entry>Maximum flight log size (kB)</entry>
	    </row>
	    <row>
	      <entry>16</entry><entry>char</entry><entry>callsign[8]</entry><entry>Radio operator identifier</entry>
	    </row>
	    <row>
	      <entry>24</entry><entry>char</entry><entry>version[8]</entry><entry>Software version identifier</entry>
	    </row>
	    <row>
	      <entry>32</entry>
	    </row>
	  </tbody>
	</tgroup>
      </table>
    </section>
    <section>
      <title>GPS Location</title>
      <informaltable frame='none' label='' tocentry='0'>
	<tgroup cols='2' align='center' colsep='1' rowsep='1'>
	  <colspec align='center' colwidth='*' colname='Offset'/>
	  <colspec align='left' colwidth='3*' colname='Description'/>
	  <thead>
	    <row>
	      <entry>Type</entry>
	      <entry>Description</entry>
	    </row>
	  </thead>
	  <tbody>
	    <row>
	      <entry>0x05</entry>
	      <entry>GPS Location</entry>
	    </row>
	  </tbody>
	</tgroup>
      </informaltable>
      <para>
	This packet provides all of the information available from the
	Venus SkyTraq GPS receiver—position, time, speed and precision
	estimates. 
      </para>
      <para>
	GPS Location packets are transmitted once per second during
	all phases of the flight
      </para>
      <table frame='all'>
	<title>GPS Location Packet Contents</title>
	<tgroup cols='4' align='center' colsep='1' rowsep='1'>
	  <colspec align='center' colwidth='*' colname='Offset'/>
	  <colspec align='center' colwidth='3*' colname='Data Type'/>
	  <colspec align='left' colwidth='3*' colname='Name'/>
	  <colspec align='left' colwidth='9*' colname='Description'/>
	  <thead>
	    <row>
	      <entry align='center'>Offset</entry>
	      <entry align='center'>Data Type</entry>
	      <entry align='center'>Name</entry>
	      <entry align='center'>Description</entry>
	    </row>
	  </thead>
	  <tbody>
	    <row>
	      <entry>5</entry><entry>uint8_t</entry><entry>flags</entry>
	      <entry>See GPS Flags table below</entry>
	    </row>
	    <row>
	      <entry>6</entry><entry>int16_t</entry><entry>altitude</entry><entry>m</entry>
	    </row>
	    <row>
	      <entry>8</entry><entry>int32_t</entry><entry>latitude</entry><entry>degrees * 10<superscript>7</superscript></entry>
	    </row>
	    <row>
	      <entry>12</entry><entry>int32_t</entry><entry>longitude</entry><entry>degrees * 10<superscript>7</superscript></entry>
	    </row>
	    <row>
	      <entry>16</entry><entry>uint8_t</entry><entry>year</entry>
	    </row>
	    <row>
	      <entry>17</entry><entry>uint8_t</entry><entry>month</entry>
	    </row>
	    <row>
	      <entry>18</entry><entry>uint8_t</entry><entry>day</entry>
	    </row>
	    <row>
	      <entry>19</entry><entry>uint8_t</entry><entry>hour</entry>
	    </row>
	    <row>
	      <entry>20</entry><entry>uint8_t</entry><entry>minute</entry>
	    </row>
	    <row>
	      <entry>21</entry><entry>uint8_t</entry><entry>second</entry>
	    </row>
	    <row>
	      <entry>22</entry><entry>uint8_t</entry><entry>pdop</entry><entry>* 5</entry>
	    </row>
	    <row>
	      <entry>23</entry><entry>uint8_t</entry><entry>hdop</entry><entry>* 5</entry>
	    </row>
	    <row>
	      <entry>24</entry><entry>uint8_t</entry><entry>vdop</entry><entry>* 5</entry>
	    </row>
	    <row>
	      <entry>25</entry><entry>uint8_t</entry><entry>mode</entry>
	      <entry>See GPS Mode table below</entry>
	    </row>
	    <row>
	      <entry>26</entry><entry>uint16_t</entry><entry>ground_speed</entry><entry>cm/s</entry>
	    </row>
	    <row>
	      <entry>28</entry><entry>int16_t</entry><entry>climb_rate</entry><entry>cm/s</entry>
	    </row>
	    <row>
	      <entry>30</entry><entry>uint8_t</entry><entry>course</entry><entry>/ 2</entry>
	    </row>
	    <row>
	      <entry>31</entry><entry>uint8_t</entry><entry>unused[1]</entry>
	    </row>
	    <row>
	      <entry>32</entry>
	    </row>
	  </tbody>
	</tgroup>
      </table>
      <para>
	Packed into a one byte field are status flags and the count of
	satellites used to compute the position fix. Note that this
	number may be lower than the number of satellites being
	tracked; the receiver will not use information from satellites
	with weak signals or which are close enough to the horizon to
	have significantly degraded position accuracy.
      </para>
      <table frame='all'>
	<title>GPS Flags</title>
	<tgroup cols='3' colsep='1' rowsep='1'>
	  <colspec align='center' colwidth='*' colname='bits'/>
	  <colspec align='left' colwidth='2*' colname='name'/>
	  <colspec align='left' colwidth='7*' colname='description'/>
	  <thead>
	    <row>
	      <entry align='center'>Bits</entry>
	      <entry align='center'>Name</entry>
	      <entry align='center'>Description</entry>
	    </row>
	  </thead>
	  <tbody>
	    <row>
	      <entry>0-3</entry>
	      <entry>nsats</entry>
	      <entry>Number of satellites in solution</entry>
	    </row>
	    <row>
	      <entry>4</entry>
	      <entry>valid</entry>
	      <entry>GPS solution is valid</entry>
	    </row>
	    <row>
	      <entry>5</entry>
	      <entry>running</entry>
	      <entry>GPS receiver is operational</entry>
	    </row>
	    <row>
	      <entry>6</entry>
	      <entry>date_valid</entry>
	      <entry>Reported date is valid</entry>
	    </row>
	    <row>
	      <entry>7</entry>
	      <entry>course_valid</entry>
	      <entry>ground speed, course and climb rates are valid</entry>
	    </row>
	  </tbody>
	</tgroup>
      </table>
      <para>
	Here are all of the valid GPS operational modes. Altus Metrum
	products will only ever report 'N' (not valid), 'A'
	(Autonomous) modes or 'E' (Estimated). The remaining modes
	are either testing modes or require additional data.
      </para>
      <table frame='all'>
	<title>GPS Mode</title>
	<tgroup cols='3' colsep='1' rowsep='1'>
	  <colspec align='center' colwidth='*' colname='value'/>
	  <colspec align='center' colwidth='3*' colname='name'/>
	  <colspec align='left' colwidth='7*' colname='description'/>
	  <thead>
	    <row>
	      <entry align='center'>Mode</entry>
	      <entry align='center'>Name</entry>
	      <entry align='center'>Decsription</entry>
	    </row>
	  </thead>
	  <tbody>
	    <row>
	      <entry>N</entry>
	      <entry>Not Valid</entry>
	      <entry>All data are invalid</entry>
	    </row>
	    <row>
	      <entry>A</entry>
	      <entry>Autonomous mode</entry>
	      <entry>Data are derived from satellite data</entry>
	    </row>
	    <row>
	      <entry>D</entry>
	      <entry>Differential Mode</entry>
	      <entry>
		  Data are augmented with differential data from a
		  known ground station. The SkyTraq unit in TeleMetrum
		  does not support this mode
		</entry>
	    </row>
	    <row>
	      <entry>E</entry>
	      <entry>Estimated</entry>
	      <entry>
		  Data are estimated using dead reckoning from the
		  last known data
		</entry>
	    </row>
	    <row>
	      <entry>M</entry>
	      <entry>Manual</entry>
	      <entry>Data were entered manually</entry>
	    </row>
	    <row>
	      <entry>S</entry>
	      <entry>Simulated</entry>
	      <entry>GPS receiver testing mode</entry>
	    </row>
	  </tbody>
	</tgroup>
      </table>
    </section>
    <section>
      <title>GPS Satellite Data</title>
      <informaltable frame='none' label='' tocentry='0'>
	<tgroup cols='2' align='center' colsep='1' rowsep='1'>
	  <colspec align='center' colwidth='*' colname='Offset'/>
	  <colspec align='left' colwidth='3*' colname='Description'/>
	  <thead>
	    <row>
	      <entry>Type</entry>
	      <entry>Description</entry>
	    </row>
	  </thead>
	  <tbody>
	    <row>
	      <entry>0x06</entry>
	      <entry>GPS Satellite Data</entry>
	    </row>
	  </tbody>
	</tgroup>
      </informaltable>
      <para>
	This packet provides space vehicle identifiers and signal
	quality information in the form of a C/N1 number for up to 12
	satellites. The order of the svids is not specified.
      </para>
      <para>
	GPS Satellite data are transmitted once per second during all
	phases of the flight.
      </para>
      <table frame='all'>
	<title>GPS Satellite Data Contents</title>
	<tgroup cols='4' align='center' colsep='1' rowsep='1'>
	  <colspec align='right' colwidth='*' colname='Offset'/>
	  <colspec align='center' colwidth='3*' colname='Data Type'/>
	  <colspec align='left' colwidth='3*' colname='Name'/>
	  <colspec align='left' colwidth='9*' colname='Description'/>
	  <thead>
	    <row>
	      <entry align='center'>Offset</entry>
	      <entry align='center'>Data Type</entry>
	      <entry align='center'>Name</entry>
	      <entry align='center'>Description</entry>
	    </row>
	  </thead>
	  <tbody>
	    <row>
	      <entry>5</entry><entry>uint8_t</entry><entry>channels</entry>
	      <entry>Number of reported satellite information</entry>
	    </row>
	    <row>
	      <entry>6</entry><entry>sat_info_t</entry><entry>sats[12]</entry>
	      <entry>See Per-Satellite data table below</entry>
	    </row>
	    <row>
	      <entry>30</entry><entry>uint8_t</entry><entry>unused[2]</entry>
	    </row>
	    <row>
	      <entry>32</entry>
	    </row>
	  </tbody>
	</tgroup>
      </table>
      <table frame='all'>
	<title>GPS Per-Satellite data (sat_info_t)</title>
	<tgroup cols='4' align='center' colsep='1' rowsep='1'>
	  <colspec align='right' colwidth='*' colname='Offset'/>
	  <colspec align='center' colwidth='3*' colname='Data Type'/>
	  <colspec align='left' colwidth='3*' colname='Name'/>
	  <colspec align='left' colwidth='9*' colname='Description'/>
	  <thead>
	    <row>
	      <entry align='center'>Offset</entry>
	      <entry align='center'>Data Type</entry>
	      <entry align='center'>Name</entry>
	      <entry align='center'>Description</entry>
	    </row>
	  </thead>
	  <tbody>
	    <row>
	      <entry>0</entry><entry>uint8_t</entry><entry>svid</entry>
	      <entry>Space Vehicle Identifier</entry>
	    </row>
	    <row>
	      <entry>1</entry><entry>uint8_t</entry><entry>c_n_1</entry>
	      <entry>C/N1 signal quality indicator</entry>
	    </row>
	    <row>
	      <entry>2</entry>
	    </row>
	  </tbody>
	</tgroup>
      </table>
    </section>
  </section>
  <section>
    <title>Data Transmission</title>
    <para>
      Altus Metrum devices use the Texas Instruments CC1111
      microcontroller which includes an integrated sub-GHz digital
      transceiver. This transceiver is used to both transmit and
      receive the telemetry packets. This section discusses what
      modulation scheme is used and how this device is configured.
    </para>
    <section>
      <title>Modulation Scheme</title>
      <para>
	Texas Instruments provides a tool for computing modulation
	parameters given a desired modulation format and basic bit
	rate. For AltOS, the basic bit rate was specified as 38 kBaud,
	resulting in the following signal parmeters:
      </para>
      <table>
	<title>Modulation Scheme</title>
	<tgroup cols='3'>
	  <colspec align="center" colwidth="*" colname="parameter"/>
	  <colspec align="center" colwidth="*" colname="value"/>
	  <colspec align="center" colwidth="*" colname="description"/>
	  <thead>
	    <row>
	      <entry align='center'>Parameter</entry>
	      <entry align='center'>Value</entry>
	      <entry align='center'>Description</entry>
	    </row>
	  </thead>
	  <tbody>
	    <row>
	      <entry>Modulation</entry>
	      <entry>GFSK</entry>
	      <entry>Gaussian Frequency Shift Keying</entry>
	    </row>
	    <row>
	      <entry>Deviation</entry>
	      <entry>20.507812 kHz</entry>
	      <entry>Frequency modulation</entry>
	    </row>
	    <row>
	      <entry>Data rate</entry>
	      <entry>38.360596 kBaud</entry>
	      <entry>Raw bit rate</entry>
	    </row>
	    <row>
	      <entry>RX Filter Bandwidth</entry>
	      <entry>93.75 kHz</entry>
	      <entry>Receiver Band pass filter bandwidth</entry>
	    </row>
	    <row>
	      <entry>IF Frequency</entry>
	      <entry>140.62 kHz</entry>
	      <entry>Receiver intermediate frequency</entry>
	    </row>
	  </tbody>
	</tgroup>
      </table>
    </section>
    <section>
      <title>Error Correction</title>
      <para>
	The cc1111 provides forward error correction in hardware,
	which AltOS uses to improve reception of weak signals. The
	overall effect of this is to halve the available bandwidth for
	data from 38 kBaud to 19 kBaud.
      </para>
      <table>
	<title>Error Correction</title>
	<tgroup cols='3'>
	  <colspec align="center" colwidth="*" colname="parameter"/>
	  <colspec align="center" colwidth="*" colname="value"/>
	  <colspec align="center" colwidth="*" colname="description"/>
	  <thead>
	    <row>
	      <entry align='center'>Parameter</entry>
	      <entry align='center'>Value</entry>
	      <entry align='center'>Description</entry>
	    </row>
	  </thead>
	  <tbody>
	    <row>
	      <entry>Error Correction</entry>
	      <entry>Convolutional coding</entry>
	      <entry>1/2 rate, constraint length m=4</entry>
	    </row>
	    <row>
	      <entry>Interleaving</entry>
	      <entry>4 x 4</entry>
	      <entry>Reduce effect of noise burst</entry>
	    </row>
	    <row>
	      <entry>Data Whitening</entry>
	      <entry>XOR with 9-bit PNR</entry>
	      <entry>Rotate right with bit 8 = bit 0 xor bit 5, initial
	      value 111111111</entry>
	    </row>
	  </tbody>
	</tgroup>
      </table>
    </section>
  </section>
  <section>
    <title>TeleDongle packet format</title>
    <para>
      TeleDongle does not do any interpretation of the packet data,
      instead it is configured to receive packets of a specified
      length (32 bytes in this case). For each received packet,
      TeleDongle produces a single line of text. This line starts with
      the string "TELEM " and is followed by a list of hexadecimal
      encoded bytes.
    </para>
    <programlisting>TELEM 224f01080b05765e00701f1a1bbeb8d7b60b070605140c000600000000000000003fa988</programlisting>
    <para>
      The hexadecimal encoded string of bytes contains a length byte,
      the packet data, two bytes added by the cc1111 radio receiver
      hardware and finally a checksum so that the host software can
      validate that the line was transmitted without any errors.
    </para>
    <table>
      <title>Packet Format</title>
      <tgroup cols='4'>
	<colspec align="center" colwidth="2*" colname="offset"/>
	<colspec align="center" colwidth="*" colname="name"/>
	<colspec align="center" colwidth="*" colname="value"/>
	<colspec align="center" colwidth="5*" colname="description"/>
	<thead>
	  <row>
	    <entry align='center'>Offset</entry>
	    <entry align='center'>Name</entry>
	    <entry align='center'>Example</entry>
	    <entry align='center'>Description</entry>
	  </row>
	</thead>
	<tbody>
	  <row>
	    <entry>0</entry>
	    <entry>length</entry>
	    <entry>22</entry>
	    <entry>Total length of data bytes in the line. Note that
	    this includes the added RSSI and status bytes</entry>
	  </row>
	  <row>
	    <entry>1 ·· length-3</entry>
	    <entry>packet</entry>
	    <entry>4f ·· 00</entry>
	    <entry>Bytes of actual packet data</entry>
	  </row>
	  <row>
	    <entry>length-2</entry>
	    <entry>rssi</entry>
	    <entry>3f</entry>
	    <entry>Received signal strength. dBm = rssi / 2 - 74</entry>
	  </row>
	  <row>
	    <entry>length-1</entry>
	    <entry>lqi</entry>
	    <entry>a9</entry>
	    <entry>Link Quality Indicator and CRC status. Bit 7
	    is set when the CRC is correct</entry>
	  </row>
	  <row>
	    <entry>length</entry>
	    <entry>checksum</entry>
	    <entry>88</entry>
	    <entry>(0x5a + sum(bytes 1 ·· length-1)) % 256</entry>
	  </row>
	</tbody>
      </tgroup>
    </table>
  </section>
  <section>
    <title>History and Motivation</title>
    <para>
      The original AltoOS telemetry mechanism encoded everything
      available piece of information on the TeleMetrum hardware into a
      single unified packet. Initially, the packets contained very
      little data—some raw sensor readings along with the current GPS
      coordinates when a GPS receiver was connected. Over time, the
      amount of data grew to include sensor calibration data, GPS
      satellite information and a host of internal state information
      designed to help diagnose flight failures in case of a loss of
      the on-board flight data.
    </para>
    <para>
      Because every packet contained all of the data, packets were
      huge—95 bytes long. Much of the information was also specific to
      the TeleMetrum hardware. With the introduction of the TeleMini
      flight computer, most of the data contained in the telemetry
      packets was unavailable. Initially, a shorter, but still
      comprehensive packet was implemented. This required that the
      ground station be pre-configured as to which kind of packet to
      expect.
    </para>
    <para>
      The development of several companion boards also made the
      shortcomings evident—each companion board would want to include
      telemetry data in the radio link; with the original design, the
      packet would have to hold the new data as well, requiring
      additional TeleMetrum and ground station changes.
    </para>
  </section>
</article>