Skip to content

Micropython documentation notes

Jump to bottom
Alex Hanson edited this page Dec 14, 2018 · 1 revision

Micropython is a great micro-controller solution, however the documentation is lacking in places. This page is an attempt to supplement the official docs. The lack of documentation (especially for esp32) is a barrier to getting started, and the confusion it causes is frustrating.

Edits which should be made

  1. http://micropython.org/download - "Firmware for ESP32 boards" i. A sentence noting the state of the documentation should be made. A reference to https://github.com/loboris/MicroPython_ESP32_psRAM_LoBo being significantly better, and perhaps recommended to begins should be made.

  2. http://docs.micropython.org/en/latest/ i. The sidebar should add an entry comparing the supported board's differences ii. Page for esp32 redirecting to esp8266 and github.com/loboris/MicroPython_ESP32_psRAM_LoBo 1. everything from https://forum.micropython.org/viewtopic.php?f=18&t=3697&p=31025&hilit=TouchPad#p31025 2. https://github.com/micropython/micropython/issues/3946 3. https://github.com/micropython/micropython/issues/3674

  3. help with is:open label:docs and similar (flag item with doc tag)

  4. fix pycharm plugin

Resources I should read

  1. ESP32 deepsleep with loboris - https://forum.micropython.org/viewtopic.php?f=18&t=3900&p=22405&hilit=TouchPad#p22405
  2. Documentation output restriction (last post) - https://github.com/micropython/micropython/issues/3220
  3. Good reads i. https://github.com/micropython/micropython/issues/2593 ii. https://github.com/micropython/micropython/wiki/Driver-API-Design-Guidelines iii. https://github.com/micropython/micropython/wiki/Hardware-API iv. https://github.com/vlasovskikh/intellij-micropython/issues/44

Clone this wiki locally