Upgrade MicroPython (#47)

I've skipped to latest master as it has changes that require source
level updates here that I expect to be in the 2.1 release.

- Add new sound and power source files
- Update conversions to use new HAL constants
- Update sound expression HAL for function name change
- Stub the power HAL for now (all void returns)
- Update config to add power module

Author: microbit-matt-hillsdon

README.md

@@ -268,6 +268,14 @@ Otherwise, the user will need to use <code>radio.receive_bytes</code> or <code>r
 
 </table>
 
+## Upgrading micropython-microbit-v2
+
+1. Update the lib/micropython-microbit-v2 to the relevant hash. Make sure that its lib/micropython submodule is updated (see checkout instructions above).
+2. Review the full diff for micropython-microbit-v2. In particular, note changes to:
+   1. main.c, src/Makefile and mpconfigport.h all which have simulator versions that may need updates
+   2. the HAL, which may require implementing in the simulator
+   3. the filesystem, which has a JavaScript implementation.
+
 ## Web Assembly debugging
 
 Steps for WASM debugging in Chrome:

lib/micropython-microbit-v2

@@ -78,6 +78,7 @@ SRC_C += $(addprefix $(CODAL_PORT)/, \
 	microbit_pinaudio.c \
 	microbit_pinmode.c \
 	microbit_sound.c \
+	microbit_soundeffect.c \
 	microbit_soundevent.c \
 	microbit_speaker.c \
 	microbit_spi.c \
@@ -91,6 +92,7 @@ SRC_C += $(addprefix $(CODAL_PORT)/, \
 	modmusic.c \
 	modmusictunes.c \
 	modos.c \
+	modpower.c \
 	modradio.c \
 	modspeech.c \
 	modthis.c \

src/Makefile

@@ -59,8 +59,8 @@ export class Audio {
     );
   }
 
-  playSoundExpression(expression: string) {
-    const soundEffects = parseSoundEffects(replaceBuiltinSound(expression));
+  playSoundExpression(expr: string) {
+    const soundEffects = parseSoundEffects(replaceBuiltinSound(expr));
     const onDone = () => {
       this.stopSoundExpression();
     };

src/board/audio/index.ts

@@ -53,8 +53,13 @@ export const MICROBIT_HAL_ACCELEROMETER_EVT_8G = 10;
 export const MICROBIT_HAL_ACCELEROMETER_EVT_SHAKE = 11;
 export const MICROBIT_HAL_ACCELEROMETER_EVT_2G = 12;
 
-export const MICROBIT_HAL_MICROPHONE_LEVEL_THRESHOLD_LOW = 1;
-export const MICROBIT_HAL_MICROPHONE_LEVEL_THRESHOLD_HIGH = 2;
+// Microphone events, passed to microbit_hal_level_detector_callback().
+export const MICROBIT_HAL_MICROPHONE_EVT_THRESHOLD_LOW = 1;
+export const MICROBIT_HAL_MICROPHONE_EVT_THRESHOLD_HIGH = 2;
+
+// Threshold kind, passed to microbit_hal_microphone_set_threshold().
+export const MICROBIT_HAL_MICROPHONE_SET_THRESHOLD_LOW = 0;
+export const MICROBIT_HAL_MICROPHONE_SET_THRESHOLD_HIGH = 1;
 
 export const MICROBIT_HAL_LOG_TIMESTAMP_NONE = 0;
 export const MICROBIT_HAL_LOG_TIMESTAMP_MILLISECONDS = 1;

src/board/constants.ts

@@ -12,8 +12,10 @@ import {
   MICROBIT_HAL_ACCELEROMETER_EVT_TILT_LEFT,
   MICROBIT_HAL_ACCELEROMETER_EVT_TILT_RIGHT,
   MICROBIT_HAL_ACCELEROMETER_EVT_TILT_UP,
-  MICROBIT_HAL_MICROPHONE_LEVEL_THRESHOLD_HIGH,
-  MICROBIT_HAL_MICROPHONE_LEVEL_THRESHOLD_LOW,
+  MICROBIT_HAL_MICROPHONE_EVT_THRESHOLD_HIGH,
+  MICROBIT_HAL_MICROPHONE_EVT_THRESHOLD_LOW,
+  MICROBIT_HAL_MICROPHONE_SET_THRESHOLD_HIGH,
+  MICROBIT_HAL_MICROPHONE_SET_THRESHOLD_LOW,
 } from "./constants";
 
 export function convertAudioBuffer(source: number, target: AudioBuffer) {
@@ -26,22 +28,13 @@ export function convertAudioBuffer(source: number, target: AudioBuffer) {
   return target;
 }
 
-export function convertSoundEventStringToNumber(value: "low" | "high"): number {
+export function convertSoundThresholdNumberToString(
+  value: number
+): "low" | "high" {
   switch (value) {
-    case "low":
-      return MICROBIT_HAL_MICROPHONE_LEVEL_THRESHOLD_LOW;
-    case "high":
-      return MICROBIT_HAL_MICROPHONE_LEVEL_THRESHOLD_HIGH;
-    default:
-      throw new Error(`Invalid value ${value}`);
-  }
-}
-
-export function convertSoundEventNumberToString(value: number): "low" | "high" {
-  switch (value) {
-    case MICROBIT_HAL_MICROPHONE_LEVEL_THRESHOLD_LOW:
+    case MICROBIT_HAL_MICROPHONE_SET_THRESHOLD_LOW:
       return "low";
-    case MICROBIT_HAL_MICROPHONE_LEVEL_THRESHOLD_HIGH:
+    case MICROBIT_HAL_MICROPHONE_SET_THRESHOLD_HIGH:
       return "high";
     default:
       throw new Error(`Invalid value ${value}`);

src/board/conversions.ts

@@ -1,4 +1,7 @@
-import { convertSoundEventStringToNumber } from "./conversions";
+import {
+  MICROBIT_HAL_MICROPHONE_EVT_THRESHOLD_HIGH,
+  MICROBIT_HAL_MICROPHONE_EVT_THRESHOLD_LOW,
+} from "./constants";
 import { RangeSensor, State } from "./state";
 
 type SoundLevelCallback = (v: number) => void;
@@ -48,9 +51,9 @@ export class Microphone {
     const low = this.soundLevel.lowThreshold!;
     const high = this.soundLevel.highThreshold!;
     if (prev > low && curr <= low) {
-      this.soundLevelCallback!(convertSoundEventStringToNumber("low"));
+      this.soundLevelCallback!(MICROBIT_HAL_MICROPHONE_EVT_THRESHOLD_LOW);
     } else if (prev < high && curr >= high!) {
-      this.soundLevelCallback!(convertSoundEventStringToNumber("high"));
+      this.soundLevelCallback!(MICROBIT_HAL_MICROPHONE_EVT_THRESHOLD_HIGH);
     }
   }
 

src/board/microphone.ts

@@ -92,7 +92,8 @@ <h1>MicroPython-micro:bit simulator example embedding</h1>
               <option value="pin_logo">Pin logo</option>
               <option value="radio">Radio</option>
               <option value="sensors">Sensors</option>
-              <option value="sound_effects">Sound effects</option>
+              <option value="sound_effects_builtin">Sound effects (builtin)</option>
+              <option value="sound_effects_user">Sound effects (user)</option>
               <option value="speech">Speech</option>
               <option value="volume">Volume</option>
             </select>

src/demo.html

@@ -0,0 +1,15 @@
+from microbit import *
+
+# Create a Sound Effect and immediately play it
+audio.play(
+    audio.SoundEffect(
+        freq_start=400,
+        freq_end=2000,
+        duration=500,
+        vol_start=100,
+        vol_end=255,
+        wave=audio.SoundEffect.WAVE_TRIANGLE,
+        fx=audio.SoundEffect.FX_VIBRATO,
+        shape=audio.SoundEffect.SHAPE_LOG,
+    )
+)

src/examples/sound_effects.py renamed to src/examples/sound_effects_builtin.py

@@ -73,7 +73,7 @@ void mp_js_hal_audio_speech_init(uint32_t sample_rate);
 void mp_js_hal_audio_speech_write_data(const uint8_t *buf, size_t num_samples);
 void mp_js_hal_audio_period_us(int period);
 void mp_js_hal_audio_amplitude_u10(int amplitude);
-void mp_js_hal_audio_play_expression_by_name(const char *name);
+void mp_js_hal_audio_play_expression(const char *name);
 void mp_js_hal_audio_stop_expression(void);
 bool mp_js_hal_audio_is_expression_active(void);
 

src/examples/sound_effects_user.py

@@ -207,8 +207,7 @@ mergeInto(LibraryManager.library, {
 
   mp_js_hal_microphone_set_threshold: function (kind, value) {
     board.microphone.setThreshold(
-      // `+ 1` is temporary, see https://github.com/microbit-foundation/micropython-microbit-v2/pull/109
-      conversions.convertSoundEventNumberToString(kind + 1),
+      conversions.convertSoundThresholdNumberToString(kind),
       value
     );
   },
@@ -217,8 +216,8 @@ mergeInto(LibraryManager.library, {
     return board.microphone.soundLevel.value;
   },
 
-  mp_js_hal_audio_play_expression_by_name: function (name) {
-    return board.audio.playSoundExpression(UTF8ToString(name));
+  mp_js_hal_audio_play_expression: function (expr) {
+    return board.audio.playSoundExpression(UTF8ToString(expr));
   },
 
   mp_js_hal_audio_stop_expression: function () {

src/jshal.h

@@ -76,6 +76,26 @@ int microbit_hal_temperature(void) {
     return mp_js_hal_temperature();
 }
 
+void microbit_hal_power_clear_wake_sources(void) {
+    // Stub, unsupported.
+}
+
+void microbit_hal_power_wake_on_button(int button, bool wake_on_active) {
+    // Stub, unsupported.
+}
+
+void microbit_hal_power_wake_on_pin(int pin, bool wake_on_active) {
+    // Stub, unsupported.
+}
+
+void microbit_hal_power_off(void) {
+    // Stub, unsupported.
+}
+
+void microbit_hal_power_deep_sleep(bool wake_on_ms, uint32_t ms) {
+    // Stub, unsupported.
+}
+
 void microbit_hal_pin_set_pull(int pin, int pull) {
     //pin_obj[pin]->setPull(pin_pull_mode_mapping[pull]);
     //pin_pull_state[pin] = pull;
@@ -431,8 +451,8 @@ bool microbit_hal_audio_is_expression_active(void) {
     return mp_js_hal_audio_is_expression_active();
 }
 
-void microbit_hal_audio_play_expression_by_name(const char *name) {
-    mp_js_hal_audio_play_expression_by_name(name);
+void microbit_hal_audio_play_expression(const char *expr) {
+    mp_js_hal_audio_play_expression(expr);
 }
 
 void microbit_hal_audio_stop_expression(void) {

src/jshal.js

@@ -115,6 +115,7 @@ extern const struct _mp_obj_module_t machine_module;
 extern const struct _mp_obj_module_t microbit_module;
 extern const struct _mp_obj_module_t music_module;
 extern const struct _mp_obj_module_t os_module;
+extern const struct _mp_obj_module_t power_module;
 extern const struct _mp_obj_module_t radio_module;
 extern const struct _mp_obj_module_t speech_module;
 extern const struct _mp_obj_module_t this_module;
@@ -129,6 +130,7 @@ extern const struct _mp_obj_module_t utime_module;
     { MP_ROM_QSTR(MP_QSTR_microbit), MP_ROM_PTR(&microbit_module) }, \
     { MP_ROM_QSTR(MP_QSTR_music), MP_ROM_PTR(&music_module) }, \
     { MP_ROM_QSTR(MP_QSTR_os), MP_ROM_PTR(&os_module) }, \
+    { MP_ROM_QSTR(MP_QSTR_power), MP_ROM_PTR(&power_module) }, \
     { MP_ROM_QSTR(MP_QSTR_radio), MP_ROM_PTR(&radio_module) }, \
     { MP_ROM_QSTR(MP_QSTR_speech), MP_ROM_PTR(&speech_module) }, \
     { MP_ROM_QSTR(MP_QSTR_this), MP_ROM_PTR(&this_module) }, \