QUERY · ISSUE

ESP8266 - 'priority' and 'wake' params in Pin.irq method are not supported

openby rsc1975opened 2017-01-08updated 2022-08-23

port-esp8266

The doc (v1.8.6 and v1.8.7) seems to be wrong for the port esp8266, the parameters priority and wake are not supported, but they appears in the Pin class doc: https://micropython.org/resources/docs/en/latest/esp8266/library/machine.Pin.html

I've seen in the port Pin implementation that those parameters are not supported: https://github.com/micropython/micropython/blob/master/esp8266/machine_pin.c

Besides, there are some constants, like Pin.IRQ_LOW_LEVEL or Pin.IRQ_HIGH_LEVEL that are not in Pin class but they appears in the doc.

It seems that there are some other issues related with doc customizations by port, maybe that are sphinx issues, but I don't think so.

CANDIDATE · PULL REQUEST

esp8266: put pin interrupt handler in iRAM

mergedby dpgeorgeopened 2020-04-23updated 2020-05-02

port-esp8266

Attempt to fix #5714

Assessment

Q Qwen · high

Issue #2773 reports a documentation mismatch where the ESP8266 Pin.irq() method documentation lists unsupported parameters ('priority', 'wake') and constants (IRQ_LOW_LEVEL, IRQ_HIGH_LEVEL). PR #5962 addresses a completely different problem: a runtime crash/instability in the ESP8266 Pin IRQ handler by moving the handler to iRAM and disabling hard interrupt mode. While both involve the ESP8266 Pin IRQ implementation, PR #5962 does not fix the documentation errors reported in #2773, nor does it add the missing parameters or constants. The PR is about performance/stability, not API documentation accuracy.

Suggested action

Keep issue #2773 open. The documentation should be updated to reflect the actual supported parameters and constants for the ESP8266 port. PR #5962 is unrelated to this documentation issue.

ESP8266 - 'priority' and 'wake' params in Pin.irq method are not supported

esp8266: put pin interrupt handler in iRAM

Keyboard