summaryrefslogtreecommitdiffstatshomepage
path: root/docs/esp32
Commit message (Collapse)AuthorAge
* docs/rp2: Add network information to the rp2 quickref.Matt Trentini2025-03-25
| | | | | | | | | | | Some rp2 boards include WiFi, at least with the very popular Pico W and Pico 2 W. New users frequently ask how to set up WiFi and are confused because it's not covered in the quickref. This commit adds the wlan section, copied and modified with notes from the ESP32 quickref. Signed-off-by: Matt Trentini <matt.trentini@gmail.com>
* esp32/machine_sdcard: Add SDCard pin assignments for ESP32-S3 support.Angus Gratton2025-03-13
| | | | | | | | | | 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>
* docs/esp32: Add documentation for SPI Ethernet devices on esp32 port.Angus Gratton2025-02-11
| | | | | | | | 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>
* docs/esp32: Defer to the download page for flashing steps.Angus Gratton2025-01-17
| | | | | | | | | 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>
* docs/esp32: Update tutorial flashing steps to match deploy.md.Angus Gratton2025-01-17
| | | | | | | | | | | | | | | 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>
* docs: Fix the quickref documentation of rtc.datetime().robert-hh2024-12-19
| | | | | | | Such that it matches the implementation and the documentation of the `machine.RTC` class. Signed-off-by: robert-hh <robert@hammelrath.com>
* docs,esp32: Update machine.TouchPad docs for ESP32-S2 and ESP32-S3.Angus Gratton2024-11-28
| | | | Signed-off-by: Angus Gratton <angus@redyak.com.au>
* 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: 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>
* esp32: Add support for esp32c6.Andrew Leech2024-10-09
| | | | | | This commit adds general support for ESP32-C6 SoCs. Signed-off-by: Andrew Leech <andrew@alelec.net>
* docs/esp32: Update pin access example with addresses for ESP32-S3.Paul Grayson2024-09-17
| | | | | Signed-off-by: Paul Grayson <pdg@alum.mit.edu> Signed-off-by: Angus Gratton <angus@redyak.com.au>
* 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>
* esp32/modesp32: Add mcu_temperature() function for C3/S2/S3 devices.Rick Sorensen2024-05-07
| | | | | | | | | | | | For ESP32C3/S2/S3 IDFv5 exposes new internal temperature API which is different to the base ESP32, IDFv4. Thanks to @robert-hh for cleaner code and testing sensor capability in these devices. See discussion #10443. Signed-off-by: Rick Sorensen <rick.sorensen@gmail.com>
* docs/esp32/quickref: Add note about different ESP32 varieties.Rick Sorensen2024-05-07
| | | | Signed-off-by: Rick Sorensen <rick.sorensen@gmail.com>
* esp32/network_lan: Add a separate argument to set PHY power pin.robert-hh2024-03-08
| | | | | | | | | | | | | | | | Prior to this commit, the pin defined for power would be used by the esp_idf driver to reset the PHY. That worked, but sometimes the MDIO configuration started before the power was fully settled, leading to an error. With the change in this commit, the power for the PHY is independently enabled in network_lan.c with a 100ms delay to allow the power to settle. A separate define for a reset pin is provided, even if the PHY reset pin is rarely connected. Fixes issue #14013. Signed-off-by: robert-hh <robert@hammelrath.com>
* docs: Use vfs module instead of os.Damien George2024-02-07
| | | | Signed-off-by: Damien George <damien@micropython.org>
* docs/esp32/quickref: Add DAC example.Ihor Nehrutsa2023-12-11
| | | | Signed-off-by: IhorNehrutsa <Ihor.Nehrutsa@gmail.com>
* docs,tools: Change remaining "urequests" references to "requests".Damien George2023-10-05
| | | | Signed-off-by: Damien George <damien@micropython.org>
* docs/esp32/tutorial: Add example for pin access via registers.IhorNehrutsa2023-09-04
| | | | | | Synchronous access to pins directly via registers. Signed-off-by: Ihor Nehrutsa <Ihor.Nehrutsa@gmail.com>
* docs/esp32/quickref: Add LAN example for WT32-ETH01 version 1.4.Elvis Pfutzenreuter2023-07-13
| | | | | | | | | | | | This board requires slightly different configuration to work. It is important to hard reset (cycle power) if you try to initialize LAN and it fails, before trying again with new parameters. Discussion: https://github.com/orgs/micropython/discussions/11446 AliExpress purchase link: https://pt.aliexpress.com/item/1005002023196214.html Signed-off-by: Elvis Pfutzenreuter <epxx@epxx.co>
* docs/esp32: Update esp32 docs based on IDF v5 changes.Damien George2023-06-23
| | | | Signed-off-by: Damien George <damien@micropython.org>
* docs/library/index: Update docs after umodule rename.Jim Mussared2023-06-08
| | | | | | | | | - Update guide for extending built-in modules. - Remove any last trace of umodule in other docs. This work was funded through GitHub Sponsors. Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
* docs: Update the PWM examples based on recent API improvements.robert-hh2023-05-04
| | | | | | | | This adds the freq and duty_u16 keyword settings to the constructor, and sometimes other details in the PWM section. For mimxrt a clarification regarding the PWM invert argument was added, and for rp2 a few words were spent on PWM output pairs of a channel/slice.
* all: Fix spelling mistakes based on codespell check.Damien George2023-04-27
| | | | Signed-off-by: Damien George <damien@micropython.org>
* docs/esp32/quickref: Add docs for the LAN interface constructor.robert-hh2023-01-18
| | | | Incorporating PR #7356.
* docs/esp32: Update UART quickref on input-only pins.Tomasz 'CeDeROM' CEDRO2022-08-26
| | | | Signed-off-by: Tomasz 'CeDeROM' CEDRO <tomek@cedro.info>
* docs/esp32: Fix string quoting consistency in SDCard mount example.David Peake2022-08-17
| | | | It appears that strings in the documentation are typically single quoted.
* docs: Update to use new WLAN argument names for ssid/security/key.iabdalkader2022-06-17
| | | | Addresses issue #8083.
* esp32/modesp32: Add new gpio_deep_sleep_hold function.Jonathan Hogg2022-03-21
| | | | | | | | Add a new function to control whether held pins will retain their function through deep-sleep. Also document this function and explain how to use this in quickref to retain pin configuration during deep-sleep.
* esp32/machine_pin: Add new hold keyword argument and remove PULL_HOLD.Jonathan Hogg2022-03-21
| | | | | | | | | | | | | | The current pull=Pin.PULL_HOLD argument doesn't make a lot of sense in the context of what it actually does vs what the ESP32 quickref document says it does. This commit removes PULL_HOLD and adds a new hold=True|False keyword argument to Pin()/Pin.init(). Setting this to True will cause the ESP32 to lock the configuration of the pin – including direction, output value, drive strength, pull-up/-down – such that it can't be accidentally changed and will be retained through a watchdog or internal reset. Fixes issue #8283, and see also #8284.
* docs/esp32/quickref: Refine deep-sleep power-saving notes.Jonathan Hogg2022-03-21
| | | | | This attempts to better explain how pull-ups and pull-downs operate in deep-sleep mode.
* docs/esp32/quickref: Document GPIO drive strength.Jonathan Hogg2022-03-07
| | | | Add brief documentation of the new `drive` keyword argument.
* docs/esp32/quickref: Update ADC documentation.Jonathan Hogg2022-02-04
| | | | | Update ADC documentation now that the new API is described in the main docs.
* docs: Remove reference to obsolete neopixel_write function.Damien George2022-02-02
| | | | | | It has been replaced by machine.bitstream. Signed-off-by: Damien George <damien@micropython.org>
* docs/esp32: Document expanded ADC API in quickref.Jonathan Hogg2022-01-21
| | | | | Document read_u16(), read_uv() and ADCBlock(). Mark old read(), atten() and width() methods as legacy.
* esp32/machine_bitstream: Reinstate bitstream bit-bang implementation.Damien George2022-01-14
| | | | | | | | | | | | | The bit-bang implementation was replaced with the RMT implementation in 599b61c08687ca077e3b0e115d5b76affcc673ca. This commit brings back that bit-bang code, and allows it to be selected via the new static method: esp32.RMT.bitstream_channel(None) The bit-bang implementation may be useful if the RMT needs to be used for something else, or if bit-banging is more stable in certain applications. Signed-off-by: Damien George <damien@micropython.org>
* docs/esp32: Update RMT quickref example to match latest code.Damien George2022-01-13
| | | | | | The start keyword was removed in 18e48a71ee69557a5340c8652f2e73e586063be3 Signed-off-by: Damien George <damien@micropython.org>
* esp32/machine_pwm: Keep duty constant when changing frequency.IhorNehrutsa2021-12-22
| | | | | | | Save and restore the same duty cycle when the frequency (or frequency resolution) is changed. This allows a smooth frequency change. Also update the esp32 PWM quickref to be clearer.
* docs: Remove trailing spaces and convert tabs to spaces.Damien George2021-12-15
| | | | Signed-off-by: Damien George <damien@micropython.org>
* esp32/machine_pwm: Implement duty_u16() and duty_ns() PWM methods.IhorNehrutsa2021-12-03
| | | | | | | | | | | | The methods duty_u16() and duty_ns() are implemented to match the existing docs. The duty will remain the same when the frequency is changed. Standard ESP32 as well as S2, S3 and C3 are supported. Thanks to @kdschlosser for the fix for rounding in resolution calculation. Documentation is updated and examples expanded for esp32, including the quickref and tutorial. Additional notes are added to the machine.PWM docs regarding limitations of hardware PWM.
* docs/esp32/tutorial: Add an example of peripheral control via regs.NitiKaur2021-10-14
|
* docs/esp32: Explain ESP32 PWM modes, timers, and channels.IhorNehrutsa2021-09-21
|
* docs: Replace ufoo with foo in all docs.Jim Mussared2021-08-13
| | | | | | | | | | | | | | | | | | | | | | 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>
* docs: Replace master/slave with controller/peripheral in I2C and SPI.David P2021-07-18
| | | | See https://www.oshwa.org/a-resolution-to-redefine-spi-signal-names
* esp32,stm32: Add new machine.I2S class for I2S protocol support.Mike Teachman2021-07-05
| | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* docs/esp32: Document WLAN "reconnects" config option.Thomas Wenrich2021-06-17
|
* docs/esp32: Mention Signal in GPIO section of quickref.Mike Causer2021-05-14
|
* docs/esp32: Add APA106 to quickref.Mike Causer2021-05-14
|
* docs/esp32: Add SDCard to quickref.Mike Causer2021-05-06
|
* docs/esp32: Add WDT to quickref.Mike Causer2021-05-06
|
generated by cgit v1.2.3 (git 2.39.1) at 2025-05-04 19:59:23 +0000