Go to file
Scott Shawcroft 30ee7019ca Merge tag 'v1.9.1'
Fixes for stmhal USB mass storage, lwIP bindings and VFS regressions

This release provides an important fix for the USB mass storage device in
the stmhal port by implementing the SCSI SYNCHRONIZE_CACHE command, which
is now require by some Operating Systems.  There are also fixes for the
lwIP bindings to improve non-blocking sockets and error codes.  The VFS has
some regressions fixed including the ability to statvfs the root.

All changes are listed below.

py core:
- modbuiltins: add core-provided version of input() function
- objstr: catch case of negative "maxsplit" arg to str.rsplit()
- persistentcode: allow to compile with complex numbers disabled
- objstr: allow to compile with obj-repr D, and unicode disabled
- modsys: allow to compile with obj-repr D and PY_ATTRTUPLE disabled
- provide mp_decode_uint_skip() to help reduce stack usage
- makeqstrdefs.py: make script run correctly with Python 2.6
- objstringio: if created from immutable object, follow copy on write policy

extmod:
- modlwip: connect: for non-blocking mode, return EINPROGRESS
- modlwip: fix error codes for duplicate calls to connect()
- modlwip: accept: fix error code for non-blocking mode
- vfs: allow to statvfs the root directory
- vfs: allow "buffering" and "encoding" args to VFS's open()
- modframebuf: fix signed/unsigned comparison pendantic warning

lib:
- libm: use isfinite instead of finitef, for C99 compatibility
- utils/interrupt_char: remove support for KBD_EXCEPTION disabled

tests:
- basics/string_rsplit: add tests for negative "maxsplit" argument
- float: convert "sys.exit()" to "raise SystemExit"
- float/builtin_float_minmax: PEP8 fixes
- basics: convert "sys.exit()" to "raise SystemExit"
- convert remaining "sys.exit()" to "raise SystemExit"

unix port:
- convert to use core-provided version of built-in import()
- Makefile: replace references to make with $(MAKE)

windows port:
- convert to use core-provided version of built-in import()

qemu-arm port:
- Makefile: adjust object-file lists to get correct dependencies
- enable micropython.mem_*() functions to allow more tests

stmhal port:
- boards: enable DAC for NUCLEO_F767ZI board
- add support for NUCLEO_F446RE board
- pass USB handler as parameter to allow more than one USB handler
- usb: use local USB handler variable in Start-of-Frame handler
- usb: make state for USB device private to top-level USB driver
- usbdev: for MSC implement SCSI SYNCHRONIZE_CACHE command
- convert from using stmhal's input() to core provided version

cc3200 port:
- convert from using stmhal's input() to core provided version

teensy port:
- convert from using stmhal's input() to core provided version

esp8266 port:
- Makefile: replace references to make with $(MAKE)
- Makefile: add clean-modules target
- convert from using stmhal's input() to core provided version

zephyr port:
- modusocket: getaddrinfo: Fix mp_obj_len() usage
- define MICROPY_PY_SYS_PLATFORM (to "zephyr")
- machine_pin: use native Zephyr types for Zephyr API calls

docs:
- machine.Pin: remove out_value() method
- machine.Pin: add on() and off() methods
- esp8266: consistently replace Pin.high/low methods with .on/off
- esp8266/quickref: polish Pin.on()/off() examples
- network: move confusingly-named cc3200 Server class to its reference
- uos: deconditionalize, remove minor port-specific details
- uos: move cc3200 port legacy VFS mounting functions to its ref doc
- machine: sort machine classes in logical order, not alphabetically
- network: first step to describe standard network class interface

examples:
- embedding: use core-provided KeyboardInterrupt object
2017-06-20 10:56:05 -07:00
atmel-samd Merge tag 'v1.9.1' 2017-06-20 10:56:05 -07:00
bare-arm all: Move BYTES_PER_WORD definition from ports to py/mpconfig.h 2017-04-01 11:39:38 +11:00
cc3200 Merge tag 'v1.9.1' 2017-06-20 10:56:05 -07:00
docs Merge tag 'v1.9.1' 2017-06-20 10:56:05 -07:00
drivers drivers: Replace deprecated Pin.high()/low() methods with .__call__(1/0). 2017-05-21 17:44:58 +03:00
esp8266 Merge tag 'v1.9.1' 2017-06-20 10:56:05 -07:00
examples examples/embedding: Use core-provided KeyboardInterrupt object. 2017-06-07 20:28:18 +10:00
extmod Merge tag 'v1.9.1' 2017-06-20 10:56:05 -07:00
lib Merge tag 'v1.9.1' 2017-06-20 10:56:05 -07:00
logo logo/1bit-logo A black & white version of the logo 2016-08-02 14:59:55 +03:00
minimal py: Add LOAD_SUPER_METHOD bytecode to allow heap-free super meth calls. 2017-04-22 23:39:20 +10:00
mpy-cross mpy-cross/Makefile: Guard "override undefine" by test for make feature. 2017-05-26 13:16:55 +10:00
pic16bit all: Move BYTES_PER_WORD definition from ports to py/mpconfig.h 2017-04-01 11:39:38 +11:00
py Merge tag 'v1.9.1' 2017-06-20 10:56:05 -07:00
qemu-arm Merge tag 'v1.9.1' 2017-06-20 10:56:05 -07:00
shared-bindings Merge tag 'v1.9.1' 2017-06-20 10:56:05 -07:00
shared-module Merge tag 'v1.9.1' 2017-06-20 10:56:05 -07:00
stmhal Merge tag 'v1.9.1' 2017-06-20 10:56:05 -07:00
teensy Merge tag 'v1.9.1' 2017-06-20 10:56:05 -07:00
tests Merge tag 'v1.9.1' 2017-06-20 10:56:05 -07:00
tools Merge tag 'v1.9.1' 2017-06-20 10:56:05 -07:00
unix Merge tag 'v1.9.1' 2017-06-20 10:56:05 -07:00
windows windows: Convert to use core-provided version of built-in import(). 2017-06-01 16:29:02 +10:00
zephyr zephyr/machine_pin: Use native Zephyr types for Zephyr API calls. 2017-06-10 19:40:31 +03:00
.gitattributes gitattributes: Remove obsolete lines. 2017-02-17 10:27:34 +11:00
.gitignore Merge tag 'v1.9.1' 2017-06-20 10:56:05 -07:00
.gitmodules Turn on build saving and uf2 creation. 2017-04-20 14:04:06 -07:00
.travis.yml Merge tag 'v1.9.1' 2017-06-20 10:56:05 -07:00
ACKNOWLEDGEMENTS ACKNOWLEDGEMENTS: Change backer 905 info, replace city with name. 2016-10-22 14:45:35 +11:00
CODECONVENTIONS.md CODECONVENTIONS.md: Fix typos. 2016-08-24 13:19:25 -07:00
CODE_OF_CONDUCT.md Add code of conduct so that expectations on contributor behavior are 2016-10-13 14:09:39 -07:00
CONTRIBUTING.md Add title to contributing doc. 2016-10-19 10:53:37 -07:00
LICENSE Add license header to (almost) all files. 2014-05-03 23:27:38 +01:00
README.md Update README with new boards and new differences. 2017-05-16 11:15:35 -07:00
c2rst.py Switch away from sphinx.parsers which isn't available in sphinx 1.3.5 on Read The Docs. 2016-10-19 10:53:37 -07:00
conf.py Merge tag 'v1.9.1' 2017-06-20 10:56:05 -07:00
index.rst docs: Add module support matrix. 2017-06-07 12:00:15 -07:00
license.rst Improve docs and update to CircuitPython. 2017-01-05 16:20:46 -08:00

README.md

Adafruit CircuitPython

Build Status Doc Status Gitter

This is an open source derivative of MicroPython for use on educational development boards designed and sold by Adafruit.

As a MicroPython derivative, this implements Python 3.x on microcontrollers such as the SAMD21 and ESP8266.

Project Status

This project is in beta. Most APIs should be stable going forward.

Supported boards

Designed for CircuitPython

Other

Download

Official binaries are available through the latest GitHub releases. Continuous (one per commit) builds are available here which includes experimental hardware support.

Documentation

Guides and videos are available through the Adafruit Learning System under the CircuitPython category and MicroPython category. An API reference is also available on Read the Docs.

Contributing

See CONTRIBUTING.md for full guidelines but please be aware that by contributing to this project you are agreeing to the Code of Conduct. Contributors who follow the Code of Conduct are welcome to submit pull requests and they will be promptly reviewed by project admins. Please join the Gitter chat too.

Differences from MicroPython

  • Port for Atmel SAMD21 (Commonly known as M0 in product names.)
  • No machine API on Atmel SAMD21 port.
  • Only supports Atmel SAMD21 and ESP8266 ports.
  • The order that files are run and the state thats shared between them. The goal is to clarify the role of each file and make them independent from each other.
    • boot.py (or settings.py) runs only once on start up before USB is initialized. This lays the ground work for configuring USB at startup rather than it being fixed. Since serial is not available, output is written to boot_out.txt.
    • code.py (or main.py) is run after every reload until it finishes or is interrupted. After its done the vm and hardware is reinitialized. This means you cannot read state from code.py in the REPL anymore. This was changed to reduce confusion about pins and memory being in use.
    • After code.py the REPL can be entered by pressing any key. It no longer shares state with code.py so its a fresh vm.
    • Autoreload state will be maintained across reload.
  • Adds a safe mode that does not run user code after a hard crash or brown out. The hope is that this will make it easier to fix code that causes nasty crashes by making it available through mass storage after the crash. A reset (the button) is needed after its fixed to get back into normal mode.
  • Unified hardware APIs: audioio, analogio, busio, digitalio, pulseio, touchio, microcontroller, board, bitbangio (Only available on atmel-samd21 and ESP8266 currently.)
  • Tracks MicroPython's releases (not master).
  • No module aliasing. (uos and utime are not available as os and time respectively.)
  • Modules with a CPython counterpart, such as time, are strict subsets of their CPython version. Therefore, code from CircuitPython is runnable on CPython but not necessarily the reverse.
  • tick count is available as time.monotonic()
  • os only available as uos
  • atmel-samd21 features
    • RGB status LED
    • Auto-reload after file write over mass storage. (Disable with samd.disable_autoreload())
    • Wait state after boot and main run, before REPL.
    • Main is one of these: code.txt, code.py, main.py, main.txt
    • Boot is one of these: settings.txt, settings.py, boot.py, boot.txt

Project Structure

Here is an overview of the top-level directories.

Core

The core code of MicroPython is shared amongst ports including CircuitPython:

  • docs High level user documentation in Sphinx reStructuredText format.
  • drivers External device drivers written in Python.
  • examples A few example Python scripts.
  • extmod Shared C code used in multiple ports' modules.
  • lib Shared core C code including externally developed libraries such as FATFS.
  • logo The MicroPython logo.
  • mpy-cross A cross compiler that converts Python files to byte code prior to being run in MicroPython. Useful for reducing library size.
  • py Core Python implementation, including compiler, runtime, and core library.
  • shared-bindings Shared definition of Python modules, their docs and backing C APIs. Ports must implement the C API to support the corresponding module.
  • shared-module Shared implementation of Python modules that may be based on common-hal.
  • tests Test framework and test scripts.
  • tools Various tools, including the pyboard.py module.

Ports

Ports include the code unique to a microcontroller line and also variations based on the board.

  • atmel-samd Support for SAMD21 based boards such as Arduino Zero, Adafruit Feather M0 Basic, and Adafruit Feather M0 Bluefruit LE.
  • bare-arm A bare minimum version of MicroPython for ARM MCUs.
  • cc3200 Support for boards based CC3200 from TI such as the WiPy 1.0.
  • esp8266 Support for boards based on ESP8266 WiFi modules such as the Adafruit Feather HUZZAH.
  • minimal A minimal MicroPython port. Start with this if you want to port MicroPython to another microcontroller.
  • pic16bit Support for 16-bit PIC microcontrollers.
  • qemu-arm Support for ARM emulation through QEMU.
  • stmhal Support for boards based on STM32 microcontrollers including the MicroPython flagship PyBoard.
  • teensy Support for the Teensy line of boards such as the Teensy 3.1.
  • unix Support for UNIX.
  • windows Support for Windows.
  • zephyr Support for Zephyr, a real-time operating system by the Linux Foundation.

CircuitPython only maintains the atmel-samd and esp8266 ports. The rest are here to maintain compatibility with the MicroPython parent project.