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.
 
 
 
 
Scott Shawcroft e9659e61f8 Switch enum-like attributes to all caps and add print support for them. Make room for this functionality by adding a shared __enter__ function object. #76 6 years ago
atmel-samd Switch enum-like attributes to all caps and add print support for them. Make room for this functionality by adding a shared __enter__ function object. #76 6 years ago
bare-arm py: Be more specific with MP_DECLARE_CONST_FUN_OBJ macros. 6 years ago
cc3200 Merge tag 'v1.8.7' 6 years ago
docs Switch design guide to rST so that the table works. Also add details based on more feedback from @deshipu. Thanks! 6 years ago
drivers Merge tag 'v1.8.7' 6 years ago
esp8266 Switch enum-like attributes to all caps and add print support for them. Make room for this functionality by adding a shared __enter__ function object. #76 6 years ago
examples examples/hwapi/hwconfig_console: Don't alloc memory in value(). 6 years ago
extmod Make mp_float_t conversions explicit to silence warnings of converting floats to doubles. 6 years ago
lib Switch enum-like attributes to all caps and add print support for them. Make room for this functionality by adding a shared __enter__ function object. #76 6 years ago
logo logo/1bit-logo A black & white version of the logo 6 years ago
minimal minimal/Makefile: Split rule for firmware.bin generation. 6 years ago
mpy-cross mpy-cross: Get compiling after recent persistent code refactors. 6 years ago
pic16bit py: Be more specific with MP_DECLARE_CONST_FUN_OBJ macros. 6 years ago
py Make mp_float_t conversions explicit to silence warnings of converting floats to doubles. 6 years ago
qemu-arm qemu-arm: Enable software floating point support, and float tests. 6 years ago
shared-bindings Switch enum-like attributes to all caps and add print support for them. Make room for this functionality by adding a shared __enter__ function object. #76 6 years ago
shared-module Rename to CircuitPython 6 years ago
stmhal Merge tag 'v1.8.7' 6 years ago
teensy all: Consistently update signatures of .make_new and .call methods. 6 years ago
tests Fix tests that rely on sys.implementation.name to work with circutpython response. 6 years ago
tools Merge tag 'v1.8.7' 6 years ago
unix Make mp_float_t conversions explicit to silence warnings of converting floats to doubles. 6 years ago
windows windows: Enable READER_POSIX to get access to lexer_new_from_file. 6 years ago
zephyr zephyr: Enable slice subscription. 6 years ago
.gitattributes Add .gitattributes file to force text line endings to LF. 8 years ago
.gitignore Ignore the bin folder that can be used to collect binaries across ports. 6 years ago
.gitmodules lib/berkeley-db-1.xx: Add Berkeley DB 1.85 as a submodule. 7 years ago
.travis.yml Add CircuitPlayground, Trinket and Gemma to Travis build. 6 years ago
ACKNOWLEDGEMENTS ACKNOWLEDGEMENTS: Change backer 905 info, replace city with name. 6 years ago
CODECONVENTIONS.md CODECONVENTIONS.md: Fix typos. 6 years ago
CODE_OF_CONDUCT.md Add code of conduct so that expectations on contributor behavior are 6 years ago
CONTRIBUTING.md Add title to contributing doc. 6 years ago
LICENSE Add license header to (almost) all files. 9 years ago
README.md Add Gitter integration to Travis and add badges to the docs. 6 years ago
c2rst.py Switch away from sphinx.parsers which isn't available in sphinx 1.3.5 on Read The Docs. 6 years ago
conf.py Link to the Bus Device docs. 6 years ago
index.rst Add a draft of a new design guide. This is meant to capture the goals of CircuitPython and the corresponding design decisions. 6 years ago
license.rst Improve docs and update to CircuitPython. 6 years ago

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 including the Arduino Zero, Adafruit Feather M0 Basic, Adafruit Feather HUZZAH and Adafruit Feather M0 Bluefruit LE.

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.

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.
  • Unified hardware API: nativeio, 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-reset after file write over mass storage. (Disable with samd.disable_autoreset())
    • 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.
  • 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.