1363 Commits

Author	SHA1	Message	Date
robert-hh	48925fd793	docs/library/machine.Pin: Show availability of low, high and toggle. ... Signed-off-by: robert-hh <robert@hammelrath.com>	2025-02-28 16:51:54 +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
Keenan Johnson	321b30ca56	extmod/modtls_mbedtls: Wire in support for DTLS. ... This commit enables support for DTLS, i.e. TLS over datagram transport protocols like UDP. While support for DTLS is absent in CPython, it is worth supporting it in MicroPython because it is the basis of the ubiquitous CoAP protocol, used in many IoT projects. To select DTLS, a new set of "protocols" are added to SSLContext: - ssl.PROTOCOL_DTLS_CLIENT - ssl.PROTOCOL_DTLS_SERVER If one of these is set, the library assumes that the underlying socket is a datagram-like socket (i.e. UDP or similar). Our own timer callbacks are implemented because the out of the box implementation relies on `gettimeofday()`. This new DTLS feature is enabled on all ports that use mbedTLS. This commit is an update to a previous PR #10062. Addresses issue #5270 which requested DTLS support. Signed-off-by: Keenan Johnson <keenan.johnson@gmail.com>	2025-02-14 12:55:25 +11:00
Damien George	e40a3fdb81	docs/library/marshal: Document the marshal module. ... Signed-off-by: Damien George <damien@micropython.org>	2025-02-11 16:59:11 +11:00
Alessandro Gatti	3b62524661	docs/library/espnow: Clarify usage of the "rate" configuration key. ... This commit adds a clarification for the ESPNow module's documentation regarding its "config" method. The original documentation for that method could be interpreted as having all its configuration keys being able to be queried, but the "rate" configuration key is actually write-only due to ESP-IDF's lack of a way to retrieve that bit of information from the radio's configuration. The documentation changes highlight the fact that said configuration key is actually write-only. Signed-off-by: Alessandro Gatti <a.gatti@frob.it>	2025-02-11 16:23:35 +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
Angus Gratton	bab099826e	docs: Note which ports have default or optional network.PPP support. ... Also add the default values of these macros to the respective `mpconfigport.h` files, to improve discoverability. Signed-off-by: Angus Gratton <angus@redyak.com.au>	2025-02-11 16:11:33 +11:00
Angus Gratton	12dd9cb745	docs/esp32: Add documentation for SPI Ethernet devices on esp32 port. ... Also cross-link with the other WIZNET5K driver, to avoid confusion. This work was funded through GitHub Sponsors. Signed-off-by: Angus Gratton <angus@redyak.com.au>	2025-02-11 12:56:42 +11:00
Markus Gyger	0662c55121	rp2/rp2_pio: Add side_pindir support for PIO. ... Side-setting can also be used to change pin directions instead of pin values. This adds a parameter `side_pindir` to decorator `asm_pio()` to configure it. Also replaces a few close-by 0s with corresponding PIO.* constants. Addresses issue #10027. Signed-off-by: Markus Gyger <markus@gyger.org>	2025-02-08 12:34:26 +11:00
robert-hh	e44a2c6921	docs/samd/pinout: Add pinout for the Generic SAMD board types. ... The table shows the devices available at the pin and the respective package letter. Signed-off-by: robert-hh <robert@hammelrath.com>	2025-02-07 18:02:52 +11:00
robert-hh	a84143d223	docs/samd/pinout: Add pinout for Adafruit NeoKey Trinkey and QT Py. ... Only pins accessible at the board are shown. Signed-off-by: robert-hh <robert@hammelrath.com>	2025-02-07 18:02:52 +11:00
Damien George	1100aa63c9	LICENSE,docs: Update copyright year range to include 2025. ... Signed-off-by: Damien George <damien@micropython.org>	2025-01-22 18:25:20 +11:00
Angus Gratton	84e0aca0fb	docs/esp32: Defer to the download page for flashing steps. ... The user already has it open, and its customised for their particular board. This work was funded through GitHub Sponsors. Signed-off-by: Angus Gratton <angus@redyak.com.au>	2025-01-17 16:54:00 +11:00
Angus Gratton	600e46800d	docs/esp32: Update tutorial flashing steps to match deploy.md. ... Includes fixing the flashing address for newer SoCs, as reported in discussion https://github.com/orgs/micropython/discussions/16417 Also removes some redundant or out of date information, and adds links to the Espressif esptool docs which are quite comprehensive. Information about ESP32_GENERIC variants is moved to the board page, as it only applies to that board. This work was funded through GitHub Sponsors. Signed-off-by: Angus Gratton <angus@redyak.com.au>	2025-01-17 16:03:45 +11:00
Angus Gratton	e8d3df51dc	stm32/pyb_can: Make pyb.CAN baud calculation a little more forgiving. ... Not every baudrate or sample point combination has an exact match, but getting within 1% on sample point and .1% on baud rate should always be good enough. Because the search goes from shorter bit periods (lowest brp) and increases, the first match which meets this criteria should still mostly be the best available. This work was funded through GitHub Sponsors. Signed-off-by: Angus Gratton <angus@redyak.com.au>	2025-01-17 12:13:17 +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
Alessandro Gatti	6760e00817	tools/mpy_ld.py: Add native modules support for RV32 code. ... This commit adds support for RV32IMC native modules, as in embedding native code into a self-contained MPY module and and make its exported functions available to the MicroPython environment. Signed-off-by: Alessandro Gatti <a.gatti@frob.it>	2024-12-23 10:02:20 +11:00
Angus Gratton	4e76acc88d	doc: Note that machine.USBDevice is now available on esp32 port. ... Support was added in commit 5f2d05d, this updates the docs to match. This work was funded through GitHub Sponsors. Signed-off-by: Angus Gratton <angus@redyak.com.au>	2024-12-20 14:02:17 +11:00
robert-hh	f4e4599523	ports: Fix machine.RTC.init() method so argument order matches the docs. ... This commit makes the argument ordering of `machine.RTC.init()` the same for all the ports that implement arguments to this method: cc3200, esp32, mimxrt and samd. The cc3200 argument ordering is used, which matches the documentation. Also document the availability and the differing semantics for the stm32 and renesas-ra port. Signed-off-by: robert-hh <robert@hammelrath.com>	2024-12-19 16:04:47 +11:00
robert-hh	0302cd65e8	mimxrt/machine_rtc: Drop machine.RTC.now() method. ... This is not part of the common machine API. It's dropped on the mimxrt port and kept only on the cc3200 port for legacy. Also show the port availability of `RTC.now()` in the documentation. Signed-off-by: robert-hh <robert@hammelrath.com>	2024-12-19 16:00:41 +11:00
robert-hh	b5de529ffc	docs: Fix the quickref documentation of rtc.datetime(). ... Such that it matches the implementation and the documentation of the `machine.RTC` class. Signed-off-by: robert-hh <robert@hammelrath.com>	2024-12-19 16:00:15 +11:00
Alessandro Gatti	e8c3f31ba2	mimxrt/machine_rtc: Deprecate RTC.cancel in MicroPython v2. ... The current documentation for the `machine.RTC` class contains information about the `RTC.cancel` method for cancelling pending alarms. However only two ports (cc3200 and mimxrt) implement this functionality but under a different name: `RTC.alarm_cancel`. The mimxrt port also implements `RTC.cancel` but it is aliased to `RTC.alarm_cancel` anyway. To maintain naming consistency, this commit updates the documentation to officially define `RTC.alarm_cancel` as the method to call to cancel pending alarms and deprecates mimxrt's `RTC.cancel` implementation. `RTC.cancel` in the mimxrt port is thus scheduled for removal in MicroPython v2. Signed-off-by: Alessandro Gatti <a.gatti@frob.it>	2024-12-10 12:16:03 +11:00
Amirreza Hamzavi	406bccc753	docs/library/binascii: Add docs for binascii.crc32 method. ... Signed-off-by: Amirreza Hamzavi <amirrezahamzavi2000@gmail.com>	2024-12-03 22:22:55 +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	154d141965	docs,esp32: Update machine.TouchPad docs for ESP32-S2 and ESP32-S3. ... Signed-off-by: Angus Gratton <angus@redyak.com.au>	2024-11-28 15:45:39 +11:00
Angus Gratton	7647c828de	tests/multi_espnow: Add channel setting test, add some docs. ... Test currently passes. It was added so it can be used to check for regressions when fixing channel selection for AP mode in a follow-up commit. Also add some docs about how channel setting is observed to work for ESP-NOW. This work was funded through GitHub Sponsors. Signed-off-by: Angus Gratton <angus@redyak.com.au>	2024-11-28 15:39:06 +11:00
Damien George	c1b8e65c8e	docs: Change copyright line to mention "authors and contributors". ... The docs have been authored by many people now. Instead of singling out individuals in the copyright line, prefer to mention all "MicroPython authors and contributors". Individual contributions can still be discovered via the git history. Signed-off-by: Damien George <damien@micropython.org>	2024-11-19 11:39:39 +11:00
Angus Gratton	c5d74fe468	docs/library: Note link between machine.soft_reset() and sys.exit(). ... This is currently an implementation detail of MicroPython rather than by design. This work was funded through GitHub Sponsors. Signed-off-by: Angus Gratton <angus@redyak.com.au>	2024-11-19 10:58:00 +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
robert-hh	898407defb	ports: Make PWM duty_u16 have an upper value of 65535 across all ports. ... The following ports used 65536 as the upper value (100% duty cycle) and are changed in this commit to use 65535: esp8266, mimxrt, nrf, samd. Tested that output is high at `duty_u16(65535)` and low at `duty_u16(0)`. Also verified that at `duty_u16(32768)` the high and low pulse have the same length. Partially reverts #10850, commits 9c7ad68165 and 2ac643c15b. Signed-off-by: robert-hh <robert@hammelrath.com>	2024-11-18 16:05:56 +11:00
Daniël van de Giessen	161e2bd37d	extmod/network_ppp: Add stream config parameter. ... This makes the stream that the PPP object wraps, which is normally only set once via the constructor, accessible and configurable via the `ppp.config()` method. Signed-off-by: Daniël van de Giessen <daniel@dvdgiessen.nl>	2024-11-13 13:10:58 +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
Damien George	8978102f35	tests/run-tests.py: Change --target/--device options to --test-instance. ... Previously to this commit, running the test suite on a bare-metal board required specifying the target (really platform) and device, eg: $ ./run-tests.py --target pyboard --device /dev/ttyACM1 That's quite a lot to type, and you also need to know what the target platform is, when a lot of the time you either don't care or it doesn't matter. This commit makes it easier to run the tests by replacing both of these options with a single `--test-instance` (`-t` for short) option. That option specifies the executable/port/device to test. Then the target platform is automatically detected. The `--test-instance` can be passed: - "unix" (the default) to use the unix version of MicroPython - "webassembly" to test the webassembly port - anything else is considered a port/device to pass to Pyboard There are also some shortcuts to specify a port/device, following `mpremote`: - a<n> is short for /dev/ttyACM<n> - u<n> is short for /dev/ttyUSB<n> - c<n> is short for COM<n> For example: $ ./run-tests.py -t a1 Note that the default test instance is "unix" and so this commit does not change the standard way to run tests on the unix port, by just doing `./run-tests.py`. As part of this change, the platform (and it's native architecture if it supports importing native .mpy files) is show at the start of the test run. Signed-off-by: Damien George <damien@micropython.org>	2024-11-04 12:47:47 +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	97af1001ae	rp2/machine_uart: Make it so TX is done only when no longer busy. ... Prior to this commit, when flushing a UART on the rp2 port, it returns just before the last character is sent out the wire. Fix this by waiting until the BUSY flag is cleared. This also fixes the behaviour of `UART.txdone()` to return `True` only when the last byte has gone out. Updated docs and tests to match. The test now checks that UART TX time is very close to the expected time (prior, it was just testing that the TX time was less than the expected time). Signed-off-by: Damien George <damien@micropython.org>	2024-10-22 10:17:05 +11:00
Phil Howard	e6093c0fbd	rp2/rp2_pio: Add support for RP2350A/B variants in PIO interface. ... Add support for 32 and 48 pin variants of RP2350. Add new `PIO.gpio_base()` method, mirroring the Pico SDK. Signed-off-by: Phil Howard <phil@gadgetoid.com> Signed-off-by: Damien George <damien@micropython.org>	2024-10-15 12:09:48 +11:00
Andrew Leech	6d799378ba	esp32: Add support for esp32c6. ... This commit adds general support for ESP32-C6 SoCs. Signed-off-by: Andrew Leech <andrew@alelec.net>	2024-10-09 23:29:38 +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
Maureen Helm	a9803f4711	zephyr: Allow using devicetree node labels to construct machine objects. ... Zephyr v3.7.0 added a new feature to allow getting devices by their devicetree node labels. Use this feature in the MicroPython Zephyr port to simplify constructing machine module objects, including Pin, SPI, I2C, and UART. It's still possible to use the more verbose device names (e.g., gpio@400ff040, i2c@40066000, spi@4002c000), but now we can also use their devicetree node labels (e.g., gpiob, i2c0, spi0). Node labels aren't standardized across all SoC families because they generally try to follow their respective SoC hardware user manual naming convention, however many boards define common labels for devices routed to Arduino headers (e.g., arduino_i2c, arduino_serial, and arduino_spi). That means I2C("arduino_i2c") will work on quite a few boards (>100 in the main Zephyr tree). Signed-off-by: Maureen Helm <maureen.helm@analog.com>	2024-10-01 20:02:01 -05:00
Maureen Helm	545d4efb55	zephyr: Upgrade to Zephyr v3.7.0. ... Updates the Zephyr port build instructions and CI to use the latest Zephyr release tag. Tested on frdm_k64f. Signed-off-by: Maureen Helm <maureen.helm@analog.com>	2024-10-02 07:49:53 +10:00
Maureen Helm	2407c46dac	docs/zephyr: Update docs to reflect device name changes. ... Zephyr v3.2.0 deprecated the devicetree label property as a base property, which had been used as the device name string for device_get_binding(). The device name string is now the devicetree node name appended with its unit-address. Update Zephyr port documentation to reflect this change. Signed-off-by: Maureen Helm <maureen.helm@intel.com>	2024-10-02 07:49:30 +10:00
Andrew Leech	7e14680a83	py/objringio: Add micropython.RingIO() interface for general use. ... This commit adds a new `RingIO` type which exposes the internal ring-buffer code for general use in Python programs. It has the stream interface making it similar to `StringIO` and `BytesIO`, except `RingIO` has a fixed buffer size and is automatically safe when reads and writes are in different threads or an IRQ. This new type is enabled at the "extra features" ROM level. Signed-off-by: Andrew Leech <andrew.leech@planetinnovation.com.au>	2024-09-19 18:00:44 +10:00
Angus Gratton	52a593cdb1	py/scheduler: Only run callbacks on the main thread if GIL is disabled. ... Otherwise it's very difficult to reason about thread safety in a scheduler callback, as it can run at any time on any thread - including racing against any bytecode operation on any thread. This work was funded through GitHub Sponsors. Signed-off-by: Angus Gratton <angus@redyak.com.au>	2024-09-19 13:17:01 +10:00
Angus Gratton	fb069f9d06	docs/library: Document machine.Pin.toggle() method. ... Original commit was by @millosolomillo from 2022, but CI no longer accepts their auto-generated GitHub commit email... Signed-off-by: Angus Gratton <angus@redyak.com.au>	2024-09-19 12:04:39 +10:00
Damien George	8feb714b4d	docs/library: Document math.log with two arguments. ... The functionality is there but was not documented. Signed-off-by: Damien George <damien@micropython.org>	2024-09-17 11:22:26 +10: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