@@ -9,6 +9,10 @@ http://charlesleifer.com/blog/saturday-morning-hack-a-little-note-taking-app-wit
99. Notes Pico is a port of this application to Picoweb web pico-framework
1010for MicroPython. It was ported by Paul Sokolovsky.
1111
12+
13+ Deploying on MicroPython "Unix" version
14+ ---------------------------------------
15+
1216To install and run the application, you should install MicroPython
1317"Unix" port as described at https://github.com/micropython/micropython .
1418Once you have ``micropython `` executable in your PATH (recommended, but
@@ -33,6 +37,29 @@ simple and low-resource, so supports only plain-text notes, unlike the
3337original Flask application.
3438
3539
40+ Deploying on embedded MicroPython targets
41+ -----------------------------------------
42+
43+ Notes Pico can also run on "embedded" (microcontroller) MicroPython
44+ targets with networking capabilities and suitable heap size (TBC).
45+ As Notes Pico is full-stack application and contains relatively a
46+ lot of code, the only realistic way to deploy it on such systems is
47+ using "frozen bytecode" approach, where pre-compiled Python modules
48+ are made part of the binary firmware image to flash on the target.
49+ Instructions below use MicroPython ESP8266 port as an example.
50+
51+ 1. ``cd micropython/esp8266 ``
52+ 2. ``micropython -m upip install -p modules notes-pico ``
53+ 3. ``make ``
54+ 4. ``make deploy `` (see README in the directory for more params)
55+ 5. Boot ESP8266 module, run following commands at the device prompt.
56+ 6. ``import notes_pico.__main__ ``
57+ 7. ``notes_pico.__main__.main(host="0.0.0.0") ``
58+ 8. Connect with a web browser to http://`DEVICE_IP `:8081, where
59+ `DEVICE_IP ` is an IP address of ESP8266 device. (Consult MicroPython
60+ ESP8266 port documentation for network connection setup.)
61+
62+
3663Storage backends
3764----------------
3865
@@ -61,6 +88,4 @@ Known issues and limitations
6188As mentioned above, Picoweb port of the application supports only
6289plain-text notes, no formatting, images or videos.
6390
64- Currently, Notes Pico tested only with "Unix" MicroPython port,
65- though there's intention to make it work on microcontroller ports
66- with networking support and suitable resources.
91+ Embedded targets support is experimental, added in version 0.8.
0 commit comments