kopia lustrzana https://github.com/peterhinch/micropython-samples
Improve Picoweb doc.
rodzic
446bb69525
commit
eae256e07a
41
PICOWEB.md
41
PICOWEB.md
|
@ -10,22 +10,36 @@ code is unchanged. The demos are trivially changed to use IP '0.0.0.0' and port
|
||||||
|
|
||||||
Two ways of installing Picoweb are available: copying this directory to the
|
Two ways of installing Picoweb are available: copying this directory to the
|
||||||
target or using `upip`. To use `upip` you should ensure your firmware is V1.11
|
target or using `upip`. To use `upip` you should ensure your firmware is V1.11
|
||||||
or later; your target will also require an internet connection.
|
or later; your target will also require an internet connection. Both methods
|
||||||
|
require the following preliminaries.
|
||||||
|
|
||||||
|
## Preliminary steps
|
||||||
|
|
||||||
|
### Clone this repo to your PC.
|
||||||
|
|
||||||
|
From a suitable destination directory issue
|
||||||
|
```
|
||||||
|
git clone https://github.com/peterhinch/micropython-samples
|
||||||
|
```
|
||||||
|
|
||||||
|
### Establish uasyncio status
|
||||||
|
|
||||||
|
Determine whether your target has `uasyncio` already installed. At the REPL
|
||||||
|
issue:
|
||||||
|
```
|
||||||
|
>>> import uasyncio
|
||||||
|
>>>
|
||||||
|
```
|
||||||
|
If this throws an `ImportError`, `uasyncio` is not installed.
|
||||||
|
|
||||||
## Installing using upip
|
## Installing using upip
|
||||||
|
|
||||||
Copy the `picoweb` subdirectory of this repo's `PicoWeb` directory, with its
|
Copy the `picoweb` subdirectory of this repo's `PicoWeb` directory, with its
|
||||||
contents, to the target. If using `rshell` to connect to a Pyboard D this would
|
contents, to the target. If using `rshell` to connect to a Pyboard D this would
|
||||||
be done with:
|
be done from the `PicoWeb` directory with:
|
||||||
```
|
```
|
||||||
/my/tree/PicoWeb> cp -r picoweb/ /flash
|
/my/tree/PicoWeb> cp -r picoweb/ /flash
|
||||||
```
|
```
|
||||||
Check whether your target has `uasyncio` pre-installed:
|
|
||||||
```
|
|
||||||
>>> import uasyncio
|
|
||||||
>>>
|
|
||||||
```
|
|
||||||
If this throws an `ImportError`, you will need to install `uasyncio`.
|
|
||||||
|
|
||||||
Ensure your target is connected to the internet. Then perform the following
|
Ensure your target is connected to the internet. Then perform the following
|
||||||
steps. The first step may be omitted if `uasyncio` is already installed.
|
steps. The first step may be omitted if `uasyncio` is already installed.
|
||||||
|
@ -46,6 +60,9 @@ prompt issue
|
||||||
```
|
```
|
||||||
This may take some time: 1 minute here on ESP32.
|
This may take some time: 1 minute here on ESP32.
|
||||||
|
|
||||||
|
If `uasyncio` was already installed, the corrsponding directory on the target
|
||||||
|
may be removed.
|
||||||
|
|
||||||
# Running Picoweb
|
# Running Picoweb
|
||||||
|
|
||||||
At the REPL connect to the network and determine your IP address
|
At the REPL connect to the network and determine your IP address
|
||||||
|
@ -67,10 +84,6 @@ or
|
||||||
|
|
||||||
Then point your browser at the IP address determined above.
|
Then point your browser at the IP address determined above.
|
||||||
|
|
||||||
Note that some platforms will have `uasyncio` installed as frozen bytecode: in
|
|
||||||
such cases there is no need to copy the `uasyncio` subdirectory (if you do, it
|
|
||||||
will be ignored).
|
|
||||||
|
|
||||||
# ESP8266
|
# ESP8266
|
||||||
|
|
||||||
RAM limitations require the use of frozen bytecode, and getting the examples
|
RAM limitations require the use of frozen bytecode, and getting the examples
|
||||||
|
@ -118,5 +131,5 @@ path/to/repo> cp picoweb/templates/squares.tpl /pyboard/picoweb/templates/
|
||||||
|
|
||||||
See [the PicoWeb docs](https://github.com/pfalcon/picoweb)
|
See [the PicoWeb docs](https://github.com/pfalcon/picoweb)
|
||||||
|
|
||||||
Note that to run the demos on platforms other than the Unix build you may want
|
Note that to run these demos on platforms other than the Unix build you may
|
||||||
to change IP and port as above.
|
want to change IP and port as above.
|
||||||
|
|
Ładowanie…
Reference in New Issue