135 Commits

Author	SHA1	Message	Date
Jos Verlinde	e39243c382	docs/reference/mpremote: Document the 'fs tree' command. ... Signed-off-by: Jos Verlinde <Jos_Verlinde@hotmail.com>	2025-05-18 00:20:46 +10:00
Jos Verlinde	ef8282c717	docs/reference/mpremote: Update docs for mpremote rm -r. ... Signed-off-by: Jos Verlinde <Jos_Verlinde@hotmail.com>	2025-04-09 10:51:48 +10:00
Damien George	0c98c60b68	tools/mpremote: Add romfs query, build and deploy commands. ... These commands use the `vfs.rom_ioctl()` function to manage the ROM partitions on a device, and create and deploy ROMFS images. Signed-off-by: Damien George <damien@micropython.org>	2025-03-06 12:52:35 +11:00
Ronald Weber	3f0dd13d93	docs: Fix double 'the' in documentation. ... Signed-off-by: Ronald Weber <ronaldxweber@gmail.com>	2025-02-25 17:07:16 +11:00
Christian Clauss	5e206fdeb5	all: Upgrade codespell to v2.4.1. ... This commit upgrades from codespell==2.2.6 to the current codespell==2.4.1, adding emac to the ignore-words-list. Signed-off-by: Christian Clauss <cclauss@me.com>	2025-02-25 16:11:33 +11:00
Glenn Moloney	2992e34956	tools/mpremote: Add support for relative urls in package.json files. ... URLs in `package.json` may now be specified relative to the base URL of the `package.json` file. Relative URLs wil work for `package.json` files installed from the web as well as local file paths. Docs: update `docs/reference/packages.rst` to add documentation for: - Installing packages from local filesystems (PR #12476); and - Using relative URLs in the `package.json` file (PR #12477); - Update the packaging example to encourage relative URLs as the default in `package.json`. Add `tools/mpremote/tests/test_mip_local_install.sh` to test the installation of a package from local files using relative URLs in the `package.json`. Signed-off-by: Glenn Moloney <glenn.moloney@gmail.com>	2025-02-24 13:29:40 +11:00
Angus Gratton	0a55f1f40c	docs/reference: Add strings vs bytes to speed optimisation tips. ... Also add some additional context links, suggestions for alternative classes, etc. This work was funded through GitHub Sponsors. Signed-off-by: Angus Gratton <angus@redyak.com.au>	2025-02-11 16:17:00 +11:00
peterhinch	624bd48d2f	docs/reference/isr_rules: Describe issue with hard ISRs and globals. ... Signed-off-by: Damien George <damien@micropython.org>	2025-01-16 16:44:00 +11:00
chuangjinglu	2e796d6c3e	docs,ports: Fix some comments and error messages with doubled-up words. ... Signed-off-by: chuangjinglu <chuangjinglu@outlook.com>	2024-11-30 13:08:33 +11:00
Angus Gratton	a23277e3b0	docs/esp32: Add a factory reset page. ... This work was funded through GitHub Sponsors. Signed-off-by: Angus Gratton <angus@redyak.com.au>	2024-11-19 10:57:53 +11:00
Angus Gratton	9361a9f50a	docs/rp2: Add a small factory reset page. ... This work was funded through GitHub Sponsors. Signed-off-by: Angus Gratton <angus@redyak.com.au>	2024-11-19 10:57:47 +11:00
Angus Gratton	0e7c3901b8	docs: Add a "Reset and Boot Sequence" reference page. ... 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-11-19 10:57:26 +11:00
Angus Gratton	48f96e9660	docs: Specify the recommended network.WLAN.IF_[AP|STA] constants. ... Removes the deprecated network.[AP|STA]_IF form from the docs. This work was funded through GitHub Sponsors. Signed-off-by: Angus Gratton <angus@redyak.com.au>	2024-11-08 10:11:03 +11:00
Jan Klusáček	0e490b7c8f	docs/reference/packages: Fix description of --target option in mip. ... Descripton of mip usage with micropython port suggest using it like this: ./micropython -m mip install --target=third-party pkgname But it should be called without equal sign: ./micropython -m mip install --target third-party pkgname Signed-off-by: honza.klu@gmail.com	2024-10-31 23:23:58 +11:00
Damien George	e5eeaa7df8	docs/reference/mpremote: Update docs to mention new features. ... Signed-off-by: Damien George <damien@micropython.org>	2024-10-09 16:39:06 +11:00
Damien George	3d53b39a2a	docs/reference: Fix pyboard.py filesystem cp example with three files. ... Fix documentation to match behaviour (directories are not preserved). Fixes issue #11101. Signed-off-by: Damien George <damien@micropython.org>	2024-09-17 11:20:17 +10:00
Felix Dörre	4d16a9cced	docs: Update docs to replace ifconfig with ipconfig. ... Follow up to 1c6012b0b5 Signed-off-by: Felix Dörre <felix@dogcraft.de>	2024-07-05 16:06:04 +10:00
Alessandro Gatti	99f5659cf5	mpy-cross: Add RISC-V RV32IMC support in MPY files. ... MPY files can now hold generated RV32IMC native code. This can be accomplished by passing the `-march=rv32imc` flag to mpy-cross. Signed-off-by: Alessandro Gatti <a.gatti@frob.it>	2024-06-21 15:06:29 +10:00
Olivier Lenoir	e816b49c44	docs/reference: Document how to mip install packages from GitLab. ... Signed-off-by: Olivier Lenoir <olivier.len02@gmail.com>	2024-05-15 13:35:27 +10:00
Damien George	628a37e6cf	docs/reference/mpyfiles: Document change in .mpy sub-version. ... Signed-off-by: Damien George <damien@micropython.org>	2024-03-28 16:21:35 +11:00
Damien George	35dd959133	tools/manifestfile.py: Change library search to use a list of paths. ... This commit changes how library packages are searched for when a manifest file is loaded: there is now simply a list of library paths that is searched in order for the given package. This list defaults to the main directories in micropython-lib, but can be added to -- either appended or prepended -- by using `add_library()`. In particular the way unix-ffi library packages are searched has changed, because the `unix_ffi` argument to `require()` is now removed. Instead, if a build wants to include packages from micropython-lib/unix-ffi, then it must explicitly add this to the list of paths to search using: add_library("unix-ffi", "$(MPY_LIB_DIR)/unix-ffi") Work done in collaboration with Jim Mussared. Signed-off-by: Damien George <damien@micropython.org>	2024-02-08 17:16:10 +11:00
Damien George	4c56b39051	docs: Use vfs module instead of os. ... Signed-off-by: Damien George <damien@micropython.org>	2024-02-07 13:25:10 +11:00
Damien George	5804aa0204	docs/reference/micropython2_migration.rst: Add info about os and vfs. ... Signed-off-by: Damien George <damien@micropython.org>	2024-02-07 13:25:09 +11:00
Damien George	45f99cb445	docs/library: Move vfs functions and classes from os to vfs module docs. ... Signed-off-by: Damien George <damien@micropython.org>	2024-02-07 13:25:09 +11:00
Damien George	ee226a8b43	all: Fix "reuse" and "overridden" spelling mistakes. ... Codespell doesn't pick up "re-used" or "re-uses", and ignores the tests/ directory, so fix these manually. Signed-off-by: Damien George <damien@micropython.org>	2024-01-05 15:08:33 +11:00
Jim Mussared	6cd99910cd	docs/reference/micropython2_migration: Add migration guide. ... This is just scaffolding for now, but the idea is that there should be an addition to this file for every commit that uses the `MICROPY_PREVIEW_VERSION_2` macro. This work was funded through GitHub Sponsors. Signed-off-by: Jim Mussared <jim.mussared@gmail.com>	2023-10-27 15:28:46 +11:00
Damien George	a1be5e1439	docs/reference/mpyfiles: Document change in .mpy sub-version. ... Signed-off-by: Damien George <damien@micropython.org>	2023-10-16 11:28:32 +11:00
Damien George	cf490a7091	all: Fix various spelling mistakes found by codespell 2.2.6. ... Signed-off-by: Damien George <damien@micropython.org>	2023-10-03 11:24:50 +11:00
Jos Verlinde	58c2c503a9	tools/mpremote: Add support for rfc2217, serial over TCP. ... Signed-off-by: Jos Verlinde <jos_verlinde@hotmail.com>	2023-09-29 14:40:17 +10:00
Jim Mussared	9092909bf5	docs: Rename uasyncio to asyncio. ... This work was funded through GitHub Sponsors. Signed-off-by: Jim Mussared <jim.mussared@gmail.com>	2023-06-19 18:36:54 +10:00
Jim Mussared	bd5d0163c4	docs/reference/mpremote.rst: Extend the mpremote guide. ... Changes in this commit: - Add a extra detail to each of the commands. - Add more about handling options and arguments. - Include shortcut commands that behave like real commands to the command list (e.g. bootloader, rtc). - Add extra information and reword to address common misconceptions, in particular how commands chain together. - Add additional examples showing some more interesting combinations. - Add descriptions to each of the examples. - Add pipx installation instructions. - Describe how user-configuration works. This work was sponsored by Google Season of Docs. Signed-off-by: Jim Mussared <jim.mussared@gmail.com>	2023-06-02 16:16:28 +10:00
Jonas Scharpf	7a17596e1a	docs/reference/packages: Add GitHub repo to package example dependency. ... Signed-off-by: Jonas Scharpf <jonas@brainelectronics.de>	2023-06-02 11:25:55 +10:00
Jim Mussared	0000eb2724	docs/reference/speed_python: Remove 4-arg limit for viper. ... This limit was removed in a676b5acf6. Signed-off-by: Jim Mussared <jim.mussared@gmail.com>	2023-05-23 17:40:17 +10:00
Damien George	2771b20d29	tools/mpremote: Add repl option to escape non-printable characters. ... This commit adds the "--escape-non-printable" option to the repl command. When specified the REPL console will escape non-printable characters, printing them as their hex value in square brackets. This escaping behaviour was previously the default and only behaviour, but it is now opt-in. As part of this change, the speed of echoing device data to the console is improved by by reading and writing in chunks. Signed-off-by: Damien George <damien@micropython.org>	2023-05-22 14:13:24 +10:00
David Lechner	3e64d76122	docs/reference/mpyfiles: Add release info on v6.1. ... This documents when MPY v6.1 was released. Also add some clarification on how the version is encoded in the header. Signed-off-by: David Lechner <david@pybricks.com>	2023-05-11 14:30:34 +10:00
algonell	a39e2827b7	docs/reference: Remove double 'are' in glossary.	2023-05-01 11:50:53 +10:00
Damien George	b1229efbd1	all: Fix spelling mistakes based on codespell check. ... Signed-off-by: Damien George <damien@micropython.org>	2023-04-27 18:03:06 +10:00
Chris Overgaauw	23ef29706e	docs/reference/constrained: Add missing heap-dump symbols to mem_info().	2023-01-19 15:59:29 +11:00
Jim Mussared	3ecbaf1e06	docs/library/neopixel: Update GitHub URL for neopixel.py link. ... Signed-off-by: Jim Mussared <jim.mussared@gmail.com>	2022-12-07 13:36:20 +11:00
Michael Mogenson	921f397acb	tools/mpremote: Only auto connect to serial device with USB VID/PID. ... On MacOS and Windows there are a few default serial devices that are returned by `serial.tools.list_ports.comports()`. For example on MacOS: ``` {'description': 'n/a', 'device': '/dev/cu.Bluetooth-Incoming-Port', 'hwid': 'n/a', 'interface': None, 'location': None, 'manufacturer': None, 'name': 'cu.Bluetooth-Incoming-Port', 'pid': None, 'product': None, 'serial_number': None, 'vid': None} {'description': 'n/a', 'device': '/dev/cu.wlan-debug', 'hwid': 'n/a', 'interface': None, 'location': None, 'manufacturer': None, 'name': 'cu.wlan-debug', 'pid': None, 'product': None, 'serial_number': None, 'vid': None} ``` Users of mpremote most likely do not want to connect to these ports. It would be desirable if mpremote did not select this ports when using the auto connect behavior. These serial ports do not have USB VID or PID values and serial ports for Micropython boards with FTDI/serial-to-USB adapter or native USB CDC/ACM support do. Check for the presence of a USB VID / PID int value when selecting a serial port to auto connect to. All serial ports will still be listed by the `list` command and can still be selected by name when connecting. Signed-off-by: Michael Mogenson <michael.mogenson@gmail.com>	2022-11-25 17:20:14 -05:00
Jim Mussared	12ca918eb2	tools/mpremote: Add mpremote mip install to install packages. ... This supports the same package sources as the new `mip` tool. - micropython-lib (by name) - http(s) & github packages with json description - directly downloading a .py/.mpy file The version is specified with an optional `@version` on the end of the package name. The target dir, index, and mpy/no-mpy can be set through command line args. This work was funded through GitHub Sponsors. Signed-off-by: Jim Mussared <jim.mussared@gmail.com>	2022-10-01 22:44:24 +10:00
Jim Mussared	924a3e03ec	top: Replace upip with mip everywhere. ... 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-30 17:34:03 +10:00
Jim Mussared	d94141e147	py/persistentcode: Introduce .mpy sub-version. ... The intent is to allow us to make breaking changes to the native ABI (e.g. changes to dynruntime.h) without needing the bytecode version to increment. With this commit the two bits previously used for the feature flags (but now unused as of .mpy version 6) encode a sub-version. A bytecode-only .mpy file can be loaded as long as MPY_VERSION matches, but a native .mpy (i.e. one with an arch set) must also match MPY_SUB_VERSION. This allows 3 additional updates to the native ABI per bytecode revision. The sub-version is set to 1 because the previous commits that changed the layout of mp_obj_type_t have changed the native ABI. Signed-off-by: Jim Mussared <jim.mussared@gmail.com> Signed-off-by: Damien George <damien@micropython.org>	2022-09-19 23:19:55 +10:00
Damien George	655c29351a	drivers/display: Don't include tests by default. ... 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>	2022-09-06 12:09:20 +10:00
Damien George	2e386bcf76	tools/mpremote: Print nicer errors for unsupported 'cp -r' arguments. ... Also document support for 'cp :a :b'. Signed-off-by: Damien George <damien@micropython.org>	2022-08-26 13:30:03 +10:00
Jim Mussared	59e3348c10	tools/mpremote: Add "edit" command. ... This allows a remote file to be edited locally by copying it over, running the local editor, then copying it back. Signed-off-by: Jim Mussared <jim.mussared@gmail.com>	2022-08-18 22:29:13 +10:00
Jim Mussared	263737ecfe	tools/pyboard.py: Add "touch" filesystem command. ... Signed-off-by: Jim Mussared <jim.mussared@gmail.com>	2022-08-18 22:24:25 +10:00
Jim Mussared	a311e9e3d4	tools/mpremote: Allow + terminator for fs commands. ... Signed-off-by: Jim Mussared <jim.mussared@gmail.com>	2022-08-18 22:22:36 +10:00
Damien George	cf7d962cf3	docs/reference/mpyfiles: Update .mpy description to match latest format. ... Signed-off-by: Damien George <damien@micropython.org>	2022-06-10 16:42:43 +10:00
Andrew Leech	ea9a904b72	docs/reference/manifest: Add link to details about opt-level for freeze.	2022-05-27 14:45:46 +10:00