Readme version 3.0				|
						|
Last updated: 		14.11.2017		|
Author: 		Soman Cheng		|
Contributions:		Marius L. Lillestøl	|
UiO Username: 		mariusll	somanc	|
Description:		README for INF5442	|
-------------------------------------------------

-------------------------------------------------------------------------------------
		WHAT YOU NEED	|	Location: LAB on 5th Floor
-------------------------------------------------------------------------------------

	1. terasic box with power cable
	2. USB to ethernet adapter
	3. Adapter for power plug
	3. Ethernet cable, CAT5 TPC
	4. MARSOM or STIMAT system

	WARNING (MUST READ)!
	- Do not remove or add any jumpers
	- Do not adjust the potentiometers (the blue components)
	- Do not lift the system with the lens or lens socket only. Hold both the FPGA and PCB
	- Fragile system
	- Do not remove lens or lens socket
	- Do not touch the chip nor blow at it

-------------------------------------------------------------------------------------
		Init		|	Location: none
-------------------------------------------------------------------------------------
PRE RUN (WIN)
		1. Power up FPGA
		2. Connect FPGA to PC/laptop with ethernet cable
		3. Open "Open Network and Sharing Centre"
		4. Go to "Change adapter settings"
		5. Disable WIFI
		6. Right click "Ethernet" and click "Properties"
		7. Enable Internet Protocol Version 4 (TCP/IPv4) and click "properties"
		8. Enter the desired IP address: 10.10.10.1
			Remember to click "ok"

PRE RUN (MAC)
		1. Power up FPGA
		2. Connect FPGA to PC/laptop with ethernet cable
		3. System preferences, open
		4. network, click wifi,remove the application and apply
		5. Enable ethernet and enter IP address: 10.10.10.1

-------------------------------------------------------------------------------------
		JAVA		|	Location: ImagerCtrl.jar 
-------------------------------------------------------------------------------------

STIMAT and MARSOM have each their own .jar file. JAVA is required and JAVA Dev. Kit for MAC.

RUNNING JAVA PROGRAM(WINDOW): 
	- Open cmd shell in the same folder as .jar file
						1. shift + right-click
						2. click "Open PowerShell window here"
						3. write	"java -jar ./ImagerCtrl.jar"  (STIMAT)  
							or	"java -Xmx1024M -jar ./ImagerCtrl.jar" (MARSOM)
							to execute
RUNNING JAVA PROGRAM(MAC):
	- Download:	Java SE dev.kit 8u151 for mac.os (remember to accept term policy)
	- Open terminal(use spotlight search) 
						1. cd to the same folder as the .jar file
						Follow the steps mentioned above, except for 1 and 2.
						
						

IN GUI: 
	- Enter IP address 10.10.10.10 and click connect
	- If connection fails
		1. restart the whole system
		2. or check the java application

-------------------------------------------------------------------------------------
		STIMAT ONLY	|	Location: GUI
-------------------------------------------------------------------------------------
	

IN COMMAND, ENTER:

		;t_col 25; use_nsf 1 ; use_psf 1
OPTIONAL:
		Exposure time:			;exp_rows [0,255]
		Subtract black image:		Capture an image in total darkness
						Enable Sub.Black in GUI to remove FPN

-------------------------------------------------------------------------------------
		MARSOM ONLY	|	Location: GUI
-------------------------------------------------------------------------------------
	
OPTIONAL COMMAND:
		Exposure time:			hps exp_time [0,255]
		Subtract black image:		Capture an image in total darkness
						Enable Sub.Black in GUI to remove FPN
		High Dynamic Range:		hps use_hdr [0,1]
			
-------------------------------------------------------------------------------------
		PUTTY		|	Location: none
-------------------------------------------------------------------------------------

Manually running the program arm2fpga. Not necessary, but in case the system doesn't run on it's own (which it should)

RUNNING PUTTY: 
	 Download putty.exe (find it somewhere on google, I don't know)
		1. Find putty.exe and double click that shit
		2. In the PuTTY Configuration window
			Enter HostName, aka the FPGA's IP address (example 10.10.10.10)
			Port = 22
			Click Open
		3. When opened, "login as" will appear
			If not
				Try again
			Else
				login as: root
				Password: terasic
		4. Find and open folder or "cd /media/sdcard"
		5. Run by entering "./arm2fpga"
		6. Following should be printed (or something similar)
		
			root@socfpga:/media/sdcard# ./arm2fpga
			test: 0x10
			t2.row: 5, t2.col: 0, t2.row: 5, t2.dds: 0, t2.pix: 16init modules
			fpga init	
			frame thread init
			network init
			Listening on port 56119
			generating help menu
			starting event loop
			network connect
			Starting frame grabber