1 #ZNP Host Framework\r
2 \r
3 ##Introduction\r
4 \r
5 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.\r
6 \r
7 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.\r
8 \r
9 The Examples currently implemented are:\r
10 \r
11 - 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. \r
12 - DataSendRecv: A Simple example to send / receive data between nodes in the network.\r
13 - NwkTopology: A Simple example to discover the topology of a network that the node is a part of.\r
14 - servDesc: A Simple example to discover services of nodes on the network.\r
15 - stressTest: A test example used for testing the robustness of the framework.\r
16 \r
17 The Platforms currently supported are:\r
18 \r
19 The framework and examples are described in more detail in the UserGuide in the /docs directory of this git.\r
20 \r
21 ##Quick Start Guide\r
22 \r
23 ###Required HW\r
24 For the Linux platform only the [CC2538DK]( https://store.ti.com/CC2538DK-CC2538-Development-Kit-P4532.aspx) is required.\r
25 \r
26 For the TIRTOS Tiva platform you will need in addition to the [CC2538DK]( https://store.ti.com/CC2538DK-CC2538-Development-Kit-P4532.aspx) ; a [TIVA-C Launchpad](https://store.ti.com/Tiva-C-LaunchPad.aspx) and an [EM Booster pack](https://store.ti.com/boost-ccemadapter.aspx ) (modified as indicated in the Users Guide).\r
27 \r
28 ###Programming the CC2538EM's with ZNP FW \r
29 Use the [SmartRF Programmer 2]( http://processors.wiki.ti.com/index.php/Download_CCS) to program the FW contain in the bin dir of the git repository.\r
30 \r
31 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\r
32 \r
33 Remember to set the P5 header correctly on the CC2538EM:\r
34 \r
35 * For use with the Linux platform set P5 to VDD -> USB so the CC2538Em is powered from the USB connector.\r
36 * For programming and use with the TIRTOS/TIVA Platform set P5 to VDD -> EM, so it is powered from the RM headers.\r
37 \r
38 Connect the CC2538EM to the Host:\r
39 \r
40 * For the Linux platform connect the CC2538EM to the Linux machine.\r
41 * For the TIRTOS/TIVA platform connect the CC2538EM to the EM Booster Pack and then to the TIRTOS/TIVA Launchpad.\r
42 \r
43 ### Building and running the examples\r
44 \r
45 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.\r
46 \r
47 Clone the git \r
48 \r
49 git clone git://git.ti.com/znp-host-framework/znp-host-framework.git\r
50 \r
51 ####Linux\r
52 \r
53 Change dir to the build directory for one of the examples and build it\r
54 \r
55 cd znp-posix-framework/examples/cmdLine/build/gnu/\r
56 make\r
57 \r
58 Then run the example:\r
59 \r
60 ./cmdLine.bin /dev/ttyACM0\r
61 \r
62 \r
63 ####TI RTOS\r
64 \r
65 Download CCS v6 from here:\r
66 [CCS v6]( http://processors.wiki.ti.com/index.php/Download_CCS)\r
67 \r
68 Download TIRTOS for TIVA-C version 2.00.02.36 from here:\r
69 [TIRTOS for TIVA-C version 2.00.02.36 (for Windows)]( 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)\r
70 \r
71 Other versions of TIRTOS are available [here]( http://software-dl.ti.com/dsps/dsps_public_sw/sdo_sb/targetcontent/tirtos/index.html) however these are not yet tested so we recommend that you use the version suggested above.\r
72 \r
73 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\r
74 \r
75 To build and download the example Right click on the example in the Project Explorer and select Debug As->Code Composer Debug Session\r
76 \r
77 ##Known Issues and Limitations\r
78 \r
79 * 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.\r
80 \r
81 * API documentation is not yet released.\r
82 \r
83 * 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.