pxt-common-packages 9.5.3 → 9.5.4

package/built/common-sim.d.ts

@@ -882,6 +882,8 @@ declare namespace pxsim.radio {
     function sendRawPacket(buf: RefBuffer): void;
     function readRawPacket(): RefBuffer;
     function onDataReceived(handler: RefAction): void;
+    function off(): void;
+    function on(): void;
 }
 declare namespace pxsim {
     interface RadioBoard extends EventBusBoard {
@@ -924,12 +926,15 @@ declare namespace pxsim {
         datagram: RadioDatagram;
         groupId: number;
         band: number;
+        enable: boolean;
         constructor(runtime: Runtime, board: BaseBoard, dal: RadioDAL);
         private handleMessage;
         setGroup(id: number): void;
         setTransmitPower(power: number): void;
         setTransmitSerialNumber(sn: boolean): void;
         setFrequencyBand(band: number): void;
+        off(): void;
+        on(): void;
         raiseEvent(id: number, eventid: number): void;
         receivePacket(packet: SimulatorRadioPacketMessage): void;
     }

package/built/common-sim.js

@@ -3119,11 +3119,13 @@ var pxsim;
         function sendRawPacket(buf) {
             let cb = pxsim.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);
         }
         radio.sendRawPacket = sendRawPacket;
@@ -3147,6 +3149,16 @@ var pxsim;
             state.datagram.onReceived(handler);
         }
         radio.onDataReceived = onDataReceived;
+        function off() {
+            const state = pxsim.getRadioState();
+            state.off();
+        }
+        radio.off = off;
+        function on() {
+            const state = pxsim.getRadioState();
+            state.on();
+        }
+        radio.on = on;
     })(radio = pxsim.radio || (pxsim.radio = {}));
 })(pxsim || (pxsim = {}));
 var pxsim;
@@ -3215,6 +3227,7 @@ var pxsim;
             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));
         }
         handleMessage(msg) {
@@ -3224,34 +3237,51 @@ var pxsim;
             }
         }
         setGroup(id) {
-            this.groupId = id & 0xff; // byte only
+            if (this.enable) {
+                this.groupId = id & 0xff; // byte only
+            }
         }
         setTransmitPower(power) {
-            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) {
             this.transmitSerialNumber = !!sn;
         }
         setFrequencyBand(band) {
-            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, eventid) {
-            pxsim.Runtime.postMessage({
-                type: "eventbus",
-                broadcast: true,
-                id,
-                eventid,
-                power: this.power,
-                group: this.groupId
-            });
+            if (this.enable) {
+                pxsim.Runtime.postMessage({
+                    type: "eventbus",
+                    broadcast: true,
+                    id,
+                    eventid,
+                    power: this.power,
+                    group: this.groupId
+                });
+            }
         }
         receivePacket(packet) {
-            if (this.groupId == packet.payload.groupId)
-                this.datagram.queue(packet);
+            if (this.enable) {
+                if (this.groupId == packet.payload.groupId) {
+                    this.datagram.queue(packet);
+                }
+            }
         }
     }
     pxsim.RadioState = RadioState;

package/libs/matrix-keypad/built/debug/binary.js

@@ -56,7 +56,7 @@ const pxsim_pxtrt = pxsim.pxtrt;
 const pxsim_numops = pxsim.numops;
 
 
-function _main___P188722(s) {
+function _main___P188726(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___188965 = (undefined);
-    globals._pollEventQueue___188978 = (undefined);
+    globals._intervals___188969 = (undefined);
+    globals._pollEventQueue___188982 = (undefined);
     r0 = undefined;
     return leave(s, r0)
   default: oops()
 } } }
-_main___P188722.info = {"start":0,"length":0,"line":0,"column":0,"endLine":0,"endColumn":0,"fileName":"keypad.ts","functionName":"<main>","argumentNames":[]}
-_main___P188722.continuations = [  ]
+_main___P188726.info = {"start":0,"length":0,"line":0,"column":0,"endLine":0,"endColumn":0,"fileName":"keypad.ts","functionName":"<main>","argumentNames":[]}
+_main___P188726.continuations = [  ]
 
-function _main___P188722_mk(s) {
+function _main___P188726_mk(s) {
     checkStack(s.depth);
     return {
-        parent: s, fn: _main___P188722, depth: s.depth + 1,
+        parent: s, fn: _main___P188726, depth: s.depth + 1,
         pc: 0, retval: undefined, r0: undefined, overwrittenPC: false, lambdaArgs: null,
 } }
 
@@ -88,5 +88,5 @@ function _main___P188722_mk(s) {
 
 const breakpoints = setupDebugger(1, [])
 
-return _main___P188722
+return _main___P188726
 })

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/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
     */

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
      */

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/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
 })