Loading...
Searching...
No Matches
ads101x.h
Go to the documentation of this file.
1/*
2 * Copyright (C) 2017 OTA keys S.A.
3 * 2018 Acutam Automation, LLC
4 *
5 * This file is subject to the terms and conditions of the GNU Lesser
6 * General Public License v2.1. See the file LICENSE in the top level
7 * directory for more details.
8 */
9
31#ifndef ADS101X_H
32#define ADS101X_H
33
34#ifdef __cplusplus
35extern "C" {
36#endif
37
38#include "periph/i2c.h"
39#include "periph/gpio.h"
40
52#ifndef CONFIG_ADS101X_I2C_ADDRESS
53#define CONFIG_ADS101X_I2C_ADDRESS (0x48)
54#endif
60enum {
64 ADS101X_NODATA = -3
65};
66
70typedef struct ads101x_params {
72 uint8_t addr;
73 uint8_t mux_gain;
75
86
93
97typedef void (*ads101x_alert_cb_t)(void *);
98
107
116int ads101x_init(ads101x_t *dev, const ads101x_params_t *params);
117
127 const ads101x_alert_params_t *params);
128
140int ads101x_set_mux_gain(const ads101x_t *dev, uint8_t mux_gain);
141
150int ads101x_read_raw(const ads101x_t *dev, int16_t *raw);
151
164 ads101x_alert_cb_t cb, void *arg);
165
178 int16_t low_limit, int16_t high_limit);
179
180#ifdef __cplusplus
181}
182#endif
183
184#endif /* ADS101X_H */
Low-level GPIO peripheral driver interface definitions.
int ads101x_set_mux_gain(const ads101x_t *dev, uint8_t mux_gain)
Set mux and gain.
void(* ads101x_alert_cb_t)(void *)
ADS101x/111x alert callback.
Definition ads101x.h:97
int ads101x_set_alert_parameters(const ads101x_alert_t *dev, int16_t low_limit, int16_t high_limit)
Set the alert parameters.
int ads101x_init(ads101x_t *dev, const ads101x_params_t *params)
Initialize an ADS101x/111x ADC device (ADC only)
int ads101x_enable_alert(ads101x_alert_t *dev, ads101x_alert_cb_t cb, void *arg)
Enable alert interrupt.
struct ads101x ads101x_t
ADS101x/111x device descriptor.
int ads101x_alert_init(ads101x_alert_t *dev, const ads101x_alert_params_t *params)
Initialize an ADS101x/111x alert device.
struct ads101x_alert_params ads101x_alert_params_t
ADS101x/111x alert params.
struct ads101x_params ads101x_params_t
ADS101x/111x params.
struct ads101x_alert ads101x_alert_t
ADS101x/111x alert device descriptor.
int ads101x_read_raw(const ads101x_t *dev, int16_t *raw)
Read a raw ADC value.
@ ADS101X_NODATA
no data available
Definition ads101x.h:64
@ ADS101X_NOI2C
I2C communication failed.
Definition ads101x.h:62
@ ADS101X_OK
everything was fine
Definition ads101x.h:61
@ ADS101X_NODEV
no ADS101X device found on the bus
Definition ads101x.h:63
uint_fast8_t i2c_t
Default i2c_t type definition.
Definition i2c.h:151
Low-level I2C peripheral driver interface definition.
ADS101x/111x alert params.
Definition ads101x.h:79
i2c_t i2c
i2c device
Definition ads101x.h:80
int16_t high_limit
alert high value
Definition ads101x.h:84
int16_t low_limit
alert low value
Definition ads101x.h:83
gpio_t alert_pin
alert pin (GPIO_UNDEF if not connected)
Definition ads101x.h:82
uint8_t addr
i2c address
Definition ads101x.h:81
ADS101x/111x alert device descriptor.
Definition ads101x.h:102
ads101x_alert_cb_t cb
alert callback
Definition ads101x.h:104
void * arg
alert callback param
Definition ads101x.h:105
ads101x_alert_params_t params
device driver configuration
Definition ads101x.h:103
ADS101x/111x params.
Definition ads101x.h:70
uint8_t mux_gain
Mux and gain boolean settings.
Definition ads101x.h:73
uint8_t addr
i2c address
Definition ads101x.h:72
i2c_t i2c
i2c device
Definition ads101x.h:71
ADS101x/111x device descriptor.
Definition ads101x.h:90
ads101x_params_t params
device driver configuration
Definition ads101x.h:91