https://blackmesalabs.wordpress.com/2016/10/24/sump2-96-msps-logic-analyzer-for-22/

[BML_sump2] / sump2_execution.txt

diff --git a/sump2_execution.txt b/sump2_execution.txt
new file mode 100644 (file)
index 0000000..00aaf34
--- /dev/null
+++ b/sump2_execution.txt
@@ -0,0 +1,48 @@
+This document describes how to execute the sump2 software.\r
+It assumes the following are already completed:\r
+  1) iCEstick FPGA configuration PROM loaded with sump2 firmware ( *.bin file ).\r
+  2) FTDI device driver for "Converter B" enabled as Virtual Com Port (VCP).\r
+  3) Python 3.x for Windows installed.\r
+  4) PySerial installed.\r
+  5) PyGame installed.\r
+\r
+Executing software involves launching two Python Scripts in proper sequence. \r
+When everything is configured and working properly, double-clicking the script\r
+name should be sufficient. When things are not working properly, launching each\r
+script via a command window ("DOS>python script_name.py") is recommend so that\r
+any error messages are displayed and readable.\r
+\r
+[ bd_server.py ]\r
+  "Backdoor Server" is the 1st script to launch.  It provides a layer in a \r
+  protocol stack separating the low-level hardware device driver and the \r
+  high-level user application.  When bd_server.py is launched for the 1st time,\r
+  it generates a bd_server.ini file which contains settings for subsequent \r
+  executions. The line "usb_port = AUTO" tells bd_server.py to communicate to \r
+  the hardware using the 1st FTDI VCP COM port it can find. If you have \r
+  multiple FTDI devices, you may need to change "AUTO" to a hard coded port \r
+  number instead, such as "COM32".  The bd_server.ini line "tcp_port=21567" \r
+  specifies the TCP socket number the server is to listen for requests on. If \r
+  TCP socket 21567 is unavailable, it may be necessary to change the socket \r
+  number both here and in the sump2.ini file to match.  Normally communication\r
+  between bd_server.py and sump2.py is via TCP "localhost" ( both processes \r
+  running on one PC ), but certain firewalls may still balk and require this \r
+  port be opened for localhost communications.\r
+\r
+\r
+[ sump2.py ]\r
+  Once bd_server.py is running, it is safe to launch the sump2.py application.\r
+  Assuming the TCP socket number 21567 for bd_server.py has not changed, the      default created sump2.ini should be sufficient. The sump2.py will start in a \r
+  VCD demo mode if launched and unable to communicate with the sump2 hardware.\r
+\r
+\r
+Users may opt to create the following "Batch" file for launching bd_server.py\r
+and sump2.py together in proper sequence.  One caveat is that bd_server.py \r
+AUTO detection of the FTDI COM port does not work for some strange Windows\r
+reason. The workaround is to change bd_server.ini line "usb_port = AUTO"\r
+to "usb_port = COM99" where 99 is the COM number assigned to your iCEstick.\r
+\r
+[ sump2_launcher.bat ]\r
+  start bd_server.py\r
+  start sump2.py\r
+   \r
+\r