ads1x1x.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2017 OTA keys S.A.
 * SPDX-FileCopyrightText: 2018 Acutam Automation, LLC
 * SPDX-FileCopyrightText: 2025 Baptiste Le Duc <baptiste.leduc38@gmail.com>
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

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

enum {
    ADS1X1X_OK          = 0,    
    ADS1X1X_NOI2C       = -1,   
    ADS1X1X_NODEV       = -2,   
    ADS1X1X_NODATA      = -3,   
    ADS1X1X_INVALID_ARG = -4,   
    ADS1X1X_GPIO_ERROR  = -5    
};

typedef struct {
    i2c_t i2c;                          
    uint8_t addr;                       
    uint8_t mux;                        
    uint8_t pga;                        
    uint8_t mode;                       
    uint8_t dr;                         
    uint8_t bits_res;                   
} ads1x1x_params_t;

typedef struct ads1x1x_alert_params {
    i2c_t i2c;              
    uint8_t addr;           
    uint8_t comp_mode;      
    uint8_t comp_polarity;  
    uint8_t comp_latch;     
    uint8_t comp_queue;     
    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_set_parameters(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(ads1x1x_t *dev, uint8_t mux);

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, uint8_t nb_assert);

int ads1x1x_set_alert_parameters(ads1x1x_alert_t *dev, const ads1x1x_alert_params_t *params);
int ads1x1x_convert_to_mv(const ads1x1x_t *dev, int16_t value);

int ads1x1x_reset(i2c_t i2c);
 
#ifdef __cplusplus
}
#endif