Skip to content

Commit ab6cbb6

Browse files
committed
Minor doc changes.
1 parent 3d40a66 commit ab6cbb6

File tree

2 files changed

+25
-15
lines changed

2 files changed

+25
-15
lines changed

v3/README.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ and incremental encoders.
1919
is a guide to interfacing interrupts to `uasyncio`.
2020

2121
[Event-based programming](./docs/EVENTS.md) is a guide to a way of writing
22-
applications and device drivers which largely does away with callbacks. Assumes
23-
some knowledge of `uasyncio`.
22+
applications and device drivers which largely does away with callbacks. The doc
23+
assumes some knowledge of `uasyncio`.
2424

2525
[Threading](./docs/THREADING.md) is a guide to the use of multi-threaded and
2626
multi-core programming. Code is offered to enable a `uasyncio` application to
@@ -51,26 +51,38 @@ Documented in the [tutorial](./docs/TUTORIAL.md).
5151
Documented in the [tutorial](./docs/TUTORIAL.md). Comprises:
5252
* Implementations of unsupported CPython primitives including `barrier`,
5353
`queue` and others.
54-
* An additional primitive `Message`.
5554
* A software retriggerable monostable timer class `Delay_ms`, similar to a
5655
watchdog.
5756
* Two primitives enabling waiting on groups of `Event` instances.
5857

59-
### 1.3.3 Asynchronous device drivers
58+
### 1.3.3 Threadsafe primitives
59+
60+
[This doc](https://github.com/peterhinch/micropython-async/blob/master/v3/docs/THREADING.md)
61+
describes issues linking `uasyncio` code with code running on other cores or in
62+
other threads. The `threadsafe` directory provides:
63+
64+
* A threadsafe primitive `Message`.
65+
* `ThreadSafeQueue`
66+
* `ThreadSafeEvent` Extends `ThreadsafeFlag`.
67+
68+
The doc also provides code to enable `uasyncio` to handle blocking functions
69+
using threading.
70+
71+
### 1.3.4 Asynchronous device drivers
6072

6173
These are documented
6274
[here](https://github.com/peterhinch/micropython-async/blob/master/v3/docs/DRIVERS.md):
6375
* Classes for interfacing switches, pushbuttons and ESP32 touch buttons.
6476
* Drivers for ADC's
6577
* Drivers for incremental encoders.
6678

67-
### 1.3.4 A scheduler
79+
### 1.3.5 A scheduler
6880

6981
This [lightweight scheduler](./docs/SCHEDULE.md) enables tasks to be scheduled
7082
at future times. These can be assigned in a flexible way: a task might run at
7183
4.10am on Monday and Friday if there's no "r" in the month.
7284

73-
### 1.3.5 Asynchronous interfaces
85+
### 1.3.6 Asynchronous interfaces
7486

7587
These device drivers are intended as examples of asynchronous code which are
7688
useful in their own right:

v3/docs/TUTORIAL.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ including device drivers, debugging aids, and documentation.
1111
# Contents
1212

1313
0. [Introduction](./TUTORIAL.md#0-introduction)
14-
0.1 [Installing uasyncio](./TUTORIAL.md#01-installing-uasyncio)
14+
0.1 [Installing uasyncio](./TUTORIAL.md#01-installing-uasyncio) Also the optional extensions.
1515
1. [Cooperative scheduling](./TUTORIAL.md#1-cooperative-scheduling)
1616
1.1 [Modules](./TUTORIAL.md#11-modules)
1717
     1.1.1 [Primitives](./TUTORIAL.md#111-primitives)
@@ -118,14 +118,12 @@ CPython V3.8 and above.
118118

119119
## 0.1 Installing uasyncio
120120

121-
Firmware builds after V1.13 incorporate `uasyncio`. The version may be checked
122-
by issuing at the REPL:
123-
```python
124-
import uasyncio
125-
print(uasyncio.__version__)
126-
```
127-
Version 3 will print a version number. Older versions will throw an exception:
128-
installing updated firmware is highly recommended.
121+
Firmware builds after V1.13 incorporate `uasyncio`. Check the firmware version
122+
number reported on boot and upgrade if necessary.
123+
124+
This repository has optional unofficial primitives and extensions. To install
125+
these the repo should be cloned to a PC. The directories `primitives` and
126+
`threadsafe` (with contents) should be copied to the hardware plaform.
129127

130128
###### [Main README](../README.md)
131129

0 commit comments

Comments
 (0)