Skip to content

Commit d6ef2b0

Browse files
committed
README improvements.
1 parent dbdbb22 commit d6ef2b0

File tree

1 file changed

+18
-10
lines changed

1 file changed

+18
-10
lines changed

README.md

+18-10
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
Notes on Unix version.
2-
31
# Introduction
42

53
This library provides a resilient full duplex communication link between a WiFi
@@ -14,6 +12,8 @@ Python objects to be exchanged. Guaranteed message delivery is available.
1412

1513
This project is a collaboration between Peter Hinch and Kevin Köck.
1614

15+
As of July 2020 it has been updated to use (and require) `uasyncio` V3.
16+
1717
# 0. MicroPython IOT application design
1818

1919
IOT (Internet of Things) systems commonly comprise a set of endpoints on a WiFi
@@ -96,7 +96,15 @@ but one which persists through outages and offers guaranteed message delivery.
9696
2.1 [Protocol](./README.md#21-protocol)
9797
3. [Files and packages](./README.md#3-files-and-packages)
9898
3.1 [Installation](./README.md#31-installation)
99+
     3.1.1 [Existing users](./README.md#311-existing_users)
100+
     3.1.2 [Firmware and dependency](./README.md#312-firmware-and-dependency)
101+
     3.1.3 [Preconditions for demos](./README.md#313-preconditions-for-demos)
99102
3.2 [Usage](./README.md#32-usage)
103+
     3.2.1 [The main demo](./README.md#321-the-main-demo)
104+
     3.2.2 [The remote control demo](./README.md#322-the-remote-control-demo)
105+
     3.2.3 [Quality of Service demo](./README.md#323-quality-of-service-demo)
106+
     3.2.4 [The fast qos demo](./README.md#324-the-fast-qos-demo)
107+
     3.2.5 [Troubleshooting the demos](./README.md#325-troubleshooting-the-demos)
100108
4. [Client side applications](./README.md#4-client-side-applications)
101109
4.1 [The Client class](./README.md#41-the-client-class)
102110
4.1.1 [Initial Behaviour](./README.md#411-initial-behaviour)
@@ -187,7 +195,7 @@ This section describes the installation of the library and the demos. The
187195
ESP8266 has limited RAM: there are specific recommendations for installation on
188196
that platform.
189197

190-
#### Existing users
198+
### 3.1.1 Existing users
191199

192200
It is recommended to remove the old version and re-install as below.
193201

@@ -196,7 +204,7 @@ event loop argument is no longer required or accepted in `Client` and `Server`
196204
constructors. The directory structure has changed, requiring minor changes to
197205
`import` statements.
198206

199-
#### Firmware/Dependency
207+
### 3.1.2 Firmware and dependency
200208

201209
On ESP8266, RAM can be saved by building firmware from source, freezing
202210
`client.py` as bytecode. If this is not done, it is necessary to
@@ -235,7 +243,7 @@ use of `client.mpy`:
235243
rm /pyboard/iot/client.py
236244
```
237245

238-
#### Preconditions for demos
246+
### 3.1.3 Preconditions for demos
239247

240248
The demo programs store client configuration data in a file `local.py`. Each
241249
demo has its own `local.py` located in the directory of the demo code. This
@@ -265,7 +273,7 @@ MicroPython.
265273

266274
## 3.2 Usage
267275

268-
#### The main demo
276+
### 3.2.1 The main demo
269277

270278
This illustrates up to four clients communicating with the server. The demo
271279
expects the clients to have ID's in the range 1 to 4: if using multiple clients
@@ -284,7 +292,7 @@ On each client run:
284292
import iot.examples.c_app
285293
```
286294

287-
#### The remote control demo
295+
### 3.2.2 The remote control demo
288296

289297
This shows one ESP8266 controlling another. The transmitter should have a
290298
pushbutton between GPIO 0 and gnd, both should have an LED on GPIO 2.
@@ -305,7 +313,7 @@ import iot.remote.c_comms_tx
305313
import iot.remote.c_comms_rx
306314
```
307315

308-
#### The standard qos (Quality of service) demo
316+
### 3.2.3 Quality of Service demo
309317

310318
This test program verifies that each message (in each direction) is received
311319
exactly once. On the server navigate to the parent directory of `iot` and run:
@@ -321,7 +329,7 @@ On the client, after editing `/pyboard/qos/local.py`, run:
321329
import iot.qos.c_qos
322330
```
323331

324-
#### The fast qos demo
332+
### 3.2.4 The fast qos demo
325333

326334
This tests the option of concurrent `qos` writes. This is an advanced feature
327335
discussed in [section 7.1](./README.md#71-the-wait-argument). To run the demo,
@@ -338,7 +346,7 @@ On the client, after editing `/pyboard/qos/local.py`, run:
338346
import iot.qos.c_qos_fast
339347
```
340348

341-
#### Troubleshooting the demos
349+
### 3.2.5 Troubleshooting the demos
342350

343351
If `local.py` specifies an SSID, on startup the demo programs will pause
344352
indefinitely if unable to connect to the WiFi. If `SSID` is an empty string the

0 commit comments

Comments
 (0)