You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
circuitpython/zephyr
Damien George 4ec803a42a all: Make static dicts use mp_rom_map_elem_t type and MP_ROM_xxx macros. 5 years ago
..
src zephyr/zephyr_getchar: Explicitly yield to other threads on char availability. 6 years ago
.gitignore zephyr: Add .gitignore to ignore Zephyr's "outdir" directory. 6 years ago
Kbuild zephyr: Initial Zephyr RTOS port, Zephyr part. 6 years ago
Makefile all: Make use of $(TOP) variable in Makefiles, instead of "..". 5 years ago
Makefile.zephyr zephyr/Makefile.zephyr: Support and default to networked (SLIP) QEMU. 6 years ago
README.md zephyr/README: Update to require Zephyr 1.8. 6 years ago
help.c zephyr: Convert to use builtin help function. 6 years ago
machine_pin.c all: Make static dicts use mp_rom_map_elem_t type and MP_ROM_xxx macros. 5 years ago
main.c zephyr/main: Check default netif before applying operations to it. 6 years ago
make-minimal zephyr: Move "minimal" configuration building to a separate wrapper script. 6 years ago
makeprj.py zephyr: Make sure that generated prj.conf is updated only on content changes. 6 years ago
modmachine.c zephyr/modmachine: Implement machine.reset(). 6 years ago
modmachine.h all: Unify header guard usage. 5 years ago
modusocket.c all: Make static dicts use mp_rom_map_elem_t type and MP_ROM_xxx macros. 5 years ago
modutime.c all: Use the name MicroPython consistently in comments 5 years ago
modzephyr.c zephyr/modzephyr: Add shell_net_iface() function. 5 years ago
mpconfigport.h all: Make static dicts use mp_rom_map_elem_t type and MP_ROM_xxx macros. 5 years ago
mpconfigport_minimal.h zephyr: Remove long-obsolete machine_ptr_t typedef's. 5 years ago
mphalport.h zephyr: Switch to Zephyr 1.6 unified kernel API. 6 years ago
prj_96b_carbon.conf zephyr/prj_96b_carbon.conf: Re-enable networking on Carbon. 5 years ago
prj_base.conf zephyr/modzephyr: Add shell_net_iface() function. 5 years ago
prj_frdm_k64f.conf zephyr/prj_frdm_k64f.conf: Add, enable Ethernet support. 6 years ago
prj_minimal.conf zephyr: Add separate Zephyr config for "minimal" build. 6 years ago
prj_qemu_cortex_m3.conf zephyr: Add qemu_cortex_m3 config fragment. 6 years ago
prj_qemu_x86.conf zephyr/prj_qemu_x86.conf: Bump RAM size to 320K. 6 years ago
uart_core.c zephyr/uart_core: Access console UART directly instead of printk() hack. 6 years ago
z_config.mk zephyr/Makefile: Automatically derive target-specific CFLAGS. 6 years ago

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 qemu

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|qemu_cortex_m3> qemu