summaryrefslogtreecommitdiff
path: root/docs/pyboard
AgeCommit message (Collapse)Author
2025-10-04all: Replace legacy name with MicroPython and MPy as applicable.Angus Gratton
With the aim of getting consistency, and removing the need to learn an additional term, replace uses of uPy/uPython with MPy/MicroPython. Rule of thumb was to use "MPy" abbreviation where "CPy" is used nearby, but the full word MicroPython otherwise. This work was funded through GitHub Sponsors. Signed-off-by: Angus Gratton <angus@redyak.com.au>
2024-12-19docs: Fix the quickref documentation of rtc.datetime().robert-hh
Such that it matches the implementation and the documentation of the `machine.RTC` class. Signed-off-by: robert-hh <robert@hammelrath.com>
2024-11-19docs: Add a "Reset and Boot Sequence" reference page.Angus Gratton
Previously individual ports documented these aspects to varying degrees, but most of the information is common to all ports. In particular, this adds a canonical explanation of `boot.py` and `main.py`. This work was funded through GitHub Sponsors. Signed-off-by: Angus Gratton <angus@redyak.com.au>
2024-02-07docs: Use vfs module instead of os.Damien George
Signed-off-by: Damien George <damien@micropython.org>
2023-04-27all: Fix spelling mistakes based on codespell check.Damien George
Signed-off-by: Damien George <damien@micropython.org>
2022-09-30top: Replace upip with mip everywhere.Jim Mussared
Updates all README.md and docs, and manifests to `require("mip")`. Also extend and improve the documentation on freezing and packaging. This work was funded through GitHub Sponsors. Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
2022-09-06drivers/display: Don't include tests by default.Damien George
The tests can be copied to the board if needed. Also update the docs to reflect this change. Signed-off-by: Damien George <damien@micropython.org>
2021-12-15docs: Remove trailing spaces and convert tabs to spaces.Damien George
Signed-off-by: Damien George <damien@micropython.org>
2021-09-16stm32: Suggest putting code in main.py not boot.py.Jim Mussared
Don't want users to accidentally use boot.py (because recovering requires knowing how to activate safe mode). Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
2021-08-13docs: Replace ufoo with foo in all docs.Jim Mussared
Anywhere a module is mentioned, use its "non-u" name for consistency. The "import module" vs "import umodule" is something of a FAQ, and this commit intends to help clear that up. As a first approximation MicroPython is Python, and so imports should work the same as Python and use the same name, to a first approximation. The u-version of a module is a detail that can be learned later on, when the user wants to understand more and have finer control over importing. Existing Python code should just work, as much as it is possible to do that within the constraints of embedded systems, and the MicroPython documentation should match the idiomatic way to write Python code. With universal weak links for modules (via MICROPY_MODULE_WEAK_LINKS) users can consistently use "import foo" across all ports (with the exception of the minimal ports). And the ability to override/extend via "foo.py" continues to work well. Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
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-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-05-04docs/pyboard: Fix typo in pyb.Switch tutorial.Gabriel M Schuyler
2020-01-06docs: More consistent capitalization and use of articles in headings.Jason Neal
See issue #3188.
2019-12-04docs: Remove spaces on lines that are empty.Damien George
2019-10-16docs: Fix spelling in various parts of the docs.Mike Causer
2019-08-15docs/pyboard: Emphasize the instructions for making a USB mouse.Vicki Lowe
It wasn't clear why that element was `10` instead of `0`. Also bumped the `10` to `100` to make the mouse movement more obvious.
2019-08-15docs/pyboard: Clarify initial files on pyboard and fix up formatting.Vicki Lowe
2019-08-15docs/pyboard: Update name of mounted volume to match code.Vicki Lowe
2019-05-20docs/pyboard/quickref: Refer to new machine.I2C instead of old pyb.I2C.Damien George
On stm32 boards, machine.I2C is now preferred over pyb.I2C.
2019-03-13docs/pyboard: Make pyboard v1.1 pinout the default shown in quickref.johnthagen
2019-03-13docs/pyboard: Add link to pyboard v1.1 schematic and layout PDF.johnthagen
2019-02-12all: Change PYB message prefix to MPY.Mike Causer
Replaces "PYB: soft reboot" with "MPY: soft reboot", etc. Having a consistent prefix across ports reduces the difference between ports, which is a general goal. And this change won't break pyboard.py because that tool only looks for "soft reboot".
2018-10-01docs: Unify all the ports into one set of documentation.Damien George
With this commit there is now only one entry point into the whole documentation, which describes the general MicroPython language, and then from there there are links to information about specific platforms/ports. This commit doesn't change content (almost, it does fix a few internal links), it just reorganises things.
2018-09-20docs/pyboard: Fix to use Sphinx style for internal/external links.Damien George
2018-07-10docs/pyboard: For latex build, use smaller quickref jpg, and no gifs.Damien George
The latexpdf target needs images that fit on the page, and does not support gifs.
2017-10-10docs/pyboard/tutorial: Update now that yellow LED also supports PWM.Mike Causer
2017-10-10docs/pyboard/quickref: Add info for Switch, RTC, CAN, Accel classes.Mike Causer
2017-08-23docs/pyboard/tutorial: Add "timeout=0" to UART in pass-through example.Damien George
Without this the pass-through will pause for 1 second at each character.
2017-07-21docs/pyboard/tutorial/amp_skin: Add example for playing large WAV files.Piotr MaliƄski
2017-07-03docs/pyboard: Move info about using Windows from topindex to general.Damien George
2017-07-02docs/pyboard: Move hardware info into General Info chapter.Paul Sokolovsky
This makes top-level ToC of the pyboard docs consistent with other ports (consisting of 3 chapters: QuickRef, General Info, and Tutorial). Also, some other minor tweaks applied, like local ToC for General Info and headings mentioning pyboard.
2017-06-15stmhal: Add .value() method to Switch object, to mirror Pin and Signal.Damien George
2017-06-03docs/uos: Deconditionalize, remove minor port-specific details.Paul Sokolovsky
For a couple of ports, there was information which directory is set as current after boot. This information doesn't belong to "uos" module, and is moved to boards' references (which actually already contained information on which directory is chosen for boot, even if without explicit mentioning that it becomes current directory, which is now done).
2017-02-07stmhal: Add ability to skip booting from SD card via /flash/SKIPSD file.Damien George
2017-02-03docs: For LCD160CR driver and tutorial, add link to positioning image.Damien George
2017-01-30docs/pyboard/tutorial/lcd160cr_skin: Fix typo, get_touched->get_touch.Damien George
2017-01-23docs/pyboard/tutorial: Add tutorial for LCD160CR.Damien George
2017-01-23docs: Add documentation for lcd160cr module.Damien George
2017-01-18docs: Fix some minor spelling mistakes.Mike Causer
paramter -> parameter send a receive -> send and receive repsonse -> response particualr -> particular constructore -> constructor
2016-11-08docs/*/quickref.rst: Use new semantics of ticks_diff()puuu
2016-08-29docs/pyboard/quickref: Add section on "delay and timing" for utime mod.Damien George
And remove reference to deprecated pyb.delay() and pyb.millis().
2016-08-29docs/pyboard/quickref: Add links to pinouts for other pyboard variants.Damien George
2016-08-29docs/pyboard: Update USB mouse tutorial to use pyb.USB_HID().Philip Potter
2016-08-29docs/pyboard: Update USB mouse tutorial to use VCP instead of CDC.Philip Potter
2016-08-02docs: Spelling mistakesMike Causer
2016-03-17docs: Update asm tutorial, maximum number of allowed args is now 4.Peter Hinch
2016-01-04docs: Add link from pyboard switch tutorial to ISR rules document.Damien George
2015-06-26docs: Add link from pyboard asm tutorial to asm reference.Damien George
2015-06-25docs: Add reference for Thumb2 inline assembler.Damien George
Thanks to Peter Hinch for contributing this.