lm75.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2021 ML!PA Consulting GmbH
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once


 
#include <errno.h> /* IWYU pragma: keep needed for EIO etc. */
#include <stdbool.h>
 
#include "periph/gpio.h"
#include "periph/i2c.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#define LM75_SUCCESS   0         
#define LM75_ERROR_I2C (-EIO)    
#define LM75_ERROR     (-EINVAL) 

typedef struct lm75_properties {
    uint16_t    os_res;      
    uint16_t    os_mult;     
    uint16_t    temp_res;    
    uint16_t    temp_mult;   
    uint8_t     os_shift;    
    uint8_t     temp_shift;  
} lm75_properties_t;
 
extern lm75_properties_t lm75a_properties;      
extern lm75_properties_t tmp1075_properties;    

typedef struct lm75_params {
    const    lm75_properties_t *res;      
    uint16_t conv_rate;
    gpio_t   gpio_alarm;                  
    i2c_t    i2c_bus;                     
    uint8_t  i2c_addr;                    
    uint8_t  shutdown_mode;               
    uint8_t  tm_mode;                     
    uint8_t  polarity;                    
    uint8_t  fault_q;                     
    /* only configurable for the TMP1075 */
    uint8_t  conv_rate_reg;               
} lm75_params_t;

typedef struct lm75 {
    lm75_params_t    lm75_params; 
} lm75_t;

int lm75_init(lm75_t *dev, const lm75_params_t *params);

int lm75_get_temperature_raw(const lm75_t *dev, int32_t *temperature);

int lm75_get_temperature(const lm75_t *dev, int32_t *temperature);

int lm75_set_temp_limits(const lm75_t *dev, int32_t temp_hyst, int32_t temp_os,
                         gpio_cb_t cb, void *arg);

int lm75_get_os_temp(const lm75_t *dev, int32_t *temperature);

int lm75_get_hyst_temp(const lm75_t *dev, int32_t *temperature);

int lm75_get_os_pin(const lm75_t *dev, bool *os_pin_state);

int lm75_poweroff(const lm75_t *dev);

int lm75_poweron(const lm75_t *dev);

int tmp1075_one_shot(const lm75_t *dev);

int lm75_low_power_mode(const lm75_t *dev, uint16_t interval);
 
#ifdef __cplusplus
}
#endif