Jeff Epler
a703561402
remove docs added in merge
2021-06-18 16:02:44 -05:00
Jeff Epler
7b46187024
Fix trailing whitespace
2021-06-18 10:58:30 -05:00
Jeff Epler
87d3740c64
Merge tag 'v1.16'
2021-06-18 10:54:19 -05:00
Damien George
7c51cb2307
all: Bump version to 1.16.
...
Signed-off-by: Damien George <damien@micropython.org>
2021-06-18 16:38:06 +10:00
Thomas Wenrich
364670ecf1
docs/esp32: Document WLAN "reconnects" config option.
2021-06-17 18:48:17 +10:00
Mike Teachman
b0b8ebc4f6
extmod/uasyncio: Add readinto() method to Stream class.
...
With docs and a multi-test using TCP server/client.
This method is a MicroPython extension, although there is discussion of
adding it to CPython: https://bugs.python.org/issue41305
Signed-off-by: Mike Teachman <mike.teachman@gmail.com>
2021-06-15 13:13:35 +10:00
Peter Hinch
c0499bc2b9
docs/library/machine.RTC.rst: Document datetime method and fix ex code.
...
This is the minimum change to fix the example code so it actually runs on
the majority of ports.
2021-06-12 22:53:49 +10:00
Damien George
71e3538a32
stm32/usb: Add USB_VCP.irq method, to set a callback on USB data RX.
...
Usage:
usb = pyb.USB_VCP()
usb.irq(lambda u:print(u, u.read()), usb.IRQ_RX)
Signed-off-by: Damien George <damien@micropython.org>
2021-06-10 15:26:21 +10:00
Matt Trentini
a6a8941d84
docs/rp2: Add skeleton docs for the rp2 port.
2021-05-30 22:31:34 +10:00
James Carr
c665eb9bb5
Incompatible .mpy file
...
Update the *ValueError: Incompatible .mpy file* section for the upcoming 6 to 7 transition.
2021-05-23 08:51:35 +01:00
Mike Causer
47b778332a
all: Replace busses with buses.
...
"buses" is the widely accepted plural form of "bus".
2021-05-20 23:22:03 +10:00
Andrew Leech
9d58d46e0a
docs/library/pyb.Pin.rst: Update the arguments for Pin.init().
...
Add details for Pin.init() value and alt arguments.
2021-05-20 23:08:43 +10:00
Brett Cannon
452fa3f8d4
docs/library: Add a blank line to fix formatting for ussl docs.
2021-05-18 12:27:57 +10:00
Brett Cannon
07528d1f85
docs/library: Clarify what type of algorithm is implemented in heapq.
2021-05-18 12:24:21 +10:00
jposada202020
82677dd966
adding parameter documentation explanation.
2021-05-15 12:06:08 -04:00
Mike Causer
97fee47716
docs/esp8266: Add SSD1306 to quickref and tutorial.
2021-05-14 12:04:21 +10:00
Mike Causer
d43ed087ae
docs/esp8266: Mention Signal in GPIO section of quickref.
2021-05-14 12:02:01 +10:00
Mike Causer
85c51a548f
docs/esp32: Mention Signal in GPIO section of quickref.
2021-05-14 11:43:47 +10:00
Mike Causer
30cbcf881d
docs/esp32: Add APA106 to quickref.
2021-05-14 11:41:42 +10:00
Scott Shawcroft
966d25c6a5
Merge MicroPython v1.15 into CircuitPython
2021-05-12 17:51:42 -07:00
Scott Shawcroft
e02a26453c
Merge MicroPython 1.14 into CircuitPython
2021-05-11 15:07:40 -07:00
Damien George
87e38b3cc8
docs/library/rp2.rst: Fix typo overriden->overridden.
...
Signed-off-by: Damien George <damien@micropython.org>
2021-05-12 00:05:55 +10:00
Jeff Epler
446169e078
Merge pull request #4720 from tannewt/merge_1.13
...
Merge in MicroPython 1.13
2021-05-08 08:46:03 -05:00
Tim Radvan
fd24e649fd
docs/library: Add initial API reference for rp2 module and its classes.
...
All the method signatures from rp2_pio.c and friends have been taken and
converted to RST format, then explanatory notes added for each signature.
Signed-off-by: Tim Radvan <tim@tjvr.org>
2021-05-08 18:02:04 +10:00
jposada202020
bba0afa464
adding_string_format_explanation
2021-05-07 15:15:05 -04:00
Scott Shawcroft
cebb10ddae
Fixes from review
2021-05-07 09:31:59 -07:00
Scott Shawcroft
42f4065c8a
Merge remote-tracking branch 'adafruit/main' into merge_1.13
2021-05-06 11:17:53 -07:00
Dan Halbert
ebf9dcb47a
Merge pull request #4689 from dhalbert/dynamic-usb-descriptors
...
Dynamic USB descriptors
2021-05-06 13:51:38 -04:00
Mike Causer
64aebed70e
docs/esp8266: Add WDT to quickref.
2021-05-06 15:50:42 +10:00
Mike Causer
a111889705
docs/esp32: Add SDCard to quickref.
2021-05-06 15:48:09 +10:00
Mike Causer
a65942a41d
docs/esp32: Add WDT to quickref.
2021-05-06 15:46:28 +10:00
Mike Causer
b98197f950
docs/esp32: Add UART to quickref.
2021-05-06 15:44:53 +10:00
Scott Shawcroft
c34ddf14d6
Switch from recommonmark to myst-parser
...
It's the *future* and fixes a doc build error.
Related to https://github.com/readthedocs/recommonmark/issues/221
2021-05-05 15:25:37 -07:00
jposada202020
0f60a3b997
Better_phrasing
2021-05-05 12:18:26 -04:00
jposada202020
0fa6f4ed76
adding_usage_template
2021-05-04 22:14:06 -04:00
Scott Shawcroft
f0bb26d70f
Merge MicroPython 1.13 into CircuitPython
2021-05-04 18:06:33 -07:00
Dan Halbert
8bb3c6fd79
handle := defs in shared_bindings_matrix.py; update adafruit_hid
2021-05-04 18:07:01 -04:00
Gabriel M Schuyler
0054fff840
docs/pyboard: Fix typo in pyb.Switch tutorial.
2021-05-04 23:05:35 +10:00
Mike Causer
31ac410a4f
docs: Fix some spelling mistakes.
2021-05-04 22:58:00 +10:00
Mordy Ovits
d70ab87b2b
docs/esp8266: Clarify limitations of SSL in esp8266 and fix typos.
2021-05-04 15:15:34 +10:00
Damien George
2bf1beef5c
docs/esp8266: Add instructions on entering programming mode manually.
...
This adds to the ESP8266 tutorial instructions explaining which pins to
pull low to enter programming mode.
Commit made originally by @ARF1 in #2910 .
Signed-off-by: Damien George <damien@micropython.org>
2021-05-04 14:24:40 +10:00
Chris Liechti
4154ffbcba
docs/esp8266: Add note about simultaneous use of STA_IF and AP_IF.
...
See also https://github.com/esp8266/Arduino/issues/1624
2021-05-04 13:48:53 +10:00
Scott Shawcroft
b35fa44c8a
Merge MicroPython 1.12 into CircuitPython
2021-05-03 14:01:18 -07:00
Damien George
dd5c831a0b
docs/library/machine: Add machine.bootloader docs.
...
This is provide by a few ports now, and is very useful.
Signed-off-by: Damien George <damien@micropython.org>
2021-04-30 16:55:55 +10:00
Damien George
9e1b25a99e
docs/library/machine: Specify initial machine.PWM class.
...
This adds an initial specification of the machine.PWM class, to provide a
way to generate PWM output that is portable across the different ports.
Such functionality may already be available in one way or another (eg
through a Timer object), but because configuring PWM via a Timer is very
port-specific, and because it's a common thing to do, it's beneficial to
have a top-level construct for it.
The specification in this commit aims to provide core functionality in a
minimal way. It also somewhat matches most existing ad-hoc implementations
of machine.PWM.
See discussion in #2283 and #4237 .
Signed-off-by: Damien George <damien@micropython.org>
2021-04-30 16:42:51 +10:00
Jeff Epler
5fa7186396
Merge remote-tracking branch 'origin/main' into defining_parameters
2021-04-29 08:18:39 -05:00
Jeff Epler
d035a68c74
Merge pull request #4652 from jposada202020/design_guide_changes
...
Referencing_documentation_other_libraries
2021-04-29 08:10:13 -05:00
jposada202020
9c12b180c8
title change
2021-04-28 13:21:18 -04:00
jposada202020
71d575f0c4
Update docs/design_guide.rst
...
Co-authored-by: Kattni <kattni@adafruit.com>
2021-04-28 13:16:33 -04:00
jposada202020
e33bc9f57b
Update docs/design_guide.rst
...
Co-authored-by: Kattni <kattni@adafruit.com>
2021-04-28 13:16:21 -04:00
jposada202020
8ff29f68db
Update docs/design_guide.rst
...
Co-authored-by: Kattni <kattni@adafruit.com>
2021-04-28 13:16:11 -04:00
jposada202020
ed2980b967
Update docs/design_guide.rst
...
Co-authored-by: Kattni <kattni@adafruit.com>
2021-04-28 13:16:02 -04:00
jposada202020
1950cf6666
Update docs/design_guide.rst
...
Co-authored-by: Kattni <kattni@adafruit.com>
2021-04-28 13:15:55 -04:00
jposada202020
aa9114254a
Update docs/design_guide.rst
...
Co-authored-by: Kattni <kattni@adafruit.com>
2021-04-28 13:15:45 -04:00
jposada202020
129df1b3f7
Update docs/design_guide.rst
...
Co-authored-by: Kattni <kattni@adafruit.com>
2021-04-28 13:15:37 -04:00
jposada202020
9fe1751f01
Update docs/design_guide.rst
...
Co-authored-by: Kattni <kattni@adafruit.com>
2021-04-28 13:15:28 -04:00
jposada202020
69a510edc1
Update docs/design_guide.rst
...
Co-authored-by: Kattni <kattni@adafruit.com>
2021-04-28 13:15:17 -04:00
jposada202020
3c49bd6bde
Update docs/design_guide.rst
...
Co-authored-by: Kattni <kattni@adafruit.com>
2021-04-28 13:15:09 -04:00
jposada202020
4e931697c6
adding_backticks, typos
2021-04-28 06:07:45 -04:00
jposada202020
0c23c73510
defining_parameters
2021-04-28 05:36:37 -04:00
jposada202020
cb42acea53
better_phrasing
2021-04-27 17:43:25 -04:00
jposada202020
a512dd230d
word_order_better_phrasing
2021-04-27 17:34:45 -04:00
jposada202020
4d0e183ae1
Module_description_changes
2021-04-27 17:18:14 -04:00
jposada202020
2d80f6b872
Module_description_changes
2021-04-27 17:11:42 -04:00
Scott Shawcroft
76033d5115
Merge MicroPython v1.11 into CircuitPython
2021-04-26 15:47:41 -07:00
jposada202020
901e6ab5b0
Referencing_documentation_other_libraries
2021-04-23 10:02:24 -04:00
Damien George
3c4bfd1dec
py/objexcept: Support errno attribute on OSError exceptions.
...
This commit adds the errno attribute to exceptions, so code can retrieve
errno codes from an OSError using exc.errno.
The implementation here simply lets `errno` (and the existing `value`)
attributes work on any exception instance (they both alias args[0]). This
is for efficiency and to keep code size down. The pros and cons of this
are:
Pros:
- more compatible with CPython, less difference to document and learn
- OSError().errno will correctly return None, whereas the current way of
doing it via OSError().args[0] will raise an IndexError
- it reduces code size on most bare-metal ports (because they already have
the errno qstr)
- for Python code that uses exc.errno the generated bytecode is 2 bytes
smaller and more efficient to execute (compared with exc.args[0]); so
bytecode loaded to RAM saves 2 bytes RAM for each use of this attribute,
and bytecode that is frozen saves 2 bytes flash/ROM for each use
- it's easier/shorter to type, and saves 2 bytes of space in .py files that
use it (for each use)
Cons:
- increases code size by 4-8 bytes on minimal ports that don't already have
the `errno` qstr
- all exceptions now have .errno and .value attributes (a cpydiff test is
added to address this)
See also #2407 .
Signed-off-by: Damien George <damien@micropython.org>
2021-04-23 22:03:46 +10:00
Dan Halbert
8f73270f2b
Merge pull request #4646 from tannewt/merge_mp1.10
...
Merge in MicroPython v1.10
2021-04-22 13:16:27 -04:00
Scott Shawcroft
09f7b43c64
Merge MicroPython 1.10 into CircuitPython
2021-04-21 15:59:17 -07:00
jposada202020
b8253680bf
Small corrections, adding examples requirements in the design guide. SI units corrections and clarifications. Using const and Defaults to in class documentation. Building reference change.
2021-04-20 18:55:50 -04:00
Damien George
321d1897c3
all: Bump version to 1.15.
...
Signed-off-by: Damien George <damien@micropython.org>
2021-04-19 00:11:51 +10:00
Neradoc
827f67813f
add a filter text field to the support matrix
2021-04-15 19:05:50 +02:00
Dan Halbert
ddca91020e
Revert "add robots.txt to specify doc versions to appear in search engines"
2021-04-09 09:28:20 -04:00
Neradoc
12b0ee0a3e
add alias boards and bus_device to the support matrix
...
add list with manual brand names for aliases
the new info in the support_matrix is used in build_board_info.py
2021-04-02 13:36:06 +02:00
Damien George
f541b3673d
docs/develop: Improve user C modules to properly describe how to build.
...
Make and CMake builds are slightly different and these changes help make it
clear what to do in each case.
Signed-off-by: Damien George <damien@micropython.org>
2021-04-02 17:07:20 +11:00
Damien George
d87f42b0e5
examples/usercmodules: Simplify user C module enabling.
...
It's a bit of a pitfall with user C modules that including them in the
build does not automatically enable them. This commit changes the docs and
examples for user C modules to encourage writers of user C modules to
enable them unconditionally. This makes things simpler and covers most use
cases.
See discussion in issue #6960 , and also #7086 .
Signed-off-by: Damien George <damien@micropython.org>
2021-04-01 16:27:38 +11:00
Phil Howard
8e5756e2b6
docs/develop/cmodules.rst: Document C-modules and micropython.cmake.
...
Documents the micropython.cmake file required to make user C modules
compatible with the CMake build system.
Signed-off-by: Phil Howard <phil@pimoroni.com>
2021-03-31 00:28:21 +11:00
stijn
914380cb89
all: Add .git-blame-ignore-revs for fixing up git blame output.
...
Add most formatting-only commits to this file so that when used with
git blame, these commits are excluded and the output shows only the
interesting bits.
2021-03-15 11:07:29 +01:00
Damien George
6129b8e401
tests: Rename run-tests to run-tests.py for consistency.
...
Signed-off-by: Damien George <damien@micropython.org>
2021-03-12 19:56:09 +11:00
Damien George
b24fcd7aec
esp32/machine_hw_spi: Use default pins when making SPI if none given.
...
The default pins can be optionally configured by a board.
Fixes issue #6974 .
Signed-off-by: Damien George <damien@micropython.org>
2021-03-12 10:56:25 +11:00
Thorsten von Eicken
c10d431819
esp32: Add basic support for Non-Volatile-Storage in esp32 module.
...
This commit implements basic NVS support for the esp32. It follows the
pattern of the esp32.Partition class and exposes an NVS object per NVS
namespace. The initial support provided is only for signed 32-bit integers
and binary blobs. It's easy (albeit a bit tedious) to add support for
more types.
See discussions in: #4436 , #4707 , #6780
2021-02-19 15:05:19 +11:00
Thorsten von Eicken
2c1299b007
extmod/modussl: Fix ussl read/recv/send/write errors when non-blocking.
...
Also fix related problems with socket on esp32, improve docs for
wrap_socket, and add more tests.
2021-02-17 11:50:54 +11:00
Jim Mussared
cdf9c8648f
docs/library/uasyncio.rst: Add docs for ThreadSafeFlag.
...
Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
2021-02-16 16:35:37 +11:00
Jim Mussared
7ed99544e4
extmod/uasyncio: Add asyncio.current_task().
...
Matches CPython behavior.
Fixes #6686
2021-02-13 15:11:17 +11:00
Brianna Laugher
d128999938
tools: Add filesystem action examples to pyboard.py help.
...
Signed-off-by: Brianna Laugher <brianna.laugher@gmail.com>
2021-02-13 14:37:28 +11:00
caternuson
ac6695faba
update design guide
2021-02-11 14:28:58 -08:00
Kevin Banks
87fe58fea5
Added WEBUSB_README to the table of contents (required by CI)
2021-02-04 08:56:51 -06:00
Damien George
78b23c3a1f
all: Bump version to 1.14.
...
Signed-off-by: Damien George <damien@micropython.org>
2021-02-03 00:59:07 +11:00
Damien George
0e44587076
docs/library/machine.Pin.rst: Make it clear which methods are not core.
...
Signed-off-by: Damien George <damien@micropython.org>
2021-02-03 00:54:18 +11:00
Damien George
ef9fde7339
LICENSE,docs: Update copyright year range to include 2021.
...
Signed-off-by: Damien George <damien@micropython.org>
2021-01-31 23:17:42 +11:00
Samuelson
407df82f81
docs/develop/natmod: Fix a small typo, con->can.
2021-01-30 15:20:44 +11:00
Christopher Tse
ddb53c9458
docs/esp8266/quickref: Add warning block about NeoPixel timing.
2021-01-30 14:36:30 +11:00
Andrew Scheller
499e199add
docs,stm32: Fix minor typos in RTC docs, and->an.
2021-01-30 14:13:30 +11:00
nanjekyejoannah
4eaebc1988
docs/develop: Add MicroPython Internals chapter.
...
This commit adds many new sections to the existing "Developing and building
MicroPython" chapter to make it all about the internals of MicroPython.
This work was done as part of Google's Season of Docs 2020.
2021-01-27 16:59:58 +11:00
Dan Halbert
d116ad042f
Merge pull request #4070 from rpavlik/patch-1
...
Update design_guide.rst
2021-01-26 15:25:10 -05:00
Ryan A. Pavlik
365fafb32b
Update design_guide.rst
...
Add CO2 as a member name, and clarify the description of eCO2.
2021-01-26 10:36:40 -06:00
Dan Halbert
5b4249e365
fix doc typos
2021-01-25 23:06:47 -05:00
Dan Halbert
a9f339b461
typo in circuitpy_mpconfig.h; forgot cxd56 port
2021-01-25 22:40:31 -05:00
Dan Halbert
34d63debd5
Remove obsolete esp.rst, network.rst
2021-01-25 09:29:16 -05:00
Dan Halbert
69869e1439
CIRCUITPY_* switches for JSON, RE, etc. Doc cleanup
2021-01-24 23:10:20 -05:00