Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Doc for new release
  • Loading branch information
mamin27 authored Jul 11, 2024
1 parent d8e7f8a commit 87865cc
Showing 1 changed file with 29 additions and 9 deletions.
38 changes: 29 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ecomet_i2c_raspberry_tools

**Last modification:** 12.03.2024
**Last modification:** 11.07.2024
**Contributor:** Marian Minar

**Dont forget to add ![/python_test_script/display/images/star.png](https://github.com/mamin27/ecomet_i2c_raspberry_tools/blob/master/python_test_scripts/display/images/star.png) if you were satisfy with the software!**
Expand All @@ -21,19 +21,22 @@ Project eCScope was created to show progress in development. Insert the #eCScope
**Current release:** 0.1.8

**New features**

* AXP209 driver added (X-Powers)
* TSL25911 driver added (Osram-AMS)
* add i2c_interface parameter as switch for libraries Adafruit_PureIO or smbus2
* Add Allwiner CPU A10 driver, olimex OLinuXino A10
* update load_config_yaml
* Add Allwiner CPU A10 driver, olimex OLinuXino A10 update load_config_yaml

Python3 library - **Stable status**
```sh
pip install ecomet-i2c-sensors
```
**Test release:** 0.1.9.post1
**Test release:** 0.1.9.post2
* AS3935 driver added (Sciosens)
* SGP40 driver added (Sensirion)
* MCP3221 driver added (Microchip)
* MCP3221 added feature for convert measured number to range or 360 degree, or cardinal points
* Fixes in PCA9632, prepared for multiple chips at I2C bus

Python3 library - **Alpfa status**
```sh
pip3 install -i https://test.pypi.org/simple/ecomet-i2c-sensors
```
Expand All @@ -51,7 +54,7 @@ The Driver for I2C Chip maintenance from **Raspberry PI 1B+** and above and **Al
* EEPROM Chip
24c01,24c02,24c04,24c08,24c16,24c32,24c64,24c128,24c256,24c512,24c1024
* [Measurement Specialties, TE Connectivity](https://www.te.com/) MS5637,HTU21D
* [Microchip](https://ww1.microchip.com/downloads/en/DeviceDoc/2301.pdf) EMC2301
* [Microchip](https://ww1.microchip.com/downloads/en/DeviceDoc/2301.pdf) EMC2301, MCP3221
* [NXP Semiconductor](https://www.nxp.com/)
PCA9632 (could be modified for PCA9624,PCA9635PW,PCA9685,PCA9955B,PCA9956B)
PCA9557
Expand All @@ -74,10 +77,11 @@ The Driver for I2C Chip maintenance from **Raspberry PI 1B+** and above and **Al
* [HTU21D module](ecomet_i2c_sensors/htu21/htu21_python_IIC.md) -> Digital Relative Humidity sensor with Temperature output, calculation of Dew Point
* [INA226,INA260 module](ecomet_i2c_sensors/ina260/ina260_python.IIC.md) -> Precision Digital Current and Power Monitor With Low-Drift, Precision Integrated Shunt
* ISL2802x module -> will be added python module description
* [MCP3221 module](https://ww1.microchip.com/downloads/en/DeviceDoc/20001732E.pdf) -> **!NEW!** Low-Power 12-Bit A/D Converter
* [MS5637 module](ecomet_i2c_sensors/ms5637/ms5637_python.IIC.md) -> Ultra-compact micro altimeter. Integrated digital pressure sensor (24 bit ΔΣ ADC), Operating range: 300 to 1200 mbar, -40 to +85 °C
* [PCA9557 module](ecomet_i2c_sensors/pca9557/pca9557_python.IIC.md) -> Remote8-Bit I2C and SMBusLow-PowerI/O ExpanderWith Reset andConfigurationRegisters
* [PCA9632 module](fpc/pca9632/pca9632_IIC.md) -> 4-bit Fm+ I2C-bus low power LED driver (could be used for motor control)
* [SGP40 module](https://sensirion.com/products/catalog/SGP40) -> **!NEW!** Indoor Air Quality Sensor for VOC Measurements
* [SGP40 module](https://sensirion.com/products/catalog/SGP40) -> Indoor Air Quality Sensor for VOC Measurements
* [SN-GCJA5](ecomet_i2c_sensors/sn_gcja5/sn_gcja5_python.IIC.md) -> Laser Type PM Sensor
* [SSD1306 module](ecomet_i2c_sensors/ssd1306/ssd1306_python.IIC.md) -> SSD1306 is a single-chip CMOS OLED/PLED driver with controller for organic / polymer light emitting
diode dot-matrix graphic display system.
Expand All @@ -97,11 +101,12 @@ diode dot-matrix graphic display system.
| HTU21D |[yes](ecomet_i2c_sensors/htu21/htu21_python_IIC.md)| no |[I03](https://github.com/mamin27/ecomet_i2c_raspberry_tools/wiki/_temp_hmd_board),[I04](https://github.com/mamin27/ecomet_i2c_raspberry_tools/wiki/_temp_hmd_pressure_board)| | | |
| INA226, INA260 |[yes](ecomet_i2c_sensors/ina260/ina260_python_IIC.md)| yes |[I01](https://github.com/mamin27/ecomet_i2c_raspberry_tools/wiki/_display_current_board) | | |
| ISL2802x |in progress | no | | | |
| MCP3221 |yes [check](wiki/common/support.md) | no | | | |
| MS5637 |[yes](ecomet_i2c_sensors/ms5637/ms5637_python.IIC.md)| no |[I04](https://github.com/mamin27/ecomet_i2c_raspberry_tools/wiki/_temp_hmd_pressure_board)| | |
| PCA9557 |[yes](ecomet_i2c_sensors/pca9557/pca9557_python.IIC.md)| no |[I01](https://github.com/mamin27/ecomet_i2c_raspberry_tools/wiki/_display_current_board)| | |
| PCA9632 |[yes](ecomet_i2c_sensors/pca9632/pca_9632_python_IIC.md)|[yes](fpc/pca9632/pca9632_IIC.md)|[I04](https://github.com/mamin27/ecomet_i2c_raspberry_tools/wiki/_temp_hmd_pressure_board)| | | |
|SN-GCJA5|yes [check](wiki/common/support.md)| no | | | |
|**!NEW!** SGP40|yes [check](wiki/common/support.md)| no | | | |
|SGP40|yes [check](wiki/common/support.md)| no | | | |
| SSD1306 |[yes](ecomet_i2c_sensors/ssd1306/ssd1306_python.IIC.md)| no |[I01](https://github.com/mamin27/ecomet_i2c_raspberry_tools/wiki/_display_current_board) | | |
|TSL25911|yes [check](wiki/common/support.md)| no | | | |

Expand All @@ -123,6 +128,18 @@ i2c:
ic: '24c01'
slaveaddr: 0x50
writestrobe: 26 # hold pin low to write to eeprom
sensor:
ms5637:
pressure:
{ min: 600, max: 1300 }
sn_gcja5:
PM1_0:
{ min: 0, max: 1200 }
PM2_5:
{ min: 0, max: 1200 }
PM10:
{ min: 0, max: 1200 }

```
| parameter | sub-parameter | description | example value |
Expand All @@ -133,6 +150,9 @@ i2c:
| | ic: | 24x00 series of eeprom chip name | '24c01' |
| | slaveaddr: | address of eeprom chip in hex | 0x50 |
| | writestrobe: | GPIO pin number used as CS (chip select) signal for eeprom IC | 26 |
| sensor: ||part for setting particular sensors ||
| | ms5637: | preasure min max | { min: 600, max: 1300 }|
| | sn_gcja5: | air quality min max ||
**Note: Currently only one eeprom chip could be added.**
Expand Down

0 comments on commit 87865cc

Please sign in to comment.