Merge pull request #2 from Zipcar/dev

Refactoring, response.read() fix, and version bump

Author: avatarneil

manifest.mf

@@ -2,5 +2,5 @@ Manifest-Version: 1.0
 AutoUpdate-Show-In-Client: true
 OpenIDE-Module: zipcar.emulator.spi
 OpenIDE-Module-Localizing-Bundle: zipcar/emulator/spi/Bundle.properties
-OpenIDE-Module-Specification-Version: 1.2
+OpenIDE-Module-Specification-Version: 1.2.1
 

nbproject/platform.properties

@@ -9,4 +9,4 @@ cluster.path=\
     ${nbplatform.active.dir}/mplablibs:\
     ${nbplatform.active.dir}/nb:\
     ${nbplatform.active.dir}/platform
-nbplatform.active=MPLAB_X_IDE_v4.20
+nbplatform.active=MPLAB_X_v4.20

nbproject/project.properties

@@ -1,4 +1,4 @@
 file.reference.jeromq-0.4.3.jar=release/modules/ext/jeromq-0.4.3.jar
 file.reference.snakeyaml-1.9.jar=release/modules/ext/snakeyaml-1.9.jar
-javac.source=1.7
+javac.source=1.8
 javac.compilerargs=-Xlint -Xlint:-serial

src/zipcar/emulator/spi/Spi.java

@@ -9,16 +9,11 @@
 import com.microchip.mplab.mdbcore.simulator.PeripheralSet;
 import java.io.BufferedInputStream;
 import java.io.BufferedOutputStream;
-import java.io.BufferedReader;
-import java.io.BufferedWriter;
 import java.io.File;
 import java.util.LinkedList;
 import java.io.FileInputStream;
+import java.io.FileNotFoundException;
 import java.io.IOException;
-import java.io.InputStream;
-import java.io.InputStreamReader;
-import java.io.OutputStreamWriter;
-import java.io.PrintWriter;
 import java.net.Socket;
 import org.openide.util.lookup.ServiceProvider;
 import java.util.Map;
@@ -30,8 +25,6 @@ public class Spi implements Peripheral {
     String SPI_NUM; // SPI Name (eg: SPI1, SPI2, etc...)
     String SPI_BUFF; // Respective SPI BUFFER SFR
     String SPI_STAT; // SPI STAT buffer
-    String REQUEST_FILE; // Request File Path (eg: "~/uartfolder/req"
-    String RESPONSE_FILE; // Response File Path (eg: "~/uartfolder/res"
 
     static Spi instance;
     SimulatorDataStore DS;
@@ -41,9 +34,10 @@ public class Spi implements Peripheral {
     SFR sfrBuff;
     SFR sfrStat;
     SFR sfrTX;
-    SFRSet sfrs;
+    SpiObserver spiMonitor;
 
     LinkedList<Byte> bytes = new LinkedList<Byte>();
+    Socket reqSocket;
     BufferedOutputStream request;
     BufferedInputStream response;
     Yaml yaml = new Yaml();
@@ -57,28 +51,43 @@ public class Spi implements Peripheral {
     boolean injectedFlag = false;
     boolean systemBooted = false;
     String tempStr = "";
+    FileInputStream conf;
+    Map config;
 
+    public Spi() {
+        spiMonitor = new SpiObserver();
+        yaml = new Yaml();
+    }
+
     @Override
     public boolean init(SimulatorDataStore DS) {
-        // Initialize DS
         this.DS = DS;
-
-        // Initialize messageHandler
+        SFRSet sfrs;
         messageHandler = DS.getMessageHandler();
 
         // Initialize instance variables
         try {
-            FileInputStream conf = new FileInputStream(new File("spiconfig.yml"));
-            Map config = (Map) yaml.load(conf);
+            conf = new FileInputStream(new File("spiconfig.yml"));
+            config = (Map) yaml.load(conf);
             SPI_NUM = config.get("spiNum").toString();
             SPI_BUFF = config.get("spiBuff").toString();
             SPI_STAT = config.get("spiStat").toString();
-            REQUEST_FILE = config.get("requestFile").toString();
-            RESPONSE_FILE = config.get("responseFile").toString();
-        } catch (Exception e) {
+        } catch (FileNotFoundException e) {
+            messageHandler.outputError(e);
+            messageHandler.outputMessage("Are you sure you placed config.yml in the correct folder?");
+            return false;
+        } catch (SecurityException e) {
+            messageHandler.outputError(e);
+            return false;
+        } catch (NullPointerException e) {
             messageHandler.outputError(e);
-            // return false;
+            messageHandler.outputMessage("Are you sure you have all of the necessary config fields?");
+            return false;
+        } catch (ClassCastException e) {
+            messageHandler.outputError(e);
+            return false;
         }
+
         sfrs = DS.getSFRSet();
         sfrBuff = sfrs.getSFR(SPI_BUFF);
         sfrStat = sfrs.getSFR(SPI_STAT);
@@ -90,32 +99,17 @@ public boolean init(SimulatorDataStore DS) {
             spiPeriph.deInit();
             periphSet.removePeripheral(spiPeriph);
         }
-
-        // Setup pipes
-        /* try {
-            request = new FileOutputStream(REQUEST_FILE);
-            response = new FileInputStream(RESPONSE_FILE);
-        } catch (FileNotFoundException e) {
-            messageHandler.outputMessage("Exception in init: " + e);
-            return false;
-        } */
 
         // Setup Sockets
-        try {
-            Socket reqSocket = new Socket("localhost", 5555);
-            request = new BufferedOutputStream(reqSocket.getOutputStream());
-            response = new BufferedInputStream(reqSocket.getInputStream());
-        } catch (Exception e) {
-            messageHandler.outputError(e);
-        } 
+        if (!openSockets()) {
+            return false;
+        }
 
         // Add observers
-        SpiObserver obs = new SpiObserver();
-        sfrBuff.addObserver(obs);
+        sfrBuff.addObserver(spiMonitor);
 
         messageHandler.outputMessage("External Peripheral Initialized: SPI");
-        instance = this;
-
+    
         // Add peripheral to list and return true
         DS.getPeripheralSet().addToActivePeripheralList(this);
         return true;
@@ -154,16 +148,20 @@ public void reset() {
 
     @Override
     public void update() {
+        byte[] bytes;
+        if (spiMonitor.changed()) {
+            output();
+        }
         if (cycleCount > 100000) {
             systemBooted = true;
         }
         try {
             if (sendFlag) {
                 injectedFlag = true;
                 sendFlag = false;
-                long readByte = response.read();
+                int readByte = response.read();
                 byte b = (byte) readByte;
-                if ((int) b == -1) {
+                if (readByte == -1) {
                     messageHandler.outputMessage("End of Stream");
                     System.exit(0);
                 } else {
@@ -206,7 +204,33 @@ public void output() {
         }
     }
 
-    public static Spi get() {
-        return instance;
+    public boolean openSockets() {
+        try {
+            reqSocket = new Socket("localhost", 5555);
+        } catch (IOException e) {
+            messageHandler.outputError(e);
+            messageHandler.outputMessage("Failed to open socket. Is there an external listener running?");
+            return false;
+        } catch (SecurityException e) {
+            messageHandler.outputError(e);
+            return false;
+        } catch (IllegalArgumentException e) {
+            messageHandler.outputError(e);
+            messageHandler.outputMessage("Provided port is outside of valid values (0-65535).");
+            return false;
+        } catch (NullPointerException e) {
+            messageHandler.outputError(e);
+            return false;
+        }
+
+        try {
+            request = new BufferedOutputStream(reqSocket.getOutputStream());
+            response = new BufferedInputStream(reqSocket.getInputStream());
+        } catch (IOException e) {
+            messageHandler.outputError(e);
+            messageHandler.outputMessage("Failed to open Req/Res streams.");
+            return false;
+        }
+        return true;
     }
 }

src/zipcar/emulator/spi/SpiObserver.java

@@ -14,12 +14,22 @@
  */
 public class SpiObserver implements SFRObserver {
 
+    boolean hasChanged = false;
+
     @Override
     public void update(SFR generator, SFRObserver.SFREvent event, SFRObserver.SFREventSource source) {
 
         if (event == SFRObserver.SFREvent.SFR_CHANGED) {
-            Spi.get().output();
+            hasChanged = true;
         }
 
     }
+
+    // Sets hasChanged to false and returns previous state
+    public boolean changed() {
+        boolean tempHasChanged = hasChanged;
+        hasChanged = false;
+        return tempHasChanged;
+    }
+    
 }