File tree 3 files changed +26
-8
lines changed 3 files changed +26
-8
lines changed Original file line number Diff line number Diff line change @@ -42,9 +42,14 @@ goes outside defined bounds.
42
42
43
43
# 2. Installation and usage
44
44
45
- The drivers require firmware version >=1.15. The drivers are in the primitives
46
- package. To install copy the ` primitives ` directory and its contents to the
47
- target hardware.
45
+ The latest release build of firmware or a newer nightly build is recommended.
46
+ To install the library, connect the target hardware to WiFi and issue:
47
+ ``` python
48
+ import mip
49
+ mip.install(" github:peterhinch/micropython-async/v3/primitives" )
50
+ ```
51
+ For non-networked targets use ` mpremote ` as described in
52
+ [ the official docs] ( http://docs.micropython.org/en/latest/reference/packages.html#installing-packages-with-mpremote ) .
48
53
49
54
Drivers are imported with:
50
55
``` python
Original file line number Diff line number Diff line change @@ -16,6 +16,15 @@ the `ThreadSafeFlag` class does not work under the Unix build. The classes
16
16
presented here depend on this: none can be expected to work on Unix until this
17
17
is fixed.
18
18
19
+ To install the threadsafe classes discussed here, connect the target hardware
20
+ to WiFi and issue:
21
+ ``` python
22
+ import mip
23
+ mip.install(" github:peterhinch/micropython-async/v3/threadsafe" )
24
+ ```
25
+ For non-networked targets use ` mpremote ` as described in
26
+ [ the official docs] ( http://docs.micropython.org/en/latest/reference/packages.html#installing-packages-with-mpremote ) .
27
+
19
28
###### [ Main README] ( ../README.md )
20
29
###### [ Tutorial] ( ./TUTORIAL.md )
21
30
Original file line number Diff line number Diff line change @@ -118,12 +118,16 @@ CPython V3.8 and above.
118
118
119
119
## 0.1 Installing uasyncio
120
120
121
- Firmware builds after V1.13 incorporate ` uasyncio ` . Check the firmware version
122
- number reported on boot and upgrade if necessary.
123
-
121
+ The latest release build of firmware or a newer nightly build is recommended.
124
122
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.
123
+ these, connect the target hardware to WiFi and issue:
124
+ ``` python
125
+ import mip
126
+ mip.install(" github:peterhinch/micropython-async/v3/primitives" )
127
+ mip.install(" github:peterhinch/micropython-async/v3/threadsafe" )
128
+ ```
129
+ For non-networked targets use ` mpremote ` as described in
130
+ [ the official docs] ( http://docs.micropython.org/en/latest/reference/packages.html#installing-packages-with-mpremote ) .
127
131
128
132
###### [ Main README] ( ../README.md )
129
133
You can’t perform that action at this time.
0 commit comments