diff options
Diffstat (limited to 'zephyr/README.md')
| -rw-r--r-- | zephyr/README.md | 46 |
1 files changed, 32 insertions, 14 deletions
diff --git a/zephyr/README.md b/zephyr/README.md index 30f668bb4..018b4ce71 100644 --- a/zephyr/README.md +++ b/zephyr/README.md @@ -1,20 +1,19 @@ MicroPython port to Zephyr RTOS =============================== -This is an initial port of MicroPython to Zephyr RTOS +This is an work-in-progress port of MicroPython to Zephyr RTOS (http://zephyrproject.org). -The port integrates well with Zephyr build system, using the latest -features which will be available in 1.6.0, and thus requires Zephyr -master to build against. All boards supported by Zephyr (with standard -level of feature support, like UART console) should work with -MicroPython (but not all were tested). +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. @@ -49,8 +48,22 @@ 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. +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 @@ -83,13 +96,18 @@ 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. Thus, this build -is more suitable for code size control and quick demonstrations even 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 contrast -to the "default" build, which may get more and more features enabled by -default over time. +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 BOARD=<board> minimal + ./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 |