pxt-common-packages 9.5.2 → 9.5.5

package/libs/palette/built/debug/binary.js

@@ -27260,7 +27260,7 @@ switch (step) {
     return leave(s, r0)
   default: oops()
 } } }
-tiles_TileMap_isOnWall__P171489.info = {"start":16824,"length":627,"line":533,"column":8,"endLine":550,"endColumn":9,"fileName":"pxt_modules/game/tilemap.ts","functionName":"isOnWall","argumentNames":["this","s"]}
+tiles_TileMap_isOnWall__P171489.info = {"start":16837,"length":627,"line":534,"column":8,"endLine":551,"endColumn":9,"fileName":"pxt_modules/game/tilemap.ts","functionName":"isOnWall","argumentNames":["this","s"]}
 
 function tiles_TileMap_isOnWall__P171489_mk(s) {
     checkStack(s.depth);
@@ -27350,7 +27350,7 @@ switch (step) {
     return leave(s, r0)
   default: oops()
 } } }
-tiles_TileMap_isObstacle__P171487.info = {"start":16183,"length":211,"line":514,"column":8,"endLine":519,"endColumn":9,"fileName":"pxt_modules/game/tilemap.ts","functionName":"isObstacle","argumentNames":["this","col","row"]}
+tiles_TileMap_isObstacle__P171487.info = {"start":16196,"length":211,"line":515,"column":8,"endLine":520,"endColumn":9,"fileName":"pxt_modules/game/tilemap.ts","functionName":"isObstacle","argumentNames":["this","col","row"]}
 
 function tiles_TileMap_isObstacle__P171487_mk(s) {
     checkStack(s.depth);
@@ -29004,7 +29004,7 @@ switch (step) {
     return leave(s, r0)
   default: oops()
 } } }
-tiles_getTileImage__P171501.info = {"start":21815,"length":207,"line":672,"column":4,"endLine":676,"endColumn":5,"fileName":"pxt_modules/game/tilemap.ts","functionName":"getTileImage","argumentNames":["loc"]}
+tiles_getTileImage__P171501.info = {"start":21828,"length":207,"line":673,"column":4,"endLine":677,"endColumn":5,"fileName":"pxt_modules/game/tilemap.ts","functionName":"getTileImage","argumentNames":["loc"]}
 
 function tiles_getTileImage__P171501_mk(s) {
     checkStack(s.depth);
@@ -29145,7 +29145,7 @@ switch (step) {
     return leave(s, r0)
   default: oops()
 } } }
-tiles_TileMap_getTileIndex__P171479.info = {"start":11142,"length":105,"line":383,"column":8,"endLine":385,"endColumn":9,"fileName":"pxt_modules/game/tilemap.ts","functionName":"getTileIndex","argumentNames":["this","col","row"]}
+tiles_TileMap_getTileIndex__P171479.info = {"start":11155,"length":105,"line":384,"column":8,"endLine":386,"endColumn":9,"fileName":"pxt_modules/game/tilemap.ts","functionName":"getTileIndex","argumentNames":["this","col","row"]}
 
 function tiles_TileMap_getTileIndex__P171479_mk(s) {
     checkStack(s.depth);
@@ -29265,7 +29265,7 @@ switch (step) {
     return leave(s, r0)
   default: oops()
 } } }
-tiles_TileMap_getTileImage__P171490.info = {"start":17461,"length":96,"line":552,"column":8,"endLine":554,"endColumn":9,"fileName":"pxt_modules/game/tilemap.ts","functionName":"getTileImage","argumentNames":["this","index"]}
+tiles_TileMap_getTileImage__P171490.info = {"start":17474,"length":96,"line":553,"column":8,"endLine":555,"endColumn":9,"fileName":"pxt_modules/game/tilemap.ts","functionName":"getTileImage","argumentNames":["this","index"]}
 
 function tiles_TileMap_getTileImage__P171490_mk(s) {
     checkStack(s.depth);
@@ -29515,7 +29515,7 @@ switch (step) {
     return leave(s, r0)
   default: oops()
 } } }
-tiles_TileMap_getTile__P171478.info = {"start":11021,"length":111,"line":379,"column":8,"endLine":381,"endColumn":9,"fileName":"pxt_modules/game/tilemap.ts","functionName":"getTile","argumentNames":["this","col","row"]}
+tiles_TileMap_getTile__P171478.info = {"start":11034,"length":111,"line":380,"column":8,"endLine":382,"endColumn":9,"fileName":"pxt_modules/game/tilemap.ts","functionName":"getTile","argumentNames":["this","col","row"]}
 
 function tiles_TileMap_getTile__P171478_mk(s) {
     checkStack(s.depth);
@@ -30139,7 +30139,7 @@ switch (step) {
     return leave(s, r0)
   default: oops()
 } } }
-tiles_TileMap_getObstacle__P171488.info = {"start":16404,"length":410,"line":521,"column":8,"endLine":531,"endColumn":9,"fileName":"pxt_modules/game/tilemap.ts","functionName":"getObstacle","argumentNames":["this","col","row"]}
+tiles_TileMap_getObstacle__P171488.info = {"start":16417,"length":410,"line":522,"column":8,"endLine":532,"endColumn":9,"fileName":"pxt_modules/game/tilemap.ts","functionName":"getObstacle","argumentNames":["this","col","row"]}
 
 function tiles_TileMap_getObstacle__P171488_mk(s) {
     checkStack(s.depth);
@@ -35027,7 +35027,7 @@ switch (step) {
     return leave(s, r0)
   default: oops()
 } } }
-Sprite_toString__P171170.info = {"start":37683,"length":93,"line":1169,"column":4,"endLine":1171,"endColumn":5,"fileName":"pxt_modules/game/sprite.ts","functionName":"toString","argumentNames":["this"]}
+Sprite_toString__P171170.info = {"start":37718,"length":93,"line":1170,"column":4,"endLine":1172,"endColumn":5,"fileName":"pxt_modules/game/sprite.ts","functionName":"toString","argumentNames":["this"]}
 
 function Sprite_toString__P171170_mk(s) {
     checkStack(s.depth);
@@ -36461,7 +36461,7 @@ switch (step) {
     return leave(s, r0)
   default: oops()
 } } }
-tiles_TileMap_draw__P171486.info = {"start":13949,"length":2224,"line":457,"column":8,"endLine":512,"endColumn":9,"fileName":"pxt_modules/game/tilemap.ts","functionName":"draw","argumentNames":["this","target","camera"]}
+tiles_TileMap_draw__P171486.info = {"start":13962,"length":2224,"line":458,"column":8,"endLine":513,"endColumn":9,"fileName":"pxt_modules/game/tilemap.ts","functionName":"draw","argumentNames":["this","target","camera"]}
 
 function tiles_TileMap_draw__P171486_mk(s) {
     checkStack(s.depth);

package/libs/radio/_locales/radio-jsdoc-strings.json

@@ -2,6 +2,8 @@
   "radio": "Communicate data using radio packets",
   "radio._packetProperty": "Gets a packet property.",
   "radio._packetProperty|param|type": "the packet property type, eg: PacketProperty.time",
+  "radio.off": "Disables the radio for use as a multipoint sender/receiver.\nDisabling radio will help conserve battery power when it is not in use.",
+  "radio.on": "Initialises the radio for use as a multipoint sender/receiver\nOnly useful when the radio.off() is used beforehand.",
   "radio.onDataReceived": "Used internally by the library.",
   "radio.onReceivedBuffer": "Registers code to run when the radio receives a buffer.",
   "radio.onReceivedNumber": "Registers code to run when the radio receives a number.",

package/libs/radio/_locales/radio-strings.json

@@ -18,5 +18,8 @@
   "radio.setTransmitPower|block": "radio set transmit power %power",
   "radio.setTransmitSerialNumber|block": "radio set transmit serial number %transmit",
   "radio|block": "radio",
-  "{id:category}Radio": "Radio"
+  "{id:category}Radio": "Radio",
+  "{id:group}Group": "Group",
+  "{id:group}Receive": "Receive",
+  "{id:group}Send": "Send"
 }

package/libs/radio/radio.cpp

@@ -73,28 +73,80 @@ CODAL_RADIO* getRadio() {
 #endif // #else
 
     bool radioEnabled = false;
+    bool init = false;
     int radioEnable() {
 #ifdef CODAL_RADIO
         auto radio = getRadio();
         if (NULL == radio) 
             return DEVICE_NOT_SUPPORTED;
 
+        if (init && !radioEnabled) {
+            //If radio was explicitly disabled from a call to off API
+            //We don't want to enable it here. User needs to call on API first.
+            return DEVICE_NOT_SUPPORTED;
+        }
+
         int r = radio->enable();
         if (r != DEVICE_OK) {
             target_panic(43);
             return r;
         }
-        if (!radioEnabled) {
-            getRadio()->setGroup(pxt::programHash());
+        if (!init) {
+            getRadio()->setGroup(0); //Default group zero. This used to be pxt::programHash()
             getRadio()->setTransmitPower(6); // start with high power by default
-            radioEnabled = true;
+            init = true;
         }
+        radioEnabled = true;
         return r;
 #else
         return DEVICE_NOT_SUPPORTED;
 #endif
     }
 
+    /**
+    * Disables the radio for use as a multipoint sender/receiver.
+    * Disabling radio will help conserve battery power when it is not in use.
+    */
+    //% help=radio/off
+    void off() {
+#ifdef CODAL_RADIO
+        auto radio = getRadio();
+        if (NULL == radio)
+            return;
+
+        int r = radio->disable();
+        if (r != DEVICE_OK) {
+            target_panic(43);
+        } else {
+            radioEnabled = false;
+        }
+#else
+        return;
+#endif
+    }
+
+    /**
+    * Initialises the radio for use as a multipoint sender/receiver
+    * Only useful when the radio.off() is used beforehand.
+    */
+    //% help=radio/on
+    void on() {
+#ifdef CODAL_RADIO
+        auto radio = getRadio();
+        if (NULL == radio)
+            return;
+
+        int r = radio->enable();
+        if (r != DEVICE_OK) {
+            target_panic(43);
+        } else {
+            radioEnabled = true;
+        }
+#else
+        return;
+#endif
+    }
+
     /**
     * Sends an event over radio to neigboring devices
     */
@@ -185,6 +237,7 @@ CODAL_RADIO* getRadio() {
     //% weight=100
     //% blockId=radio_set_group block="radio set group %ID"
     //% id.min=0 id.max=255
+    //% group="Group"
     void setGroup(int id) {
 #ifdef CODAL_RADIO        
         if (radioEnable() != DEVICE_OK) return;

package/libs/radio/radio.ts

@@ -14,7 +14,7 @@ enum RadioPacketProperty {
 /**
  * Communicate data using radio packets
  */
-//% color=#E3008C weight=96 icon="\uf012"
+//% color=#E3008C weight=96 icon="\uf012" groups='["Group", "Broadcast", "Send", "Receive"]'
 namespace radio {
 
     // keep in sync with CODAL
@@ -95,6 +95,8 @@ namespace radio {
     //% help=radio/on-received-number
     //% blockId=radio_on_number_drag block="on radio received" blockGap=16
     //% useLoc="radio.onDataPacketReceived" draggableParameters=reporter
+    //% group="Receive"
+    //% weight=20
     export function onReceivedNumber(cb: (receivedNumber: number) => void) {
         init();
         onReceivedNumberHandler = cb;
@@ -106,6 +108,8 @@ namespace radio {
     //% help=radio/on-received-value
     //% blockId=radio_on_value_drag block="on radio received" blockGap=16
     //% useLoc="radio.onDataPacketReceived" draggableParameters=reporter
+    //% group="Receive"
+    //% weight=19
     export function onReceivedValue(cb: (name: string, value: number) => void) {
         init();
         onReceivedValueHandler = cb;
@@ -117,6 +121,8 @@ namespace radio {
     //% help=radio/on-received-string
     //% blockId=radio_on_string_drag block="on radio received" blockGap=16
     //% useLoc="radio.onDataPacketReceived" draggableParameters=reporter
+    //% group="Receive"
+    //% weight=18
     export function onReceivedString(cb: (receivedString: string) => void) {
         init();
         onReceivedStringHandler = cb;
@@ -138,8 +144,10 @@ namespace radio {
      * @param type the type of property to retrieve from the last packet
      */
     //% help=radio/received-packet
-    //% weight=11 blockGap=8
+    //% blockGap=8
     //% blockId=radio_received_packet block="received packet %type=radio_packet_property" blockGap=16
+    //% group="Receive"
+    //% weight=16
     export function receivedPacket(type: number) {
         if (lastPacket) {
             switch (type) {
@@ -272,6 +280,7 @@ namespace radio {
     //% help=radio/send-number
     //% weight=60
     //% blockId=radio_datagram_send block="radio send number %value" blockGap=8
+    //% group="Send"
     export function sendNumber(value: number) {
         let packet: RadioPacket;
 
@@ -296,6 +305,7 @@ namespace radio {
     //% help=radio/send-value
     //% weight=59
     //% blockId=radio_datagram_send_value block="radio send|value %name|= %value" blockGap=8
+    //% group="Send"
     export function sendValue(name: string, value: number) {
         let packet: RadioPacket;
 
@@ -319,6 +329,7 @@ namespace radio {
     //% weight=58
     //% blockId=radio_datagram_send_string block="radio send string %msg"
     //% msg.shadowOptions.toString=true
+    //% group="Send"
     export function sendString(value: string) {
         const packet = RadioPacket.mkPacket(PACKET_TYPE_STRING);
         packet.stringPayload = value;

package/libs/radio/shims.d.ts

@@ -5,6 +5,20 @@
     //% color=#E3008C weight=96 icon="\uf012"
 declare namespace radio {
 
+    /**
+     * Disables the radio for use as a multipoint sender/receiver.
+     * Disabling radio will help conserve battery power when it is not in use.
+     */
+    //% help=radio/off shim=radio::off
+    function off(): void;
+
+    /**
+     * Initialises the radio for use as a multipoint sender/receiver
+     * Only useful when the radio.off() is used beforehand.
+     */
+    //% help=radio/on shim=radio::on
+    function on(): void;
+
     /**
      * Sends an event over radio to neigboring devices
      */
@@ -44,7 +58,8 @@ declare namespace radio {
     //% help=radio/set-group
     //% weight=100
     //% blockId=radio_set_group block="radio set group %ID"
-    //% id.min=0 id.max=255 shim=radio::setGroup
+    //% id.min=0 id.max=255
+    //% group="Group" shim=radio::setGroup
     function setGroup(id: int32): void;
 
     /**

package/libs/radio/sim/radio.ts

@@ -22,11 +22,13 @@ namespace pxsim.radio {
     export function sendRawPacket(buf: RefBuffer) {
         let cb = getResume();
         const state = pxsim.getRadioState();
-        state.datagram.send({
-            type: 0,
-            groupId: state.groupId,
-            bufferData: buf.data
-        });
+        if (state.enable) {
+            state.datagram.send({
+                type: 0,
+                groupId: state.groupId,
+                bufferData: buf.data
+            });
+        }
         setTimeout(cb, 1);
     }
 
@@ -50,4 +52,15 @@ namespace pxsim.radio {
         const state = pxsim.getRadioState();
         state.datagram.onReceived(handler);
     }
+
+    export function off(){
+        const state = pxsim.getRadioState();
+        state.off();
+    }
+
+    export function on(){
+        const state = pxsim.getRadioState();
+        state.on();
+    }
+
 }

package/libs/radio/sim/state.ts

@@ -87,13 +87,14 @@ namespace pxsim {
         datagram: RadioDatagram;
         groupId: number;
         band: number;
+        enable: boolean;
 
         constructor(private readonly runtime: Runtime, private readonly board: BaseBoard, dal: RadioDAL) {
             this.datagram = new RadioDatagram(runtime, dal);
             this.power = 6; // default value
             this.groupId = 0;
             this.band = 7; // https://github.com/lancaster-university/microbit-dal/blob/master/inc/core/MicroBitConfig.h#L320
-
+            this.enable = true;
             this.board.addMessageListener(this.handleMessage.bind(this))
         }
 
@@ -105,12 +106,16 @@ namespace pxsim {
         }
 
         public setGroup(id: number) {
-            this.groupId = id & 0xff; // byte only
+            if (this.enable) {
+                this.groupId = id & 0xff; // byte only
+            }
         }
 
         setTransmitPower(power: number) {
-            power = power | 0;
-            this.power = Math.max(0, Math.min(7, power));
+            if (this.enable) {
+                power = power | 0;
+                this.power = Math.max(0, Math.min(7, power));
+            }
         }
 
         setTransmitSerialNumber(sn: boolean) {
@@ -118,25 +123,40 @@ namespace pxsim {
         }
 
         setFrequencyBand(band: number) {
-            band = band | 0;
-            if (band < 0 || band > 83) return;
-            this.band = band;
+            if (this.enable) {
+                band = band | 0;
+                if (band < 0 || band > 83) return;
+                this.band = band;
+            }
+        }
+
+        off() {
+           this.enable = false;
         }
 
+        on() {
+            this.enable = true;
+         }
+ 
         raiseEvent(id: number, eventid: number) {
-            Runtime.postMessage(<SimulatorEventBusMessage>{
-                type: "eventbus",
-                broadcast: true,
-                id,
-                eventid,
-                power: this.power,
-                group: this.groupId
-            })
+            if (this.enable) {
+                Runtime.postMessage(<SimulatorEventBusMessage>{
+                    type: "eventbus",
+                    broadcast: true,
+                    id,
+                    eventid,
+                    power: this.power,
+                    group: this.groupId
+                })
+            }
         }
 
         receivePacket(packet: SimulatorRadioPacketMessage) {
-            if (this.groupId == packet.payload.groupId)
-                this.datagram.queue(packet)
+            if (this.enable) {
+                if (this.groupId == packet.payload.groupId) {
+                    this.datagram.queue(packet)
+               }
+            }
         }
     }
 }

package/libs/radio-broadcast/_locales/radio-broadcast-strings.json

@@ -2,5 +2,6 @@
   "radio.onReceivedMessage|block": "on radio $msg received",
   "radio.sendMessage|block": "radio send $msg",
   "radio|block": "radio",
-  "{id:category}Radio": "Radio"
+  "{id:category}Radio": "Radio",
+  "{id:group}Broadcast": "Broadcast"
 }

package/libs/radio-broadcast/built/debug/binary.js

@@ -56,7 +56,7 @@ const pxsim_pxtrt = pxsim.pxtrt;
 const pxsim_numops = pxsim.numops;
 
 
-function _main___P186883(s) {
+function _main___P186885(s) {
 let r0 = s.r0, step = s.pc;
 s.pc = -1;
 
@@ -66,19 +66,19 @@ if (yieldSteps-- < 0 && maybeYield(s, step, r0) || runtime !== pxsim.runtime) re
 switch (step) {
   case 0:
 
-    globals._intervals___187126 = (undefined);
-    globals._pollEventQueue___187139 = (undefined);
+    globals._intervals___187128 = (undefined);
+    globals._pollEventQueue___187141 = (undefined);
     r0 = undefined;
     return leave(s, r0)
   default: oops()
 } } }
-_main___P186883.info = {"start":0,"length":0,"line":0,"column":0,"endLine":0,"endColumn":0,"fileName":"radio-broadcast.ts","functionName":"<main>","argumentNames":[]}
-_main___P186883.continuations = [  ]
+_main___P186885.info = {"start":0,"length":0,"line":0,"column":0,"endLine":0,"endColumn":0,"fileName":"radio-broadcast.ts","functionName":"<main>","argumentNames":[]}
+_main___P186885.continuations = [  ]
 
-function _main___P186883_mk(s) {
+function _main___P186885_mk(s) {
     checkStack(s.depth);
     return {
-        parent: s, fn: _main___P186883, depth: s.depth + 1,
+        parent: s, fn: _main___P186885, depth: s.depth + 1,
         pc: 0, retval: undefined, r0: undefined, overwrittenPC: false, lambdaArgs: null,
 } }
 
@@ -88,5 +88,5 @@ function _main___P186883_mk(s) {
 
 const breakpoints = setupDebugger(1, [])
 
-return _main___P186883
+return _main___P186885
 })

package/libs/radio-broadcast/radio-broadcast.ts

@@ -21,6 +21,7 @@ namespace radio {
     //% weight=200
     //% blockGap=8
     //% help=radio/send-message
+    //% group="Broadcast"
     export function sendMessage(msg: number): void {
         // 0 is MICROBIT_EVT_ANY, shifting by 1
         radio.raiseEvent(BROADCAST_GENERAL_ID, msg + 1);
@@ -35,6 +36,7 @@ namespace radio {
     //% msg.shadow=radioMessageCode draggableParameters
     //% weight=199
     //% help=radio/on-received-message
+    //% group="Broadcast"
     export function onReceivedMessage(msg: number, handler: () => void) {
         control.onEvent(BROADCAST_GENERAL_ID, msg + 1, handler);
     }