adcxx1c.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2017 OTA keys S.A.
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

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

#ifndef ADCXX1C_I2C_ADDRESS
#define ADCXX1C_I2C_ADDRESS  (0x54)
#endif

enum {
    ADCXX1C_RES_8BITS  = 8,  
    ADCXX1C_RES_10BITS = 10, 
    ADCXX1C_RES_12BITS = 12, 
};

#if   defined(MODULE_ADC081C)
#define ADCXX1C_RES_DEFAULT     ADCXX1C_RES_8BITS
#elif defined(MODULE_ADC101C)
#define ADCXX1C_RES_DEFAULT     ADCXX1C_RES_10BITS
#elif defined(MODULE_ADC121C)
#define ADCXX1C_RES_DEFAULT     ADCXX1C_RES_12BITS
#else
#define ADCXX1C_RES_DEFAULT     (-1)
#error "ADCXX1C: Failed to select resolution: unknown ADCXX1C device variant!"
#endif

enum {
    ADCXX1C_CYCLE_DISABLED = 0,  
    ADCXX1C_CYCLE_32,            
    ADCXX1C_CYCLE_64,            
    ADCXX1C_CYCLE_128,           
    ADCXX1C_CYCLE_256,           
    ADCXX1C_CYCLE_512,           
    ADCXX1C_CYCLE_1024,          
    ADCXX1C_CYCLE_2048,          
};

enum {
    ADCXX1C_OK          =  0,       
    ADCXX1C_NOI2C       = -1,       
    ADCXX1C_NODEV       = -2,       
    ADCXX1C_NODATA      = -3        
};

enum {
    ADCXX1C_ALERT_UNDER_RANGE   = 1,    
    ADCXX1C_ALERT_OVER_RANGE    = 2,    
};

typedef struct adcxx1c_params {
    i2c_t i2c;            
    uint8_t addr;         
    uint8_t bits;         
    uint8_t cycle;        
    gpio_t alert_pin;     
    int16_t low_limit;    
    int16_t high_limit;   
    int16_t hysteresis;   
} adcxx1c_params_t;

typedef void (*adcxx1c_cb_t)(void *);

typedef struct adcxx1c {
    adcxx1c_params_t params; 
    adcxx1c_cb_t cb;         
    void *arg;               
} adcxx1c_t;

int adcxx1c_init(adcxx1c_t *dev, const adcxx1c_params_t *params);

int adcxx1c_read_raw(const adcxx1c_t *dev, int16_t *raw);

int adcxx1c_enable_alert(adcxx1c_t *dev, adcxx1c_cb_t cb, void *arg);

int adcxx1c_set_alert_parameters(const adcxx1c_t *dev, int16_t low_limit,
                                 int16_t high_limit, int16_t hysteresis);

int adcxx1c_get_and_clear_alert(const adcxx1c_t *dev);
 
#ifdef __cplusplus
}
#endif