summaryrefslogtreecommitdiffstatshomepage
path: root/docs/reference
Commit message (Collapse)AuthorAge
* docs/reference/mpremote: Update docs for mpremote rm -r.Jos Verlinde2025-04-09
| | | | Signed-off-by: Jos Verlinde <Jos_Verlinde@hotmail.com>
* tools/mpremote: Add romfs query, build and deploy commands.Damien George2025-03-06
| | | | | | | 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>
* docs: Fix double 'the' in documentation.Ronald Weber2025-02-25
| | | | Signed-off-by: Ronald Weber <ronaldxweber@gmail.com>
* all: Upgrade codespell to v2.4.1.Christian Clauss2025-02-25
| | | | | | | 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>
* tools/mpremote: Add support for relative urls in package.json files.Glenn Moloney2025-02-24
| | | | | | | | | | | | | | | | | | | | | 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>
* docs/reference: Add strings vs bytes to speed optimisation tips.Angus Gratton2025-02-11
| | | | | | | | | 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>
* docs/reference/isr_rules: Describe issue with hard ISRs and globals.peterhinch2025-01-16
| | | | Signed-off-by: Damien George <damien@micropython.org>
* docs,ports: Fix some comments and error messages with doubled-up words.chuangjinglu2024-11-30
| | | | Signed-off-by: chuangjinglu <chuangjinglu@outlook.com>
* docs/esp32: Add a factory reset page.Angus Gratton2024-11-19
| | | | | | This work was funded through GitHub Sponsors. Signed-off-by: Angus Gratton <angus@redyak.com.au>
* docs/rp2: Add a small factory reset page.Angus Gratton2024-11-19
| | | | | | This work was funded through GitHub Sponsors. Signed-off-by: Angus Gratton <angus@redyak.com.au>
* docs: Add a "Reset and Boot Sequence" reference page.Angus Gratton2024-11-19
| | | | | | | | | | | | 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>
* docs: Specify the recommended network.WLAN.IF_[AP|STA] constants.Angus Gratton2024-11-08
| | | | | | | | 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>
* docs/reference/packages: Fix description of --target option in mip.Jan Klusáček2024-10-31
| | | | | | | | | | | | 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
* docs/reference/mpremote: Update docs to mention new features.Damien George2024-10-09
| | | | Signed-off-by: Damien George <damien@micropython.org>
* docs/reference: Fix pyboard.py filesystem cp example with three files.Damien George2024-09-17
| | | | | | | | Fix documentation to match behaviour (directories are not preserved). Fixes issue #11101. Signed-off-by: Damien George <damien@micropython.org>
* docs: Update docs to replace ifconfig with ipconfig.Felix Dörre2024-07-05
| | | | | | Follow up to 1c6012b0b5c62f18130217f30e73ad3ce4c8c9e6 Signed-off-by: Felix Dörre <felix@dogcraft.de>
* mpy-cross: Add RISC-V RV32IMC support in MPY files.Alessandro Gatti2024-06-21
| | | | | | | 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>
* docs/reference: Document how to mip install packages from GitLab.Olivier Lenoir2024-05-15
| | | | Signed-off-by: Olivier Lenoir <olivier.len02@gmail.com>
* docs/reference/mpyfiles: Document change in .mpy sub-version.Damien George2024-03-28
| | | | Signed-off-by: Damien George <damien@micropython.org>
* tools/manifestfile.py: Change library search to use a list of paths.Damien George2024-02-08
| | | | | | | | | | | | | | | | | | | 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>
* docs: Use vfs module instead of os.Damien George2024-02-07
| | | | Signed-off-by: Damien George <damien@micropython.org>
* docs/reference/micropython2_migration.rst: Add info about os and vfs.Damien George2024-02-07
| | | | Signed-off-by: Damien George <damien@micropython.org>
* docs/library: Move vfs functions and classes from os to vfs module docs.Damien George2024-02-07
| | | | Signed-off-by: Damien George <damien@micropython.org>
* all: Fix "reuse" and "overridden" spelling mistakes.Damien George2024-01-05
| | | | | | | 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>
* docs/reference/micropython2_migration: Add migration guide.Jim Mussared2023-10-27
| | | | | | | | | | 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>
* docs/reference/mpyfiles: Document change in .mpy sub-version.Damien George2023-10-16
| | | | Signed-off-by: Damien George <damien@micropython.org>
* all: Fix various spelling mistakes found by codespell 2.2.6.Damien George2023-10-03
| | | | Signed-off-by: Damien George <damien@micropython.org>
* tools/mpremote: Add support for rfc2217, serial over TCP.Jos Verlinde2023-09-29
| | | | Signed-off-by: Jos Verlinde <jos_verlinde@hotmail.com>
* docs: Rename uasyncio to asyncio.Jim Mussared2023-06-19
| | | | | | This work was funded through GitHub Sponsors. Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
* docs/reference/mpremote.rst: Extend the mpremote guide.Jim Mussared2023-06-02
| | | | | | | | | | | | | | | | | | 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>
* docs/reference/packages: Add GitHub repo to package example dependency.Jonas Scharpf2023-06-02
| | | | Signed-off-by: Jonas Scharpf <jonas@brainelectronics.de>
* docs/reference/speed_python: Remove 4-arg limit for viper.Jim Mussared2023-05-23
| | | | | | This limit was removed in a676b5acf6ee9c17926cf9786370d30a077d99c0. Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
* tools/mpremote: Add repl option to escape non-printable characters.Damien George2023-05-22
| | | | | | | | | | | | | | 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>
* docs/reference/mpyfiles: Add release info on v6.1.David Lechner2023-05-11
| | | | | | | | 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>
* docs/reference: Remove double 'are' in glossary.algonell2023-05-01
|
* all: Fix spelling mistakes based on codespell check.Damien George2023-04-27
| | | | Signed-off-by: Damien George <damien@micropython.org>
* docs/reference/constrained: Add missing heap-dump symbols to mem_info().Chris Overgaauw2023-01-19
|
* docs/library/neopixel: Update GitHub URL for neopixel.py link.Jim Mussared2022-12-07
| | | | Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
* tools/mpremote: Only auto connect to serial device with USB VID/PID.Michael Mogenson2022-11-25
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* tools/mpremote: Add `mpremote mip install` to install packages.Jim Mussared2022-10-01
| | | | | | | | | | | | | | | 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>
* top: Replace upip with mip everywhere.Jim Mussared2022-09-30
| | | | | | | | | | 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>
* py/persistentcode: Introduce .mpy sub-version.Jim Mussared2022-09-19
| | | | | | | | | | | | | | | | | 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>
* drivers/display: Don't include tests by default.Damien George2022-09-06
| | | | | | | | 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>
* tools/mpremote: Print nicer errors for unsupported 'cp -r' arguments.Damien George2022-08-26
| | | | | | Also document support for 'cp :a :b'. Signed-off-by: Damien George <damien@micropython.org>
* tools/mpremote: Add "edit" command.Jim Mussared2022-08-18
| | | | | | | 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>
* tools/pyboard.py: Add "touch" filesystem command.Jim Mussared2022-08-18
| | | | Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
* tools/mpremote: Allow + terminator for fs commands.Jim Mussared2022-08-18
| | | | Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
* docs/reference/mpyfiles: Update .mpy description to match latest format.Damien George2022-06-10
| | | | Signed-off-by: Damien George <damien@micropython.org>
* docs/reference/manifest: Add link to details about opt-level for freeze.Andrew Leech2022-05-27
|
* py/parse: Allow all constant objects to be used in "X = const(o)".Damien George2022-05-18
| | | | | | | | | | | | | | | | | | | | | | | | | | | Now that constant tuples are supported in the parser, eg (1, True, "str"), it's a small step to allow anything that is a constant to be used with the pattern: from micropython import const X = const(obj) This commit makes the required changes to allow the following types of constants: from micropython import const _INT = const(123) _FLOAT = const(1.2) _COMPLEX = const(3.4j) _STR = const("str") _BYTES = const(b"bytes") _TUPLE = const((_INT, _STR, _BYTES)) _TUPLE2 = const((None, False, True, ..., (), _TUPLE)) Prior to this, only integers could be used in const(...). Signed-off-by: Damien George <damien@micropython.org>
generated by cgit v1.2.3 (git 2.39.1) at 2025-05-04 21:58:23 +0000