Track duration of an ML action until it changes to a different one. (#10)

- Add on action stop block with duration for callback
- Update tsconfig to ignore example datasets
- Rename test.ts to main.ts & add empty main.blocks so that we import the GH repo to MakeCode and it loads by default
the test code into the project as the main entry point.
---------

Co-authored-by: Robert Knight <[email protected]>

Author: microbit-carlos

autogenerated.ts

@@ -9,19 +9,19 @@ namespace mlrunner {
     //% fixedInstance
     export const Circle = new MlEvent(4, "Circle");
 
-    actions = [None,Shake,Still,Circle];
+    actions = [None, Shake, Still, Circle];
 
     control.onEvent(MlRunnerIds.MlRunnerInference, 1, () => {
-      prevAction = 1;
+      maybeUpdateActionStats(None);
     });
     control.onEvent(MlRunnerIds.MlRunnerInference, 2, () => {
-      prevAction = 2;
+      maybeUpdateActionStats(Shake);
     });
     control.onEvent(MlRunnerIds.MlRunnerInference, 3, () => {
-      prevAction = 3;
+      maybeUpdateActionStats(Still);
     });
     control.onEvent(MlRunnerIds.MlRunnerInference, 4, () => {
-      prevAction = 4;
+      maybeUpdateActionStats(Circle);
     });
   }
 }

main.blocks

@@ -0,0 +1 @@
+<xml xmlns="https://developers.google.com/blockly/xml"></xml>

test.ts renamed to main.ts

@@ -1,5 +1,7 @@
+let timeStill = 0
 input.onButtonPressed(Button.A, function () {
     basic.clearScreen()
+    serial.writeLine("Total time still: " + timeStill + "\n")
 })
 input.onButtonPressed(Button.B, function () {
     if (mlrunner.isRunning()) {
@@ -14,12 +16,15 @@ mlrunner.Action.Shake.onEvent(function () {
 mlrunner.Action.Still.onEvent(function () {
     basic.showIcon(IconNames.Asleep)
 })
-mlrunner.Action.Circle.onEvent( function () {
+mlrunner.Action.Circle.onEvent(function () {
     basic.showString("C")
 })
 mlrunner.Action.None.onEvent(function () {
     basic.clearScreen()
 })
+mlrunner.Action.Still.onStop(function (duration) {
+    timeStill += duration
+})
 basic.forever(function () {
     serial.writeLine("Is Shake: " + mlrunner.Action.Shake.isEvent() + "\n")
     basic.pause(10000)

pxt.json

@@ -15,7 +15,8 @@
     ],
     "testFiles": [
         "autogenerated.ts",
-        "test.ts"
+        "main.ts",
+        "main.blocks"
     ],
     "targetVersions": {
         "branch": "v6.0.26",
@@ -28,7 +29,7 @@
     "supportedTargets": [
         "microbit"
     ],
-    "preferredEditor": "blocksprj",
+    "preferredEditor": "tsprj",
     "yotta": {
         "config": {
             "ML_INFERENCE_PERIOD_MS": 250,

pxtextension.cpp

@@ -294,6 +294,8 @@ namespace mlrunner {
         mlDataProcessor.deinit();
         free(actions);
         free(predictions);
+        actions = NULL;
+        predictions = NULL;
         mlSampleCountsPerInference = 0;
         lastPredictionEventId = -1;
 

pxtextension.ts

@@ -16,12 +16,13 @@ function mlRunnerCustomOnEvent(
 class MlEvent {
   eventValue: number;
   eventLabel: string;
-  hasOnEventHandler: boolean;
+  lastDuration: number;
+  onStopHandler: (duration: number) => void;
 
   constructor(value: number, label: string) {
     this.eventValue = value;
     this.eventLabel = label;
-    this.hasOnEventHandler = false;
+    this.lastDuration = 0;
   }
 
   /**
@@ -35,13 +36,21 @@ class MlEvent {
    * @param body The code to run when the model predicts the label.
    */
   //% blockId=mlrunner_on_ml_event
-  //% block="on ML event $this"
+  //% block="on $this start"
   onEvent(body: () => void): void {
-    this.hasOnEventHandler = true;
     const wrappedBody = () => {
-      if (mlrunner.Action.prevAction !== this.eventValue) {
+      if (
+        mlrunner.Action.prevActionInstance !== this ||
+        mlrunner.deviceIsSim()
+      ) {
         body();
       }
+      if (
+        mlrunner.Action.prevActionInstance !== this &&
+        mlrunner.deviceIsSim()
+      ) {
+        mlrunner.Action.maybeUpdateActionStats(this);
+      }
     };
     if (!mlrunner.isRunning()) {
       mlrunner.startRunning();
@@ -54,14 +63,21 @@ class MlEvent {
   }
 
   //% blockId=mlrunner_is_ml_event
-  //% block="is %this action"
+  //% block="is $this action"
   isEvent(): boolean {
     if (!mlrunner.isRunning()) {
       mlrunner.startRunning();
       return false;
     }
     return this.eventValue == mlrunner.currentActionId();
   }
+
+  //% blockId=mlrunner_on_ml_event_stop
+  //% block="on $this stop $duration"
+  //% draggableParameters="reporter"
+  onStop(body: (duration: number) => void): void {
+    this.onStopHandler = body;
+  }
 }
 
 //% color=#2b64c3 weight=100 icon="\uf108" block="ML Runner" advanced=false
@@ -70,12 +86,31 @@ namespace mlrunner {
     //% fixedInstance
     export const None = new MlEvent(1, "None");
     export let actions = [None];
-    export let prevAction: number = 0;
-    export let currentAction: number = 1;
+    export let prevActionInstance: MlEvent = None;
+    export let currentAction: MlEvent = None;
+    export let lastActionTimestamp: number = 0;
+
+    export function maybeUpdateActionStats(currentAction: MlEvent) {
+      if (currentAction !== prevActionInstance) {
+        let now = input.runningTime();
+        prevActionInstance.lastDuration = now - lastActionTimestamp;
+
+        if (prevActionInstance.onStopHandler) {
+          prevActionInstance.onStopHandler(prevActionInstance.lastDuration);
+        }
+
+        lastActionTimestamp = now;
+        prevActionInstance = currentAction;
+      }
+    }
   }
 
   let simIsRunning = false;
 
+  export function deviceIsSim() {
+    return control.deviceName().slice(0, 3) === "sim";
+  }
+
   /**
    * TS shim for C++ function init(), which initialize the ML model with
    * an address to a model blob.
@@ -127,7 +162,7 @@ namespace mlrunner {
 
   //% shim=mlrunner::currentEventId
   export function currentActionId(): number {
-    return Action.currentAction;
+    return Action.currentAction.eventValue;
   }
 
   // Start simulator code.
@@ -174,21 +209,13 @@ namespace mlrunner {
   }
 
   function simulateAction(eventValue: number) {
-    // Set prevAction to 0 so that re-triggering the same action in the
-    // sim still runs the code in the action event handler.
-    Action.prevAction = 0;
-    Action.currentAction = eventValue;
     const simulatedAction = Action.actions.find(
       (action) => action.eventValue === eventValue
     );
-    if (simulatedAction.hasOnEventHandler) {
-      control.raiseEvent(MlRunnerIds.MlRunnerInference, eventValue);
-    } else {
-      Action.prevAction = simulatedAction.eventValue;
-    }
-    basic.pause(500);
-    Action.prevAction = 0;
-    Action.currentAction = 1;
+    Action.currentAction = simulatedAction;
+    // This will run the MLEvent onEvent block if it exists in the user's code.
+    // Otherwise, control.onEvent in autogenerated.ts is fired.
+    control.raiseEvent(MlRunnerIds.MlRunnerInference, eventValue);
   }
 
   function handleMessage(buffer: Buffer) {

tsconfig.json

@@ -1,13 +1,14 @@
 {
-    "compilerOptions": {
-        "target": "ES5",
-        "noImplicitAny": true,
-        "outDir": "built",
-        "rootDir": "."
-    },
-    "exclude": [
-        "pxt_modules/**/*test.ts",
-        "pxt_modules/**/autogenerated.ts",
-        "pxt_modules/**/testextension.ts"
-    ]
+  "compilerOptions": {
+    "target": "ES5",
+    "noImplicitAny": true,
+    "outDir": "built",
+    "rootDir": "."
+  },
+  "exclude": [
+    "pxt_modules/**/*test.ts",
+    "pxt_modules/**/autogenerated.ts",
+    "pxt_modules/**/testextension.ts",
+    "example-datasets/"
+  ]
 }