MicroPython ESP8266 docs x WiPy docs

All ESP8266 boards running MicroPython.
Official boards are the Adafruit Huzzah and Feather boards.
Target audience: MicroPython users with an ESP8266 board.
Post Reply
User avatar
rcolistete
Posts: 352
Joined: Thu Dec 31, 2015 3:12 pm
Location: Brazil
Contact:

MicroPython ESP8266 docs x WiPy docs

Post by rcolistete » Tue Nov 15, 2016 2:07 pm

I haven't seen this issue reported here. So I think it deserves somes attention.

Part of the official MicroPython ESP8266 documentation still has content related to WiPy 1.0 :
- 'uos' module cites '/flash' as the internal flash filesystem on ESP8266 where it should be '/'. New 'os.umount' function (from v1.8.4) is not listed :
http://docs.micropython.org/en/latest/e ... y/uos.html
http://docs.micropython.org/en/latest/w ... y/uos.html
- 'Machine.ADC', it is dangerous because it doesn't show de 0-1.0V range restriction of ESP8266 ADC (but instead 0-1.4V, which is for WiPy 1.0 ADC), and it cites 12 bits ADC (ESP8266 ADC has 10 bits) and many methods not available to ESP8266 ADC :
http://docs.micropython.org/en/latest/e ... e.ADC.html
http://docs.micropython.org/en/latest/w ... e.ADC.html
In Quick Ref docs, it is correct :
http://docs.micropython.org/en/latest/e ... conversion
- 'Machine.SD' is listed, equal to WiPy, but it isn't available at all on ESP8266 :
http://docs.micropython.org/en/latest/e ... ne.SD.html
http://docs.micropython.org/en/latest/w ... ne.SD.html

Some parts cite ESP8266 and WiPy, I think because it is simple to generate the docs from the same set of files. For the use, it would be better to separate de docs from ESP8266 and WiPy (like it is separated from Pyboard) :
- 'Machine.I2C', where some methods are only for WiPy or only for ESP8266, or cite some specific features for WiPy or ESP8266 :
http://docs.micropython.org/en/latest/e ... e.I2C.html
http://docs.micropython.org/en/latest/w ... e.I2C.html
My "MicroPython Samples". My "MicroPython Firmwares" with many options (double precision, ulab, etc).

Post Reply