1 <!DOCTYPE html>\r
2 <html>\r
3 <head>\r
4 <title>README</title>\r
5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />\r
6 <style type="text/css">\r
7 /* GitHub stylesheet for MarkdownPad (http://markdownpad.com) */
8 /* Author: Nicolas Hery - http://nicolashery.com */
9 /* Version: b13fe65ca28d2e568c6ed5d7f06581183df8f2ff */
10 /* Source: https://github.com/nicolahery/markdownpad-github */
12 /* RESET
13 =============================================================================*/
15 html, body, div, span, applet, object, iframe, h1, h2, h3, h4, h5, h6, p, blockquote, pre, a, abbr, acronym, address, big, cite, code, del, dfn, em, img, ins, kbd, q, s, samp, small, strike, strong, sub, sup, tt, var, b, u, i, center, dl, dt, dd, ol, ul, li, fieldset, form, label, legend, table, caption, tbody, tfoot, thead, tr, th, td, article, aside, canvas, details, embed, figure, figcaption, footer, header, hgroup, menu, nav, output, ruby, section, summary, time, mark, audio, video {
16 margin: 0;
17 padding: 0;
18 border: 0;
19 }
21 /* BODY
22 =============================================================================*/
24 body {
25 font-family: Helvetica, arial, freesans, clean, sans-serif;
26 font-size: 14px;
27 line-height: 1.6;
28 color: #333;
29 background-color: #fff;
30 padding: 20px;
31 max-width: 960px;
32 margin: 0 auto;
33 }
35 body>*:first-child {
36 margin-top: 0 !important;
37 }
39 body>*:last-child {
40 margin-bottom: 0 !important;
41 }
43 /* BLOCKS
44 =============================================================================*/
46 p, blockquote, ul, ol, dl, table, pre {
47 margin: 15px 0;
48 }
50 /* HEADERS
51 =============================================================================*/
53 h1, h2, h3, h4, h5, h6 {
54 margin: 20px 0 10px;
55 padding: 0;
56 font-weight: bold;
57 -webkit-font-smoothing: antialiased;
58 }
60 h1 tt, h1 code, h2 tt, h2 code, h3 tt, h3 code, h4 tt, h4 code, h5 tt, h5 code, h6 tt, h6 code {
61 font-size: inherit;
62 }
64 h1 {
65 font-size: 28px;
66 color: #000;
67 }
69 h2 {
70 font-size: 24px;
71 border-bottom: 1px solid #ccc;
72 color: #000;
73 }
75 h3 {
76 font-size: 18px;
77 }
79 h4 {
80 font-size: 16px;
81 }
83 h5 {
84 font-size: 14px;
85 }
87 h6 {
88 color: #777;
89 font-size: 14px;
90 }
92 body>h2:first-child, body>h1:first-child, body>h1:first-child+h2, body>h3:first-child, body>h4:first-child, body>h5:first-child, body>h6:first-child {
93 margin-top: 0;
94 padding-top: 0;
95 }
97 a:first-child h1, a:first-child h2, a:first-child h3, a:first-child h4, a:first-child h5, a:first-child h6 {
98 margin-top: 0;
99 padding-top: 0;
100 }
102 h1+p, h2+p, h3+p, h4+p, h5+p, h6+p {
103 margin-top: 10px;
104 }
106 /* LINKS
107 =============================================================================*/
109 a {
110 color: #4183C4;
111 text-decoration: none;
112 }
114 a:hover {
115 text-decoration: underline;
116 }
118 /* LISTS
119 =============================================================================*/
121 ul, ol {
122 padding-left: 30px;
123 }
125 ul li > :first-child,
126 ol li > :first-child,
127 ul li ul:first-of-type,
128 ol li ol:first-of-type,
129 ul li ol:first-of-type,
130 ol li ul:first-of-type {
131 margin-top: 0px;
132 }
134 ul ul, ul ol, ol ol, ol ul {
135 margin-bottom: 0;
136 }
138 dl {
139 padding: 0;
140 }
142 dl dt {
143 font-size: 14px;
144 font-weight: bold;
145 font-style: italic;
146 padding: 0;
147 margin: 15px 0 5px;
148 }
150 dl dt:first-child {
151 padding: 0;
152 }
154 dl dt>:first-child {
155 margin-top: 0px;
156 }
158 dl dt>:last-child {
159 margin-bottom: 0px;
160 }
162 dl dd {
163 margin: 0 0 15px;
164 padding: 0 15px;
165 }
167 dl dd>:first-child {
168 margin-top: 0px;
169 }
171 dl dd>:last-child {
172 margin-bottom: 0px;
173 }
175 /* CODE
176 =============================================================================*/
178 pre, code, tt {
179 font-size: 12px;
180 font-family: Consolas, "Liberation Mono", Courier, monospace;
181 }
183 code, tt {
184 margin: 0 0px;
185 padding: 0px 0px;
186 white-space: nowrap;
187 border: 1px solid #eaeaea;
188 background-color: #f8f8f8;
189 border-radius: 3px;
190 }
192 pre>code {
193 margin: 0;
194 padding: 0;
195 white-space: pre;
196 border: none;
197 background: transparent;
198 }
200 pre {
201 background-color: #f8f8f8;
202 border: 1px solid #ccc;
203 font-size: 13px;
204 line-height: 19px;
205 overflow: auto;
206 padding: 6px 10px;
207 border-radius: 3px;
208 }
210 pre code, pre tt {
211 background-color: transparent;
212 border: none;
213 }
215 kbd {
216 -moz-border-bottom-colors: none;
217 -moz-border-left-colors: none;
218 -moz-border-right-colors: none;
219 -moz-border-top-colors: none;
220 background-color: #DDDDDD;
221 background-image: linear-gradient(#F1F1F1, #DDDDDD);
222 background-repeat: repeat-x;
223 border-color: #DDDDDD #CCCCCC #CCCCCC #DDDDDD;
224 border-image: none;
225 border-radius: 2px 2px 2px 2px;
226 border-style: solid;
227 border-width: 1px;
228 font-family: "Helvetica Neue",Helvetica,Arial,sans-serif;
229 line-height: 10px;
230 padding: 1px 4px;
231 }
233 /* QUOTES
234 =============================================================================*/
236 blockquote {
237 border-left: 4px solid #DDD;
238 padding: 0 15px;
239 color: #777;
240 }
242 blockquote>:first-child {
243 margin-top: 0px;
244 }
246 blockquote>:last-child {
247 margin-bottom: 0px;
248 }
250 /* HORIZONTAL RULES
251 =============================================================================*/
253 hr {
254 clear: both;
255 margin: 15px 0;
256 height: 0px;
257 overflow: hidden;
258 border: none;
259 background: transparent;
260 border-bottom: 4px solid #ddd;
261 padding: 0;
262 }
264 /* TABLES
265 =============================================================================*/
267 table th {
268 font-weight: bold;
269 }
271 table th, table td {
272 border: 1px solid #ccc;
273 padding: 6px 13px;
274 }
276 table tr {
277 border-top: 1px solid #ccc;
278 background-color: #fff;
279 }
281 table tr:nth-child(2n) {
282 background-color: #f8f8f8;
283 }
285 /* IMAGES
286 =============================================================================*/
288 img {
289 max-width: 100%
290 }\r
291 </style>\r
292 </head>\r
293 <body>\r
294 <h1>ZNP Host Framework</h1>
295 <h2>Introduction</h2>
296 <p>This git repository contains the source code for the ZNP POSIX Host Framework and Examples. The project is intended to help developer to develop ZigBee application on a host MCU/MPU connected to the Texas Instruments ZigBee Network Processor (CC253x). The framework offers a C callable / callback API to access the ZigBee Network Processor functionality available as a Binary Remote Procedure Call format over the UART/SPI interface.</p>
297 <p>The Framework and Examples utilize a subset of POSIX functions to access OS functionality (Semaphores etc) making it easily portable between OS’s (High Level or Real Time) and HW platforms.</p>
298 <p>The Examples currently implemented are:</p>
299 <ul>
300 <li>CmdLine: A command line example that exposes the ZNP API on the command line, auto complete and help on the available commands is at hand by pressing TAB. This example allows the user to intuitively learn the ZNP interface API as well as ZigBee commands. </li>
301 <li>DataSendRecv: A Simple example to send / receive data between nodes in the network.</li>
302 <li>NwkTopology: A Simple example to discover the topology of a network that the node is a part of.</li>
303 <li>servDesc: A Simple example to discover services of nodes on the network.</li>
304 <li>stressTest: A test example used for testing the robustness of the framework.</li>
305 </ul>
306 <p>The Platforms currently supported are:</p>
307 <p>The framework and examples are described in more detail in the UserGuide in the /docs directory of this git.</p>
308 <h2>Quick Start Guide</h2>
309 <h3>Required HW</h3>
310 <p>For the Linux platform only the <a href="https://store.ti.com/CC2538DK-CC2538-Development-Kit-P4532.aspx">CC2538DK</a> is required.</p>
311 <p>For the TIRTOS Tiva platform you will need in addition to the <a href="https://store.ti.com/CC2538DK-CC2538-Development-Kit-P4532.aspx">CC2538DK</a> ; a <a href="https://store.ti.com/Tiva-C-LaunchPad.aspx">TIVA-C Launchpad</a> and an <a href="https://store.ti.com/boost-ccemadapter.aspx">EM Booster pack</a> (modified as indicated in the Users Guide).</p>
312 <h3>Programming the CC2538EM's with ZNP FW</h3>
313 <p>Use the <a href="http://processors.wiki.ti.com/index.php/Download_CCS">SmartRF Programmer 2</a> to program the FW contain in the bin dir of the git repository.</p>
314 <p>For the Linux Platform use /bin/cc2538-znp-120-usb-tclk.hex FW. For the TIRTOS/TIVA Platform use the cc2538-znp-120-uart-tclk.hex</p>
315 <p>Remember to set the P5 header correctly on the CC2538EM:</p>
316 <ul>
317 <li>For use with the Linux platform set P5 to VDD -> USB so the CC2538Em is powered from the USB connector.</li>
318 <li>For programming and use with the TIRTOS/TIVA Platform set P5 to VDD -> EM, so it is powered from the RM headers.</li>
319 </ul>
320 <p>Connect the CC2538EM to the Host:</p>
321 <ul>
322 <li>For the Linux platform connect the CC2538EM to the Linux machine.</li>
323 <li>For the TIRTOS/TIVA platform connect the CC2538EM to the EM Booster Pack and then to the TIRTOS/TIVA Launchpad.</li>
324 </ul>
325 <h3>Building and running the examples</h3>
326 <p>The following describe how the build environment is setup and how one of the examples can be run. For a complete description consult the Users Guide.</p>
327 <p>Clone the git </p>
328 <pre><code>git clone git://git.ti.com/znp-host-framework/znp-host-framework.git
329 </code></pre>
331 <h4>Linux</h4>
332 <p>Change dir to the build directory for one of the examples and build it</p>
333 <pre><code>cd znp-posix-framework/examples/cmdLine/build/gnu/
334 make
335 </code></pre>
337 <p>Then run the example:</p>
338 <pre><code>./cmdLine.bin /dev/ttyACM0
339 </code></pre>
341 <h4>TI RTOS</h4>
342 <p>Download CCS v6 from here:\r
343 <a href="http://processors.wiki.ti.com/index.php/Download_CCS">CCS v6</a></p>
344 <p>Download TIRTOS for TIVA-C version 2.00.02.36 from here:\r
345 <a href="http://software-dl.ti.com/dsps/dsps_public_sw/sdo_sb/targetcontent/tirtos/2_00_02_36/exports/tirtos_tivac_setupwin32_2_00_02_36.exe">TIRTOS for TIVA-C version 2.00.02.36 (for Windows)</a></p>
346 <p>Other versions of TIRTOS are available <a href="http://software-dl.ti.com/dsps/dsps_public_sw/sdo_sb/targetcontent/tirtos/index.html">here</a> however these are not yet tested so we recommend that you use the version suggested above.</p>
347 <p>Open CCSv6, Import the project through Project->Import->Code Composer Studio->CCS Project. Browse to <base dir>/znp-posix-framework\examples\cmdLine\build\tirtos\ccs</p>
348 <p>To build and download the example Right click on the example in the Project Explorer and select Debug As->Code Composer Debug Session</p>
349 <h2>Known Issues and Limitations</h2>
350 <ul>
351 <li>
352 <p>When built from ZStack-Home-1.2.1 ZNP for CC2538 USB the host framework intermittently receives corrupted RPC messages. For this reason hex files from ZStack-Home-1.2.0 are included. The root cause of this issue is currently being investigated.</p>
353 </li>
354 <li>
355 <p>API documentation is not yet released.</p>
356 </li>
357 <li>
358 <p>stressTest Example with ED's results in high level of lost packets. This is because the Ed device sleeps and polls it parent at a default rate, its parent is responsible for buffering any messages until it polls. In this test the Coordinator will send a test message every 200ms, this can cause the parents buffer to overflow and messages to get lost. A possible resolution would be to configure the EndDevice a Always On for this test, but this has not yet been implemented. </p>
359 </li>
360 </ul>
361 \r
362 </body>\r
363 </html>\r
364 <!-- This document was created with MarkdownPad, the Markdown editor for Windows (http://markdownpad.com) -->\r