ads1x1x.h

Go to the documentation of this file.

/*
 * Copyright (C) 2017 OTA keys S.A.
 *               2018 Acutam Automation, LLC
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */
 
#pragma once

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


#ifndef CONFIG_ADS1X1X_I2C_ADDRESS
#define CONFIG_ADS1X1X_I2C_ADDRESS    (0x48)
#endif

enum {
    ADS1X1X_OK          =  0,       
    ADS1X1X_NOI2C       = -1,       
    ADS1X1X_NODEV       = -2,       
    ADS1X1X_NODATA      = -3        
};

typedef struct ads1x1x_params {
    i2c_t i2c;              
    uint8_t addr;           
    uint8_t mux_gain;       
} ads1x1x_params_t;

typedef struct ads1x1x_alert_params {
    i2c_t i2c;              
    uint8_t addr;           
    gpio_t alert_pin;       
    int16_t low_limit;      
    int16_t high_limit;     
} ads1x1x_alert_params_t;

typedef struct ads1x1x {
    ads1x1x_params_t params;    
} ads1x1x_t;

typedef void (*ads1x1x_alert_cb_t)(void *);

typedef struct ads1x1x_alert {
    ads1x1x_alert_params_t params;    
    ads1x1x_alert_cb_t cb;            
    void *arg;                        
} ads1x1x_alert_t;

int ads1x1x_init(ads1x1x_t *dev, const ads1x1x_params_t *params);

int ads1x1x_alert_init(ads1x1x_alert_t *dev,
                       const ads1x1x_alert_params_t *params);

int ads1x1x_set_mux_gain(const ads1x1x_t *dev, uint8_t mux_gain);

int ads1x1x_read_raw(const ads1x1x_t *dev, int16_t *raw);

int ads1x1x_enable_alert(ads1x1x_alert_t *dev,
                         ads1x1x_alert_cb_t cb, void *arg);

int ads1x1x_set_alert_parameters(const ads1x1x_alert_t *dev,
                                 int16_t low_limit, int16_t high_limit);
 
#ifdef __cplusplus
}
#endif