refactor + notifications

Author: microbit-sam

src/main/java/org/microbit/android/partialflashing/HexUtils.java

@@ -27,8 +27,6 @@
 public class HexUtils {
     private final static String TAG = HexUtils.class.getSimpleName();
 
-    private final static String PXT_MAGIC = "708E3B92C615A841C49866C975EE5197";
-
     private final static int INIT = 0;
     private final static int INVALID_FILE = 1;
     private final static int NO_PARTIAL_FLASH = 2;
@@ -38,18 +36,6 @@ public class HexUtils {
     BufferedReader reader = null;
     List<String> hexLines = new ArrayList<String>();
 
-    int BUFFER_LIMIT = 10000;
-
-    String templateHash;
-    String programHash;
-    int sectionAddress;
-    int magicAddress;
-
-    int currentRecordType   = 0;
-    int currentRecordOffset = 0;
-
-    int magicLines = 0;
-
     public HexUtils(String filePath){
         // Hex Utils initialization
         // Open File
@@ -87,10 +73,20 @@ public Boolean openHexFile(String filePath) throws IOException {
         return true;
     }
 
+    /* 
+     * A function to find the length of the hex file
+     * @param none
+     * @ return the size (# of lines) in the hex file
+     */
     public int numOfLines() {
             return hexLines.size();
     }
-
+    
+    /* 
+     * A function to search for data in a hex file
+     * @param the _string_ of data to search for
+     * @return the index of the data. -1 if not found.
+     */
     public int searchForData(String search) throws IOException {
         // Iterate through
         ListIterator i = hexLines.listIterator();
@@ -105,19 +101,40 @@ public int searchForData(String search) throws IOException {
         // Return -1 if no match
         return -1;
     }
-
+    
+    /*
+     * Returns data from an index
+     * @param index
+     * @return data as string
+     */
     public String getDataFromIndex(int index) throws IOException {
             return getRecordData(hexLines.get(index)); 
     }
 
+    /*
+     * Returns record type from an index
+     * @param index
+     * @return type as int
+     */
     public int getRecordTypeFromIndex(int index) throws IOException {
             return getRecordType(hexLines.get(index));
     }
 
+    /*
+     * Returns record address from an index
+     * Note: does not include segment address
+     * @param index
+     * @return address as int
+     */
     public int getRecordAddressFromIndex(int index) throws IOException {
             return getRecordAddress(hexLines.get(index));
     }
 
+    /*
+     * Returns segment address from an index
+     * @param index
+     * @return address as int
+     */
     public int getSegmentAddress(int index) throws IOException {
             // Look backwards to find current segment address
             int segmentAddress = -1;
@@ -132,46 +149,6 @@ public int getSegmentAddress(int index) throws IOException {
             return Integer.parseInt(getRecordData(hexLines.get(cur)), 16);
     }
 
-    public Boolean findMagic(String magic) throws IOException {
-        String record;
-
-        try {
-            while ((record = reader.readLine()) != null) {
-                // Inc magic lines
-                magicLines++;
-
-                // Record Type
-                switch(getRecordType(record)) {
-                    case 0: // Data
-                        // Once the magic happens..
-                        if(getRecordData(record).equals(magic)){
-                            // Store Magic Address and Break
-                            magicAddress = sectionAddress + getRecordAddress(record);
-                            Log.v(TAG, "Magic Found!");
-                            return true;
-                        }
-                        break;
-                    case 1: // If record type is EOF break the loop
-                        return false;
-                    case 4:
-                        // Recent Section
-                        sectionAddress = Integer.parseInt(getRecordData(record), 16);
-                        break;
-                }
-
-                // Set mark to Magic record -1
-                reader.mark(BUFFER_LIMIT);
-
-            }
-        } catch (Exception e){
-            Log.e(TAG, "Find Magic " + e.toString());
-        }
-
-        // If magic is never found and there is no EOF file marker
-        // Should never return here
-        return false;
-    }
-
     /*
         Used to get the data address from a record
         @param Record as a String
@@ -208,14 +185,6 @@ private int getRecordType(String record){
         }
     }
 
-    /*
-    Used to get the record type from the current record if it exists
-    @return Record type as a decimal
-    */
-    public int getRecordType(){
-        return currentRecordType;
-    }
-
     /*
     Used to get the data from a record
     @param Record as a String
@@ -231,68 +200,6 @@ private String getRecordData(String record){
         }
     }
 
-    /*
-    Used to return the data from the next record
-     */
-    public String getNextData() throws IOException {
-        String data = reader.readLine();
-        currentRecordType = getRecordType(data);
-        currentRecordOffset = getRecordAddress(data);
-        return getRecordData(data);
-    }
-
-    // Specific Functions Used For Partial Flashing Below
-    /*
-    Returns the template hash
-    @return templateHash
-     */
-    public String getTemplateHash(){
-        return templateHash;
-    }
-
-    /*
-    Returns the program hash
-    @return programHash
-     */
-    public String getProgramHash(){
-        return programHash;
-    }
-
-    /*
-    Find HEX Meta Data
-     */
-    public Boolean findHexMetaData(String filePath) throws IOException {
-      return false;
-    }
-
-    /*
-    Find start address & start of PXT data
-     */
-    public Integer getSectionAddress(){
-        return sectionAddress;
-    }
-
-    /*
-    Get offset of current record
-     */
-    public int getRecordOffset(){
-        return currentRecordOffset;
-    }
-
-    /*
-    Set mark to beginning of page
-     */
-    public void setMark() throws IOException {
-        reader.mark(BUFFER_LIMIT);
-    }
-
-    /*
-    Rewind to start of page
-     */
-    public void rewind() throws IOException {
-        reader.reset();
-    }
-
     /*
     Number of lines / packets in file
      */
@@ -304,12 +211,5 @@ public int numOfLines(String filePath) throws IOException {
         return lines;
     }
 
-    /*
-    Lines / packets before magic
-     */
-    public int getMagicLines()
-    {
-        return magicLines;
-    }
 }
 

src/main/java/org/microbit/android/partialflashing/PartialFlashingBaseService.java

@@ -62,6 +62,7 @@ public abstract class PartialFlashingBaseService extends IntentService {
     private static final byte PACKET_STATE_RETRANSMIT = (byte)0xAA;
     private byte packetState = PACKET_STATE_WAITING;
 
+    // Used to lock the program state while we wait for a Bluetooth operation to complete
     private static final boolean BLE_WAITING = false;
     private static final boolean BLE_READY = true;
     private boolean bluetoothStatus = BLE_WAITING;
@@ -102,10 +103,13 @@ public abstract class PartialFlashingBaseService extends IntentService {
     @Override
     public void onCreate() {
         super.onCreate();
+
+        // Create intent filter and add to Local Broadcast Manager so that we can use an Intent to 
+        // start the Partial Flashing Service
 
         final IntentFilter intentFilter = new IntentFilter();                           
         intentFilter.addAction(PartialFlashingBaseService.BROADCAST_ACTION);                       
-
+        
         final LocalBroadcastManager manager = LocalBroadcastManager.getInstance(this);
         manager.registerReceiver(broadcastReceiver, intentFilter);
     }
@@ -237,14 +241,6 @@ private void sendProgressBroadcast(final int progress) {
         LocalBroadcastManager.getInstance(this).sendBroadcast(broadcast);
     }
 
-//    private void sendErrorBroadcast(final int error) {
-//
-//       final Intent broadcast = new Intent(BROADCAST_ERROR);
-//
-//        broadcast.putExtra(EXTRA_DEVICE_ADDRESS, mDeviceAddress);
-//        LocalBroadcastManager.getInstance(this).sendBroadcast(broadcast);
-//    }
-
     // Write to BLE Flash Characteristic
     public Boolean writePartialFlash(byte data[]){
 
@@ -265,13 +261,13 @@ public Boolean attemptPartialFlash(String filePath) {
         int numOfLines = 0;
         try {
 
-            Log.v(TAG, "starting pf");
+            Log.v(TAG, "attemptPartialFlash()");
 
             HexUtils hex = new HexUtils(filePath);
             int magicIndex = hex.searchForData(PXT_MAGIC);
             if (magicIndex > -1) {
 
-                Log.v(TAG, "found meta");
+                Log.v(TAG, "Found PXT_MAGIC");
 
                 numOfLines = hex.numOfLines() - magicIndex;
                 Log.v(TAG, "Total lines: " + numOfLines);
@@ -329,7 +325,6 @@ public Boolean attemptPartialFlash(String filePath) {
                     if(count == 4){
                         count = 0;
                         // Wait for notification
-                        int waitTime = 0;
                         while(packetState == PACKET_STATE_WAITING);
 
                         // Reset to waiting state
@@ -344,15 +339,17 @@ public Boolean attemptPartialFlash(String filePath) {
                     if(packetState == PACKET_STATE_RETRANSMIT) {
                         lineCount = lineCount - 4;
                     } else {
-                        // send progress update
+                        // Send progress update
                         Log.v(TAG, "LC: " + lineCount + ", NL: " + numOfLines);
                         int percent = Math.round((float)100 * ((float)(lineCount) / (float)(numOfLines)));
                         sendProgressBroadcast(percent);
+                        
+                        // Next line
+                        lineCount = lineCount + 1;
                     }
 
                     // Increment packet #
                     packetNum = packetNum + 1;
-                    lineCount = lineCount + 1;
 
                 }