Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/libdriver/sgp30
SGP30 full function driver library for general MCU and Linux.
https://github.com/libdriver/sgp30
c co2 full-function-driver iic linux mcu sgp30 tvoc
Last synced: 11 days ago
JSON representation
SGP30 full function driver library for general MCU and Linux.
- Host: GitHub
- URL: https://github.com/libdriver/sgp30
- Owner: libdriver
- License: mit
- Created: 2021-05-16T07:08:20.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-31T12:36:39.000Z (2 months ago)
- Last Synced: 2024-10-11T00:18:58.793Z (28 days ago)
- Topics: c, co2, full-function-driver, iic, linux, mcu, sgp30, tvoc
- Language: C
- Homepage: https://www.libdriver.com
- Size: 4.13 MB
- Stars: 47
- Watchers: 19
- Forks: 27
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
[English](/README.md) | [ 简体中文](/README_zh-Hans.md) | [繁體中文](/README_zh-Hant.md) | [日本語](/README_ja.md) | [Deutsch](/README_de.md) | [한국어](/README_ko.md)
## LibDriver SGP30
[](/misra/README.md) [](https://www.libdriver.com/docs/sgp30/index.html) [](/LICENSE)
The SGP30 is a digital multi-pixel gas sensor designed for easy integration into air purifier, demand-controlled ventilation, and IoT applications. Sensirion’s CMOSens technology offers a complete sensor system on a single chip featuring a digital I2C interface, a temperature controlled micro hotplate, and two preprocessed indoor air quality signals. As the first metal-oxide gas sensor featuring multiple sensing elements on one chip, the SGP30 provides more detailed information about the air quality.The sensing element features an unmatched robustness against contaminating gases present in real-world applications enabling a unique long-term stability and low drift. The very small 2.45 x 2.45 x 0.9 mm3 DFN package enables applications in limited spaces. Sensirion’s state-of-the-art production process guarantees high reproducibility and reliability. Tape and reel packaging, together with suitability for standard SMD assembly processes make the SGP30 predestined for high-volume applications.
LibDriver SGP30 is a full function driver of SGP30 launched by LibDriver.It provides TVOC, CO2 eq reading, temperature and humidity correction and other functions.LibDriver is MISRA compliant.
### Table of Contents
- [Instruction](#Instruction)
- [Install](#Install)
- [Usage](#Usage)
- [example basic](#example-basic)
- [example advance](#example-advance)
- [Document](#Document)
- [Contributing](#Contributing)
- [License](#License)
- [Contact Us](#Contact-Us)
### Instruction
/src includes LibDriver SGP30 source files.
/interface includes LibDriver SGP30 IIC platform independent template.
/test includes LibDriver SGP30 driver test code and this code can test the chip necessary function simply.
/example includes LibDriver SGP30 sample code.
/doc includes LibDriver SGP30 offline document.
/datasheet includes SGP30 datasheet.
/project includes the common Linux and MCU development board sample code. All projects use the shell script to debug the driver and the detail instruction can be found in each project's README.md.
/misra includes the LibDriver MISRA code scanning results.
### Install
Reference /interface IIC platform independent template and finish your platform IIC driver.
Add the /src directory, the interface driver for your platform, and your own drivers to your project, if you want to use the default example drivers, add the /example directory to your project.
### Usage
You can refer to the examples in the /example directory to complete your own driver. If you want to use the default programming examples, here's how to use them.
#### example basic
```C
#include "driver_sgp30_basic.h"
uint8_t res;
uint8_t i;
uint16_t co2_eq_ppm;
uint16_t tvoc_ppb;
res = sgp30_basic_init();
if (res != 0)
{
return 1;
}
...
for (i = 0; i < 3; i++)
{
sgp30_interface_delay_ms(1000);
res = sgp30_basic_read((uint16_t *)&co2_eq_ppm, (uint16_t *)&tvoc_ppb);
if (res != 0)
{
(void)sgp30_basic_deinit();
return 1;
}
sgp30_interface_debug_print("sgp30: co2 eq is %d ppm.\n", co2_eq_ppm);
sgp30_interface_debug_print("sgp30: tvoc is %d ppb.\n", tvoc_ppb);
...
}
...
(void)sgp30_basic_deinit();
return 0;
```
#### example advance
```C
#include "driver_sgp30_advance.h"
uint8_t res;
uint8_t i;
uint16_t co2_eq_ppm;
uint16_t tvoc_ppb;
uint16_t id[3];
uint8_t product_type;
uint8_t product_version;
res = sgp30_advance_init();
if (res != 0)
{
return 1;
}
...
res = sgp30_advance_get_serial_id((uint16_t *)id);
if (res != 0)
{
(void)sgp30_advance_deinit();
return 1;
}
sgp30_interface_debug_print("sgp30: serial id 0x%04X 0x%04X 0x%04X.\n", (uint16_t)(id[0]), (uint16_t)(id[1]), (uint16_t)(id[2]))
...
res = sgp30_advance_get_feature((uint8_t *)&product_type, (uint8_t *)&product_version);
if (res != 0)
{
(void)sgp30_advance_deinit();
return 1;
}
sgp30_interface_debug_print("sgp30: product type is 0x%02X.\n", product_type);
sgp30_interface_debug_print("sgp30: product version is 0x%02X.\n", product_version);
...
res = sgp30_advance_set_iaq_baseline(0x01, 0x02);
if (res != 0)
{
(void)sgp30_advance_deinit();
return 1;
}
...
res = sgp30_advance_set_absolute_humidity(25.6, 30.2f);
if (res != 0)
{
(void)sgp30_advance_deinit();
return 1;
}
...
for (i = 0; i < 3; i++)
{
sgp30_interface_delay_ms(1000);
res = sgp30_advance_read((uint16_t *)&co2_eq_ppm, (uint16_t *)&tvoc_ppb);
if (res != 0)
{
(void)sgp30_advance_deinit();
return 1;
}
sgp30_interface_debug_print("sgp30: co2 eq is %d ppm.\n", co2_eq_ppm);
sgp30_interface_debug_print("sgp30: tvoc is %d ppb.\n", tvoc_ppb);
...
}
...
(void)sgp30_advance_deinit();
return 0;
```
### Document
Online documents: [https://www.libdriver.com/docs/sgp30/index.html](https://www.libdriver.com/docs/sgp30/index.html).
Offline documents: /doc/html/index.html.
### Contributing
Please refer to CONTRIBUTING.md.
### License
Copyright (c) 2015 - present LibDriver All rights reserved
The MIT License (MIT)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
### Contact Us
Please send an e-mail to [email protected].