Skip to content

Commit e51cc4e

Browse files
committed
Merge branch 'develop'
2 parents 9272688 + e4e2a3e commit e51cc4e

File tree

2 files changed

+17
-3
lines changed

2 files changed

+17
-3
lines changed

README.md

+17-2
Original file line numberDiff line numberDiff line change
@@ -46,12 +46,14 @@ A full example is provided in `/example` directory.
4646

4747
#### 1a - **network-enabled MicroPython ports**
4848

49+
> Warning: in latest MicroPython releases `upip` has been deprecated in favor of [`mip`](https://docs.micropython.org/en/latest/reference/packages.html#package-management). Please use the manual installation until I set up the driver to work with `mip`.
50+
4951
To include the library into a network-enabled MicroPython project, it's sufficient to install the package using `upip`:
5052

5153
```python
5254
import upip
5355

54-
upip.install(micropython - max30102)
56+
upip.install("micropython-max30102")
5557
```
5658

5759
Make sure that your firmware runs these lines **after** an Internet connection has been established.
@@ -62,7 +64,20 @@ content into your microcontroller. If you prefer, you can perform a manual insta
6264
#### 1b - **manual way** (no Internet access required)
6365

6466
To directly include the library into a MicroPython project, it's sufficient to copy `max30102/circular_buffer.py`
65-
and `max30102/max30102.py` next to your `main.py` file, into a `lib` directory. Then, import the constructor as follows:
67+
and `max30102/max30102.py` next to your `main.py` file, into a `lib` directory.
68+
69+
The folder tree should look as follows:
70+
71+
```text
72+
.
73+
┣ 📜 boot.py
74+
┣ 📜 main.py
75+
┗ 📂 lib
76+
┣ 📜 max30102.py
77+
┗ 📜 circular_buffer.py
78+
```
79+
80+
Then, import the constructor as follows:
6681

6782
```python
6883
from max30102 import MAX30102

max30102/max30102.py

-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@
1414
# This driver aims at giving almost full access to Maxim MAX30102 functionalities.
1515
# n-elia
1616

17-
import uerrno
1817
from machine import SoftI2C
1918
from ustruct import unpack
2019
from utime import sleep_ms, ticks_diff, ticks_ms

0 commit comments

Comments
 (0)