LibDriver SHTC3
Loading...
Searching...
No Matches
driver_shtc3.h File Reference

driver shtc3 header file More...

#include <stdio.h>
#include <stdint.h>
#include <string.h>
Include dependency graph for driver_shtc3.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  shtc3_handle_s
 shtc3 handle structure definition More...
struct  shtc3_info_s
 shtc3 information structure definition More...

Macros

#define DRIVER_SHTC3_LINK_INIT(HANDLE, STRUCTURE)
 initialize shtc3_handle_t structure
#define DRIVER_SHTC3_LINK_IIC_INIT(HANDLE, FUC)
 link iic_init function
#define DRIVER_SHTC3_LINK_IIC_DEINIT(HANDLE, FUC)
 link iic_deinit function
#define DRIVER_SHTC3_LINK_IIC_READ_ADDRESS16(HANDLE, FUC)
 link iic_read_address16 function
#define DRIVER_SHTC3_LINK_IIC_WRITE_ADDRESS16(HANDLE, FUC)
 link iic_write_address16 function
#define DRIVER_SHTC3_LINK_DELAY_MS(HANDLE, FUC)
 link delay_ms function
#define DRIVER_SHTC3_LINK_DEBUG_PRINT(HANDLE, FUC)
 link debug_print function
#define DRIVER_SHTC3_LINK_RECEIVE_CALLBACK(HANDLE, FUC)
 link receive_callback function

Typedefs

typedef struct shtc3_handle_s shtc3_handle_t
 shtc3 handle structure definition
typedef struct shtc3_info_s shtc3_info_t
 shtc3 information structure definition

Enumerations

enum  shtc3_bool_t { SHTC3_BOOL_FALSE = 0x00 , SHTC3_BOOL_TRUE = 0x01 }
 shtc3 bool enumeration definition More...

Functions

uint8_t shtc3_info (shtc3_info_t *info)
 get chip's information
uint8_t shtc3_init (shtc3_handle_t *handle)
 initialize the chip
uint8_t shtc3_deinit (shtc3_handle_t *handle)
 close the chip
uint8_t shtc3_read (shtc3_handle_t *handle, shtc3_bool_t clock_stretching_enable, uint16_t *temperature_raw, float *temperature_s, uint16_t *humidity_raw, float *humidity_s)
 normal read
uint8_t shtc3_read_low_power (shtc3_handle_t *handle, shtc3_bool_t clock_stretching_enable, uint16_t *temperature_raw, float *temperature_s, uint16_t *humidity_raw, float *humidity_s)
 read in low power mode
uint8_t shtc3_soft_reset (shtc3_handle_t *handle)
 soft reset the chip
uint8_t shtc3_sleep (shtc3_handle_t *handle)
 sleep
uint8_t shtc3_wakeup (shtc3_handle_t *handle)
 wakeup
uint8_t shtc3_set_reg (shtc3_handle_t *handle, uint16_t command)
 set the chip register
uint8_t shtc3_get_reg (shtc3_handle_t *handle, uint16_t command, uint8_t *buf, uint16_t len)
 get the chip register

Detailed Description

driver shtc3 header file

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.

Version
1.0.0
Author
Shifeng Li
Date
2025-11-03

history

Date Version Author Description
2025/11/03 1.0 Shifeng Li first upload

Definition in file driver_shtc3.h.