Skip to content

Commit 57161f3

Browse files
committed
fixed some issues and improved third party libraries reference
1 parent 2d5956f commit 57161f3

File tree

1 file changed

+19
-30
lines changed

1 file changed

+19
-30
lines changed

README.md

Lines changed: 19 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
# Air Quality Sensors Library
55

6-
Generic sensor manager, abstractions and bindings of multiple sensors [libraries](https://github.com/kike-canaries/canairio_sensorlib/blob/master/platformio.ini#L18-L34): Honeywell, Plantower, Panasonic, Sensirion, etc. and CO2 sensors. Also it's handling others environment sensors. This library is for general purpose, but also is the sensors library base of [CanAirIO project](https://canair.io/docs).
6+
Generic sensor manager, abstractions and bindings of multiple sensors [libraries](https://github.com/kike-canaries/canairio_sensorlib/blob/master/unified-lib-deps.ini): Honeywell, Plantower, Panasonic, Sensirion, etc. and CO2 sensors. Also it's handling others environment sensors. This library is for general purpose, but also is the sensors library base of [CanAirIO project](https://canair.io/docs).
77

88
For developers also you can check the complete library documentation [here](http://hpsaturn.com/canairio_sensorlib_doc/html/index.html)
99

@@ -25,7 +25,7 @@ For developers also you can check the complete library documentation [here](http
2525
| Panasonic SN-GCJA5L | Yes | Yes | Auto | STABLE |
2626
| Plantower models | Yes | --- | Auto | STABLE |
2727
| Nova SDS011 | Yes | --- | Auto | STABLE |
28-
| IKEA Vindriktning | Yes | --- | Select | TESTING|
28+
| IKEA Vindriktning | Yes | --- | Select | STABLE |
2929
| Sensirion SPS30 | Yes | Yes | Select / Auto | STABLE |
3030

3131
NOTE: Panasonic via UART in ESP8266 maybe needs select in detection
@@ -49,11 +49,11 @@ NOTE: Panasonic via UART in ESP8266 maybe needs select in detection
4949
| SHT31 | i2c | Auto | STABLE |
5050
| AHT10 | i2c | Auto | STABLE |
5151
| BME280 | i2c | Auto | STABLE |
52-
| BMP280 | i2c | Auto | TESTING |
52+
| BMP280 | i2c | Auto | STABLE |
5353
| BME680 | i2c | Auto | STABLE |
54+
| DfRobot SEN0469 NH3 | i2c | Auto | TESTING |
55+
| DFRobot SEN0466 CO | i2c | Auto | TESTING |
5456
| DHTxx | TwoWire | Auto | DISABLED |
55-
| DfRobot SEN0469 NH3 | --- | Yes | Auto | TESTING |
56-
| DFRobot SEN0466 CO | --- | Yes | Auto | TESTING |
5757

5858
NOTE: DHT22 is supported but is not recommended. Please see the documentation.
5959

@@ -62,8 +62,8 @@ NOTE: DHT22 is supported but is not recommended. Please see the documentation.
6262
| Platform | Variants | Notes | Status |
6363
|:----------------------- |:-----:|:-------:|:----------:|
6464
| ESP32 | WROVER* | ESP32Devkit and similar (recommended) | STABLE |
65-
| ESP32S3 | LilyGo TDisplay | In testing | UNSTABLE |
66-
| ESP32C3 | Devkit v3 | In testing | UNSTABLE |
65+
| ESP32S3 | LilyGo TDisplay | In testing | STABLE |
66+
| ESP32C3 | Devkit v3 | In testing | STABLE |
6767
| ESP8266 | 12 | D1MINI tested and similar (old) | STABLE |
6868
| Atmelsam | seeed_wio_terminal | Only works via i2c on left port | STABLE |
6969
| Arduino | Atmel | Some third party libraries fails | IN PROGRESS |
@@ -74,9 +74,9 @@ NOTE: DHT22 is supported but is not recommended. Please see the documentation.
7474

7575
- Unified variables and getters for all sensors
7676
- Auto UART port selection (Hw, Sw, UART1, UART2, etc)
77-
- Multiple i2c reads and one UART sensor read support
77+
- Multiple i2c sensors and one UART sensor supported at the same time
7878
- Two I2C channel supported (Wire and Wire1)
79-
- Real time registry of sensors unit registered (see multivariable)
79+
- Real time registry of sensor units (see multivariable)
8080
- Get vendor names of all devices detected
8181
- Preselected main stream UART pins from popular boards
8282
- Auto config UART port for Plantower, Honeywell and Panasonic sensors
@@ -87,9 +87,8 @@ NOTE: DHT22 is supported but is not recommended. Please see the documentation.
8787
- Get unit symbol and name and each sub-sensor
8888
- Get the main group type: NONE, PM, CO2 and ENV.
8989
- Basic debug mode support toggle in execution
90-
- Basic power saving management with sample time > 30s on SPS30
9190

92-
Full list of all sub libraries supported [here](https://github.com/kike-canaries/canairio_sensorlib/blob/master/library.json#L72-L89)
91+
Full list of all sub libraries supported [here](https://github.com/kike-canaries/canairio_sensorlib/blob/master/unified-lib-deps.ini)
9392

9493
# Quick implementation
9594

@@ -172,7 +171,6 @@ In this [demo](https://www.youtube.com/watch?v=uxlmP905-FE) on a simple sketch y
172171

173172
[![CanAirIO Sensors Lib DEMO with M5CoreInk](https://img.youtube.com/vi/i15iEF47CbY/0.jpg)](https://youtu.be/i15iEF47CbY)
174173

175-
176174
## Multivariable alternative implementation
177175

178176
The last version added new getters to have the current status of each unit of each sensor connected to the device in real time. Also you can retrieve the list of device names and other stuff:
@@ -233,16 +231,14 @@ void setup() {
233231
void loop() {
234232
sensors.loop(); // read sensor data and showed it
235233
}
236-
```
237-
234+
```
238235

239-
## UART detection demo
236+
## UART detection demo
240237

241238
[![CanAirIO auto configuration demo](https://img.youtube.com/vi/hmukAmG5Eec/0.jpg)](https://www.youtube.com/watch?v=hmukAmG5Eec)
242239

243240
CanAirIO sensorlib auto configuration demo on [Youtube](https://www.youtube.com/watch?v=hmukAmG5Eec)
244241

245-
246242
# Wiring
247243

248244
The current version of library supports 3 kinds of wiring connection, UART, i2c and TwoWire, in the main boards the library using the defaults pins of each board, but in some special cases the pins are:
@@ -253,20 +249,20 @@ The current version of library supports 3 kinds of wiring connection, UART, i2c
253249

254250
The library has [pre-defined some UART pin configs](https://github.com/kike-canaries/canairio_sensorlib/blob/master/src/Sensors.hpp#L19-L52), these are selected on compiling time. Maybe you don't need change anything with your board, and maybe the nexts alternatives works for you:
255251

256-
| Board model | TX | RX | Notes
252+
| Board model | TX | RX | Notes |
257253
|:---------------|:---:|:---:|:------------------:|
258254
| ESP32GENERIC | 1 | 3 | ESP32 Pio defaults
259255
| TTGOT7 / ESP32DEVKIT / D1MINI / NODEFINED | 16 | 17 | CanAirIO devices **
260256
| TTGO_TDISPLAY | 12 | 13 | |
261257
| M5COREINK | 14 | 13 | |
262258
| TTGO TQ | 18 | 13 | |
263-
| HELTEC | 18 | 17 | |
259+
| HELTEC | 18 | 17 | |
264260
| WEMOSOLED | 15 | 13 | |
265261
| ESP32PICOD4 | 3 | 1 | |
266262

267263
** This pines are when you compile your project without specific any build variable or you board isn't in the list.
268264

269-
### Custom UART:
265+
### Custom UART
270266

271267
Also you could define a custom UART pins in the init() method and select specific sensors model, like this:
272268

@@ -282,27 +278,22 @@ We are using the default pins for each board, some times it's pins are 21,22, pl
282278

283279
For now we are using it only for DHT sensors in PIN 23. For more info please review the next lines [here](https://github.com/kike-canaries/canairio_sensorlib/blob/master/src/Sensors.hpp#L19-L52).
284280

285-
286281
# Examples
287282

288283
### PlatformIO (recommended)
289284

290-
#### Compiling and Installing
291-
292285
We recommended PlatformIO because is more easy than Arduino IDE. For this, please install first [PlatformIO](http://platformio.org/) and its command line tools (Windows, MacOs and Linux), **pio** command, then connect your compatible board to the USB and run the next command:
293286

294287
```python
295-
pio run --target upload
288+
pio run -e esp32 --target upload
296289
```
297290

298291
### Arduino IDE
299292

300-
Only import the `ino` file of the sample and install the libraries listed on `library.json` and this library.
293+
Only import the `ino` file of the sample and install the libraries listed on `library.json` and this library. Complete list of libraries used [here](https://github.com/kike-canaries/canairio_sensorlib/blob/master/unified-lib-deps.ini)
301294

302295
### Arduino CLI
303296

304-
#### Prerequisites
305-
306297
For run the examples, you first need to install **arduino-cli** or the **Arduino IDE** with the libraries referenced in **lib_deps** on the file [platformio.ini](https://github.com/kike-canaries/canairio_sensorlib/blob/master/platformio.ini), becuase **Arduino don't install it automatically** like PlatformIO. Then put CanAirIO sensor library in your library directory, you can download it from [releases](https://github.com/kike-canaries/canairio_sensorlib/releases) section.
307298

308299
Also you need to add the **alternative links** for supporting the ESP32 boards:
@@ -318,9 +309,7 @@ board_manager:
318309
additional_urls:
319310
- https://arduino.esp8266.com/stable/package_esp8266com_index.json
320311
- https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json
321-
```
322-
323-
#### Compiling and Installing
312+
```
324313
325314
From `arduino-cli` you can run the basic example in a ESP32 board following these steps:
326315

@@ -354,7 +343,6 @@ Also you can make a donation, be a patreon or buy a device:
354343
- **Buy a device**: [CanAirIO Bike in Tindie](https://www.tindie.com/products/hpsaturn/canairio-bike/)
355344
- [Inviting us **a coffee**](https://www.buymeacoffee.com/hpsaturn)
356345

357-
358346
# TODO
359347

360348
- [x] Auto detection for UART sensors (Honeywell, Panasonic and Plantower)
@@ -372,6 +360,7 @@ Also you can make a donation, be a patreon or buy a device:
372360
- [x] SenseAir S8 via UART support
373361
- [x] Multivariable selection (getNextUnit(),getUnitName(),etc)
374362
- [x] Two I2C channel supported for M5Stack Devices (M5StickC tested)
363+
- [x] Added CO and NH3 sensors
375364
- [ ] Sea level setting for Pressure sensors and others
376365
- [ ] Support to second UART port
377366

0 commit comments

Comments
 (0)