esp-idf-hal icon indicating copy to clipboard operation
esp-idf-hal copied to clipboard

Docstrings for GPIO/PinDriver

Open IvanSanchez opened this issue 1 year ago • 1 comments

A bit of documentation for the GPIO module. This should help people who (like me) struggle a bit to understand why a esp_idf_hal::gpio::AnyInputPin is not an embedded_hal::digital::Input.

IvanSanchez avatar Aug 18 '24 02:08 IvanSanchez

@IvanSanchez Thanks for contributing. If you could address my feedback.

In general, I do understand that in older hals there was a mix-up between the notion of pin peripheral and the notion of a pin driver - yet - in all "more modern" hals supported by the embassy project, as well as in the baremetal esp-hal sibling of this one there is a clear distinction between the pin peripheral and the pin driver.

It is just that these other hals tend to come up with "inventive" names for their drivers (which I definitely dislike) while esp-idf-hal sticks with the <Peripheral> <-> Peripheral>Driver name dihotomy.

ivmarkov avatar Aug 20 '24 11:08 ivmarkov