Add micro:bit matrix field block (#1314)

* Add micro:bit matrix field block

* Remove debug logs

* Remove rowcol menu

* Fix lint errors

src/engine/runtime.js

@@ -58,6 +58,10 @@ const ArgumentTypeMap = (() => {
     map[ArgumentType.BOOLEAN] = {
         check: 'Boolean'
     };
+    map[ArgumentType.MATRIX] = {
+        shadowType: 'matrix',
+        fieldType: 'MATRIX'
+    };
     return map;
 })();
 

src/extension-support/argument-type.js

@@ -26,7 +26,12 @@ const ArgumentType = {
     /**
      * String value with text field
      */
-    STRING: 'string'
+    STRING: 'string',
+
+    /**
+     * String value with matirx field
+     */
+    MATRIX: 'matrix'
 };
 
 module.exports = ArgumentType;

src/extensions/scratch3_microbit/index.js

@@ -1,6 +1,7 @@
 const ArgumentType = require('../../extension-support/argument-type');
 const BlockType = require('../../extension-support/block-type');
 const log = require('../../util/log');
+const cast = require('../../util/cast');
 const BLESession = require('../../io/bleSession');
 const Base64Util = require('../../util/base64-util');
 
@@ -272,26 +273,6 @@ const TiltDirection = {
     ANY: 'any'
 };
 
-/**
- * Converting symbols to hex values
- * @readonly
- */
-const symbols2hex = {
-    '❤': 0xAAC544,
-    '♫': 0xF4AF78,
-    '☓': 0x1151151,
-    '✓': 0x8A88,
-    '↑': 0x477C84,
-    '↓': 0x427DC4,
-    '←': 0x467D84,
-    '→': 0x437CC4,
-    '◯': 0xE8C62E,
-    '☀': 0x1577DD5,
-    '☺': 0x5022E,
-    '!': 0x421004,
-    '?': 0xC91004
-};
-
 /**
  * Scratch 3.0 blocks to interact with a MicroBit device.
  */
@@ -357,19 +338,41 @@ class Scratch3MicroBitBlocks {
                     }
                 },
                 {
-                    opcode: 'whenMoved',
+                    opcode: 'isButtonPressed',
-                    text: 'when moved',
+                    text: '[BTN] button pressed?',
-                    blockType: BlockType.HAT
+                    blockType: BlockType.BOOLEAN,
+                    arguments: {
+                        BTN: {
+                            type: ArgumentType.STRING,
+                            menu: 'buttons',
+                            defaultValue: 'A'
+                        }
+                    }
                 },
+                '---',
                 {
-                    opcode: 'whenShaken',
+                    opcode: 'whenGesture',
-                    text: 'when shaken',
+                    text: 'when [GESTURE]',
-                    blockType: BlockType.HAT
+                    blockType: BlockType.HAT,
+                    arguments: {
+                        GESTURE: {
+                            type: ArgumentType.STRING,
+                            menu: 'gestures',
+                            defaultValue: 'moved'
+                        }
+                    }
                 },
+                '---',
                 {
-                    opcode: 'whenJumped',
+                    opcode: 'displaySymbol',
-                    text: 'when jumped',
+                    text: 'display [MATRIX]',
-                    blockType: BlockType.HAT
+                    blockType: BlockType.COMMAND,
+                    arguments: {
+                        MATRIX: {
+                            type: ArgumentType.MATRIX,
+                            defaultValue: '0101010101100010101000100'
+                        }
+                    }
                 },
                 {
                     opcode: 'displayText',
@@ -382,45 +385,12 @@ class Scratch3MicroBitBlocks {
                         }
                     }
                 },
-                {
-                    opcode: 'displaySymbol',
-                    text: 'display [SYMBOL]',
-                    blockType: BlockType.COMMAND,
-                    arguments: {
-                        SYMBOL: {
-                            type: ArgumentType.STRING,
-                            menu: 'symbols',
-                            defaultValue: '❤'
-                        }
-                    }
-                },
-                {
-                    opcode: 'displayMatrix',
-                    text: 'set light x:[X] y:[Y] [STATE]',
-                    blockType: BlockType.COMMAND,
-                    arguments: {
-                        X: {
-                            type: ArgumentType.STRING,
-                            menu: 'rowcol',
-                            defaultValue: '1'
-                        },
-                        Y: {
-                            type: ArgumentType.STRING,
-                            menu: 'rowcol',
-                            defaultValue: '1'
-                        },
-                        STATE: {
-                            type: ArgumentType.STRING,
-                            menu: 'pinState',
-                            defaultValue: 'on'
-                        }
-                    }
-                },
                 {
                     opcode: 'displayClear',
-                    text: 'set all lights off',
+                    text: 'clear display',
                     blockType: BlockType.COMMAND
                 },
+                '---',
                 {
                     opcode: 'whenTilted',
                     text: 'when tilted [DIRECTION]',
@@ -457,6 +427,7 @@ class Scratch3MicroBitBlocks {
                         }
                     }
                 },
+                '---',
                 {
                     opcode: 'whenPinConnected',
                     text: 'when pin [PIN] connected',
@@ -472,9 +443,8 @@ class Scratch3MicroBitBlocks {
             ],
             menus: {
                 buttons: ['A', 'B', 'any'],
-                rowcol: ['1', '2', '3', '4', '5'],
+                gestures: ['moved', 'shaken', 'jumped'],
                 pinState: ['on', 'off'],
-                symbols: Object.keys(symbols2hex),
                 tiltDirection: [TiltDirection.FRONT, TiltDirection.BACK, TiltDirection.LEFT, TiltDirection.RIGHT],
                 tiltDirectionAny: [
                     TiltDirection.FRONT, TiltDirection.BACK, TiltDirection.LEFT,
@@ -501,28 +471,58 @@ class Scratch3MicroBitBlocks {
         return false;
     }
 
+    /**
+     * Test whether the A or B button is pressed
+     * @param {object} args - the block's arguments.
+     * @return {boolean} - true if the button is pressed.
+     */
+    isButtonPressed (args) {
+        if (args.BTN === 'any') {
+            return this._device.buttonA | this._device.buttonB;
+        } else if (args.BTN === 'A') {
+            return this._device.buttonA;
+        } else if (args.BTN === 'B') {
+            return this._device.buttonB;
+        }
+        return false;
+    }
+
     /**
      * Test whether the micro:bit is moving
+     * @param {object} args - the block's arguments.
      * @return {boolean} - true if the micro:bit is moving.
      */
-    whenMoved () {
+    whenGesture (args) {
-        return (this._device.gestureState >> 2) & 1;
+        const gesture = cast.toString(args.GESTURE);
+        if (gesture === 'moved') {
+            return (this._device.gestureState >> 2) & 1;
+        } else if (gesture === 'shaken') {
+            return this._device.gestureState & 1;
+        } else if (gesture === 'jumped') {
+            return (this._device.gestureState >> 1) & 1;
+        }
+        return false;
     }
 
     /**
-     * Test whether the micro:bit is shaken
+     * Display a predefined symbol on the 5x5 LED matrix.
-     * @return {boolean} - true if the micro:bit is shaken.
+     * @param {object} args - the block's arguments.
+     * @return {Promise} - a Promise that resolves when writing to device.
      */
-    whenShaken () {
+    displaySymbol (args) {
-        return this._device.gestureState & 1;
+        const symbol = cast.toString(args.MATRIX);
-    }
+        const reducer = (accumulator, c, index) => {
-
+            const value = (c === '0') ? accumulator : accumulator + Math.pow(2, index);
-    /**
+            return value;
-     * Test whether the micro:bit is free falling
+        };
-     * @return {boolean} - true if the micro:bit is free falling.
+        const hex = symbol.split('').reduce(reducer, 0);
-     */
+        if (!hex) return;
-    whenJumped () {
+        this._device.ledMatrixState[0] = hex & 0x1F;
-        return (this._device.gestureState >> 1) & 1;
+        this._device.ledMatrixState[1] = (hex >> 5) & 0x1F;
+        this._device.ledMatrixState[2] = (hex >> 10) & 0x1F;
+        this._device.ledMatrixState[3] = (hex >> 15) & 0x1F;
+        this._device.ledMatrixState[4] = (hex >> 20) & 0x1F;
+        return this._device.displayMatrix(this._device.ledMatrixState);
     }
 
     /**
@@ -536,36 +536,6 @@ class Scratch3MicroBitBlocks {
         return this._device.displayText(text);
     }
 
-    /**
-     * Display a predefined symbol on the 5x5 LED matrix.
-     * @param {object} args - the block's arguments.
-     * @return {Promise} - a Promise that resolves when writing to device.
-     */
-    displaySymbol (args) {
-        const hex = symbols2hex[args.SYMBOL];
-        if (!hex) return;
-        this._device.ledMatrixState[0] = (hex >> 20) & 0x1F;
-        this._device.ledMatrixState[1] = (hex >> 15) & 0x1F;
-        this._device.ledMatrixState[2] = (hex >> 10) & 0x1F;
-        this._device.ledMatrixState[3] = (hex >> 5) & 0x1F;
-        this._device.ledMatrixState[4] = hex & 0x1F;
-        return this._device.displayMatrix(this._device.ledMatrixState);
-    }
-
-    /**
-     * Control individual LEDs on the 5x5 matrix.
-     * @param {object} args - the block's arguments.
-     */
-    displayMatrix (args) {
-        if (args.STATE === 'on') {
-            this._device.ledMatrixState[args.Y - 1] |= 1 << 5 - args.X;
-        } else if (args.STATE === 'off') {
-            this._device.ledMatrixState[args.Y - 1] &= ~(1 << 5 - args.X);
-        } else return;
-        this._device.displayMatrix(this._device.ledMatrixState);
-        return;
-    }
-
     /**
      * Turn all 5x5 matrix LEDs off.
      */