800 Commits

Author	SHA1	Message	Date
Meir Armon	171d751242	esp32/modesp32: Make wake_on_ext1 available only on SoCs supporting it. ... The `esp32.wake_on_ext1()` method should only be available on boards that have SOC_PM_SUPPORT_EXT1_WAKEUP=y. And update docs to reflect this. Signed-off-by: Meir Armon <meirarmon@gmail.com>	2025-06-16 14:18:02 +10:00
Meir Armon	4697a06fdb	esp32/modesp32: Make wake_on_ext0 available only on SoCs supporting it. ... The `esp32.wake_on_ext0()` method should only be available on boards that have SOC_PM_SUPPORT_EXT0_WAKEUP=y. And update docs to reflect this. Signed-off-by: Meir Armon <meirarmon@gmail.com>	2025-06-16 14:17:14 +10:00
Meir Armon	cb315bb8e4	esp32/modesp32: Make wake_on_touch available only on SoCs supporting it. ... The `esp32.wake_on_touch()` method should only be available on boards that have SOC_TOUCH_SENSOR_SUPPORTED=y. And update docs to reflect this. Signed-off-by: Meir Armon <meirarmon@gmail.com>	2025-06-16 14:16:16 +10:00
Meir Armon	42404b5588	esp32/modesp32: Make wake_on_ulp available only on SoCs that support it. ... The `esp32.wake_on_ulp()` method should only be available on boards that have SOC_ULP_SUPPORTED=y. Update docs to reflect this. Signed-off-by: Meir Armon <meirarmon@gmail.com>	2025-06-16 11:24:25 +10:00
Damien George	b15348415e	extmod/modframebuf: Add support for blit'ing read-only data. ... Currently the `FrameBuffer.blit(buf, x, y)` method requires the `buf` argument to be another `FrameBuffer`, which is quite restrictive because it doesn't allow blit'ing read-only memory/data. This commit extends `blit()` to allow the `buf` argument to be a tuple or list of the form: (buffer, width, height, format[, stride]) where `buffer` can be anything with the buffer protocol and may be read-only, eg `bytes`. Also, the palette argument to `blit()` may be of the same form. The form of this tuple/list was chosen to be the same as the signature of the `FrameBuffer` constructor (that saves quite a bit of code size doing it that way). Signed-off-by: Damien George <damien@micropython.org>	2025-06-04 02:40:45 +10:00
Angus Gratton	ba92063d64	docs: Add a description of recv/recvfrom flags argument. ... Implementation added for various ports in the parent commits. This work was funded through GitHub Sponsors. Signed-off-by: Angus Gratton <angus@redyak.com.au>	2025-06-03 12:52:25 +10:00
robert-hh	5cfafb73da	docs/esp32: Mention the use of Timer(0) by UART.IRQ_RXIDLE. ... In both the machine.UART and esp32.quickref sections. Signed-off-by: robert-hh <robert@hammelrath.com>	2025-05-28 12:13:51 +10:00
robert-hh	2f864416c6	docs/library/time: Amend the documentation of time.mktime(). ... By showing the argument and refer to epoch instead of a fixed date. The note about epoch lists the ports using the POSIX epoch. Signed-off-by: robert-hh <robert@hammelrath.com>	2025-05-28 12:13:28 +10:00
Daniël van de Giessen	06d8c084b9	esp32/modesp32: Implement esp32.idf_task_info(). ... This adds a new function, `esp32.idf_task_info()`, that can be used to retrieve task statistics which is useful for diagnosing issues where some tasks are using up a lot of CPU time. It's best used in conjunction with the `utop` module from micropython-lib. Signed-off-by: Daniël van de Giessen <daniel@dvdgiessen.nl>	2025-05-16 16:49:59 +10:00
IhorNehrutsa	c310301f27	docs/esp32: Improve PWM documentation and examples. ... This reduces inconsitencies between esp32 and other ports. According to the discussion in #10817. Signed-off-by: Ihor Nehrutsa <Ihor.Nehrutsa@gmail.com>	2025-05-16 12:34:32 +10:00
Malcolm McKellips	288dce26bd	docs,ports: Fix SparkFun capitalization. ... This is a follow-up to 1e92bdd206 correcting more of the instances where "Sparkfun" should be "SparkFun". Signed-off-by: Damien George <damien@micropython.org>	2025-05-07 15:16:55 +10:00
Detlev Zundel	cd3eaad05c	zephyr: Fix call to thread_analyzer_print for v4.0. ... Commit 1b6e0f64796dfd6f86a8679ea6d24e1fca1e63a8 for Zephyr v4.0.0 changed the function "thread_analyzer_print" to require a cpu argument and allow thread analysis on each cpu separately. The argument is ignored when THREAD_ANALYZER_AUTO_SEPARATE_CORES=n which is the default on single core machines. Promote this change to the MicroPython zephyr module. Signed-off-by: Detlev Zundel <dzu@member.fsf.org> Signed-off-by: Maureen Helm <maureen.helm@analog.com>	2025-04-29 23:00:37 +10:00
Anson Mansfield	c68a40ac94	docs/library/vfs: Document no-args mount output. ... Signed-off-by: Anson Mansfield <amansfield@mantaro.com>	2025-03-27 16:37:04 +11:00
Angus Gratton	c85eefc55b	esp32/machine_sdcard: Add SDCard SPI mode support for ESP32-S2,C3,C6. ... These micros don't have full SDMMC host support, but they can initialise the SDCard in SPI mode. A bit limited on C3 and C6 as they only have one host SPI peripheral. This work was funded through GitHub Sponsors. Signed-off-by: Angus Gratton <angus@redyak.com.au>	2025-03-13 12:27:23 +11:00
Angus Gratton	79fb5aa878	esp32/machine_sdcard: Add SDCard pin assignments for ESP32-S3 support. ... Previously ESP32-S3 SDMMC could only use fixed pin assignments, however the ESP-IDF defaults don't match common boards. The chip also supports using GPIO Matrix to assign any pin. This work was funded through GitHub Sponsors. Signed-off-by: Angus Gratton <angus@redyak.com.au>	2025-03-13 12:27:01 +11:00
Alessandro Gatti	4d034f817c	esp8266/network_wlan: Allow enumerating connected stations in AP mode. ... This commit introduces the ability to obtain a list of stations connected to the device when in soft-AP mode. A new parameter ("stations") to pass to WLAN.status is supported, returning a tuple of (bssid, ipv4) entries, one per connected station. An empty tuple is returned if no stations are connected, and an exception is raised if an error occurred whilst building the python objects to return to the interpreter. Documentation is also updated to cover the new parameter. This fixes #5395. Signed-off-by: Alessandro Gatti <a.gatti@frob.it>	2025-03-05 16:15:31 +11:00
Damien George	f5b4545761	py/modsys: Add sys.implementation._build entry. ... For a given MicroPython firmware/executable it can be sometimes important to know how it was built, which variant/board configuration it came from. This commit adds a new field `sys.implementation._build` that can help identify the configuration that MicroPython was built with. For now it's either: * <VARIANT> for unix, webassembly and windows ports * <BOARD>-<VARIANT> for microcontroller ports (the variant is optional) In the future additional elements may be added to this string, separated by a hyphen. Resolves issue #16498. Signed-off-by: Damien George <damien@micropython.org>	2025-03-05 12:23:40 +11:00
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
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
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
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
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	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
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	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
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	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	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	35b6a66b0b	docs/library: Document the network.PPP class. ... Signed-off-by: Damien George <damien@micropython.org>	2024-08-29 23:47:55 +10:00
robert-hh	03b1b6d8e6	docs/library/machine.UART: Extend the documentation for UART.irq. ... For more ports and trigger options, based on the current state of the code. Signed-off-by: robert-hh <robert@hammelrath.com>	2024-08-29 16:48:09 +10:00
Damien George	9bbe61607a	docs/library/machine.UART: Fix UART.irq docs to match current code. ... These docs now match the code in `extmod/machine_uart.c`. IRQ trigger support still need to be updated for each port (to be done in a follow-up commit). Signed-off-by: Damien George <damien@micropython.org>	2024-08-29 16:34:45 +10:00
Tim Weber	d1685a3f5f	docs/library/neopixel: Mention bitstream timing tuple. ... Signed-off-by: Tim Weber <scy@scy.name>	2024-08-01 12:04:58 +10:00
Angus Gratton	81daba31c5	docs: Specify that machine.idle() returns at least every 1ms. ... A lot of existing code (i.e. micropython-lib lps22h, lcd160cr sensor drivers, lora sync_modem driver, usb-device-hid) calls machine.idle() inside a tight loop that is polling some condition. This reduces the power usage compared to constantly looping, but can be faster than calling a sleep function. However on a tickless port there's not always an interrupt before the condition they are polling for, so it's difficult to restructure this code if machine.idle() doesn't have any upper limit on execution time. This commit specifies an upper limit of 1ms before machine.idle() resumes execution. This is already the case for all ports except rp2. This work was funded through GitHub Sponsors. Signed-off-by: Angus Gratton <angus@redyak.com.au>	2024-07-23 16:42:42 +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