Skip to content

Commit 2129a07

Browse files
committed
Add sw_array.py and 1st pass at docs.
1 parent 1e27280 commit 2129a07

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

v3/docs/DRIVERS.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,10 @@ To install the library, connect the target hardware to WiFi and issue:
4848
import mip
4949
mip.install("github:peterhinch/micropython-async/v3/primitives")
5050
```
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).
51+
For any target including non-networked ones use `mpremote`:
52+
```bash
53+
$ mpremote mip install "github:peterhinch/micropython-async/v3/primitives"
54+
```
5355

5456
Drivers are imported with:
5557
```python
@@ -102,7 +104,7 @@ implicit: contact bounce will not cause spurious execution of the `callable`.
102104
Constructor argument (mandatory):
103105

104106
1. `pin` The initialised Pin instance.
105-
107+
106108
Methods:
107109

108110
1. `close_func` Args: `func` (mandatory) a `callable` to run on contact

v3/docs/EVENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -620,7 +620,7 @@ enabling scan codes and event types to be retrieved with an asynchronous iterato
620620

621621
```python
622622
import asyncio
623-
from primitives import SwArray
623+
from primitives.sw_array import SwArray, CLOSE, OPEN, LONG, DOUBLE, SUPPRESS
624624
from machine import Pin
625625
rowpins = [Pin(p, Pin.OPEN_DRAIN) for p in range(10, 14)]
626626
colpins = [Pin(p, Pin.IN, Pin.PULL_UP) for p in range(16, 20)]

0 commit comments

Comments
 (0)