Skip to content

Commit

Permalink
docs/esp32: Update esp32 docs based on IDF v5 changes.
Browse files Browse the repository at this point in the history
Signed-off-by: Damien George <damien@micropython.org>
  • Loading branch information
dpgeorge committed Jun 23, 2023
1 parent 7170604 commit 68e0e88
Show file tree
Hide file tree
Showing 3 changed files with 2 additions and 26 deletions.
19 changes: 0 additions & 19 deletions docs/esp32/quickref.rst
Expand Up @@ -57,7 +57,6 @@ The :mod:`esp32` module::

import esp32

esp32.hall_sensor() # read the internal hall sensor
esp32.raw_temperature() # read the internal temperature of the MCU, in Fahrenheit
esp32.ULP() # access to the Ultra-Low-Power Co-processor

Expand Down Expand Up @@ -137,19 +136,11 @@ The keyword arguments for the constructor defining the PHY type and interface ar
or output. Suitable values are Pin.IN and Pin.OUT.
- ref_clk=pin-object # defines the Pin used for ref_clk.

The options ref_clk_mode and ref_clk require at least esp-idf version 4.4. For
earlier esp-idf versions, these parameters must be defined by kconfig board options.

These are working configurations for LAN interfaces of popular boards::

# Olimex ESP32-GATEWAY: power controlled by Pin(5)
# Olimex ESP32 PoE and ESP32-PoE ISO: power controlled by Pin(12)

lan = network.LAN(mdc=machine.Pin(23), mdio=machine.Pin(18), power=machine.Pin(5),
phy_type=network.PHY_LAN8720, phy_addr=0)

# or with dynamic ref_clk pin configuration

lan = network.LAN(mdc=machine.Pin(23), mdio=machine.Pin(18), power=machine.Pin(5),
phy_type=network.PHY_LAN8720, phy_addr=0,
ref_clk=machine.Pin(17), ref_clk_mode=machine.Pin.OUT)
Expand All @@ -164,16 +155,6 @@ These are working configurations for LAN interfaces of popular boards::
lan = network.LAN(id=0, mdc=Pin(23), mdio=Pin(18), power=Pin(5),
phy_type=network.PHY_IP101, phy_addr=1)

A suitable definition of the PHY interface in a sdkconfig.board file is::

CONFIG_ETH_PHY_INTERFACE_RMII=y
CONFIG_ETH_RMII_CLK_OUTPUT=y
CONFIG_ETH_RMII_CLK_OUT_GPIO=17
CONFIG_LWIP_LOCAL_HOSTNAME="ESP32_POE"

The value assigned to CONFIG_ETH_RMII_CLK_OUT_GPIO may vary depending on the
board's wiring.

Delay and timing
----------------

Expand Down
4 changes: 0 additions & 4 deletions docs/library/esp32.rst
Expand Up @@ -44,10 +44,6 @@ Functions

Read the raw value of the internal temperature sensor, returning an integer.

.. function:: hall_sensor()

Read the raw value of the internal Hall sensor, returning an integer.

.. function:: idf_heap_info(capabilities)

Returns information about the ESP-IDF heap memory regions. One of them contains
Expand Down
5 changes: 2 additions & 3 deletions docs/library/machine.WDT.rst
Expand Up @@ -25,9 +25,8 @@ Constructors
Create a WDT object and start it. The timeout must be given in milliseconds.
Once it is running the timeout cannot be changed and the WDT cannot be stopped either.

Notes: On the esp32 the minimum timeout is 1 second. On the esp8266 a timeout
cannot be specified, it is determined by the underlying system. On rp2040 devices,
the maximum timeout is 8388 ms.
Notes: On the esp8266 a timeout cannot be specified, it is determined by the underlying system.
On rp2040 devices, the maximum timeout is 8388 ms.

Methods
-------
Expand Down

0 comments on commit 68e0e88

Please sign in to comment.