Skip to content

Commit 2875cbf

Browse files
committed
Update docs to reflect pfalcon fork.
1 parent a76909a commit 2875cbf

File tree

2 files changed

+26
-41
lines changed

2 files changed

+26
-41
lines changed

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,18 +19,19 @@ This GitHub repository consists of the following parts:
1919
boards to communicate without using a UART. Primarily intended to enable a
2020
a Pyboard-like device to achieve bidirectional communication with an ESP8266.
2121

22-
# 2. Installation of uasyncio
22+
# 2. Version and installation of uasyncio
2323

24-
Firstly install the latest version of `micropython-uasyncio`. To use queues,
25-
also install the `micropython-uasyncio.queues` module. A `Lock` synchronisation
26-
primitive is provided by `micropython-uasyncio.synchro`.
24+
This has become more involved owing to the development of Paul Sokolovsky's
25+
fork. At the time of writing this fork supports `uasyncio` version 2.0, which
26+
requires the build of firmware from his repository. The version on PyPI is
27+
V2.0.
2728

28-
Instructions on installing library modules may be found
29-
[here](https://github.com/micropython/micropython-lib).
29+
Until the situation becomes clearer I plan to support the official firmware.
30+
Hence these docs, code samples etc. are based on `uasyncio.core` V1.7.1 which
31+
is in [micropython-lib](https://github.com/micropython/micropython-lib).
3032

31-
On networked hardware, upip may be run locally. The
32-
[tutorial](./TUTORIAL.md#installing-uasyncio-on-bare-metal) has instructions
33-
for methods of installation on non-networked baremetal targets.
33+
See [tutorial](./TUTORIAL.md#installing-uasyncio-on-bare-metal) for
34+
installation instructions.
3435

3536
# 3. uasyncio development state
3637

TUTORIAL.md

Lines changed: 16 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -22,38 +22,22 @@ features.
2222

2323
# Installing uasyncio on bare metal
2424

25-
MicroPython libraries are located on [PyPi](https://pypi.python.org/pypi).
26-
Libraries to be installed are:
27-
28-
* micropython-uasyncio
29-
* micropython-uasyncio.queues
30-
* micropython-uasyncio.synchro
31-
32-
The `queues` and `synchro` modules are optional, but are required to run all
33-
the examples below.
34-
35-
The oficial approach is to use the `upip` utility as described
36-
[here](https://github.com/micropython/micropython-lib). Network enabled
37-
hardware has this included in the firmware so it can be run locally. This is
38-
the preferred approach.
39-
40-
On non-networked hardware there are two options. One is to use `upip` under a
41-
Linux real or virtual machine. This involves installing and building the Unix
42-
version of MicroPython, using `upip` to install to a directory on the PC, and
43-
then copying the library to the target.
44-
45-
The need for Linux and the Unix build may be avoided by using
46-
[micropip.py](https://github.com/peterhinch/micropython-samples/tree/master/micropip).
47-
This runs under Python 3.2 or above. Create a temporary directory on your PC
48-
and install to that. Then copy the contents of the temporary direcory to the
49-
device. The following assume Linux and a temporary directory named `~/syn` -
50-
adapt to suit your OS. The first option requires that `micropip.py` has
51-
executable permission.
52-
53-
```
54-
$ ./micropip.py install -p ~/syn micropython-uasyncio
55-
$ python3 -m micropip.py install -p ~/syn micropython-uasyncio
56-
```
25+
As discussed in the [main README](./README.md) these instructions assume the
26+
official build of MicroPython firmware. Accordingly the `uasyncio` files from
27+
the [official library](https://github.com/micropython/micropython-lib) are
28+
required. At the time of writing the PyPI repository contains `uasyncio` V2.0
29+
which is incompatible with that fimware so `upip` cannot be used.
30+
31+
The aim is to create a `uasyncio` directory on the device's filesystem
32+
containing the following files:
33+
34+
[__init__.py](https://github.com/micropython/micropython-lib/blob/master/uasyncio/uasyncio/__init__.py)
35+
[core.py](https://github.com/micropython/micropython-lib/blob/master/uasyncio.core/uasyncio/core.py)
36+
[queues.py](https://github.com/micropython/micropython-lib/blob/master/uasyncio.queues/uasyncio/queues.py)
37+
[synchro.py](https://github.com/micropython/micropython-lib/blob/master/uasyncio.synchro/uasyncio/synchro.py)
38+
39+
These modules may be frozen as bytecode in the usual way, by placing the above
40+
`uasyncio` directory in the port's `modules` directory and rebuilding.
5741

5842
###### [Main README](./README.md)
5943

0 commit comments

Comments
 (0)