packet.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
  2. <HTML>
  3. <HEAD>
  4. <META NAME="GENERATOR" Content="Visual Page 1.0 for Windows">
  5. <META HTTP-EQUIV="Content-Type" CONTENT="text/html;CHARSET=iso-8859-1">
  6. <TITLE>TI-85 Link Protocol Guide - Packet formats</TITLE>
  7. </HEAD>
  8. <BODY BGCOLOR="#FFFFE8">
  9. <P><B>TI-85 Link Protocol Guide v1.0</B> - Packet formats</P>
  10. <CENTER>
  11. <H2>
  12. <HR ALIGN="CENTER">
  13. Packet Formats</H2>
  14. </CENTER>
  15. <P>Texas Instruments calculators always send data and responses in self-contained &quot;packets.&quot;<BR>
  16. Packets have the following format:<BR>
  17. <I>Note - all 2-byte integers are transmitted little-endian Intel-style (least significant byte first).</I></P>
  18. <P>
  19. <TABLE BORDER="1" CELLSPACING="0" WIDTH="92%">
  20. <TR>
  21. <TH WIDTH="7%" BGCOLOR="#008800"><FONT COLOR="#FFFFFF">Offset</FONT></TH>
  22. <TH WIDTH="8%" BGCOLOR="#008800"><FONT COLOR="#FFFFFF">Length</FONT></TH>
  23. <TH WIDTH="85%" BGCOLOR="#008800"><FONT COLOR="#FFFFFF">Description</FONT></TH>
  24. </TR>
  25. <TR>
  26. <TD WIDTH="7%" BGCOLOR="#FFFFFF">0</TD>
  27. <TD WIDTH="8%" BGCOLOR="#FFFFFF">1 byte</TD>
  28. <TD WIDTH="85%" BGCOLOR="#FFFFFF">Machine ID byte</TD>
  29. </TR>
  30. <TR>
  31. <TD WIDTH="7%" BGCOLOR="#FFFFFF">1</TD>
  32. <TD WIDTH="8%" BGCOLOR="#FFFFFF">1 byte</TD>
  33. <TD WIDTH="85%" BGCOLOR="#FFFFFF">Command ID byte</TD>
  34. </TR>
  35. <TR>
  36. <TD WIDTH="7%" BGCOLOR="#FFFFFF">2</TD>
  37. <TD WIDTH="8%" BGCOLOR="#FFFFFF">2 bytes</TD>
  38. <TD WIDTH="85%" BGCOLOR="#FFFFFF">Length of data (see note below)</TD>
  39. </TR>
  40. <TR>
  41. <TD WIDTH="7%" BGCOLOR="#FFFFFF">4</TD>
  42. <TD WIDTH="8%" BGCOLOR="#FFFFFF"><I>n</I> bytes</TD>
  43. <TD WIDTH="85%" BGCOLOR="#FFFFFF">Data (if attached)</TD>
  44. </TR>
  45. <TR>
  46. <TD WIDTH="7%" BGCOLOR="#FFFFFF">4+<I>n</I></TD>
  47. <TD WIDTH="8%" BGCOLOR="#FFFFFF">2 bytes</TD>
  48. <TD WIDTH="85%" BGCOLOR="#FFFFFF">Checksum (if data is attached)</TD>
  49. </TR>
  50. </TABLE>
  51. <I>Note - The &quot;Length of data&quot; element may not be equal to zero if the packet contains no data. In this
  52. case, the Command ID byte will indicate that the packet contains no data.</I><p></P>
  53. <H4>The Machine ID Byte</H4>
  54. <P>The Machine ID byte identifies the machine that is sending the packet. It can have one of the following values:
  55. <TABLE BORDER="1" CELLSPACING="0" WIDTH="66%">
  56. <TR>
  57. <TH WIDTH="13%" BGCOLOR="#DDDDDD">Value</TH>
  58. <TH BGCOLOR="#DDDDDD">Description</TH>
  59. </TR>
  60. <TR>
  61. <TD WIDTH="13%">05h</TD>
  62. <TD>Computer sending TI-85 data</TD>
  63. </TR>
  64. <TR>
  65. <TD WIDTH="13%">85h</TD>
  66. <TD>TI-85</TD>
  67. </TR>
  68. </TABLE>
  69. <p></P>
  70. <H4>The Command ID Byte</H4>
  71. <P>The Command ID byte identifies the request or response that the machine is sending. It can have one of the following
  72. values:</P>
  73. <P>
  74. <TABLE BORDER="1" CELLSPACING="0" WIDTH="66%">
  75. <TR>
  76. <TH WIDTH="22%" BGCOLOR="#DDDDDD">Value</TH>
  77. <TH WIDTH="259" BGCOLOR="#DDDDDD">Description</TH>
  78. <TH BGCOLOR="#DDDDDD">Data Included</TH>
  79. </TR>
  80. <TR>
  81. <TD WIDTH="22%">06h</TD>
  82. <TD WIDTH="259">Variable Header (VAR)</TD>
  83. <TD>A standard <A HREF="#varheader">variable header</A></TD>
  84. </TR>
  85. <TR>
  86. <TD WIDTH="22%">09h</TD>
  87. <TD WIDTH="259">Clear to send (CTS)</TD>
  88. <TD><I>None</I></TD>
  89. </TR>
  90. <TR>
  91. <TD WIDTH="22%">15h</TD>
  92. <TD WIDTH="259">Data packet (DATA)</TD>
  93. <TD>Screenshot/variable/backup data</TD>
  94. </TR>
  95. <TR>
  96. <TD WIDTH="22%">36h</TD>
  97. <TD WIDTH="259">Skip/Exit (SKIP/EXIT)</TD>
  98. <TD>A one-byte rejection code (see codes below)</TD>
  99. </TR>
  100. <TR>
  101. <TD WIDTH="22%">56h</TD>
  102. <TD WIDTH="259">Acknowledge (ACK)</TD>
  103. <TD><I>None</I></TD>
  104. </TR>
  105. <TR>
  106. <TD WIDTH="22%">5Ah</TD>
  107. <TD WIDTH="259">Checksum Error (ERR)<BR>
  108. The previous packet must be sent again.</TD>
  109. <TD><I>None</I></TD>
  110. </TR>
  111. <TR>
  112. <TD WIDTH="22%">6Dh</TD>
  113. <TD WIDTH="259"><I>Silent</I> - Request Screenshot (SCR)</TD>
  114. <TD><I>None</I></TD>
  115. </TR>
  116. <TR>
  117. <TD WIDTH="22%">92h</TD>
  118. <TD WIDTH="259">End of Transmission (EOT)</TD>
  119. <TD><I>None</I></TD>
  120. </TR>
  121. <TR>
  122. <TD WIDTH="22%">A2h</TD>
  123. <TD WIDTH="259"><I>Silent</I> - Request Variable (REQ)</TD>
  124. <TD>A NUL padded (fixed-length) <A HREF="#varheader">variable header</A></TD>
  125. </TR>
  126. <TR>
  127. <TD WIDTH="22%">C9h</TD>
  128. <TD WIDTH="259"><I>Silent</I> - Request to Send Variable (RTS)</TD>
  129. <TD>A SPC padded (fixed-length) <A HREF="#varheader">variable header</A></TD>
  130. </TR>
  131. </TABLE>
  132. <p></P>
  133. <P>Rejection codes (used with Command ID 36h) can have one of the following values:</P>
  134. <P>
  135. <TABLE BORDER="1" CELLSPACING="0" WIDTH="66%">
  136. <TR>
  137. <TH WIDTH="13%" BGCOLOR="#DDDDDD">Value</TH>
  138. <TH BGCOLOR="#DDDDDD">Description</TH>
  139. </TR>
  140. <TR>
  141. <TD WIDTH="13%">01h</TD>
  142. <TD>EXIT - The entire transmission has been cancelled.</TD>
  143. </TR>
  144. <TR>
  145. <TD WIDTH="13%">02h</TD>
  146. <TD>SKIP - The current variable has been skipped.</TD>
  147. </TR>
  148. <TR>
  149. <TD WIDTH="13%">03h</TD>
  150. <TD>OUT OF MEMORY (silent transmissions only) - The receiving calculator is out of memory.</TD>
  151. </TR>
  152. </TABLE>
  153. <p></P>
  154. <H4>The Checksum</H4>
  155. <P>The checksum is a 16-bit value used to verify the integrity of the data in the packet. It only present if data
  156. is present.<BR>
  157. The checksum is calculated by taking the lower 16 bits of the sum of the data bytes, as shown below:</P>
  158. <PRE>int calculateChecksum(unsigned char* data, unsigned short datalength) {
  159. unsigned short x, checksum;
  160. for(x=0; x&lt;datalength; x++) {
  161. checksum+=data[x]; //overflow automatically limits to 16 bits
  162. }
  163. return checksum;
  164. }</PRE>
  165. <CENTER>
  166. <H3>
  167. <HR ALIGN="CENTER">
  168. <A NAME="varheader"></A>Variable Headers</H3>
  169. </CENTER>
  170. <P>A Variable header contains information about one variable in the calculator.<BR>
  171. Standard and padded variable headers have the following format:</P>
  172. <P>
  173. <TABLE BORDER="1" CELLSPACING="0" WIDTH="92%">
  174. <TR>
  175. <TH WIDTH="7%" BGCOLOR="#008800"><FONT COLOR="#FFFFFF">Offset</FONT></TH>
  176. <TH WIDTH="8%" BGCOLOR="#008800"><FONT COLOR="#FFFFFF">Length</FONT></TH>
  177. <TH WIDTH="85%" BGCOLOR="#008800"><FONT COLOR="#FFFFFF">Description</FONT></TH>
  178. </TR>
  179. <TR>
  180. <TD WIDTH="7%" BGCOLOR="#FFFFFF">0</TD>
  181. <TD WIDTH="8%" BGCOLOR="#FFFFFF">2 bytes</TD>
  182. <TD WIDTH="85%" BGCOLOR="#FFFFFF">Size of actual variable data, in bytes</TD>
  183. </TR>
  184. <TR>
  185. <TD WIDTH="7%" BGCOLOR="#FFFFFF">2</TD>
  186. <TD WIDTH="8%" BGCOLOR="#FFFFFF">1 byte</TD>
  187. <TD WIDTH="85%" BGCOLOR="#FFFFFF">Type ID Byte (see type ID's below)</TD>
  188. </TR>
  189. <TR>
  190. <TD WIDTH="7%" BGCOLOR="#FFFFFF">3</TD>
  191. <TD WIDTH="8%" BGCOLOR="#FFFFFF">1 byte</TD>
  192. <TD WIDTH="85%" BGCOLOR="#FFFFFF">Size of variable name, in characters</TD>
  193. </TR>
  194. <TR>
  195. <TD WIDTH="7%" BGCOLOR="#FFFFFF">4</TD>
  196. <TD WIDTH="8%" BGCOLOR="#FFFFFF"><I>n</I> bytes</TD>
  197. <TD WIDTH="85%" BGCOLOR="#FFFFFF">Variable name (not zero-terminated)</TD>
  198. </TR>
  199. </TABLE>
  200. <I>Note: These bytes only make up the &quot;data&quot; section of the packet.</I><p></P>
  201. <P>A padded variable header will always be 12 bytes long. The unused bytes at the end are padded with space characters
  202. (20h) or NULLs (0h). The standard and padded formats for variable headers are interchangeable.</P>
  203. <H4><A NAME="vartypes"></A>The Type ID Byte</H4>
  204. <P>The type ID byte specifies the type of variable that is being transmitted. It can have one of the following
  205. values:</P>
  206. <P>
  207. <TABLE BORDER="1" CELLSPACING="0" WIDTH="66%">
  208. <TR>
  209. <TH WIDTH="13%" BGCOLOR="#DDDDDD">Value</TH>
  210. <TH BGCOLOR="#DDDDDD">Description (click for variable format)</TH>
  211. </TR>
  212. <TR>
  213. <TD WIDTH="13%">00h</TD>
  214. <TD><A HREF="vars.html#real">Real Number</A></TD>
  215. </TR>
  216. <TR>
  217. <TD WIDTH="13%">01h</TD>
  218. <TD><A HREF="vars.html#complex">Complex Number</A></TD>
  219. </TR>
  220. <TR>
  221. <TD WIDTH="13%">02h</TD>
  222. <TD><A HREF="vars.html#vector">Real Vector</A></TD>
  223. </TR>
  224. <TR>
  225. <TD WIDTH="13%">03h</TD>
  226. <TD><A HREF="vars.html#vector">Complex Vector</A></TD>
  227. </TR>
  228. <TR>
  229. <TD WIDTH="13%">04h</TD>
  230. <TD><A HREF="vars.html#list">Real List</A></TD>
  231. </TR>
  232. <TR>
  233. <TD WIDTH="13%">05h</TD>
  234. <TD><A HREF="vars.html#list">Complex List</A></TD>
  235. </TR>
  236. <TR>
  237. <TD WIDTH="13%">06h</TD>
  238. <TD><A HREF="vars.html#matrix">Real Matrix</A></TD>
  239. </TR>
  240. <TR>
  241. <TD WIDTH="13%">07h</TD>
  242. <TD><A HREF="vars.html#matrix">Complex Matrix</A></TD>
  243. </TR>
  244. <TR>
  245. <TD WIDTH="13%">08h</TD>
  246. <TD><A HREF="vars.html#constant">Real Constant</A></TD>
  247. </TR>
  248. <TR>
  249. <TD WIDTH="13%">09h</TD>
  250. <TD><A HREF="vars.html#constant">Complex Constant</A></TD>
  251. </TR>
  252. <TR>
  253. <TD WIDTH="13%">0Ah</TD>
  254. <TD><A HREF="vars.html#equation">Equation</A></TD>
  255. </TR>
  256. <TR>
  257. <TD WIDTH="13%">0Ch</TD>
  258. <TD><A HREF="vars.html#string">String</A></TD>
  259. </TR>
  260. <TR>
  261. <TD WIDTH="13%">0Dh</TD>
  262. <TD><A HREF="vars.html#gdb">Function GDB</A></TD>
  263. </TR>
  264. <TR>
  265. <TD WIDTH="13%">0Eh</TD>
  266. <TD><A HREF="vars.html#gdb">Polar GDB</A></TD>
  267. </TR>
  268. <TR>
  269. <TD WIDTH="13%">0Fh</TD>
  270. <TD><A HREF="vars.html#gdb">Parametric GDB</A></TD>
  271. </TR>
  272. <TR>
  273. <TD WIDTH="13%">10h</TD>
  274. <TD><A HREF="vars.html#gdb">Differential Equation GDB</A></TD>
  275. </TR>
  276. <TR>
  277. <TD WIDTH="13%">11h</TD>
  278. <TD><A HREF="vars.html#picture">Picture</A></TD>
  279. </TR>
  280. <TR>
  281. <TD WIDTH="13%">12h</TD>
  282. <TD><A HREF="vars.html#program">Program</A></TD>
  283. </TR>
  284. <TR>
  285. <TD WIDTH="13%">14h</TD>
  286. <TD>Screenshot sent by PrtScrn <I>(See note below)</I></TD>
  287. </TR>
  288. <TR>
  289. <TD WIDTH="13%">17h</TD>
  290. <TD><A HREF="vars.html#window">Func: Function Window Settings</A><I> (See note below)</I></TD>
  291. </TR>
  292. <TR>
  293. <TD WIDTH="13%">18h</TD>
  294. <TD><A HREF="vars.html#window">Pol: Polar Window Settings</A><I> (See note below)</I></TD>
  295. </TR>
  296. <TR>
  297. <TD WIDTH="13%">19h</TD>
  298. <TD><A HREF="vars.html#window">Param: Parametric Window Settings</A><I> (See note below)</I></TD>
  299. </TR>
  300. <TR>
  301. <TD WIDTH="13%">1Ah</TD>
  302. <TD><A HREF="vars.html#window">DifEq: Differential Equation Window Settings</A><I> (See note below)</I></TD>
  303. </TR>
  304. <TR>
  305. <TD WIDTH="13%">1Bh</TD>
  306. <TD><A HREF="vars.html#window">ZRCL: Saved Window Settings</A><I> (See note below)</I></TD>
  307. </TR>
  308. <TR>
  309. <TD WIDTH="13%">1Dh</TD>
  310. <TD>Backup <I>(No meaningful name)</I></TD>
  311. </TR>
  312. <TR>
  313. <TD WIDTH="13%">1Eh</TD>
  314. <TD>Unknown (only used when requesting variables of unknown type)</TD>
  315. </TR>
  316. </TABLE>
  317. <I>Note - If the Type ID is in the range 14h - 1Bh, then the name length byte has a value of 0 and the name field
  318. consists of a single 0 byte.</I><p></P>
  319. <H4><A NAME="backup"></A>Backup Header Format</H4>
  320. <P>If the type ID byte specifies a backup, the variable header takes the following 9-byte format:</P>
  321. <P>
  322. <TABLE BORDER="1" CELLSPACING="0" WIDTH="92%">
  323. <TR>
  324. <TH WIDTH="7%" BGCOLOR="#008800"><FONT COLOR="#FFFFFF">Offset</FONT></TH>
  325. <TH WIDTH="8%" BGCOLOR="#008800"><FONT COLOR="#FFFFFF">Length</FONT></TH>
  326. <TH WIDTH="85%" BGCOLOR="#008800"><FONT COLOR="#FFFFFF">Description</FONT></TH>
  327. </TR>
  328. <TR>
  329. <TD WIDTH="7%" BGCOLOR="#FFFFFF">0</TD>
  330. <TD WIDTH="8%" BGCOLOR="#FFFFFF">2 bytes</TD>
  331. <TD WIDTH="85%" BGCOLOR="#FFFFFF">Size of first backup section, in bytes</TD>
  332. </TR>
  333. <TR>
  334. <TD WIDTH="7%" BGCOLOR="#FFFFFF">2</TD>
  335. <TD WIDTH="8%" BGCOLOR="#FFFFFF">1 byte</TD>
  336. <TD WIDTH="85%" BGCOLOR="#FFFFFF">Type ID Byte (1Dh in this case)</TD>
  337. </TR>
  338. <TR>
  339. <TD WIDTH="7%" BGCOLOR="#FFFFFF">3</TD>
  340. <TD WIDTH="8%" BGCOLOR="#FFFFFF">2 bytes</TD>
  341. <TD WIDTH="85%" BGCOLOR="#FFFFFF">Size of second backup section, in bytes</TD>
  342. </TR>
  343. <TR>
  344. <TD WIDTH="7%" BGCOLOR="#FFFFFF">5</TD>
  345. <TD WIDTH="8%" BGCOLOR="#FFFFFF">2 bytes</TD>
  346. <TD WIDTH="85%" BGCOLOR="#FFFFFF">Size of third backup section, in bytes</TD>
  347. </TR>
  348. <TR>
  349. <TD WIDTH="7%" BGCOLOR="#FFFFFF">7</TD>
  350. <TD WIDTH="8%" BGCOLOR="#FFFFFF">2 bytes</TD>
  351. <TD WIDTH="85%" BGCOLOR="#FFFFFF">Memory address of second section</TD>
  352. </TR>
  353. </TABLE>
  354. <p></P>
  355. <P>
  356. <TABLE BORDER="0" CELLSPACING="0" WIDTH="100%">
  357. <TR>
  358. <TD WIDTH="32%">
  359. <P ALIGN="CENTER"><A HREF="cable.html"><IMG SRC="graphics/prevpage.gif" WIDTH="32" HEIGHT="32" ALIGN="BOTTOM" ALT="[previous page]"
  360. BORDER="2"><BR>
  361. Link Cables</A>
  362. </TD>
  363. <TD WIDTH="34%">
  364. <P ALIGN="CENTER"><A HREF="index.html"><IMG SRC="graphics/home.gif" WIDTH="32" HEIGHT="32" ALIGN="BOTTOM" ALT="[home]"
  365. BORDER="2"><BR>
  366. Table of Contents</A>
  367. </TD>
  368. <TD WIDTH="34%">
  369. <P ALIGN="CENTER"><A HREF="screenshot.html"><IMG SRC="graphics/nextpage.gif" WIDTH="32" HEIGHT="32" ALIGN="BOTTOM"
  370. ALT="[next page]" BORDER="2"><BR>
  371. Screenshots</A>
  372. </TD>
  373. </TR>
  374. </TABLE>
  375. <HR ALIGN="CENTER">
  376. <I>Site maintained by Romain Li&eacute;vin (</I><A HREF="mailto:roms@lpg.ticalc.org"><I>roms@lpg.ticalc.org</I></A><I>)
  377. and Tim Singer (</I><A HREF="mailto:tsinger@gladstone.uoregon.edu"><I>tsinger@gladstone.uoregon.edu</I></A><I>)</I>
  378. </BODY>
  379. </HTML>