MicroPython Documentation Discussion

General discussions and questions abound development of code with MicroPython that is not hardware specific.
Target audience: MicroPython Users.
Post Reply
flywire
Posts: 22
Joined: Wed Jan 02, 2019 7:08 am

MicroPython Documentation Discussion

Post by flywire » Fri Jan 04, 2019 6:11 am

What is the best way to comment on MicroPython documentation at http://docs.micropython.org/en/latest/index.html

flywire
Posts: 22
Joined: Wed Jan 02, 2019 7:08 am

Re: MicroPython Documentation Discussion

Post by flywire » Fri Jan 04, 2019 6:27 am

Quick reference for the ESP8266, Networking
A useful function for connecting to your local WiFi network is:

Code: Select all

def do_connect():
    import network
    wlan = network.WLAN(network.STA_IF)
    wlan.active(True)
    if not wlan.isconnected():
        print('connecting to network...')
        wlan.connect('essid', 'password')
        while not wlan.isconnected():
            pass
    print('network config:', wlan.ifconfig())
This is right under Installing MicroPython, at least add a line to call the function.

WebREPL (web browser interactive prompt)
If you disabled automatic start-up on boot...
in boot.py
...but the daemon is also started on STA interface if it is active, so if your router is set up and works correctly, you may also use WebREPL while connected to your normal Internet access point...
good place for a link to Quick reference for the ESP8266, Networking

tannewt
Posts: 35
Joined: Thu Aug 25, 2016 2:43 am

Re: MicroPython Documentation Discussion

Post by tannewt » Mon Jan 07, 2019 5:31 am

The source for those docs is in the repo itself. Here is the ESP quickref: https://github.com/micropython/micropyt ... ickref.rst

flywire
Posts: 22
Joined: Wed Jan 02, 2019 7:08 am

Re: MicroPython Documentation Discussion

Post by flywire » Mon Jan 07, 2019 11:08 am

tannewt wrote:
Mon Jan 07, 2019 5:31 am
The source ... [is]: https://github.com/micropython/micropyt ... ickref.rst
Thank you, easy to edit with the pencil icon. :D

172 pull requests - hard to implement. :(

flywire
Posts: 22
Joined: Wed Jan 02, 2019 7:08 am

esptool.py erase all flash before writing (single command)

Post by flywire » Wed Jan 09, 2019 9:37 am

wrote:
Wed Jan 09, 2019 7:46 am
https://github.com/espressif/esptool/releases/tag/v2.6
Version 2.6 Features:
New write_flash --erase-all ... option to erase all flash before writing (single command).

User avatar
mattyt
Posts: 247
Joined: Mon Jan 23, 2017 6:39 am

Re: MicroPython Documentation Discussion

Post by mattyt » Sun Jan 27, 2019 5:13 am

Hi flywire, sorry for the lack of communication, things were a little hectic in the lead-up to the 1.10 release! Right here is a good place to discuss documentation though of course, raising PR's or issues is helpful too.

If you do raise a PR please let me know and I'll push to get it integrated; I'm trying to help out with the documentation.

User avatar
vdb_peter
Posts: 6
Joined: Mon Feb 11, 2019 12:51 am
Location: Melbourne

Re: MicroPython Documentation Discussion

Post by vdb_peter » Thu Feb 14, 2019 1:28 am

Hi mattyt

Can a note be added to the ESP8266 Documentation on the "maximum Period" a timer can be set to, please?

I can confirm that the MAXIMUM value is 6870947 (1:54:30.947).

Please see viewtopic.php?f=16&t=5116&start=10 where this has been discussed.

Thanks
Peter

Post Reply