Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/libdriver/sht4x
SHT4X(SHT40, SHT41, SHT45) full function driver library for general MCU and Linux.
https://github.com/libdriver/sht4x
c full-function-driver humidity iic linux mcu sht40 sht41 sht45 sht4x temprature
Last synced: about 2 months ago
JSON representation
SHT4X(SHT40, SHT41, SHT45) full function driver library for general MCU and Linux.
- Host: GitHub
- URL: https://github.com/libdriver/sht4x
- Owner: libdriver
- License: mit
- Created: 2023-06-23T07:03:40.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-31T12:38:07.000Z (4 months ago)
- Last Synced: 2024-10-11T00:18:59.202Z (2 months ago)
- Topics: c, full-function-driver, humidity, iic, linux, mcu, sht40, sht41, sht45, sht4x, temprature
- Language: C
- Homepage: https://www.libdriver.com
- Size: 2.93 MB
- Stars: 30
- Watchers: 7
- Forks: 7
- 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 SHT4X
[](/misra/README.md) [](https://www.libdriver.com/docs/sht4x/index.html) [](/LICENSE)
SHT4X is a digital sensor platform for measuring relative humidity and temperature at different accuracy classes. Its I2C interface provides several preconfigured I2C addresses while maintaining an ultra-low power budget (0.4 μW). The power-trimmed internal heater can be used at three heating levels thus enabling sensor operation in demanding environments. The four-pin dual-flatno-leads package is suitable for surface mount technology (SMT) processing and comprises an optional on-package patented PTFE membrane or a removable protective cover. Sensor specific calibration certificates according to ISO17025, identifiable through unique serial number, are available.
LibDriver SHT4X is the full function driver of SHT4X launched by LibDriver.It provides functions of temperature and humidity reading and serial number reading. LibDriver is MISRA compliant.
### Table of Contents
- [Instruction](#Instruction)
- [Install](#Install)
- [Usage](#Usage)
- [example basic](#example-basic)
- [Document](#Document)
- [Contributing](#Contributing)
- [License](#License)
- [Contact Us](#Contact-Us)
### Instruction
/src includes LibDriver SHT4X source files.
/interface includes LibDriver SHT4X IIC platform independent template.
/test includes LibDriver SHT4X driver test code and this code can test the chip necessary function simply.
/example includes LibDriver SHT4X sample code.
/doc includes LibDriver SHT4X offline document.
/datasheet includes SHT4X 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_sht4x_basic.h"
uint8_t res;
uint8_t num[4];
uint32_t i;
float temperature;
float humidity;
/* basic init */
res = sht4x_basic_init(SHT4X_ADDRESS_0);
if (res != 0)
{
return 1;
}
...
/* loop */
for (i = 0; i < 3; i++)
{
/* delay 1000ms */
sht4x_interface_delay_ms(1000);
/* read data */
res = sht4x_basic_read((float *)&temperature, (float *)&humidity);
if (res != 0)
{
(void)sht4x_basic_deinit();
return 1;
}
/* output */
sht4x_interface_debug_print("sht4x: %d/%d.\n", (uint32_t)(i + 1), (uint32_t)3);
sht4x_interface_debug_print("sht4x: temperature is %0.2fC.\n", temperature);
sht4x_interface_debug_print("sht4x: humidity is %0.2f%%.\n", humidity);
}
...
/* get serial number */
res = sht4x_basic_get_serial_number(num);
if (res != 0)
{
(void)sht4x_basic_deinit();
return 1;
}
/* output */
sht4x_interface_debug_print("sht4x: serial number is 0x%02X 0x%02X 0x%02X 0x%02X.\n", num[0], num[1], num[2], num[3]);
...
/* basic deinit */
(void)sht4x_basic_deinit();
return 0;
```
### Document
Online documents: [https://www.libdriver.com/docs/sht4x/index.html](https://www.libdriver.com/docs/sht4x/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].