REFERENCE GUIDE SNAP Connect® Python Package Manual Reference Manual for Version 3.1 © 2012 Synapse, All Rights Reserved. All Synapse products are patented or patent pending. Synapse, the Synapse logo, SNAP, and Portal are all registered trademarks of Synapse Wireless, Inc. 500 Discovery Drive Huntsville, Alabama 35806 877- 982- 7888 Doc# 600045- 01B Table of Contents Table of Contents ..................................................................................................................................... 3 Overview .................................................................................................................................................. 8 All SNAP Nodes: ................................................................................................................................. 8 Why run SNAP on a PC? Typical applications are: ............................................................................ 8 It’s a Standalone Application. It’s a Software Library. It’s both! ....................................................... 8 How does my PC know what SNAP Address it should use? .............................................................. 9 Introducing SNAP Connect .................................................................................................................... 10 SNAP Connect Licensing ....................................................................................................................... 11 Option 1 - Evaluation License (10 nodes or less) .............................................................................. 11 Option 2 - Unrestricted License (more than 10 nodes) ...................................................................... 11 Installation.............................................................................................................................................. 12 Step 1 – Obtain the latest SNAP Connect ZIP file ............................................................................ 12 Step 2 – Unzip the ZIP file ................................................................................................................ 12 Step 3 – Go into the newly created directory ..................................................................................... 12 Step 4 – Look in the README.txt file .............................................................................................. 13 Step 5 (optional) – Unzip the EXAMPLES onto your computer too ................................................ 13 Sample Application: McastCounter ....................................................................................................... 14 Remote Connection Capabilities ............................................................................................................ 15 Sample Application: Remote TCP Access ............................................................................................ 16 Recommended Practices ........................................................................................................................ 17 Hooks ................................................................................................................................................. 17 Asynchronous Programming ............................................................................................................. 18 The apy Package ............................................................................................................................ 18 Multiple Instances .............................................................................................................................. 19 SNAP Connect on the E10 ..................................................................................................................... 20 UserMain.py....................................................................................................................................... 21 Sample Application – simpleSnapRouter.py ......................................................................................... 27 Usage.................................................................................................................................................. 27 Source Code ....................................................................................................................................... 29 Source Code with Commentary ......................................................................................................... 31 Additional Examples .............................................................................................................................. 35 DisplayInfo – Sanity Check and Version Numbers Display ............................................................. 35 What It Does .................................................................................................................................. 35 How To Run This Example ........................................................................................................... 35 Example Files................................................................................................................................. 35 EchoTest – Simple Benchmark .......................................................................................................... 36 What It Does .................................................................................................................................. 36 How To Run This Example ........................................................................................................... 36 Example Files................................................................................................................................. 36 SPY File Upload ................................................................................................................................ 37 What It Does .................................................................................................................................. 37 How To Run This Example ........................................................................................................... 37 Example Files................................................................................................................................. 37 TcpRawLink – Extending SNAP Data Mode over raw sockets ........................................................ 38 SNAP Connect Python Package Manual Document Number 600045-01B Page 3 of 88 What It Does .................................................................................................................................. 38 How To Run This Example ........................................................................................................... 38 Example Files................................................................................................................................. 38 Extra Example Files ....................................................................................................................... 38 Pachube – Pushing data to a web server ............................................................................................ 39 What It Does .................................................................................................................................. 39 How To Run This Example ........................................................................................................... 39 Example Files................................................................................................................................. 40 Extra Example Files ....................................................................................................................... 40 RobotAr m – Example SNAP Connect Web Server ........................................................................... 41 What It Does .................................................................................................................................. 41 How To Run This Example ........................................................................................................... 41 How To Run The Web Server Portion Of This Example .............................................................. 41 Example Files................................................................................................................................. 43 Hints and Tips ........................................................................................................................................ 44 Make sure you know the correct SNAP Address for your SNAP Connect Application ................... 44 Make sure each SNAP Connect application has a unique SNAP Address ........................................ 45 Make sure you know the correct serial port for your external devices .............................................. 45 Make sure that external bridge device really is available .................................................................. 45 Don’t forget to call loop() or at least poll() ........................................................................................ 45 Don’t call poll() when you mean to call loop() .................................................................................. 45 Adjust the logging levels to meet your needs .................................................................................... 45 Be very careful if you