Browse Source

docs/esp32: Update esp32 docs based on IDF v5 changes.

Signed-off-by: Damien George <damien@micropython.org>
pull/11528/head
Damien George 1 year ago
parent
commit
68e0e889b4
  1. 19
      docs/esp32/quickref.rst
  2. 4
      docs/library/esp32.rst
  3. 5
      docs/library/machine.WDT.rst

19
docs/esp32/quickref.rst

@ -57,7 +57,6 @@ The :mod:`esp32` module::
import esp32 import esp32
esp32.hall_sensor() # read the internal hall sensor
esp32.raw_temperature() # read the internal temperature of the MCU, in Fahrenheit esp32.raw_temperature() # read the internal temperature of the MCU, in Fahrenheit
esp32.ULP() # access to the Ultra-Low-Power Co-processor esp32.ULP() # access to the Ultra-Low-Power Co-processor
@ -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. or output. Suitable values are Pin.IN and Pin.OUT.
- ref_clk=pin-object # defines the Pin used for ref_clk. - 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:: These are working configurations for LAN interfaces of popular boards::
# Olimex ESP32-GATEWAY: power controlled by Pin(5) # Olimex ESP32-GATEWAY: power controlled by Pin(5)
# Olimex ESP32 PoE and ESP32-PoE ISO: power controlled by Pin(12) # 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), lan = network.LAN(mdc=machine.Pin(23), mdio=machine.Pin(18), power=machine.Pin(5),
phy_type=network.PHY_LAN8720, phy_addr=0, phy_type=network.PHY_LAN8720, phy_addr=0,
ref_clk=machine.Pin(17), ref_clk_mode=machine.Pin.OUT) ref_clk=machine.Pin(17), ref_clk_mode=machine.Pin.OUT)
@ -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), lan = network.LAN(id=0, mdc=Pin(23), mdio=Pin(18), power=Pin(5),
phy_type=network.PHY_IP101, phy_addr=1) 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 Delay and timing
---------------- ----------------

4
docs/library/esp32.rst

@ -44,10 +44,6 @@ Functions
Read the raw value of the internal temperature sensor, returning an integer. 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) .. function:: idf_heap_info(capabilities)
Returns information about the ESP-IDF heap memory regions. One of them contains Returns information about the ESP-IDF heap memory regions. One of them contains

5
docs/library/machine.WDT.rst

@ -25,9 +25,8 @@ Constructors
Create a WDT object and start it. The timeout must be given in milliseconds. 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. 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 Notes: On the esp8266 a timeout cannot be specified, it is determined by the underlying system.
cannot be specified, it is determined by the underlying system. On rp2040 devices, On rp2040 devices, the maximum timeout is 8388 ms.
the maximum timeout is 8388 ms.
Methods Methods
------- -------

Loading…
Cancel
Save