nrf: Move pyb module to boards module

Cleaning up use of "pyb" module.
Moving the file to a new folder and updating the
makefile accordingly. New module created called
"board" to take over the functionality of the legacy
"pyb" module.

Updating outdated documentation referring to pyb.Pin,
to now point to machine.Pin.

Author: glennrub

ports/nrf/Makefile

@@ -57,6 +57,7 @@ INC += -I./modules/ubluepy
 INC += -I./modules/music
 INC += -I./modules/random
 INC += -I./modules/ble
+INC += -I./modules/board
 INC += -I../../lib/mp-readline
 INC += -I./drivers/bluetooth
 INC += -I./drivers
@@ -203,12 +204,12 @@ DRIVERS_SRC_C += $(addprefix modules/,\
 	machine/timer.c \
 	machine/rtcounter.c \
 	machine/pwm.c \
-	machine/led.c \
 	machine/temp.c \
 	uos/moduos.c \
 	uos/microbitfs.c \
 	utime/modutime.c \
-	pyb/modpyb.c \
+	board/modboard.c \
+	board/led.c \
 	ubluepy/modubluepy.c \
 	ubluepy/ubluepy_peripheral.c \
 	ubluepy/ubluepy_service.c \

ports/nrf/examples/ubluepy_temp.py

@@ -22,7 +22,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE
 
-from pyb import LED
+from board import LED
 from machine import RTCounter, Temp
 from ubluepy import Service, Characteristic, UUID, Peripheral, constants
 

ports/nrf/help.c

@@ -4,7 +4,7 @@
  * The MIT License (MIT)
  *
  * Copyright (c) 2013, 2014 Damien P. George
- * Copyright (c) 2016 Glenn Ruben Bakke
+ * Copyright (c) 2016 - 2018 Glenn Ruben Bakke
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -38,7 +38,7 @@ const char nrf5_help_text[] =
 "\n"
 "Quick overview of commands for the board:\n"
 #if MICROPY_HW_HAS_LED
-"  pyb.LED(n)    -- create an LED object for LED n (n=" HELP_TEXT_BOARD_LED ")\n"
+"  board.LED(n)    -- create an LED object for LED n (n=" HELP_TEXT_BOARD_LED ")\n"
 "\n"
 #endif
 #if BLUETOOTH_SD

ports/nrf/main.c

@@ -149,7 +149,7 @@ int main(int argc, char **argv) {
             MP_OBJ_NEW_SMALL_INT(0),
             MP_OBJ_NEW_SMALL_INT(115200),
         };
-        MP_STATE_PORT(pyb_stdio_uart) = machine_hard_uart_type.make_new((mp_obj_t)&machine_hard_uart_type, MP_ARRAY_SIZE(args), 0, args);
+        MP_STATE_PORT(board_stdio_uart) = machine_hard_uart_type.make_new((mp_obj_t)&machine_hard_uart_type, MP_ARRAY_SIZE(args), 0, args);
     }
 #endif
 
@@ -195,8 +195,8 @@ pin_init0();
 #if (MICROPY_HW_HAS_LED)
     led_init();
 
-    do_str("import pyb\r\n" \
-           "pyb.LED(1).on()",
+    do_str("import board\r\n" \
+           "board.LED(1).on()",
            MP_PARSE_FILE_INPUT);
 #endif
 

ports/nrf/modules/machine/led.c ports/nrf/modules/board/led.cports/nrf/modules/machine/led.c renamed to ports/nrf/modules/board/led.c

@@ -4,7 +4,7 @@
  * The MIT License (MIT)
  *
  * Copyright (c) 2013-2016 Damien P. George
- * Copyright (c) 2015 Glenn Ruben Bakke
+ * Copyright (c) 2015 - 2018 Glenn Ruben Bakke
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -36,49 +36,49 @@
 #define LED_OFF(pin) {(MICROPY_HW_LED_PULLUP) ? nrf_gpio_pin_set(pin) : nrf_gpio_pin_clear(pin); }
 #define LED_ON(pin) {(MICROPY_HW_LED_PULLUP) ? nrf_gpio_pin_clear(pin) : nrf_gpio_pin_set(pin); }
 
-typedef struct _pyb_led_obj_t {
+typedef struct _board_led_obj_t {
     mp_obj_base_t base;
     mp_uint_t led_id;
     mp_uint_t hw_pin;
     uint8_t hw_pin_port;
-} pyb_led_obj_t;
+} board_led_obj_t;
 
-STATIC const pyb_led_obj_t pyb_led_obj[] = {
+STATIC const board_led_obj_t board_led_obj[] = {
 #if MICROPY_HW_LED_TRICOLOR
-    {{&pyb_led_type}, PYB_LED_RED, MICROPY_HW_LED_RED},
-    {{&pyb_led_type}, PYB_LED_GREEN, MICROPY_HW_LED_GREEN},
-    {{&pyb_led_type}, PYB_LED_BLUE, MICROPY_HW_LED_BLUE},
+    {{&board_led_type}, BOARD_LED_RED, MICROPY_HW_LED_RED},
+    {{&board_led_type}, BOARD_LED_GREEN, MICROPY_HW_LED_GREEN},
+    {{&board_led_type}, BOARD_LED_BLUE, MICROPY_HW_LED_BLUE},
 #elif (MICROPY_HW_LED_COUNT == 1)
-    {{&pyb_led_type}, PYB_LED1, MICROPY_HW_LED1},
+    {{&board_led_type}, BOARD_LED1, MICROPY_HW_LED1},
 #elif (MICROPY_HW_LED_COUNT == 2)
-    {{&pyb_led_type}, PYB_LED1, MICROPY_HW_LED1},
-    {{&pyb_led_type}, PYB_LED2, MICROPY_HW_LED2},
+    {{&board_led_type}, BOARD_LED1, MICROPY_HW_LED1},
+    {{&board_led_type}, BOARD_LED2, MICROPY_HW_LED2},
 #else
-    {{&pyb_led_type}, PYB_LED1, MICROPY_HW_LED1},
-    {{&pyb_led_type}, PYB_LED2, MICROPY_HW_LED2},
-    {{&pyb_led_type}, PYB_LED3, MICROPY_HW_LED3},
-    {{&pyb_led_type}, PYB_LED4, MICROPY_HW_LED4},
+    {{&board_led_type}, BOARD_LED1, MICROPY_HW_LED1},
+    {{&board_led_type}, BOARD_LED2, MICROPY_HW_LED2},
+    {{&board_led_type}, BOARD_LED3, MICROPY_HW_LED3},
+    {{&board_led_type}, BOARD_LED4, MICROPY_HW_LED4},
 #endif
 };
 
-#define NUM_LEDS MP_ARRAY_SIZE(pyb_led_obj)
+#define NUM_LEDS MP_ARRAY_SIZE(board_led_obj)
 
 void led_init(void) {
     for (uint8_t i = 0; i < NUM_LEDS; i++) {
-        LED_OFF(pyb_led_obj[i].hw_pin);
-        nrf_gpio_cfg_output(pyb_led_obj[i].hw_pin);
+        LED_OFF(board_led_obj[i].hw_pin);
+        nrf_gpio_cfg_output(board_led_obj[i].hw_pin);
     }
 }
 
-void led_state(pyb_led_obj_t * led_obj, int state) {
+void led_state(board_led_obj_t * led_obj, int state) {
     if (state == 1) {
         LED_ON(led_obj->hw_pin);
     } else {
         LED_OFF(led_obj->hw_pin);
     }
 }
 
-void led_toggle(pyb_led_obj_t * led_obj) {
+void led_toggle(board_led_obj_t * led_obj) {
     nrf_gpio_pin_toggle(led_obj->hw_pin);
 }
 
@@ -88,7 +88,7 @@ void led_toggle(pyb_led_obj_t * led_obj) {
 /* MicroPython bindings                                                      */
 
 void led_obj_print(const mp_print_t *print, mp_obj_t self_in, mp_print_kind_t kind) {
-    pyb_led_obj_t *self = self_in;
+    board_led_obj_t *self = self_in;
     mp_printf(print, "LED(%lu)", self->led_id);
 }
 
@@ -109,29 +109,29 @@ STATIC mp_obj_t led_obj_make_new(const mp_obj_type_t *type, size_t n_args, size_
     }
 
     // return static led object
-    return (mp_obj_t)&pyb_led_obj[led_id - 1];
+    return (mp_obj_t)&board_led_obj[led_id - 1];
 }
 
 /// \method on()
 /// Turn the LED on.
 mp_obj_t led_obj_on(mp_obj_t self_in) {
-    pyb_led_obj_t *self = self_in;
+    board_led_obj_t *self = self_in;
     led_state(self, 1);
     return mp_const_none;
 }
 
 /// \method off()
 /// Turn the LED off.
 mp_obj_t led_obj_off(mp_obj_t self_in) {
-    pyb_led_obj_t *self = self_in;
+    board_led_obj_t *self = self_in;
     led_state(self, 0);
     return mp_const_none;
 }
 
 /// \method toggle()
 /// Toggle the LED between on and off.
 mp_obj_t led_obj_toggle(mp_obj_t self_in) {
-    pyb_led_obj_t *self = self_in;
+    board_led_obj_t *self = self_in;
     led_toggle(self);
     return mp_const_none;
 }
@@ -148,7 +148,7 @@ STATIC const mp_rom_map_elem_t led_locals_dict_table[] = {
 
 STATIC MP_DEFINE_CONST_DICT(led_locals_dict, led_locals_dict_table);
 
-const mp_obj_type_t pyb_led_type = {
+const mp_obj_type_t board_led_type = {
     { &mp_type_type },
     .name = MP_QSTR_LED,
     .print = led_obj_print,

ports/nrf/modules/machine/led.h ports/nrf/modules/board/led.hports/nrf/modules/machine/led.h renamed to ports/nrf/modules/board/led.h

@@ -4,7 +4,7 @@
  * The MIT License (MIT)
  *
  * Copyright (c) 2013, 2014 Damien P. George
- * Copyright (c) 2015 Glenn Ruben Bakke
+ * Copyright (c) 2015 - 2018 Glenn Ruben Bakke
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -30,24 +30,24 @@
 
 typedef enum {
 #if MICROPY_HW_LED_TRICOLOR
-    PYB_LED_RED = 1,
-    PYB_LED_GREEN = 2,
-    PYB_LED_BLUE = 3
+    BOARD_LED_RED = 1,
+    BOARD_LED_GREEN = 2,
+    BOARD_LED_BLUE = 3
 #elif (MICROPY_HW_LED_COUNT == 1)
-    PYB_LED1 = 1,
+    BOARD_LED1 = 1,
 #elif (MICROPY_HW_LED_COUNT == 2)
-    PYB_LED1 = 1,
-    PYB_LED2 = 2,
+    BOARD_LED1 = 1,
+    BOARD_LED2 = 2,
 #else
-    PYB_LED1 = 1,
-    PYB_LED2 = 2,
-    PYB_LED3 = 3,
-    PYB_LED4 = 4
+    BOARD_LED1 = 1,
+    BOARD_LED2 = 2,
+    BOARD_LED3 = 3,
+    BOARD_LED4 = 4
 #endif
-} pyb_led_t;
+} board_led_t;
 
 void led_init(void);
 
-extern const mp_obj_type_t pyb_led_type;
+extern const mp_obj_type_t board_led_type;
 
 #endif // LED_H

ports/nrf/modules/pyb/modpyb.c ports/nrf/modules/board/modboard.cports/nrf/modules/pyb/modpyb.c renamed to ports/nrf/modules/board/modboard.c

@@ -3,7 +3,7 @@
  *
  * The MIT License (MIT)
  *
- * Copyright (c) 2015 Glenn Ruben Bakke
+ * Copyright (c) 2015 - 2018 Glenn Ruben Bakke
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -33,23 +33,21 @@
 #include "pin.h"
 
 #if MICROPY_HW_HAS_LED
-#define PYB_LED_MODULE { MP_ROM_QSTR(MP_QSTR_LED), MP_ROM_PTR(&pyb_led_type) },
+#define PYB_LED_MODULE { MP_ROM_QSTR(MP_QSTR_LED), MP_ROM_PTR(&board_led_type) },
 #else
 #define PYB_LED_MODULE
 #endif
 
-STATIC const mp_rom_map_elem_t pyb_module_globals_table[] = {
-    { MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_pyb) },
+STATIC const mp_rom_map_elem_t board_module_globals_table[] = {
+    { MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_board) },
     { MP_ROM_QSTR(MP_QSTR_repl_info), MP_ROM_PTR(&pyb_set_repl_info_obj) },
-    { MP_ROM_QSTR(MP_QSTR_Pin), MP_ROM_PTR(&pin_type) },
     PYB_LED_MODULE
-/*    { MP_ROM_QSTR(MP_QSTR_main), MP_ROM_PTR(&pyb_main_obj) }*/
 };
 
 
-STATIC MP_DEFINE_CONST_DICT(pyb_module_globals, pyb_module_globals_table);
+STATIC MP_DEFINE_CONST_DICT(board_module_globals, board_module_globals_table);
 
-const mp_obj_module_t pyb_module = {
+const mp_obj_module_t board_module = {
     .base = { &mp_type_module },
-    .globals = (mp_obj_dict_t*)&pyb_module_globals,
+    .globals = (mp_obj_dict_t*)&board_module_globals,
 };

ports/nrf/modules/machine/modmachine.c

@@ -136,7 +136,7 @@ STATIC mp_obj_t machine_info(mp_uint_t n_args, const mp_obj_t *args) {
 }
 MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(machine_info_obj, 0, 1, machine_info);
 
-// Resets the pyboard in a manner similar to pushing the external RESET button.
+// Resets the board in a manner similar to pushing the external RESET button.
 STATIC mp_obj_t machine_reset(void) {
     NVIC_SystemReset();
     return mp_const_none;
@@ -176,7 +176,7 @@ STATIC mp_obj_t machine_enable_irq(void) {
 }
 MP_DEFINE_CONST_FUN_OBJ_0(machine_enable_irq_obj, machine_enable_irq);
 
-// Resets the pyboard in a manner similar to pushing the external RESET button.
+// Resets the board in a manner similar to pushing the external RESET button.
 STATIC mp_obj_t machine_disable_irq(void) {
 #ifndef BLUETOOTH_SD
     __disable_irq();
@@ -195,7 +195,7 @@ STATIC const mp_rom_map_elem_t machine_module_globals_table[] = {
     { MP_ROM_QSTR(MP_QSTR_enable_irq),         MP_ROM_PTR(&machine_enable_irq_obj) },
     { MP_ROM_QSTR(MP_QSTR_disable_irq),        MP_ROM_PTR(&machine_disable_irq_obj) },
 #if MICROPY_HW_ENABLE_RNG
-    { MP_ROM_QSTR(MP_QSTR_rng),                MP_ROM_PTR(&pyb_rng_get_obj) },
+    { MP_ROM_QSTR(MP_QSTR_rng),                MP_ROM_PTR(&random_module) },
 #endif
     { MP_ROM_QSTR(MP_QSTR_sleep),              MP_ROM_PTR(&machine_sleep_obj) },
     { MP_ROM_QSTR(MP_QSTR_deepsleep),          MP_ROM_PTR(&machine_deepsleep_obj) },