add pcb overall dimensions and screw sizes the holes are intended for
[fw/altos] / doc / telemetry.xsl
index d2b17126743457df94f5f4644db92ca5c8dfdaed..fa66bff919bea61d80f9dc24c96a96fd9e7c2793 100644 (file)
              <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>accel</entry><entry>m/s² * 16</entry>
+             <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>
              <entry>22</entry><entry>int16_t</entry><entry>height</entry><entry>m</entry>
            </row>
            <row>
-             <entry>24</entry><entry>int16_t</entry><entry>ground_accel</entry><entry>TM</entry>
+             <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_pres</entry><entry>Average barometer reading on ground</entry>
+             <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>
              <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>main_deploy</entry><entry>Main deploy alt in meters</entry>
+             <entry>10</entry><entry>uint16_t</entry><entry>apogee_delay</entry>
+             <entry>Apogee deploy delay in seconds</entry>
            </row>
            <row>
-             <entry>12</entry><entry>uint32_t</entry><entry>flight_log_max</entry><entry>Maximum flight log size (B)</entry>
+             <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>
              <entry>26</entry><entry>uint16_t</entry><entry>ground_speed</entry><entry>cm/s</entry>
            </row>
            <row>
-             <entry>28</entry><entry>uint8_t</entry><entry>course</entry><entry>/ 2</entry>
+             <entry>28</entry><entry>int16_t</entry><entry>climb_rate</entry><entry>cm/s</entry>
            </row>
            <row>
-             <entry>29</entry><entry>uint8_t</entry><entry>unused[3]</entry>
+             <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>
       </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>
+      <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>