summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2021-07-22docs/library/uasyncio.rst: Document stream readexactly() method.Damien George
Signed-off-by: Damien George <damien@micropython.org>
2021-07-22docs/library/utime.rst: Clarify behaviour and precision of sleep ms/us.Damien George
This description is based on the existing bare-metal ports implementations. Signed-off-by: Damien George <damien@micropython.org>
2021-07-20docs/rp2: Update general section to give a brief technical overview.NitiKaur
2021-07-20docs/rp2: Enhance quickref and change image to Pico pinout.NitiKaur
2021-07-18docs: Replace master/slave with controller/peripheral in I2C and SPI.David P
See https://www.oshwa.org/a-resolution-to-redefine-spi-signal-names
2021-07-12all: Update to point to files in new shared/ directory.Damien George
Signed-off-by: Damien George <damien@micropython.org>
2021-07-07docs/esp8266/tutorial: Change flash mode from dio to dout.finefoot
For some boards, even -fm dio is too fast and they require -fm dout. This commit links to the esptool wiki about available flash modes and changes dio to dout.
2021-07-06docs/library: Warn that ustruct doesn't handle spaces in format strings.Tom McDermott
And also add a test to capture the CPython difference.
2021-07-05esp32,stm32: Add new machine.I2S class for I2S protocol support.Mike Teachman
This commit adds I2S protocol support for the esp32 and stm32 ports, via a new machine.I2S class. It builds on the stm32 work of blmorris, #1361. Features include: - a consistent I2S API across the esp32 and stm32 ports - I2S configurations supported: - master transmit and master receive - 16-bit and 32-bit sample sizes - mono and stereo formats - sampling frequency - 3 modes of operation: - blocking - non-blocking with callback - uasyncio - internal ring buffer size can be tuned - documentation for Pyboards and esp32-based boards - tested on the following development boards: - Pyboard D SF2W - Pyboard V1.1 - ESP32 with SPIRAM - ESP32 Signed-off-by: Mike Teachman <mike.teachman@gmail.com>
2021-07-01docs/library: Document new esp32.RMT features and fix wait_done.Jonathan Hogg
Add new API for specifying the idle level and TX carrier output level, and new write_pulses modes of operation. Also fix wait_done documentation which was inverted and wrong about timing.
2021-06-25rp2: Use 0=Monday datetime convention in RTC.Krzysztof Adamski
The RTC in rp2 can store any, even wrong, number as a weekday in RTC. It was, however, discussed in #7394 that we would like to unify all ports and use 0 as Monday, not Sunday in the machine.RTC implementation. This patch makes sure that the default date set in RTC is adheres to this convention. It also fixes the example in quickref to use proper weekday to avoid confusion. Signed-off-by: Krzysztof Adamski <k@japko.eu>
2021-06-23stm32/usb: Make irq's default trigger enable all events.Damien George
Following how other .irq() methods work on other objects. Signed-off-by: Damien George <damien@micropython.org>
2021-06-22LICENSE: Reference third-party licenses.Jim Mussared
This is to provide a summary of the licenses used by MicroPython. - Add SPDX identifier for every directory that includes non-MIT-licensed content. - Add brief summary. - Update docs license to be more explicit. Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
2021-06-18all: Bump version to 1.16.v1.16Damien George
Signed-off-by: Damien George <damien@micropython.org>
2021-06-17docs/esp32: Document WLAN "reconnects" config option.Thomas Wenrich
2021-06-15extmod/uasyncio: Add readinto() method to Stream class.Mike Teachman
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-12docs/library/machine.RTC.rst: Document datetime method and fix ex code.Peter Hinch
This is the minimum change to fix the example code so it actually runs on the majority of ports.
2021-06-10stm32/usb: Add USB_VCP.irq method, to set a callback on USB data RX.Damien George
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-05-30docs/rp2: Add skeleton docs for the rp2 port.Matt Trentini
2021-05-20all: Replace busses with buses.Mike Causer
"buses" is the widely accepted plural form of "bus".
2021-05-20docs/library/pyb.Pin.rst: Update the arguments for Pin.init().Andrew Leech
Add details for Pin.init() value and alt arguments.
2021-05-18docs/library: Add a blank line to fix formatting for ussl docs.Brett Cannon
2021-05-18docs/library: Clarify what type of algorithm is implemented in heapq.Brett Cannon
2021-05-14docs/esp8266: Add SSD1306 to quickref and tutorial.Mike Causer
2021-05-14docs/esp8266: Mention Signal in GPIO section of quickref.Mike Causer
2021-05-14docs/esp32: Mention Signal in GPIO section of quickref.Mike Causer
2021-05-14docs/esp32: Add APA106 to quickref.Mike Causer
2021-05-12docs/library/rp2.rst: Fix typo overriden->overridden.Damien George
Signed-off-by: Damien George <damien@micropython.org>
2021-05-08docs/library: Add initial API reference for rp2 module and its classes.Tim Radvan
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-06docs/esp8266: Add WDT to quickref.Mike Causer
2021-05-06docs/esp32: Add SDCard to quickref.Mike Causer
2021-05-06docs/esp32: Add WDT to quickref.Mike Causer
2021-05-06docs/esp32: Add UART to quickref.Mike Causer
2021-05-04docs/pyboard: Fix typo in pyb.Switch tutorial.Gabriel M Schuyler
2021-05-04docs: Fix some spelling mistakes.Mike Causer
2021-05-04docs/esp8266: Clarify limitations of SSL in esp8266 and fix typos.Mordy Ovits
2021-05-04docs/esp8266: Add instructions on entering programming mode manually.Damien George
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-04docs/esp8266: Add note about simultaneous use of STA_IF and AP_IF.Chris Liechti
See also https://github.com/esp8266/Arduino/issues/1624
2021-04-30docs/library/machine: Add machine.bootloader docs.Damien George
This is provide by a few ports now, and is very useful. Signed-off-by: Damien George <damien@micropython.org>
2021-04-30docs/library/machine: Specify initial machine.PWM class.Damien George
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-23py/objexcept: Support errno attribute on OSError exceptions.Damien George
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-19all: Bump version to 1.15.v1.15Damien George
Signed-off-by: Damien George <damien@micropython.org>
2021-04-02docs/develop: Improve user C modules to properly describe how to build.Damien George
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-01examples/usercmodules: Simplify user C module enabling.Damien George
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-03-31docs/develop/cmodules.rst: Document C-modules and micropython.cmake.Phil Howard
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-15all: Add .git-blame-ignore-revs for fixing up git blame output.stijn
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-12tests: Rename run-tests to run-tests.py for consistency.Damien George
Signed-off-by: Damien George <damien@micropython.org>
2021-03-12esp32/machine_hw_spi: Use default pins when making SPI if none given.Damien George
The default pins can be optionally configured by a board. Fixes issue #6974. Signed-off-by: Damien George <damien@micropython.org>
2021-02-19esp32: Add basic support for Non-Volatile-Storage in esp32 module.Thorsten von Eicken
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-17extmod/modussl: Fix ussl read/recv/send/write errors when non-blocking.Thorsten von Eicken
Also fix related problems with socket on esp32, improve docs for wrap_socket, and add more tests.
generated by cgit v1.2.3 (git 2.46.0) at 2025-11-20 09:06:26 +0000