git.gag.com Git - fw/altos/blob - doc/telemetry.xsl

   1 <?xml version="1.0" encoding="utf-8" ?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3 "/usr/share/xml/docbook/schema/dtd/4.5/docbookx.dtd">
   4
   5 <article>
   6   <articleinfo>
   7     <title>AltOS Telemetry</title>
   8     <subtitle>Packet Definitions</subtitle>
   9     <author>
  10       <firstname>Keith</firstname>
  11       <surname>Packard</surname>
  12     </author>
  13     <copyright>
  14       <year>2011</year>
  15       <holder>Keith Packard</holder>
  16     </copyright>
  17     <legalnotice>
  18       <para>
  19         This document is released under the terms of the
  20         <ulink url="http://creativecommons.org/licenses/by-sa/3.0/">
  21           Creative Commons ShareAlike 3.0
  22         </ulink>
  23         license.
  24       </para>
  25     </legalnotice>
  26     <revhistory>
  27       <revision>
  28         <revnumber>0.1</revnumber>
  29         <date>01 July 2011</date>
  30         <revremark>Initial content</revremark>
  31       </revision>
  32     </revhistory>
  33   </articleinfo>
  34   <section>
  35     <title>Packet Format Design</title>
  36     <para>
  37       AltOS telemetry data is split into multiple different packets,
  38       all the same size, but each includs an identifier so that the
  39       ground station can distinguish among different types. A single
  40       flight board will transmit multiple packet types, each type on a
  41       different schedule. The ground software need look for only a
  42       single packet size, and then decode the information within the
  43       packet and merge data from multiple packets to construct the
  44       full flight computer state.
  45     </para>
  46     <para>
  47       Each AltOS packet is 32 bytes long. This size was chosen based
  48       on the known telemetry data requirements. The power of two size
  49       allows them to be stored easily in flash memory without having
  50       them split across blocks or leaving gaps at the end.
  51     </para>
  52     <para>
  53       All packet types start with a five byte header which encodes the
  54       device serial number, device clock value and the packet
  55       type. The remaining 27 bytes encode type-specific data.
  56     </para>
  57   </section>
  58   <section>
  59     <title>Packet Formats</title>
  60     This section first defines the packet header common to all packets
  61     and then the per-packet data layout.
  62     <section>
  63       <title>Packet Header</title>
  64       <table frame='all'>
  65         <title>Telemetry Packet Header</title>
  66         <tgroup cols='4' align='center' colsep='1' rowsep='1'>
  67           <colspec align='center' colwidth='*' colname='Offset'/>
  68           <colspec align='center' colwidth='3*' colname='Data Type'/>
  69           <colspec align='left' colwidth='3*' colname='Name'/>
  70           <colspec align='left' colwidth='9*' colname='Description'/>
  71           <thead>
  72             <row>
  73               <entry align='center'>Offset</entry>
  74               <entry align='center'>Data Type</entry>
  75               <entry align='center'>Name</entry>
  76               <entry align='center'>Description</entry>
  77             </row>
  78           </thead>
  79           <tbody>
  80             <row>
  81               <entry>0</entry>
  82               <entry>uint16_t</entry>
  83               <entry>serial</entry>
  84               <entry>Device serial Number</entry>
  85             </row>
  86             <row>
  87               <entry>2</entry>
  88               <entry>uint16_t</entry>
  89               <entry>tick</entry>
  90               <entry>Device time in 100ths of a second</entry>
  91             </row>
  92             <row>
  93               <entry>4</entry>
  94               <entry>uint8_t</entry>
  95               <entry>type</entry>
  96               <entry>Packet type</entry>
  97             </row>
  98             <row>
  99               <entry>5</entry>
 100             </row>
 101           </tbody>
 102         </tgroup>
 103       </table>
 104       <para>
 105       Each packet starts with these five bytes which serve to identify
 106       which device has transmitted the packet, when it was transmitted
 107       and what the rest of the packet contains.
 108       </para>
 109     </section>
 110     <section>
 111       <title>Sensor Data</title>
 112       <informaltable frame='none' label='' tocentry='0'>
 113         <tgroup cols='2' align='center' colsep='1' rowsep='1'>
 114           <colspec align='center' colwidth='*' colname='Offset'/>
 115           <colspec align='left' colwidth='3*' colname='Description'/>
 116           <thead>
 117             <row>
 118               <entry>Type</entry>
 119               <entry>Description</entry>
 120             </row>
 121           </thead>
 122           <tbody>
 123             <row>
 124               <entry>0x01</entry>
 125               <entry>TeleMetrum Sensor Data</entry>
 126             </row>
 127             <row>
 128               <entry>0x02</entry>
 129               <entry>TeleMini Sensor Data</entry>
 130             </row>
 131             <row>
 132               <entry>0x03</entry>
 133               <entry>TeleNano Sensor Data</entry>
 134             </row>
 135           </tbody>
 136         </tgroup>
 137       </informaltable>
 138       <para>
 139         TeleMetrum, TeleMini and TeleNano share this same packet
 140         format for sensor data. Each uses a distinct packet type so
 141         that the receiver knows which data values are valid and which
 142         are undefined.
 143       </para>
 144       <para>
 145         Sensor Data packets are transmitted once per second on the
 146         ground, 10 times per second during ascent and once per second
 147         during descent and landing
 148       </para>
 149       <table frame='all'>
 150         <title>Sensor Packet Contents</title>
 151         <tgroup cols='4' align='center' colsep='1' rowsep='1'>
 152           <colspec align='center' colwidth='*' colname='Offset'/>
 153           <colspec align='center' colwidth='3*' colname='Data Type'/>
 154           <colspec align='left' colwidth='3*' colname='Name'/>
 155           <colspec align='left' colwidth='9*' colname='Description'/>
 156           <thead>
 157             <row>
 158               <entry align='center'>Offset</entry>
 159               <entry align='center'>Data Type</entry>
 160               <entry align='center'>Name</entry>
 161               <entry align='center'>Description</entry>
 162             </row>
 163           </thead>
 164           <tbody>
 165             <row>
 166               <entry>5</entry><entry>uint8_t</entry><entry>state</entry><entry>Flight state</entry>
 167             </row>
 168             <row>
 169               <entry>6</entry><entry>int16_t</entry><entry>accel</entry><entry>accelerometer (TM only)</entry>
 170             </row>
 171             <row>
 172               <entry>8</entry><entry>int16_t</entry><entry>pres</entry><entry>pressure sensor</entry>
 173             </row>
 174             <row>
 175               <entry>10</entry><entry>int16_t</entry><entry>temp</entry><entry>temperature sensor</entry>
 176             </row>
 177             <row>
 178               <entry>12</entry><entry>int16_t</entry><entry>v_batt</entry><entry>battery voltage</entry>
 179             </row>
 180             <row>
 181               <entry>14</entry><entry>int16_t</entry><entry>sense_d</entry><entry>drogue continuity sense (TM/Tm)</entry>
 182             </row>
 183             <row>
 184               <entry>16</entry><entry>int16_t</entry><entry>sense_m</entry><entry>main continuity sense (TM/Tm)</entry>
 185             </row>
 186             <row>
 187               <entry>18</entry><entry>int16_t</entry><entry>acceleration</entry><entry>m/s² * 16</entry>
 188             </row>
 189             <row>
 190               <entry>20</entry><entry>int16_t</entry><entry>speed</entry><entry>m/s * 16</entry>
 191             </row>
 192             <row>
 193               <entry>22</entry><entry>int16_t</entry><entry>height</entry><entry>m</entry>
 194             </row>
 195             <row>
 196               <entry>24</entry><entry>int16_t</entry><entry>ground_pres</entry><entry>Average barometer reading on ground</entry>
 197             </row>
 198             <row>
 199               <entry>26</entry><entry>int16_t</entry><entry>ground_accel</entry><entry>TM</entry>
 200             </row>
 201             <row>
 202               <entry>28</entry><entry>int16_t</entry><entry>accel_plus_g</entry><entry>TM</entry>
 203             </row>
 204             <row>
 205               <entry>30</entry><entry>int16_t</entry><entry>accel_minus_g</entry><entry>TM</entry>
 206             </row>
 207             <row>
 208               <entry>32</entry>
 209             </row>
 210           </tbody>
 211         </tgroup>
 212       </table>
 213     </section>
 214     <section>
 215       <title>Configuration Data</title>
 216       <informaltable frame='none' label='' tocentry='0'>
 217         <tgroup cols='2' align='center' colsep='1' rowsep='1'>
 218           <colspec align='center' colwidth='*' colname='Offset'/>
 219           <colspec align='left' colwidth='3*' colname='Description'/>
 220           <thead>
 221             <row>
 222               <entry>Type</entry>
 223               <entry>Description</entry>
 224             </row>
 225           </thead>
 226           <tbody>
 227             <row>
 228               <entry>0x04</entry>
 229               <entry>Configuration Data</entry>
 230             </row>
 231           </tbody>
 232         </tgroup>
 233       </informaltable>
 234       <para>
 235         This provides a description of the software installed on the
 236         flight computer as well as any user-specified configuration data.
 237       </para>
 238       <para>
 239         Configuration data packets are transmitted once per second
 240         during all phases of the flight
 241       </para>
 242       <table frame='all'>
 243         <title>Sensor Packet Contents</title>
 244         <tgroup cols='4' align='center' colsep='1' rowsep='1'>
 245           <colspec align='center' colwidth='*' colname='Offset'/>
 246           <colspec align='center' colwidth='3*' colname='Data Type'/>
 247           <colspec align='left' colwidth='3*' colname='Name'/>
 248           <colspec align='left' colwidth='9*' colname='Description'/>
 249           <thead>
 250             <row>
 251               <entry align='center'>Offset</entry>
 252               <entry align='center'>Data Type</entry>
 253               <entry align='center'>Name</entry>
 254               <entry align='center'>Description</entry>
 255             </row>
 256           </thead>
 257           <tbody>
 258             <row>
 259               <entry>5</entry><entry>uint8_t</entry><entry>type</entry><entry>Device type</entry>
 260             </row>
 261             <row>
 262               <entry>6</entry><entry>uint16_t</entry><entry>flight</entry><entry>Flight number</entry>
 263             </row>
 264             <row>
 265               <entry>8</entry><entry>uint8_t</entry><entry>config_major</entry><entry>Config major version</entry>
 266             </row>
 267             <row>
 268               <entry>9</entry><entry>uint8_t</entry><entry>config_minor</entry><entry>Config minor version</entry>
 269             </row>
 270             <row>
 271               <entry>10</entry><entry>uint16_t</entry><entry>apogee_delay</entry>
 272               <entry>Apogee deploy delay in seconds</entry>
 273             </row>
 274             <row>
 275               <entry>12</entry><entry>uint16_t</entry><entry>main_deploy</entry><entry>Main deploy alt in meters</entry>
 276             </row>
 277             <row>
 278               <entry>14</entry><entry>uint16_t</entry><entry>flight_log_max</entry>
 279               <entry>Maximum flight log size (kB)</entry>
 280             </row>
 281             <row>
 282               <entry>16</entry><entry>char</entry><entry>callsign[8]</entry><entry>Radio operator identifier</entry>
 283             </row>
 284             <row>
 285               <entry>24</entry><entry>char</entry><entry>version[8]</entry><entry>Software version identifier</entry>
 286             </row>
 287             <row>
 288               <entry>32</entry>
 289             </row>
 290           </tbody>
 291         </tgroup>
 292       </table>
 293     </section>
 294     <section>
 295       <title>GPS Location</title>
 296       <informaltable frame='none' label='' tocentry='0'>
 297         <tgroup cols='2' align='center' colsep='1' rowsep='1'>
 298           <colspec align='center' colwidth='*' colname='Offset'/>
 299           <colspec align='left' colwidth='3*' colname='Description'/>
 300           <thead>
 301             <row>
 302               <entry>Type</entry>
 303               <entry>Description</entry>
 304             </row>
 305           </thead>
 306           <tbody>
 307             <row>
 308               <entry>0x05</entry>
 309               <entry>GPS Location</entry>
 310             </row>
 311           </tbody>
 312         </tgroup>
 313       </informaltable>
 314       <para>
 315         This packet provides all of the information available from the
 316         Venus SkyTraq GPS receiver—position, time, speed and precision
 317         estimates.
 318       </para>
 319       <para>
 320         GPS Location packets are transmitted once per second during
 321         all phases of the flight
 322       </para>
 323       <table frame='all'>
 324         <title>GPS Location Packet Contents</title>
 325         <tgroup cols='4' align='center' colsep='1' rowsep='1'>
 326           <colspec align='center' colwidth='*' colname='Offset'/>
 327           <colspec align='center' colwidth='3*' colname='Data Type'/>
 328           <colspec align='left' colwidth='3*' colname='Name'/>
 329           <colspec align='left' colwidth='9*' colname='Description'/>
 330           <thead>
 331             <row>
 332               <entry align='center'>Offset</entry>
 333               <entry align='center'>Data Type</entry>
 334               <entry align='center'>Name</entry>
 335               <entry align='center'>Description</entry>
 336             </row>
 337           </thead>
 338           <tbody>
 339             <row>
 340               <entry>5</entry><entry>uint8_t</entry><entry>flags</entry>
 341               <entry>See GPS Flags table below</entry>
 342             </row>
 343             <row>
 344               <entry>6</entry><entry>int16_t</entry><entry>altitude</entry><entry>m</entry>
 345             </row>
 346             <row>
 347               <entry>8</entry><entry>int32_t</entry><entry>latitude</entry><entry>degrees * 10<superscript>7</superscript></entry>
 348             </row>
 349             <row>
 350               <entry>12</entry><entry>int32_t</entry><entry>longitude</entry><entry>degrees * 10<superscript>7</superscript></entry>
 351             </row>
 352             <row>
 353               <entry>16</entry><entry>uint8_t</entry><entry>year</entry>
 354             </row>
 355             <row>
 356               <entry>17</entry><entry>uint8_t</entry><entry>month</entry>
 357             </row>
 358             <row>
 359               <entry>18</entry><entry>uint8_t</entry><entry>day</entry>
 360             </row>
 361             <row>
 362               <entry>19</entry><entry>uint8_t</entry><entry>hour</entry>
 363             </row>
 364             <row>
 365               <entry>20</entry><entry>uint8_t</entry><entry>minute</entry>
 366             </row>
 367             <row>
 368               <entry>21</entry><entry>uint8_t</entry><entry>second</entry>
 369             </row>
 370             <row>
 371               <entry>22</entry><entry>uint8_t</entry><entry>pdop</entry><entry>* 5</entry>
 372             </row>
 373             <row>
 374               <entry>23</entry><entry>uint8_t</entry><entry>hdop</entry><entry>* 5</entry>
 375             </row>
 376             <row>
 377               <entry>24</entry><entry>uint8_t</entry><entry>vdop</entry><entry>* 5</entry>
 378             </row>
 379             <row>
 380               <entry>25</entry><entry>uint8_t</entry><entry>mode</entry>
 381               <entry>See GPS Mode table below</entry>
 382             </row>
 383             <row>
 384               <entry>26</entry><entry>uint16_t</entry><entry>ground_speed</entry><entry>cm/s</entry>
 385             </row>
 386             <row>
 387               <entry>28</entry><entry>int16_t</entry><entry>climb_rate</entry><entry>cm/s</entry>
 388             </row>
 389             <row>
 390               <entry>30</entry><entry>uint8_t</entry><entry>course</entry><entry>/ 2</entry>
 391             </row>
 392             <row>
 393               <entry>31</entry><entry>uint8_t</entry><entry>unused[1]</entry>
 394             </row>
 395             <row>
 396               <entry>32</entry>
 397             </row>
 398           </tbody>
 399         </tgroup>
 400       </table>
 401       <para>
 402         Packed into a one byte field are status flags and the count of
 403         satellites used to compute the position fix. Note that this
 404         number may be lower than the number of satellites being
 405         tracked; the receiver will not use information from satellites
 406         with weak signals or which are close enough to the horizon to
 407         have significantly degraded position accuracy.
 408       </para>
 409       <table frame='all'>
 410         <title>GPS Flags</title>
 411         <tgroup cols='3' colsep='1' rowsep='1'>
 412           <colspec align='center' colwidth='*' colname='bits'/>
 413           <colspec align='left' colwidth='2*' colname='name'/>
 414           <colspec align='left' colwidth='7*' colname='description'/>
 415           <thead>
 416             <row>
 417               <entry align='center'>Bits</entry>
 418               <entry align='center'>Name</entry>
 419               <entry align='center'>Description</entry>
 420             </row>
 421           </thead>
 422           <tbody>
 423             <row>
 424               <entry>0-3</entry>
 425               <entry>nsats</entry>
 426               <entry>Number of satellites in solution</entry>
 427             </row>
 428             <row>
 429               <entry>4</entry>
 430               <entry>valid</entry>
 431               <entry>GPS solution is valid</entry>
 432             </row>
 433             <row>
 434               <entry>5</entry>
 435               <entry>running</entry>
 436               <entry>GPS receiver is operational</entry>
 437             </row>
 438             <row>
 439               <entry>6</entry>
 440               <entry>date_valid</entry>
 441               <entry>Reported date is valid</entry>
 442             </row>
 443             <row>
 444               <entry>7</entry>
 445               <entry>course_valid</entry>
 446               <entry>ground speed, course and climb rates are valid</entry>
 447             </row>
 448           </tbody>
 449         </tgroup>
 450       </table>
 451       <para>
 452         Here are all of the valid GPS operational modes. Altus Metrum
 453         products will only ever report 'N' (not valid), 'A'
 454         (Autonomous) modes or 'E' (Estimated). The remaining modes
 455         are either testing modes or require additional data.
 456       </para>
 457       <table frame='all'>
 458         <title>GPS Mode</title>
 459         <tgroup cols='3' colsep='1' rowsep='1'>
 460           <colspec align='center' colwidth='*' colname='value'/>
 461           <colspec align='center' colwidth='3*' colname='name'/>
 462           <colspec align='left' colwidth='7*' colname='description'/>
 463           <thead>
 464             <row>
 465               <entry align='center'>Mode</entry>
 466               <entry align='center'>Name</entry>
 467               <entry align='center'>Decsription</entry>
 468             </row>
 469           </thead>
 470           <tbody>
 471             <row>
 472               <entry>N</entry>
 473               <entry>Not Valid</entry>
 474               <entry>All data are invalid</entry>
 475             </row>
 476             <row>
 477               <entry>A</entry>
 478               <entry>Autonomous mode</entry>
 479               <entry>Data are derived from satellite data</entry>
 480             </row>
 481             <row>
 482               <entry>D</entry>
 483               <entry>Differential Mode</entry>
 484               <entry>
 485                   Data are augmented with differential data from a
 486                   known ground station. The SkyTraq unit in TeleMetrum
 487                   does not support this mode
 488                 </entry>
 489             </row>
 490             <row>
 491               <entry>E</entry>
 492               <entry>Estimated</entry>
 493               <entry>
 494                   Data are estimated using dead reckoning from the
 495                   last known data
 496                 </entry>
 497             </row>
 498             <row>
 499               <entry>M</entry>
 500               <entry>Manual</entry>
 501               <entry>Data were entered manually</entry>
 502             </row>
 503             <row>
 504               <entry>S</entry>
 505               <entry>Simulated</entry>
 506               <entry>GPS receiver testing mode</entry>
 507             </row>
 508           </tbody>
 509         </tgroup>
 510       </table>
 511     </section>
 512     <section>
 513       <title>GPS Satellite Data</title>
 514       <informaltable frame='none' label='' tocentry='0'>
 515         <tgroup cols='2' align='center' colsep='1' rowsep='1'>
 516           <colspec align='center' colwidth='*' colname='Offset'/>
 517           <colspec align='left' colwidth='3*' colname='Description'/>
 518           <thead>
 519             <row>
 520               <entry>Type</entry>
 521               <entry>Description</entry>
 522             </row>
 523           </thead>
 524           <tbody>
 525             <row>
 526               <entry>0x06</entry>
 527               <entry>GPS Satellite Data</entry>
 528             </row>
 529           </tbody>
 530         </tgroup>
 531       </informaltable>
 532       <para>
 533         This packet provides space vehicle identifiers and signal
 534         quality information in the form of a C/N1 number for up to 12
 535         satellites. The order of the svids is not specified.
 536       </para>
 537       <para>
 538         GPS Satellite data are transmitted once per second during all
 539         phases of the flight.
 540       </para>
 541       <table frame='all'>
 542         <title>GPS Satellite Data Contents</title>
 543         <tgroup cols='4' align='center' colsep='1' rowsep='1'>
 544           <colspec align='right' colwidth='*' colname='Offset'/>
 545           <colspec align='center' colwidth='3*' colname='Data Type'/>
 546           <colspec align='left' colwidth='3*' colname='Name'/>
 547           <colspec align='left' colwidth='9*' colname='Description'/>
 548           <thead>
 549             <row>
 550               <entry align='center'>Offset</entry>
 551               <entry align='center'>Data Type</entry>
 552               <entry align='center'>Name</entry>
 553               <entry align='center'>Description</entry>
 554             </row>
 555           </thead>
 556           <tbody>
 557             <row>
 558               <entry>5</entry><entry>uint8_t</entry><entry>channels</entry>
 559               <entry>Number of reported satellite information</entry>
 560             </row>
 561             <row>
 562               <entry>6</entry><entry>sat_info_t</entry><entry>sats[12]</entry>
 563               <entry>See Per-Satellite data table below</entry>
 564             </row>
 565             <row>
 566               <entry>30</entry><entry>uint8_t</entry><entry>unused[2]</entry>
 567             </row>
 568             <row>
 569               <entry>32</entry>
 570             </row>
 571           </tbody>
 572         </tgroup>
 573       </table>
 574       <table frame='all'>
 575         <title>GPS Per-Satellite data (sat_info_t)</title>
 576         <tgroup cols='4' align='center' colsep='1' rowsep='1'>
 577           <colspec align='right' colwidth='*' colname='Offset'/>
 578           <colspec align='center' colwidth='3*' colname='Data Type'/>
 579           <colspec align='left' colwidth='3*' colname='Name'/>
 580           <colspec align='left' colwidth='9*' colname='Description'/>
 581           <thead>
 582             <row>
 583               <entry align='center'>Offset</entry>
 584               <entry align='center'>Data Type</entry>
 585               <entry align='center'>Name</entry>
 586               <entry align='center'>Description</entry>
 587             </row>
 588           </thead>
 589           <tbody>
 590             <row>
 591               <entry>0</entry><entry>uint8_t</entry><entry>svid</entry>
 592               <entry>Space Vehicle Identifier</entry>
 593             </row>
 594             <row>
 595               <entry>1</entry><entry>uint8_t</entry><entry>c_n_1</entry>
 596               <entry>C/N1 signal quality indicator</entry>
 597             </row>
 598             <row>
 599               <entry>2</entry>
 600             </row>
 601           </tbody>
 602         </tgroup>
 603       </table>
 604     </section>
 605   </section>
 606   <section>
 607     <title>Data Transmission</title>
 608     <para>
 609       Altus Metrum devices use the Texas Instruments CC1111
 610       microcontroller which includes an integrated sub-GHz digital
 611       transceiver. This transceiver is used to both transmit and
 612       receive the telemetry packets. This section discusses what
 613       modulation scheme is used and how this device is configured.
 614     </para>
 615     <section>
 616       <title>Modulation Scheme</title>
 617       <para>
 618         Texas Instruments provides a tool for computing modulation
 619         parameters given a desired modulation format and basic bit
 620         rate. For AltOS, the basic bit rate was specified as 38 kBaud,
 621         resulting in the following signal parmeters:
 622       </para>
 623       <table>
 624         <tgroup cols='3'>
 625           <colspec align="center" colwidth="*" colname="parameter"/>
 626           <colspec align="center" text-align="." colwidth="*" colname="value"/>
 627           <colspec align="center" colwidth="*" colname="description"/>
 628           <thead>
 629             <row>
 630               <entry align='center'>Parameter</entry>
 631               <entry align='center'>Value</entry>
 632               <entry align='center'>Description</entry>
 633             </row>
 634           </thead>
 635           <tbody>
 636             <row>
 637               <entry>Modulation</entry>
 638               <entry>GFSK</entry>
 639               <entry>Gaussian Frequency Shift Keying</entry>
 640             </row>
 641             <row>
 642               <entry>Deviation</entry>
 643               <entry>20.507812 kHz</entry>
 644               <entry>Frequency modulation</entry>
 645             </row>
 646             <row>
 647               <entry>Data rate</entry>
 648               <entry>38.360596 kBaud</entry>
 649               <entry>Raw bit rate</entry>
 650             </row>
 651             <row>
 652               <entry>RX Filter Bandwidth</entry>
 653               <entry>93.75 kHz</entry>
 654               <entry>Receiver Band pass filter bandwidth</entry>
 655             </row>
 656             <row>
 657               <entry>IF Frequency</entry>
 658               <entry>140.62 kHz</entry>
 659               <entry>Receiver intermediate frequency</entry>
 660             </row>
 661           </tbody>
 662         </tgroup>
 663       </table>
 664     </section>
 665     <section>
 666       <para>
 667         The cc1111 provides forward error correction in hardware,
 668         which AltOS uses to improve reception of weak signals. The
 669         overall effect of this is to halve the available bandwidth for
 670         data from 38 kBaud to 19 kBaud.
 671       </para>
 672       <title>Error Correction</title>
 673       <table>
 674         <tgroup cols='3'>
 675           <colspec align="center" colwidth="*" colname="parameter"/>
 676           <colspec align="center" colwidth="*" colname="value"/>
 677           <colspec align="center" colwidth="*" colname="description"/>
 678           <thead>
 679             <row>
 680               <entry align='center'>Parameter</entry>
 681               <entry align='center'>Value</entry>
 682               <entry align='center'>Description</entry>
 683             </row>
 684           </thead>
 685           <tbody>
 686             <row>
 687               <entry>Error Correction</entry>
 688               <entry>Convolutional coding FEC</entry>
 689               <entry>1/2 code, constraint length m=4</entry>
 690             </row>
 691             <row>
 692               <entry>Interleaving</entry>
 693               <entry>4 x 4</entry>
 694               <entry>Reduce effect of noise burst</entry>
 695             </row>
 696             <row>
 697               <entry>Data Whitening</entry>
 698               <entry>XOR with 9-bit PNR</entry>
 699               <entry>Rotate right with bit 8 = bit 0 xor bit 5, initial
 700               value 111111111</entry>
 701             </row>
 702           </tbody>
 703         </tgroup>
 704       </table>
 705     </section>
 706   </section>
 707   <section>
 708     <title>TeleDongle packet format</title>
 709     <para>
 710       TeleDongle does not do any interpretation of the packet data,
 711       instead it is configured to receive packets of a specified
 712       length (32 bytes in this case). For each received packet,
 713       TeleDongle produces a single line of text. This line starts with
 714       the string "TELEM " and is followed by a list of hexadecimal
 715       encoded bytes.
 716     </para>
 717     <programlisting>TELEM 224f01080b05765e00701f1a1bbeb8d7b60b070605140c000600000000000000003fa988</programlisting>
 718     <para>
 719       The hexadecimal encoded string of bytes contains a length byte,
 720       the packet data, two bytes added by the cc1111 radio receiver
 721       hardware and finally a checksum so that the host software can
 722       validate that the line was transmitted without any errors.
 723     </para>
 724     <table>
 725       <tgroup cols='4'>
 726         <colspec align="center" colwidth="2*" colname="offset"/>
 727         <colspec align="center" colwidth="*" colname="name"/>
 728         <colspec align="center" colwidth="*" colname="value"/>
 729         <colspec align="center" colwidth="5*" colname="description"/>
 730         <thead>
 731           <row>
 732             <entry align='center'>Offset</entry>
 733             <entry align='center'>Name</entry>
 734             <entry align='center'>Example</entry>
 735             <entry align='center'>Description</entry>
 736           </row>
 737         </thead>
 738         <tbody>
 739           <row>
 740             <entry>0</entry>
 741             <entry>length</entry>
 742             <entry>22</entry>
 743             <entry>Total length of data bytes in the line. Note that
 744             this includes the added RSSI and status bytes</entry>
 745           </row>
 746           <row>
 747             <entry>1 ·· length-3</entry>
 748             <entry>packet</entry>
 749             <entry>4f ·· 00</entry>
 750             <entry>Bytes of actual packet data</entry>
 751           </row>
 752           <row>
 753             <entry>length-2</entry>
 754             <entry>rssi</entry>
 755             <entry>3f</entry>
 756             <entry>Received signal strength. dBm = rssi / 2 - 74</entry>
 757           </row>
 758           <row>
 759             <entry>length-1</entry>
 760             <entry>lqi</entry>
 761             <entry>a9</entry>
 762             <entry>Link Quality Indicator and CRC status. Bit 7
 763             is set when the CRC is correct</entry>
 764           </row>
 765           <row>
 766             <entry>length</entry>
 767             <entry>checksum</entry>
 768             <entry>88</entry>
 769             <entry>(0x5a + sum(bytes 1 ·· length-1)) % 256</entry>
 770           </row>
 771         </tbody>
 772       </tgroup>
 773     </table>
 774   </section>
 775   <section>
 776     <title>History and Motivation</title>
 777     <para>
 778       The original AltoOS telemetry mechanism encoded everything
 779       available piece of information on the TeleMetrum hardware into a
 780       single unified packet. Initially, the packets contained very
 781       little data—some raw sensor readings along with the current GPS
 782       coordinates when a GPS receiver was connected. Over time, the
 783       amount of data grew to include sensor calibration data, GPS
 784       satellite information and a host of internal state information
 785       designed to help diagnose flight failures in case of a loss of
 786       the on-board flight data.
 787     </para>
 788     <para>
 789       Because every packet contained all of the data, packets were
 790       huge—95 bytes long. Much of the information was also specific to
 791       the TeleMetrum hardware. With the introduction of the TeleMini
 792       flight computer, most of the data contained in the telemetry
 793       packets was unavailable. Initially, a shorter, but still
 794       comprehensive packet was implemented. This required that the
 795       ground station be pre-configured as to which kind of packet to
 796       expect.
 797     </para>
 798     <para>
 799       The development of several companion boards also made the
 800       shortcomings evident—each companion board would want to include
 801       telemetry data in the radio link; with the original design, the
 802       packet would have to hold the new data as well, requiring
 803       additional TeleMetrum and ground station changes.
 804     </para>
 805   </section>
 806 </article>