From 3cf326b9b3c8855da3c8703db401f01324af9645 Mon Sep 17 00:00:00 2001 From: Simon Albinsson Date: Sat, 17 Mar 2018 22:15:51 +0100 Subject: [PATCH] Updates readme with project description --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 172a809..eadb08f 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,13 @@ # RPI_SGP30 -Python-based SPI30 "program" for the SGP30 + +Based on the smbus2 for ease of use. Program to read eCO_2 and TVOC from the [https://www.sensirion.com/fileadmin/user_upload/customers/sensirion/Dokumente/9_Gas_Sensors/Sensirion_Gas_Sensors_SGP30_Datasheet_EN.pdf](SGP30 sensor). + +It currently lacks support for many features features and is more of a crude demo than a proper library. + +## Features that are known to be missing (listing in rough order of importance): +* CRC support +* reading/writing base-line data +* reading raw-values +* Proper structuring of the code + +If you have the AdaFruit board with built in level shifters and voltage regulator it is should work if you just plug in [https://pinout.xyz/pinout/i2c](SDA to pin 3, SCL to pin 5, VCC to pin 17 and GND to pin 20). You should then be able to find the SGP30 an address 0x58 using `i2cdetect -y 1`. If you get an error message you probbably need to enable i2c in the kernel using [https://learn.sparkfun.com/tutorials/raspberry-pi-spi-and-i2c-tutorial](`raspi-config` and reboot)