LibDriver ADS1115
Loading...
Searching...
No Matches
driver_ads1115.h File Reference

driver ads1115 header file More...

#include <stdio.h>
#include <stdint.h>
#include <string.h>
Include dependency graph for driver_ads1115.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  ads1115_handle_s
 ads1115 handle structure definition More...
struct  ads1115_info_s
 ads1115 information structure definition More...

Macros

#define DRIVER_ADS1115_LINK_INIT(HANDLE, STRUCTURE)
 initialize ads1115_handle_t structure
#define DRIVER_ADS1115_LINK_IIC_INIT(HANDLE, FUC)
 link iic_init function
#define DRIVER_ADS1115_LINK_IIC_DEINIT(HANDLE, FUC)
 link iic_deinit function
#define DRIVER_ADS1115_LINK_IIC_READ(HANDLE, FUC)
 link iic_read function
#define DRIVER_ADS1115_LINK_IIC_WRITE(HANDLE, FUC)
 link iic_write function
#define DRIVER_ADS1115_LINK_DELAY_MS(HANDLE, FUC)
 link delay_ms function
#define DRIVER_ADS1115_LINK_DEBUG_PRINT(HANDLE, FUC)
 link debug_print function

Typedefs

typedef struct ads1115_handle_s ads1115_handle_t
 ads1115 handle structure definition
typedef struct ads1115_info_s ads1115_info_t
 ads1115 information structure definition

Enumerations

enum  ads1115_address_t { ADS1115_ADDR_GND = 0x00 , ADS1115_ADDR_VCC = 0x01 , ADS1115_ADDR_SDA = 0x02 , ADS1115_ADDR_SCL = 0x03 }
 ads1115 address enumeration definition More...
enum  ads1115_bool_t { ADS1115_BOOL_FALSE = 0x00 , ADS1115_BOOL_TRUE = 0x01 }
 ads1115 bool enumeration definition More...
enum  ads1115_range_t {
  ADS1115_RANGE_6P144V = 0x00 , ADS1115_RANGE_4P096V = 0x01 , ADS1115_RANGE_2P048V = 0x02 , ADS1115_RANGE_1P024V = 0x03 ,
  ADS1115_RANGE_0P512V = 0x04 , ADS1115_RANGE_0P256V = 0x05
}
 ads1115 range enumeration definition More...
enum  ads1115_rate_t {
  ADS1115_RATE_8SPS = 0x00 , ADS1115_RATE_16SPS = 0x01 , ADS1115_RATE_32SPS = 0x02 , ADS1115_RATE_64SPS = 0x03 ,
  ADS1115_RATE_128SPS = 0x04 , ADS1115_RATE_250SPS = 0x05 , ADS1115_RATE_475SPS = 0x06 , ADS1115_RATE_860SPS = 0x07
}
 ads1115 channel rate enumeration definition More...
enum  ads1115_channel_t {
  ADS1115_CHANNEL_AIN0_AIN1 = 0x00 , ADS1115_CHANNEL_AIN0_AIN3 = 0x01 , ADS1115_CHANNEL_AIN1_AIN3 = 0x02 , ADS1115_CHANNEL_AIN2_AIN3 = 0x03 ,
  ADS1115_CHANNEL_AIN0_GND = 0x04 , ADS1115_CHANNEL_AIN1_GND = 0x05 , ADS1115_CHANNEL_AIN2_GND = 0x06 , ADS1115_CHANNEL_AIN3_GND = 0x07
}
 ads1115 channel enumeration definition More...
enum  ads1115_pin_t { ADS1115_PIN_LOW = 0x00 , ADS1115_PIN_HIGH = 0x01 }
 ads1115 pin enumeration definition More...
enum  ads1115_compare_t { ADS1115_COMPARE_THRESHOLD = 0x00 , ADS1115_COMPARE_WINDOW = 0x01 }
 ads1115 compare mode enumeration definition More...
enum  ads1115_comparator_queue_t { ADS1115_COMPARATOR_QUEUE_1_CONV = 0x00 , ADS1115_COMPARATOR_QUEUE_2_CONV = 0x01 , ADS1115_COMPARATOR_QUEUE_4_CONV = 0x02 , ADS1115_COMPARATOR_QUEUE_NONE_CONV = 0x03 }
 ads1115 comparator queue enumeration definition More...

Functions

uint8_t ads1115_info (ads1115_info_t *info)
 get chip's information
uint8_t ads1115_set_addr_pin (ads1115_handle_t *handle, ads1115_address_t addr_pin)
 set the iic address pin
uint8_t ads1115_get_addr_pin (ads1115_handle_t *handle, ads1115_address_t *addr_pin)
 get the iic address pin
uint8_t ads1115_init (ads1115_handle_t *handle)
 initialize the chip
uint8_t ads1115_deinit (ads1115_handle_t *handle)
 close the chip
uint8_t ads1115_single_read (ads1115_handle_t *handle, int16_t *raw, float *v)
 read data from the chip once
uint8_t ads1115_start_continuous_read (ads1115_handle_t *handle)
 start the chip reading
uint8_t ads1115_stop_continuous_read (ads1115_handle_t *handle)
 stop the chip reading
uint8_t ads1115_continuous_read (ads1115_handle_t *handle, int16_t *raw, float *v)
 read data from the chip continuously
uint8_t ads1115_set_channel (ads1115_handle_t *handle, ads1115_channel_t channel)
 set the adc channel
uint8_t ads1115_get_channel (ads1115_handle_t *handle, ads1115_channel_t *channel)
 get the adc channel
uint8_t ads1115_set_range (ads1115_handle_t *handle, ads1115_range_t range)
 set the adc range
uint8_t ads1115_get_range (ads1115_handle_t *handle, ads1115_range_t *range)
 get the adc range
uint8_t ads1115_set_rate (ads1115_handle_t *handle, ads1115_rate_t rate)
 set the sample rate
uint8_t ads1115_get_rate (ads1115_handle_t *handle, ads1115_rate_t *rate)
 get the sample rate
uint8_t ads1115_set_alert_pin (ads1115_handle_t *handle, ads1115_pin_t pin)
 set the alert pin active status
uint8_t ads1115_get_alert_pin (ads1115_handle_t *handle, ads1115_pin_t *pin)
 get the alert pin active status
uint8_t ads1115_set_compare_mode (ads1115_handle_t *handle, ads1115_compare_t compare)
 set the interrupt compare mode
uint8_t ads1115_get_compare_mode (ads1115_handle_t *handle, ads1115_compare_t *compare)
 get the interrupt compare mode
uint8_t ads1115_set_comparator_queue (ads1115_handle_t *handle, ads1115_comparator_queue_t comparator_queue)
 set the interrupt comparator queue
uint8_t ads1115_get_comparator_queue (ads1115_handle_t *handle, ads1115_comparator_queue_t *comparator_queue)
 get the interrupt comparator queue
uint8_t ads1115_set_compare (ads1115_handle_t *handle, ads1115_bool_t enable)
 enable or disable the interrupt compare
uint8_t ads1115_get_compare (ads1115_handle_t *handle, ads1115_bool_t *enable)
 get the interrupt compare status
uint8_t ads1115_set_compare_threshold (ads1115_handle_t *handle, int16_t high_threshold, int16_t low_threshold)
 set the interrupt compare threshold
uint8_t ads1115_get_compare_threshold (ads1115_handle_t *handle, int16_t *high_threshold, int16_t *low_threshold)
 get the interrupt compare threshold
uint8_t ads1115_convert_to_register (ads1115_handle_t *handle, float s, int16_t *reg)
 convert a adc value to a register raw data
uint8_t ads1115_convert_to_data (ads1115_handle_t *handle, int16_t reg, float *s)
 convert a register raw data to a converted adc data
uint8_t ads1115_set_reg (ads1115_handle_t *handle, uint8_t reg, int16_t value)
 set the chip register
uint8_t ads1115_get_reg (ads1115_handle_t *handle, uint8_t reg, int16_t *value)
 get the chip register

Detailed Description

driver ads1115 header file

Copyright (c) 2015 - present LibDriver All rights reserved

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Version
2.0.0
Author
Shifeng Li
Date
2021-02-13

history

Date Version Author Description
2021/02/13 2.0 Shifeng Li format the code
2020/10/13 1.0 Shifeng Li first upload

Definition in file driver_ads1115.h.