8000 Update README with new boards and new differences. · sparkfun/circuitpython@d275d5b · GitHub
[go: up one dir, main page]

Skip to content

Commit d275d5b

Browse files
committed
Update README with new boards and new differences.
1 parent b1925b1 commit d275d5b

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

README.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@ This project is in beta. Most APIs should be stable going forward.
1414
### Supported boards
1515

1616
#### Designed for CircuitPython
17+
* [Adafruit CircuitPlayground Express](https://www.adafruit.com/product/3333)
1718
* [Adafruit Feather M0 Express](https://www.adafruit.com/product/3403)
19+
* [Adafruit Metro M0 Express](https://www.adafruit.com/product/3505)
1820

1921
#### Other
2022
* [Adafruit Feather HUZZAH](https://www.adafruit.com/products/2821)
@@ -48,18 +50,25 @@ project admins. Please join the [Gitter chat](https://gitter.im/adafruit/circuit
4850
* Port for Atmel SAMD21 (Commonly known as M0 in product names.)
4951
* No `machine` API on Atmel SAMD21 port.
5052
* Only supports Atmel SAMD21 and ESP8266 ports.
51-
* Unified hardware APIs: [`analogio`](https://circuitpython.readthedocs.io/en/latest/shared-bindings/analogio/__init__.html), [`busio`](https://circuitpython.readthedocs.io/en/latest/shared-bindings/busio/__init__.html), [`digitalio`](https://circuitpython.readthedocs.io/en/latest/shared-bindings/digitalio/__init__.html), [`pulseio`](https://circuitpython.readthedocs.io/en/latest/shared-bindings/pulseio/__init__.html), [`touchio`](https://circuitpython.readthedocs.io/en/latest/shared-bindings/touchio/__init__.html), [`microcontroller`](https://circuitpython.readthedocs.io/en/latest/shared-bindings/microcontroller/__init__.html), [`board`](https://circuitpython.readthedocs.io/en/latest/shared-bindings/board/__init__.html), [`bitbangio`](https://circuitpython.readthedocs.io/en/latest/shared-bindings/bitbangio/__init__.html) (Only available on atmel-samd21 and ESP8266 currently.)
53+
* 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.
54+
* `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.
55+
* `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.
56+
* 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.
57+
* Autoreload state will be maintained across reload.
58+
* 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.
59+
* Unified hardware APIs:
60+
[`audioio`](https://circuitpython.readthedocs.io/en/latest/shared-bindings/audioio/__init__.html), [`analogio`](https://circuitpython.readthedocs.io/en/latest/shared-bindings/analogio/__init__.html), [`busio`](https://circuitpython.readthedocs.io/en/latest/shared-bindings/busio/__init__.html), [`digitalio`](https://circuitpython.readthedocs.io/en/latest/shared-bindings/digitalio/__init__.html), [`pulseio`](https://circuitpython.readthedocs.io/en/latest/shared-bindings/pulseio/__init__.html), [`touchio`](https://circuitpython.readthedocs.io/en/latest/shared-bindings/touchio/__init__.html), [`microcontroller`](https://circuitpython.readthedocs.io/en/latest/shared-bindings/microcontroller/__init__.html), [`board`](https://circuitpython.readthedocs.io/en/latest/shared-bindings/board/__init__.html), [`bitbangio`](https://circuitpython.readthedocs.io/en/latest/shared-bindings/bitbangio/__init__.html) (Only available on atmel-samd21 and ESP8266 currently.)
5261
* Tracks MicroPython's releases (not master).
5362
* No module aliasing. (`uos` and `utime` are not available as `os` and `time` respectively.)
5463
* Modules with a CPython counterpart, such as `time`, are strict [subsets](https://circuitpython.readthedocs.io/en/latest/shared-bindings/time/__init__.html) of their [CPython version](https://docs.python.org/3.4/library/time.html?highlight=time#module-time). Therefore, code from CircuitPython is runnable on CPython but not necessarily the reverse.
5564
* tick count is available as [`time.monotonic()`](https://circuitpython.readthedocs.io/en/latest/shared-bindings/time/__init__.html#time.monotonic)
5665
* `os` only available as `uos`
5766
* atmel-samd21 features
5867
* RGB status LED
59-
* Auto-reset after file write over mass storage. (Disable with `samd.disable_autoreset()`)
68+
* Auto-reload after file write over mass storage. (Disable with `samd.disable_autoreload()`)
6069
* Wait state after boot and main run, before REPL.
61-
* Main is one of these: code.txt, code.py, main.py, main.txt
62-
* Boot is one of these: settings.txt, settings.py, boot.py, boot.txt
70+
* Main is one of these: `code.txt`, `code.py`, `main.py`, `main.txt`
71+
* Boot is one of these: `settings.txt`, `settings.py`, `boot.py`, `boot.txt`
6372

6473
## Project Structure
6574
Here is an overview of the top-level directories.

0 commit comments

Comments
 (0)
0