Colin Hogben / micropython

Port of MicroPython to the mbed platform. See micropython-repl for an interactive program.

Dependents:   micropython-repl

This a port of MicroPython to the mbed Classic platform.

This provides an interpreter running on the board's USB serial connection.

Getting Started

Import the micropython-repl program into your IDE workspace on developer.mbed.org. Compile and download to your board. Connect to the USB serial port in your usual manner. You should get a startup message similar to the following:

  MicroPython v1.7-155-gdddcdd8 on 2016-04-23; K64F with ARM
  Type "help()" for more information.
  >>>

Then you can start using micropython. For example:

  >>> from mbed import DigitalOut
  >>> from pins import LED1
  >>> led = DigitalOut(LED1)
  >>> led.write(1)

Requirements

You need approximately 100K of flash memory, so this will be no good for boards with smaller amounts of storage.

Caveats

This can be considered an alpha release of the port; things may not work; APIs may change in later releases. It is NOT an official part part the micropython project, so if anything doesn't work, blame me. If it does work, most of the credit is due to micropython.

  • Only a few of the mbed classes are available in micropython so far, and not all methods of those that are.
  • Only a few boards have their full range of pin names available; for others, only a few standard ones (USBTX, USBRX, LED1) are implemented.
  • The garbage collector is not yet implemented. The interpreter will gradually consume memory and then fail.
  • Exceptions from the mbed classes are not yet handled.
  • Asynchronous processing (e.g. events on inputs) is not supported.

Credits

  • Damien P. George and other contributors who created micropython.
  • Colin Hogben, author of this port.

modmbed.c

Committer:
Colin Hogben
Date:
2016-04-27
Revision:
10:33521d742af1
Parent:
8:6c5fa976a1e3

File content as of revision 10:33521d742af1:

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2016 Colin Hogben
 *
 * 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.
 */
// High-level mbed objects

#include "py/runtime.h"

// Only if selected in mpconfigport.h
#if MICROPY_PY_MBED

#include "modmbed_i.h"

#if MICROPY_PY_BUILTINS_FLOAT
STATIC MP_DEFINE_CONST_FUN_OBJ_1(mbed_wait_obj,
                                 mbed_wait);
#endif
STATIC MP_DEFINE_CONST_FUN_OBJ_1(mbed_wait_ms_obj,
                                 mbed_wait_ms);
STATIC MP_DEFINE_CONST_FUN_OBJ_1(mbed_wait_us_obj,
                                 mbed_wait_us);

#if MICROPY_MBED_DIGITALOUT
//-----------------------------------------------------------------------
//      DigitalOut class
//-----------------------------------------------------------------------
STATIC MP_DEFINE_CONST_FUN_OBJ_2(mbed_DigitalOut_write_obj,
                                 mbed_DigitalOut_write);
STATIC MP_DEFINE_CONST_FUN_OBJ_1(mbed_DigitalOut_read_obj,
                                 mbed_DigitalOut_read);
STATIC MP_DEFINE_CONST_FUN_OBJ_1(mbed_DigitalOut_is_connected_obj,
                                 mbed_DigitalOut_is_connected);

STATIC const mp_map_elem_t mbed_DigitalOut_locals_dict_table[] = {
    { MP_OBJ_NEW_QSTR(MP_QSTR_write), (mp_obj_t)&mbed_DigitalOut_write_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_read), (mp_obj_t)&mbed_DigitalOut_read_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_is_connected), (mp_obj_t)&mbed_DigitalOut_is_connected_obj },
};

STATIC MP_DEFINE_CONST_DICT(mbed_DigitalOut_locals_dict,
                            mbed_DigitalOut_locals_dict_table);

const mp_obj_type_t mbed_DigitalOut_type = {
    { &mp_type_type },
    .name = MP_QSTR_DigitalOut,
    // .print
    .make_new = mbed_DigitalOut_make_new,
    .locals_dict = (mp_obj_t)&mbed_DigitalOut_locals_dict,
};

#endif // MICROPY_MBED_DIGITALOUT

#if MICROPY_MBED_DIGITALIN
//-----------------------------------------------------------------------
//      DigitalIn class
//-----------------------------------------------------------------------
STATIC MP_DEFINE_CONST_FUN_OBJ_1(mbed_DigitalIn_read_obj,
                                 mbed_DigitalIn_read);
STATIC MP_DEFINE_CONST_FUN_OBJ_2(mbed_DigitalIn_mode_obj,
                                 mbed_DigitalIn_mode);
STATIC MP_DEFINE_CONST_FUN_OBJ_1(mbed_DigitalIn_is_connected_obj,
                                 mbed_DigitalIn_is_connected);

STATIC const mp_map_elem_t mbed_DigitalIn_locals_dict_table[] = {
    { MP_OBJ_NEW_QSTR(MP_QSTR_read), (mp_obj_t)&mbed_DigitalIn_read_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_mode), (mp_obj_t)&mbed_DigitalIn_mode_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_is_connected), (mp_obj_t)&mbed_DigitalIn_is_connected_obj },
};

STATIC MP_DEFINE_CONST_DICT(mbed_DigitalIn_locals_dict,
                            mbed_DigitalIn_locals_dict_table);

const mp_obj_type_t mbed_DigitalIn_type = {
    { &mp_type_type },
    .name = MP_QSTR_DigitalIn,
    // .print
    .make_new = mbed_DigitalIn_make_new,
    .locals_dict = (mp_obj_t)&mbed_DigitalIn_locals_dict,
};

#endif // MICROPY_MBED_DIGITALIN

#if MICROPY_MBED_SERIAL
/*-----------------------------------------------------------------------
 *      Serial class
 *-----------------------------------------------------------------------*/
STATIC MP_DEFINE_CONST_FUN_OBJ_2(mbed_Serial_baud_obj,
                                 mbed_Serial_baud);
STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(mbed_Serial_format_obj, 1, 4,
                                           mbed_Serial_format);
STATIC MP_DEFINE_CONST_FUN_OBJ_2(mbed_Serial_putc_obj,
                                 mbed_Serial_putc);
STATIC MP_DEFINE_CONST_FUN_OBJ_2(mbed_Serial_puts_obj,
                                 mbed_Serial_puts);
STATIC MP_DEFINE_CONST_FUN_OBJ_1(mbed_Serial_getc_obj,
                                 mbed_Serial_getc);
STATIC MP_DEFINE_CONST_FUN_OBJ_1(mbed_Serial_readable_obj,
                                 mbed_Serial_readable);
STATIC MP_DEFINE_CONST_FUN_OBJ_1(mbed_Serial_writeable_obj,
                                 mbed_Serial_writeable);
STATIC MP_DEFINE_CONST_FUN_OBJ_1(mbed_Serial_send_break_obj,
                                 mbed_Serial_send_break);

STATIC const mp_map_elem_t mbed_Serial_locals_dict_table[] = {
    { MP_OBJ_NEW_QSTR(MP_QSTR_baud), (mp_obj_t)&mbed_Serial_baud_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_format), (mp_obj_t)&mbed_Serial_format_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_putc), (mp_obj_t)&mbed_Serial_putc_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_puts), (mp_obj_t)&mbed_Serial_puts_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_getc), (mp_obj_t)&mbed_Serial_getc_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_readable), (mp_obj_t)&mbed_Serial_readable_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_writeable), (mp_obj_t)&mbed_Serial_writeable_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_send_break), (mp_obj_t)&mbed_Serial_send_break_obj },
};

STATIC MP_DEFINE_CONST_DICT(mbed_Serial_locals_dict,
                            mbed_Serial_locals_dict_table);

const mp_obj_type_t mbed_Serial_type = {
    { &mp_type_type },
    .name = MP_QSTR_Serial,
    // .print
    .make_new = mbed_Serial_make_new,
    .locals_dict = (mp_obj_t)&mbed_Serial_locals_dict,
};

#endif // MICROPY_MBED_SERIAL

// Module
STATIC const mp_rom_map_elem_t mbed_module_globals_table[] = {
    { MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_mbed) },
#if MICROPY_PY_BUILTINS_FLOAT
    { MP_ROM_QSTR(MP_QSTR_wait), MP_ROM_PTR(&mbed_wait_obj) },
#endif
    { MP_ROM_QSTR(MP_QSTR_wait_ms), MP_ROM_PTR(&mbed_wait_ms_obj) },
    { MP_ROM_QSTR(MP_QSTR_wait_us), MP_ROM_PTR(&mbed_wait_us_obj) },
#if MICROPY_MBED_DIGITALOUT
    { MP_ROM_QSTR(MP_QSTR_DigitalOut), MP_ROM_PTR(&mbed_DigitalOut_type) },
#endif
#if MICROPY_MBED_DIGITALIN
    { MP_ROM_QSTR(MP_QSTR_DigitalIn), MP_ROM_PTR(&mbed_DigitalIn_type) },
#endif
#if MICROPY_MBED_SERIAL
    { MP_ROM_QSTR(MP_QSTR_Serial), MP_ROM_PTR(&mbed_Serial_type) },
#endif
};

STATIC MP_DEFINE_CONST_DICT(mbed_module_globals,
                            mbed_module_globals_table);

const mp_obj_module_t mp_module_mbed = {
    .base = { &mp_type_module },
    .name = MP_QSTR_mbed,
    .globals = (mp_obj_dict_t *)&mbed_module_globals,
};

#endif