LibDriver HDC2080
Loading...
Searching...
No Matches
driver_hdc2080.h File Reference

driver hdc2080 header file More...

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

Go to the source code of this file.

Data Structures

struct  hdc2080_handle_s
 hdc2080 handle structure definition More...
struct  hdc2080_info_s
 hdc2080 information structure definition More...

Macros

#define DRIVER_HDC2080_LINK_INIT(HANDLE, STRUCTURE)
 initialize hdc2080_handle_t structure
#define DRIVER_HDC2080_LINK_IIC_INIT(HANDLE, FUC)
 link iic_init function
#define DRIVER_HDC2080_LINK_IIC_DEINIT(HANDLE, FUC)
 link iic_deinit function
#define DRIVER_HDC2080_LINK_IIC_READ(HANDLE, FUC)
 link iic_read function
#define DRIVER_HDC2080_LINK_IIC_WRITE(HANDLE, FUC)
 link iic_write function
#define DRIVER_HDC2080_LINK_DELAY_MS(HANDLE, FUC)
 link delay_ms function
#define DRIVER_HDC2080_LINK_DEBUG_PRINT(HANDLE, FUC)
 link debug_print function

Typedefs

typedef struct hdc2080_handle_s hdc2080_handle_t
 hdc2080 handle structure definition
typedef struct hdc2080_info_s hdc2080_info_t
 hdc2080 information structure definition

Enumerations

enum  hdc2080_address_t { HDC2080_ADDRESS_0 = (0x40 << 1) , HDC2080_ADDRESS_1 = (0x41 << 1) }
 hdc2080 address enumeration definition More...
enum  hdc2080_bool_t { HDC2080_BOOL_FALSE = 0x00 , HDC2080_BOOL_TRUE = 0x01 }
 hdc2080 bool enumeration definition More...
enum  hdc2080_resolution_t { HDC2080_RESOLUTION_14_BIT = 0x00 , HDC2080_RESOLUTION_11_BIT = 0x01 , HDC2080_RESOLUTION_9_BIT = 0x02 }
 hdc2080 resolution enumeration definition More...
enum  hdc2080_mode_t { HDC2080_MODE_HUMIDITY_TEMPERATURE = 0x00 , HDC2080_MODE_TEMPERATURE = 0x01 }
 hdc2080 mode enumeration definition More...
enum  hdc2080_auto_measurement_mode_t {
  HDC2080_AUTO_MEASUREMENT_MODE_DISABLED = 0x00 , HDC2080_AUTO_MEASUREMENT_MODE_1_DIV_120_HZ = 0x01 , HDC2080_AUTO_MEASUREMENT_MODE_1_DIV_60_HZ = 0x02 , HDC2080_AUTO_MEASUREMENT_MODE_1_DIV_10_HZ = 0x03 ,
  HDC2080_AUTO_MEASUREMENT_MODE_1_DIV_5_HZ = 0x04 , HDC2080_AUTO_MEASUREMENT_MODE_1_HZ = 0x05 , HDC2080_AUTO_MEASUREMENT_MODE_2_HZ = 0x06 , HDC2080_AUTO_MEASUREMENT_MODE_5_HZ = 0x07
}
 hdc2080 auto measurement mode enumeration definition More...
enum  hdc2080_interrupt_polarity_t { HDC2080_INTERRUPT_POLARITY_LOW = 0x00 , HDC2080_INTERRUPT_POLARITY_HIGH = 0x01 }
 hdc2080 interrupt polarity enumeration definition More...
enum  hdc2080_interrupt_t {
  HDC2080_INTERRUPT_DRDY = 7 , HDC2080_INTERRUPT_TEMPERATURE_HIGH_THRESHOLD = 6 , HDC2080_INTERRUPT_TEMPERATURE_LOW_THRESHOLD = 5 , HDC2080_INTERRUPT_HUMIDITY_HIGH_THRESHOLD = 4 ,
  HDC2080_INTERRUPT_HUMIDITY_LOW_THRESHOLD = 3
}
 hdc2080 interrupt enumeration definition More...
enum  hdc2080_interrupt_mode_t { HDC2080_INTERRUPT_MODE_LEVEL = 0x00 , HDC2080_INTERRUPT_MODE_COMPARATOR = 0x01 }
 hdc2080 interrupt mode enumeration definition More...

Functions

uint8_t hdc2080_info (hdc2080_info_t *info)
 get chip's information
uint8_t hdc2080_set_addr_pin (hdc2080_handle_t *handle, hdc2080_address_t addr_pin)
 set the iic address pin
uint8_t hdc2080_get_addr_pin (hdc2080_handle_t *handle, hdc2080_address_t *addr_pin)
 get the iic address pin
uint8_t hdc2080_init (hdc2080_handle_t *handle)
 initialize the chip
uint8_t hdc2080_deinit (hdc2080_handle_t *handle)
 close the chip
uint8_t hdc2080_read_temperature_humidity (hdc2080_handle_t *handle, uint16_t *temperature_raw, float *temperature_s, uint16_t *humidity_raw, float *humidity_s)
 read the temperature and humidity data
uint8_t hdc2080_read_temperature (hdc2080_handle_t *handle, uint16_t *temperature_raw, float *temperature_s)
 read the temperature
uint8_t hdc2080_read_humidity (hdc2080_handle_t *handle, uint16_t *humidity_raw, float *humidity_s)
 read the humidity data
uint8_t hdc2080_read_poll (hdc2080_handle_t *handle)
 read poll
uint8_t hdc2080_set_temperature_resolution (hdc2080_handle_t *handle, hdc2080_resolution_t resolution)
 set temperature resolution
uint8_t hdc2080_get_temperature_resolution (hdc2080_handle_t *handle, hdc2080_resolution_t *resolution)
 get temperature resolution
uint8_t hdc2080_set_humidity_resolution (hdc2080_handle_t *handle, hdc2080_resolution_t resolution)
 set humidity resolution
uint8_t hdc2080_get_humidity_resolution (hdc2080_handle_t *handle, hdc2080_resolution_t *resolution)
 get humidity resolution
uint8_t hdc2080_set_mode (hdc2080_handle_t *handle, hdc2080_mode_t mode)
 set the chip mode
uint8_t hdc2080_get_mode (hdc2080_handle_t *handle, hdc2080_mode_t *mode)
 get the chip mode
uint8_t hdc2080_set_measurement (hdc2080_handle_t *handle, hdc2080_bool_t enable)
 enable or disable measurement
uint8_t hdc2080_get_measurement (hdc2080_handle_t *handle, hdc2080_bool_t *enable)
 get measurement status
uint8_t hdc2080_soft_reset (hdc2080_handle_t *handle)
 soft reset
uint8_t hdc2080_set_auto_measurement_mode (hdc2080_handle_t *handle, hdc2080_auto_measurement_mode_t mode)
 set auto measurement mode
uint8_t hdc2080_get_auto_measurement_mode (hdc2080_handle_t *handle, hdc2080_auto_measurement_mode_t *mode)
 get auto measurement mode
uint8_t hdc2080_set_heater (hdc2080_handle_t *handle, hdc2080_bool_t enable)
 enable or disable heater
uint8_t hdc2080_get_heater (hdc2080_handle_t *handle, hdc2080_bool_t *enable)
 get heater status
uint8_t hdc2080_set_interrupt_pin (hdc2080_handle_t *handle, hdc2080_bool_t enable)
 enable or disable interrupt pin
uint8_t hdc2080_get_interrupt_pin (hdc2080_handle_t *handle, hdc2080_bool_t *enable)
 get interrupt pin status
uint8_t hdc2080_set_interrupt_polarity (hdc2080_handle_t *handle, hdc2080_interrupt_polarity_t polarity)
 set interrupt polarity
uint8_t hdc2080_get_interrupt_polarity (hdc2080_handle_t *handle, hdc2080_interrupt_polarity_t *polarity)
 get interrupt polarity
uint8_t hdc2080_set_interrupt_mode (hdc2080_handle_t *handle, hdc2080_interrupt_mode_t mode)
 set interrupt mode
uint8_t hdc2080_get_interrupt_mode (hdc2080_handle_t *handle, hdc2080_interrupt_mode_t *mode)
 get interrupt mode
uint8_t hdc2080_set_humidity_high_threshold (hdc2080_handle_t *handle, uint8_t threshold)
 set humidity high threshold
uint8_t hdc2080_get_humidity_high_threshold (hdc2080_handle_t *handle, uint8_t *threshold)
 get humidity high threshold
uint8_t hdc2080_set_humidity_low_threshold (hdc2080_handle_t *handle, uint8_t threshold)
 set humidity low threshold
uint8_t hdc2080_get_humidity_low_threshold (hdc2080_handle_t *handle, uint8_t *threshold)
 get humidity low threshold
uint8_t hdc2080_set_temperature_high_threshold (hdc2080_handle_t *handle, uint8_t threshold)
 set temperature high threshold
uint8_t hdc2080_get_temperature_high_threshold (hdc2080_handle_t *handle, uint8_t *threshold)
 get temperature high threshold
uint8_t hdc2080_set_temperature_low_threshold (hdc2080_handle_t *handle, uint8_t threshold)
 set temperature low threshold
uint8_t hdc2080_get_temperature_low_threshold (hdc2080_handle_t *handle, uint8_t *threshold)
 get temperature low threshold
uint8_t hdc2080_set_humidity_offset_adjustment (hdc2080_handle_t *handle, int8_t offset)
 set humidity offset adjustment
uint8_t hdc2080_get_humidity_offset_adjustment (hdc2080_handle_t *handle, int8_t *offset)
 get humidity offset adjustment
uint8_t hdc2080_set_temperature_offset_adjustment (hdc2080_handle_t *handle, int8_t offset)
 set temperature offset adjustment
uint8_t hdc2080_get_temperature_offset_adjustment (hdc2080_handle_t *handle, int8_t *offset)
 get temperature offset adjustment
uint8_t hdc2080_set_interrupt (hdc2080_handle_t *handle, hdc2080_interrupt_t interrupt, hdc2080_bool_t enable)
 enable or disable interrupt
uint8_t hdc2080_get_interrupt (hdc2080_handle_t *handle, hdc2080_interrupt_t interrupt, hdc2080_bool_t *enable)
 get interrupt status
uint8_t hdc2080_set_humidity_max (hdc2080_handle_t *handle, uint8_t max)
 set humidity max
uint8_t hdc2080_get_humidity_max (hdc2080_handle_t *handle, uint8_t *max)
 get humidity max
uint8_t hdc2080_set_temperature_max (hdc2080_handle_t *handle, uint8_t max)
 set temperature max
uint8_t hdc2080_get_temperature_max (hdc2080_handle_t *handle, uint8_t *max)
 get temperature max
uint8_t hdc2080_get_interrupt_status (hdc2080_handle_t *handle, uint8_t *status)
 get interrupt status
uint8_t hdc2080_humidity_convert_to_register (hdc2080_handle_t *handle, float percent, uint8_t *reg)
 convert the humidity to the register raw data
uint8_t hdc2080_humidity_convert_to_data (hdc2080_handle_t *handle, uint8_t reg, float *percent)
 convert the register raw data to the humidity
uint8_t hdc2080_temperature_convert_to_register (hdc2080_handle_t *handle, float deg, uint8_t *reg)
 convert the temperature to the register raw data
uint8_t hdc2080_temperature_convert_to_data (hdc2080_handle_t *handle, uint8_t reg, float *deg)
 convert the register raw data to the temperature
uint8_t hdc2080_humidity_offset_convert_to_register (hdc2080_handle_t *handle, float percent, int8_t *reg)
 convert the humidity offset to the register raw data
uint8_t hdc2080_humidity_offset_convert_to_data (hdc2080_handle_t *handle, int8_t reg, float *percent)
 convert the register raw data to the humidity offset
uint8_t hdc2080_temperature_offset_convert_to_register (hdc2080_handle_t *handle, float deg, int8_t *reg)
 convert the temperature offset to the register raw data
uint8_t hdc2080_temperature_offset_convert_to_data (hdc2080_handle_t *handle, int8_t reg, float *deg)
 convert the register raw data to the temperature offset
uint8_t hdc2080_set_reg (hdc2080_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len)
 set chip register
uint8_t hdc2080_get_reg (hdc2080_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len)
 get chip register

Detailed Description

driver hdc2080 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
2024-05-30

history

Date Version Author Description
2024/05/30 1.0 Shifeng Li first upload

Definition in file driver_hdc2080.h.