si70xx.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2016 Bas Stottelaar <basstottelaar@gmail.com>
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include "periph/i2c.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#if MODULE_SI7050 || MODULE_SI7051 || MODULE_SI7053 || MODULE_SI7054 || \
    MODULE_SI7055
/* Si705x sensors don't have a humidity sensor hardware, only temperature. */
#define SI70XX_HAS_HUMIDITY_SENSOR 0
#else
#define SI70XX_HAS_HUMIDITY_SENSOR 1
#endif

enum {
    SI70XX_OK,                 
    SI70XX_ERR_NODEV,          
    SI70XX_ERR_I2C,            
};

typedef struct {
    i2c_t i2c_dev;              
    uint8_t address;            
} si70xx_params_t;

typedef struct {
    si70xx_params_t params;     
} si70xx_t;

int si70xx_init(si70xx_t *dev, const si70xx_params_t *params);
 
#if SI70XX_HAS_HUMIDITY_SENSOR || DOXYGEN
uint16_t si70xx_get_relative_humidity(const si70xx_t *dev);
#endif /* SI70XX_HAS_HUMIDITY_SENSOR || DOXYGEN */

int16_t si70xx_get_temperature(const si70xx_t *dev);
 
#if SI70XX_HAS_HUMIDITY_SENSOR || DOXYGEN
void si70xx_get_both(const si70xx_t *dev, uint16_t *humidity, int16_t *temperature);
#endif /* SI70XX_HAS_HUMIDITY_SENSOR || DOXYGEN */

uint64_t si70xx_get_serial(const si70xx_t *dev);

uint8_t si70xx_get_id(const si70xx_t *dev);

uint8_t si70xx_get_revision(const si70xx_t *dev);
 
#ifdef __cplusplus
}
#endif