Skip to content

Commit 86a5679

Browse files
committed
TUTORIAL.md: Rename uasyncio. Add note re task references.
1 parent dfeb18c commit 86a5679

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

v3/docs/TUTORIAL.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ import uasyncio as asyncio
1717
# Contents
1818

1919
0. [Introduction](./TUTORIAL.md#0-introduction)
20-
0.1 [Installing asyncio](./TUTORIAL.md#01-installing-asyncio) Also the optional extensions.
20+
0.1 [Installing asyncio primitives](./TUTORIAL.md#01-installing-asyncio-primitives) Extensions used in the demos.
2121
1. [Cooperative scheduling](./TUTORIAL.md#1-cooperative-scheduling)
2222
1.1 [Modules](./TUTORIAL.md#11-modules)
2323
     1.1.1 [Primitives](./TUTORIAL.md#111-primitives)
@@ -122,9 +122,8 @@ under MicroPython and CPython 3.8.
122122
This tutorial aims to present a consistent programming style compatible with
123123
CPython V3.8 and above.
124124

125-
## 0.1 Installing asyncio
125+
## 0.1 Installing asyncio primitives
126126

127-
The latest release build of firmware or a newer nightly build is recommended.
128127
This repository has optional unofficial primitives and extensions. To install
129128
these, connect the target hardware to WiFi and issue:
130129
```python
@@ -151,11 +150,17 @@ pitfalls associated with truly asynchronous threads of execution.
151150

152151
The directory `primitives` contains a Python package containing the following:
153152
* Synchronisation primitives: "micro" versions of CPython's classes.
154-
* Additional Python primitives including an ISR-compatible version of `Event`
155-
and a software retriggerable delay class.
153+
* Additional Python primitives including a software retriggerable delay class
154+
and a MicroPython optimised `ringbuf_queue`.
156155
* Primitives for interfacing hardware. These comprise classes for debouncing
157-
switches and pushbuttons and an asynchronous ADC class. These are documented
158-
[here](./DRIVERS.md).
156+
switches and pushbuttons, an `Encoder` class and an asynchronous ADC class.
157+
These are documented [here](./DRIVERS.md).
158+
* Primitives for event-based coding which aims to reduce the use of callbacks
159+
and is discussed [here](./EVENTS.md).
160+
161+
The directory `threadsafe` includes primitives designed to interface `asyncio`
162+
tasks to code running on other threads. These are documented
163+
[here](./THREADING.md).
159164

160165
See above for installation.
161166

0 commit comments

Comments
 (0)