circuitpython/ports/zephyr
Damien George 05e0103e9e zephyr: Rename CONFIG_CONSOLE_PULL to CONFIG_CONSOLE_SUBSYS.
Following a similar change in the Zephyr Project.
2018-06-27 15:33:59 +10:00
..
src zephyr: Rename CONFIG_CONSOLE_PULL to CONFIG_CONSOLE_SUBSYS. 2018-06-27 15:33:59 +10:00
.gitignore ports: Make new ports/ sub-directory and move all ports there. 2017-09-06 13:40:51 +10:00
CMakeLists.txt zephyr/CMakeLists.txt: Properly separate CFLAGS parts gotten from CMake. 2017-12-06 16:45:27 +02:00
Kbuild ports: Make new ports/ sub-directory and move all ports there. 2017-09-06 13:40:51 +10:00
Makefile zephyr/Makefile: Add kobj_types_h_target to Z_EXPORTS. 2018-05-21 10:35:16 +10:00
Makefile.zephyr ports: Make new ports/ sub-directory and move all ports there. 2017-09-06 13:40:51 +10:00
README.md zephyr/README: Hint about existence of qemu_x86_nommu. 2018-05-21 10:35:16 +10:00
help.c py/builtinhelp: Change signature of help text var from pointer to array. 2017-09-12 16:03:52 +10:00
machine_pin.c all: Remove inclusion of internal py header files. 2017-10-04 12:37:50 +11:00
main.c zephyr/main: After builtin testsuite, drop to REPL. 2018-05-21 10:35:16 +10:00
make-bin-testsuite zephyr: Add support for binary with builtin testsuite. 2017-12-15 12:10:39 +02:00
make-minimal ports: Make new ports/ sub-directory and move all ports there. 2017-09-06 13:40:51 +10:00
makeprj.py ports: Make new ports/ sub-directory and move all ports there. 2017-09-06 13:40:51 +10:00
modmachine.c ports: Make new ports/ sub-directory and move all ports there. 2017-09-06 13:40:51 +10:00
modmachine.h ports: Make new ports/ sub-directory and move all ports there. 2017-09-06 13:40:51 +10:00
modusocket.c py/stream: Switch stream close operation from method to ioctl. 2018-04-10 13:41:32 +10:00
modutime.c ports: Make new ports/ sub-directory and move all ports there. 2017-09-06 13:40:51 +10:00
modzephyr.c ports: Make new ports/ sub-directory and move all ports there. 2017-09-06 13:40:51 +10:00
modzsensor.c zephyr/modzsensor: Zephyr sensor subsystem bindings. 2018-05-21 10:35:16 +10:00
mpconfigport.h zephyr/modzsensor: Zephyr sensor subsystem bindings. 2018-05-21 10:35:16 +10:00
mpconfigport_bin_testsuite.h zephyr: Add support for binary with builtin testsuite. 2017-12-15 12:10:39 +02:00
mpconfigport_minimal.h ports: Make new ports/ sub-directory and move all ports there. 2017-09-06 13:40:51 +10:00
mphalport.h ports: Make new ports/ sub-directory and move all ports there. 2017-09-06 13:40:51 +10:00
prj_96b_carbon.conf ports: Make new ports/ sub-directory and move all ports there. 2017-09-06 13:40:51 +10:00
prj_base.conf zephyr: Rename CONFIG_CONSOLE_PULL to CONFIG_CONSOLE_SUBSYS. 2018-06-27 15:33:59 +10:00
prj_disco_l475_iot1.conf zephyr: Add prj_disco_l475_iot1.conf with sensor drivers. 2018-05-21 10:35:16 +10:00
prj_frdm_k64f.conf ports: Make new ports/ sub-directory and move all ports there. 2017-09-06 13:40:51 +10:00
prj_minimal.conf ports: Make new ports/ sub-directory and move all ports there. 2017-09-06 13:40:51 +10:00
prj_qemu_cortex_m3.conf zephyr: Rename CONFIG_CONSOLE_PULL to CONFIG_CONSOLE_SUBSYS. 2018-06-27 15:33:59 +10:00
prj_qemu_x86.conf zephyr: Rename CONFIG_CONSOLE_PULL to CONFIG_CONSOLE_SUBSYS. 2018-06-27 15:33:59 +10:00
uart_core.c zephyr: Rename CONFIG_CONSOLE_PULL to CONFIG_CONSOLE_SUBSYS. 2018-06-27 15:33:59 +10:00
z_config.mk ports: Make new ports/ sub-directory and move all ports there. 2017-09-06 13:40:51 +10:00

README.md

MicroPython port to Zephyr RTOS

This is an work-in-progress port of MicroPython to Zephyr RTOS (http://zephyrproject.org).

This port requires Zephyr version 1.8 or higher. All boards supported by Zephyr (with standard level of features support, like UART console) should work with MicroPython (but not all were tested).

Features supported at this time:

  • REPL (interactive prompt) over Zephyr UART console.
  • utime module for time measurements and delays.
  • machine.Pin class for GPIO control.
  • usocket module for networking (IPv4/IPv6).
  • "Frozen modules" support to allow to bundle Python modules together with firmware. Including complete applications, including with run-on-boot capability.

Over time, bindings for various Zephyr subsystems may be added.

Building

Follow to Zephyr web site for Getting Started instruction of installing Zephyr SDK, getting Zephyr source code, and setting up development environment. (Direct link: https://www.zephyrproject.org/doc/getting_started/getting_started.html). You may want to build Zephyr's own sample applications to make sure your setup is correct.

To build MicroPython port, in the port subdirectory (zephyr/), run:

make BOARD=<board>

If you don't specify BOARD, the default is qemu_x86 (x86 target running in QEMU emulator). Consult Zephyr documentation above for the list of supported boards.

Running

To run the resulting firmware in QEMU (for BOARDs like qemu_x86, qemu_cortex_m3):

make run

With the default configuration, networking is now enabled, so you need to follow instructions in https://wiki.zephyrproject.org/view/Networking-with-Qemu to setup host side of TAP/SLIP networking. If you get error like:

could not connect serial device to character backend 'unix:/tmp/slip.sock'

it's a sign that you didn't followed instructions above. If you would like to just run it quickly without extra setup, see "minimal" build below.

For deploying/flashing a firmware on a real board, follow Zephyr documentation for a given board, including known issues for that board (if any). (Mind again that networking is enabled for the default build, so you should know if there're any special requirements in that regard, cf. for example QEMU networking requirements above; real hardware boards generally should not have any special requirements, unless there're known issues).

Quick example

To blink an LED:

import time
from machine import Pin

LED = Pin(("GPIO_1", 21), Pin.OUT)
while True:
    LED.value(1)
    time.sleep(0.5)
    LED.value(0)
    time.sleep(0.5)

The above code uses an LED location for a FRDM-K64F board (port B, pin 21; following Zephyr conventions port are identified by "GPIO_x", where x starts from 0). You will need to adjust it for another board (using board's reference materials). To execute the above sample, copy it to clipboard, in MicroPython REPL enter "paste mode" using Ctrl+E, paste clipboard, press Ctrl+D to finish paste mode and start execution.

Minimal build

MicroPython is committed to maintain minimal binary size for Zephyr port below 128KB, as long as Zephyr project is committed to maintain stable minimal size of their kernel (which they appear to be). Note that at such size, there is no support for any Zephyr features beyond REPL over UART, and only very minimal set of builtin Python modules is available. Thus, this build is more suitable for code size control and quick demonstrations on smaller systems. It's also suitable for careful enabling of features one by one to achieve needed functionality and code size. This is in the contrast to the "default" build, which may get more and more features enabled over time.

To make a minimal build:

./make-minimal BOARD=<board>

To run a minimal build in QEMU without requiring TAP networking setup run the following after you built image with the previous command:

./make-minimal BOARD=<qemu_x86_nommu|qemu_x86|qemu_cortex_m3> run