codal_port/microbit_speaker: Add microbit.speaker object.

Changes are:
- add microbit.speaker object
- move pin_speaker disable/enable methods to speaker off/on
- change pin_speaker type to a normal digital pin

Signed-off-by: Damien George <[email protected]>

Author: dpgeorge

src/codal_port/Makefile

@@ -71,6 +71,7 @@ SRC_C += \
 	microbit_pinmode.c \
 	microbit_sound.c \
 	microbit_soundevent.c \
+	microbit_speaker.c \
 	microbit_spi.c \
 	microbit_uart.c \
 	modaudio.c \

src/codal_port/microbit_pin.c

@@ -49,7 +49,7 @@ const microbit_pin_obj_t microbit_p19_obj = {{&microbit_dig_pin_type},  19, MICR
 const microbit_pin_obj_t microbit_p20_obj = {{&microbit_dig_pin_type},  20, MICROBIT_HAL_PIN_P20, MODE_I2C};
 
 const microbit_pin_obj_t microbit_pin_logo_obj = {{&microbit_touch_only_pin_type}, 30, MICROBIT_HAL_PIN_FACE, MODE_UNUSED};
-const microbit_pin_obj_t microbit_pin_speaker_obj = {{&microbit_speaker_pin_type}, 31, MICROBIT_HAL_PIN_SPEAKER, MODE_UNUSED};
+const microbit_pin_obj_t microbit_pin_speaker_obj = {{&microbit_dig_pin_type}, 31, MICROBIT_HAL_PIN_SPEAKER, MODE_UNUSED};
 
 static mp_obj_t microbit_pin_get_mode_func(mp_obj_t self_in) {
     microbit_pin_obj_t *self = (microbit_pin_obj_t*)self_in;
@@ -177,20 +177,6 @@ mp_obj_t microbit_pin_set_touch_mode(mp_obj_t self_in, mp_obj_t mode_in) {
 }
 MP_DEFINE_CONST_FUN_OBJ_2(microbit_pin_set_touch_mode_obj, microbit_pin_set_touch_mode);
 
-STATIC mp_obj_t microbit_pin_speaker_disable(mp_obj_t self_in) {
-    (void)self_in;
-    microbit_pin_audio_speaker_enable(false);
-    return mp_const_none;
-}
-STATIC MP_DEFINE_CONST_FUN_OBJ_1(microbit_pin_speaker_disable_obj, microbit_pin_speaker_disable);
-
-STATIC mp_obj_t microbit_pin_speaker_enable(mp_obj_t self_in) {
-    (void)self_in;
-    microbit_pin_audio_speaker_enable(true);
-    return mp_const_none;
-}
-STATIC MP_DEFINE_CONST_FUN_OBJ_1(microbit_pin_speaker_enable_obj, microbit_pin_speaker_enable);
-
 #define PULL_CONSTANTS \
     { MP_ROM_QSTR(MP_QSTR_PULL_UP), MP_ROM_INT(MICROBIT_HAL_PIN_PULL_UP) }, \
     { MP_ROM_QSTR(MP_QSTR_PULL_DOWN), MP_ROM_INT(MICROBIT_HAL_PIN_PULL_DOWN) }, \
@@ -278,26 +264,9 @@ const mp_obj_type_t microbit_touch_only_pin_type = {
     .locals_dict = (mp_obj_dict_t *)&microbit_touch_only_pin_locals_dict,
 };
 
-STATIC const mp_rom_map_elem_t microbit_speaker_pin_locals_dict_table[] = {
-    { MP_ROM_QSTR(MP_QSTR_write_digital), MP_ROM_PTR(&microbit_pin_write_digital_obj) },
-    { MP_ROM_QSTR(MP_QSTR_write_analog), MP_ROM_PTR(&microbit_pin_write_analog_obj) },
-    { MP_ROM_QSTR(MP_QSTR_set_analog_period), MP_ROM_PTR(&microbit_pin_set_analog_period_obj) },
-    { MP_ROM_QSTR(MP_QSTR_set_analog_period_microseconds), MP_ROM_PTR(&microbit_pin_set_analog_period_microseconds_obj) },
-    { MP_ROM_QSTR(MP_QSTR_get_analog_period_microseconds), MP_ROM_PTR(&microbit_pin_get_analog_period_microseconds_obj) },
-    { MP_ROM_QSTR(MP_QSTR_disable), MP_ROM_PTR(&microbit_pin_speaker_disable_obj) },
-    { MP_ROM_QSTR(MP_QSTR_enable), MP_ROM_PTR(&microbit_pin_speaker_enable_obj) },
-};
-STATIC MP_DEFINE_CONST_DICT(microbit_speaker_pin_locals_dict, microbit_speaker_pin_locals_dict_table);
-
-const mp_obj_type_t microbit_speaker_pin_type = {
-    { &mp_type_type },
-    .name = MP_QSTR_MicroBitSpeakerPin,
-    .locals_dict = (mp_obj_dict_t *)&microbit_speaker_pin_locals_dict,
-};
-
 const microbit_pin_obj_t *microbit_obj_get_pin(mp_obj_t o) {
     const mp_obj_type_t *type = mp_obj_get_type(o);
-    if (type == &microbit_touch_pin_type || type == &microbit_ad_pin_type || type == &microbit_dig_pin_type || type == &microbit_speaker_pin_type) {
+    if (type == &microbit_touch_pin_type || type == &microbit_ad_pin_type || type == &microbit_dig_pin_type) {
         return (microbit_pin_obj_t*)o;
     } else {
         mp_raise_TypeError("expecting a pin");

src/codal_port/microbit_speaker.c

@@ -0,0 +1,63 @@
+/*
+ * This file is part of the MicroPython project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2020 Damien P. George
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#include "py/runtime.h"
+#include "microbithal.h"
+#include "modmicrobit.h"
+
+typedef struct _microbit_speaker_obj_t {
+    mp_obj_base_t base;
+} microbit_speaker_obj_t;
+
+STATIC mp_obj_t microbit_speaker_off(mp_obj_t self_in) {
+    (void)self_in;
+    microbit_hal_audio_select_speaker(false);
+    return mp_const_none;
+}
+STATIC MP_DEFINE_CONST_FUN_OBJ_1(microbit_speaker_off_obj, microbit_speaker_off);
+
+STATIC mp_obj_t microbit_speaker_on(mp_obj_t self_in) {
+    (void)self_in;
+    microbit_hal_audio_select_speaker(true);
+    return mp_const_none;
+}
+STATIC MP_DEFINE_CONST_FUN_OBJ_1(microbit_speaker_on_obj, microbit_speaker_on);
+
+STATIC const mp_rom_map_elem_t microbit_speaker_locals_dict_table[] = {
+    { MP_ROM_QSTR(MP_QSTR_off), MP_ROM_PTR(&microbit_speaker_off_obj) },
+    { MP_ROM_QSTR(MP_QSTR_on), MP_ROM_PTR(&microbit_speaker_on_obj) },
+};
+STATIC MP_DEFINE_CONST_DICT(microbit_speaker_locals_dict, microbit_speaker_locals_dict_table);
+
+STATIC const mp_obj_type_t microbit_speaker_type = {
+    { &mp_type_type },
+    .name = MP_QSTR_MicroBitSpeakerPin,
+    .locals_dict = (mp_obj_dict_t *)&microbit_speaker_locals_dict,
+};
+
+const microbit_speaker_obj_t microbit_speaker_obj = {
+    { &microbit_speaker_type },
+};

src/codal_port/modmicrobit.c

@@ -103,6 +103,7 @@ STATIC const mp_rom_map_elem_t microbit_module_globals_table[] = {
     { MP_ROM_QSTR(MP_QSTR_button_b), (mp_obj_t)&microbit_button_b_obj },
     { MP_ROM_QSTR(MP_QSTR_accelerometer), MP_ROM_PTR(&microbit_accelerometer_obj) },
     { MP_ROM_QSTR(MP_QSTR_compass), MP_ROM_PTR(&microbit_compass_obj) },
+    { MP_ROM_QSTR(MP_QSTR_speaker), MP_ROM_PTR(&microbit_speaker_obj) },
     { MP_ROM_QSTR(MP_QSTR_microphone), MP_ROM_PTR(&microbit_microphone_obj) },
     { MP_ROM_QSTR(MP_QSTR_audio), MP_ROM_PTR(&audio_module) },
 

src/codal_port/modmicrobit.h

@@ -82,7 +82,6 @@ extern const mp_obj_type_t microbit_ad_pin_type;
 extern const mp_obj_type_t microbit_dig_pin_type;
 extern const mp_obj_type_t microbit_touch_pin_type;
 extern const mp_obj_type_t microbit_touch_only_pin_type;
-extern const mp_obj_type_t microbit_speaker_pin_type;
 extern const mp_obj_type_t microbit_sound_type;
 extern const mp_obj_type_t microbit_soundevent_type;
 
@@ -184,6 +183,7 @@ extern const microbit_soundevent_obj_t microbit_soundevent_quiet_obj;
 extern struct _microbit_display_obj_t microbit_display_obj;
 extern const struct _microbit_accelerometer_obj_t microbit_accelerometer_obj;
 extern const struct _microbit_compass_obj_t microbit_compass_obj;
+extern const struct _microbit_speaker_obj_t microbit_speaker_obj;
 extern const struct _microbit_microphone_obj_t microbit_microphone_obj;
 extern const struct _microbit_button_obj_t microbit_button_a_obj;
 extern const struct _microbit_button_obj_t microbit_button_b_obj;