Merge pull request csg-tokyo#94 from maejima-fumika/bugfix/load-protocol

Fix the bug in the loading protocol in the run command.

Author: maejima-fumika

cli/package.json

@@ -11,7 +11,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "keywords": ["BlueScript", "TypeScript", "Microcontroller", "MCU","ESP32"],
+  "keywords": ["BlueScript", "TypeScript", "Microcontroller", "MCU", "IoT", "Robotics", "ESP32"],
   "author": "Fumika Mochizuki <fumika.maejima@csg.ci.i.u-tokyo.ac.jp>",
   "description": "A CLI for BlueScript",
   "repository": {

cli/src/services/device-protocol.ts

@@ -34,6 +34,7 @@ export class ProtocolPacketBuilder {
     private lastUnitRemain: number;
 
     constructor(unitSize: number, useFirstHeader = true) {
+        this.checkUnitSize(unitSize);
         if (useFirstHeader) {
             this.unitSize = unitSize - FIRST_HEADER_SIZE;
             this.lastUnit = Buffer.from(FIRST_HEADER);
@@ -44,6 +45,12 @@ export class ProtocolPacketBuilder {
         this.lastUnitRemain = this.unitSize;
     }
 
+    private checkUnitSize(size: number) {
+        if (size < 15) {
+            throw new Error('Unit size is smaller than minimum unit size.');
+        }
+    }
+
     public build(): Buffer[] {
         if (this.lastUnit.length > FIRST_HEADER_SIZE) {
             this.units.push(this.lastUnit);
@@ -64,11 +71,12 @@ export class ProtocolPacketBuilder {
 
         while (dataOffset < data.length) {
             const dataRemain = data.length - dataOffset;
-            const writtenBytes = this.loadChunk(currentAddress, data.subarray(dataOffset), dataRemain);
+            let writtenBytes = this.loadChunk(currentAddress, data.subarray(dataOffset), dataRemain);
 
             if (writtenBytes <= 0) {
                 this.flushUnit();
-                if (this.loadChunk(currentAddress, data.subarray(dataOffset), dataRemain) <= 0) {
+                writtenBytes = this.loadChunk(currentAddress, data.subarray(dataOffset), dataRemain);
+                if (writtenBytes === 0) {
                     throw new Error("Failed to make progress in load method. Check data and unit sizes.");
                 }
             }
@@ -93,7 +101,7 @@ export class ProtocolPacketBuilder {
             return 0;
         }
 
-        const header = this.createLoadHeader(Protocol.Load, address, chunkSize);
+        const header = this.createLoadHeader(address, chunkSize);
         const chunk = data.subarray(0, chunkSize);
 
         this.appendToCurrentUnit(header);
@@ -106,9 +114,9 @@ export class ProtocolPacketBuilder {
         return value & ~(alignment - 1);
     }
 
-    private createLoadHeader(loadCmd: number, address: number, size: number) {
+    private createLoadHeader(address: number, size: number) {
         const header = Buffer.allocUnsafe(LOAD_HEADER_SIZE);
-        header.writeUInt8(loadCmd, 0);       // cmd(1)
+        header.writeUInt8(Protocol.Load, 0); // cmd(1)
         header.writeUInt32LE(address, 1);    // address(4)
         header.writeUInt32LE(size, 5);       // size(4)
         return header;

cli/tests/services/device-protocol.test.ts

@@ -0,0 +1,83 @@
+import { ProtocolPacketBuilder, Protocol } from '../../src/services/device-protocol'
+
+
+const BUFFER_SIZE =  17;
+
+describe('ProtocolPacketBuilder', () => {
+    test('should add jump command', () => {
+        const builder = new ProtocolPacketBuilder(BUFFER_SIZE);
+        builder.jump(1, 0x1234);
+        const expectedBuffer = Buffer.from([
+            0x03, 0x00, // First Header
+            Protocol.Jump,
+            0x01, 0x00, 0x00, 0x00, // id
+            0x34, 0x12, 0x00, 0x00, // address
+        ]);
+        expect(builder.build()).toEqual([expectedBuffer]);
+    });
+
+    test('should add reset command', () => {
+        const builder = new ProtocolPacketBuilder(BUFFER_SIZE);
+        builder.reset();
+        const expectedBuffer = Buffer.from([
+            0x03, 0x00, // First Header
+            Protocol.Reset,
+        ]);
+        expect(builder.build()).toEqual([expectedBuffer]);
+    });
+
+    test('should add short load command', () => {
+        const builder = new ProtocolPacketBuilder(BUFFER_SIZE);
+        builder.load(0x1234, Buffer.from([0x00, 0x01, 0x02, 0x03]));
+        const expectedBuffer = Buffer.from([
+            0x03, 0x00, // First Header
+            Protocol.Load,
+            0x34, 0x12, 0x00, 0x00, // address
+            0x04, 0x00, 0x00, 0x00, // size
+            0x00, 0x01, 0x02, 0x03, // data
+        ]);
+        expect(builder.build()).toEqual([expectedBuffer]);
+    });
+
+    test('should add long load command', () => {
+        const builder = new ProtocolPacketBuilder(BUFFER_SIZE);
+        builder.load(0x1234, Buffer.from([0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06]));
+        const expectedBuffer1 = Buffer.from([
+            0x03, 0x00, // First Header
+            Protocol.Load,
+            0x34, 0x12, 0x00, 0x00, // address
+            0x04, 0x00, 0x00, 0x00, // size
+            0x00, 0x01, 0x02, 0x03, // data
+        ]);
+        const expectedBuffer2 = Buffer.from([
+            0x03, 0x00, // First Header
+            Protocol.Load,
+            0x38, 0x12, 0x00, 0x00, // address
+            0x03, 0x00, 0x00, 0x00, // size
+            0x04, 0x05, 0x06, // data
+        ]);
+        expect(builder.build()).toEqual([expectedBuffer1, expectedBuffer2]);
+    });
+
+    test('should add reset command after full load command', () => {
+        const builder = new ProtocolPacketBuilder(BUFFER_SIZE);
+        builder.load(0x1234, Buffer.from([0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06]));
+        builder.reset();
+        const expectedBuffer1 = Buffer.from([
+            0x03, 0x00, // First Header
+            Protocol.Load,
+            0x34, 0x12, 0x00, 0x00, // address
+            0x04, 0x00, 0x00, 0x00, // size
+            0x00, 0x01, 0x02, 0x03, // data
+        ]);
+        const expectedBuffer2 = Buffer.from([
+            0x03, 0x00, // First Header
+            Protocol.Load,
+            0x38, 0x12, 0x00, 0x00, // address
+            0x03, 0x00, 0x00, 0x00, // size
+            0x04, 0x05, 0x06, // data
+            Protocol.Reset,
+        ]);
+        expect(builder.build()).toEqual([expectedBuffer1, expectedBuffer2]);
+    })
+})

lang/package.json

@@ -12,8 +12,8 @@
   "publishConfig": {
     "access": "public"
   },
-  "keywords": ["BlueScript", "TypeScript", "Microcontroller", "MCU","ESP32"],
-  "description": "A CLI for BlueScript",
+  "keywords": ["BlueScript", "TypeScript", "Microcontroller", "MCU", "IoT", "Robotics", "ESP32"],
+  "description": "A BlueScript Compiler",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/csg-tokyo/bluescript.git"