Nuvoton NuMicro series User manual

NuMaker
Mar 29, 2019 Page 1of 31 Rev 1.00
NUMICROPY USER MANUAL
Arm®Cortex®-M
32-bit Microcontroller
NuMicro®Family
NuMicroPy
User Manual
The information described in this document is the exclusive intellectual property of
Nuvoton Technology Corporation and shall not be reproduced without permission from Nuvoton.
Nuvoton is providing this document only for reference purposes of NuMicro microcontroller based system
design. Nuvoton assumes no responsibility for errors or omissions.
All data and specifications are subject to change without notice.
For additional information or questions, please contact: Nuvoton Technology Corporation.
www.nuvoton.com

NuMaker
Mar 29, 2019 Page 2of 31 Rev 1.00
NUMICROPY USER MANUAL
Table of Contents
1Overview.............................................................................................4
2NuMicroPy Introduction ...........................................................................5
REPL..................................................................................................... 5
Embedded Flash Partition............................................................................ 5
Modules and I/O Classes Support List ............................................................. 6
3How to Start NuMicroPy...........................................................................9
Nuvoton Nu-Link Driver Download and Install .................................................... 9
Hardware Setup Steps................................................................................ 9
Burn Firmware.........................................................................................10
Python Code Update Steps .........................................................................11
4How to Customize MicroPython Firmware................................................... 13
Packages Requirement..............................................................................13
Install GNU Arm Toolchain..........................................................................13
Build Firmware ........................................................................................13
Enable/Disable Module ..............................................................................13
Enable/Disable I/O Class............................................................................15
5I/O Class Quick Reference ..................................................................... 17
LAN Class..............................................................................................17
Pin Class...............................................................................................17
ADC Class .............................................................................................19
SPI Class...............................................................................................19
I2C Class ...............................................................................................20
RTC Class .............................................................................................21
UART Class............................................................................................21
CAN Class .............................................................................................22
USB HID Class........................................................................................23
USB VCP Class.......................................................................................23
LED Class..............................................................................................24
Switch Class...........................................................................................24
Timer Class............................................................................................24
PWM Class ............................................................................................25
WDT Class.............................................................................................28

NuMaker
Mar 29, 2019 Page 3of 31 Rev 1.00
NUMICROPY USER MANUAL
Accel Class ............................................................................................28
Gyro Class.............................................................................................28
Mag Class..............................................................................................28
6Summary .......................................................................................... 29
7Revision History .................................................................................. 30

NuMaker
Mar 29, 2019 Page 4of 31 Rev 1.00
NUMICROPY USER MANUAL
1 OVERVIEW
NuMicroPy is the port of MicroPython to Nuvoton NuMicro®family microcontrollers (MCUs). The
MicroPython
1
project aims to put an implementation of Python 3.x on the microcontrollers and
small embedded systems. Refer to Table 1-1 for NuMicroPy support status.
MCU
Board
Firmware ROM Size
Firmware RAM Size
M487
NuMaker-PFM-M487
362KB
77KB
M487
NuMaker-IOT-M487
373KB
77KB
Table 1-1 NuMicroPy Support Status
The MicroPython implements Python 3.4 and some selected feature of Python 3.5, but there are
some conflicting results in MicroPython when compared to standard Python. See details
2
.
1
http://micropython.org/
2
http://docs.micropython.org/en/latest/genrst/index.html#

NuMaker
Mar 29, 2019 Page 5of 31 Rev 1.00
NUMICROPY USER MANUAL
2 NUMICROPY INTRODUCTION
The MicroPython divides the code into two parts, python interpreter firmware (firmware.bin) and
the user’s python code. The firmware must be burned into the MCU first. After boot, the firmware
executes the user’s python code.
The execution of the python code supports the REPL mode and/or performs the python code from
storage. The firmware tries to perform the python code from storage first, and finally enter REPL
mode. Uses can test their python code in REPL mode, and finally put the python code into
storage.
The MicroPython defines the I/O classes associated with the MCU peripheral in the pyb module
3
.
NuMicroPy implements these I/O classes according to these definitions.
REPL
REPL stands for Read Evaluate Print Loop, and is the name given to the interactive MicroPython
prompt that you can access on the MCUs. Using the REPL is by far the easiest way to test out
your python code (Figure 2-1).
The REPL is always available on the UART0 serial peripheral. The baud rate of the REPL is
115200. In the NuMaker-PFM-M487 board, Nu-Link-Me has a USB-to-serial converter on it then
you should be able to access the REPL directly from your PC.
To access the prompt over USB-to-serial you need to use a terminal emulator program. On
Windows, Tera Term is a good choice; on Mac you can use the built-in screen program, and
Linux has picocom and minicom.
Figure 2-1 REPL Mode
Embedded Flash Partition
The NuMicroPy divides the MCU’s embedded flash into two partitions, one is the firmware
partition and the other is the data partition.
The firmware partition is used to put the firmware binary code.
The data partition will be a partition of FAT file system. The firmware will attempt to mount the
data partition at the beginning of execution. If mount fails, it will force the data partition to be
formatted into FAT file system and produce two blank python file (main.py and boot.py). You can
3
pyb module: MicroPython board related module.

NuMaker
Mar 29, 2019 Page 6of 31 Rev 1.00
NUMICROPY USER MANUAL
force the firmware into USB mass storage mode and then write your python code to these files.
Table 2-1 shows the default embedded Flash partition status.
MCU
Embedded
Flash Size
Firmware
Partition Start
Address
Firmware
Partition Size
Data
Partition
Start
Address
Data
Partition
Size
M487
512KB
0x0
384KB
0x60000
128KB
Table 2-1 Default Embedded Flash Partition Status
Modules and I/O Classes Support List
Table 2-2 and Table 2-3 show the M487 support status on the modules and I/O classes of
MicroPython.
Module
Description
M487
array
Arrays of numeric data

cmath
Mathematical function for complex numbers

gc
Control the garbage collector

math
Mathematical functions

sys
System specific functions

ubinascii
Binary/ASCII conversions

ucollections
Collection and container types

uerrno
System error codes

uhashlib
Hashing algorithms

uheapq
Heap queue algorithm

uio
Input/output streams

ujson
JSON encoding and decoding

uos
Basic “operating system”service

ure
Simple regular expressions

uselect
Wait for events on a set of streams

usocket
Socket module

ussl
SSL/TLS module

ustruct
Pack and unpack primitive data types


NuMaker
Mar 29, 2019 Page 7of 31 Rev 1.00
NUMICROPY USER MANUAL
utime
Time related functions

uzlib
zlib decompression

_thread
Multithreading support

network
Network configuration

uctypes
Access binary data in a structured way

Machine
Functions related to the hardware

ucryptolib
Cryptographic ciphers

Table 2-2 Default Supported Modules
I/O Class
Description
M487
ADC
Analog to digital conversion

CAN
Controller area network communication bus

I2C
A two-wire serial protocol

LED
LED object

Pin
Control I/O pins

PinAF
Pin alternate functions

RTC
Real time clock

SPI
A master-driven serial protocol

Switch
Switch button object

Timer
Control internal timers

TimerChannel
Setup a channel for a timer

UART
Duplex serial communication bus

USB_HID
USB Human Interface Device

USB_VCP
USP virtual com port

PWM
BPWM/EPWM generator and capture timer

WDT
Watchdog timer

Accel
Accelerometer control (Bosch BMX055)
Only for
NuMaker-IOT-
M487

NuMaker
Mar 29, 2019 Page 8of 31 Rev 1.00
NUMICROPY USER MANUAL
Gyro
Gyroscope control (Bosch BMX055)
Only for
NuMaker-IOT-
M487
Mag
Magnetometer control (Bosch BMX055)
Only for
NuMaker-IOT-
M487
Table 2-3 Default Supported I/O Classes

NuMaker
Mar 29, 2019 Page 9of 31 Rev 1.00
NUMICROPY USER MANUAL
3 HOW TO START NUMICROPY
The following uses the NuMaker-PFM-M487 board to show how to burn firmware into the
NuMicro®MCU and how to update your python code.
Nuvoton Nu-Link Driver Download and Install
Please visit the Nuvoton software download website to download “Nu-Link_Command_Tool” file.
When the Nu-Link command tool has been downloaded successfully, please unzip the file and
execute the “NuMicro NuLink Command Tool.exe” to install the driver.
Hardware Setup Steps
1. Turn on ICE function switch pin 1, 2, 3 and 4.
2. Connect USB ICE and USB1.1 to PC (Figure 3-1).
3. Set up your terminal program (Figure 3-2 and Figure 3-3).
Figure 3-1 NuMaker-PFM-M487 Board
Figure 3-2 Create a Serial Connection

NuMaker
Mar 29, 2019 Page 10 of 31 Rev 1.00
NUMICROPY USER MANUAL
Figure 3-3 Serial Port Setup
Burn Firmware
The Nu-Link-Me exports a MBED disk, just Copy and Paste your firmware.bin into MBED disk
(Figure 3-4). After firmware burning, you can see MicroPython prompt on your terminal screen as
Figure 2-1.
You can get prebuilt firmware from NuMicroPy repository
4
.
Figure 3-4 Copy and Paste Firmware
4
https://github.com/OpenNuvoton/NuMicroPy