driver ads1118 header file More...

#include <stdio.h>
#include <stdint.h>
#include <string.h>

Include dependency graph for driver_ads1118.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	ads1118_handle_s
	ads1118 handle structure definition More...
struct	ads1118_info_s
	ads1118 information structure definition More...

Macros
#define	DRIVER_ADS1118_LINK_INIT(HANDLE, STRUCTURE)
	initialize ads1118_handle_t structure
#define	DRIVER_ADS1118_LINK_SPI_INIT(HANDLE, FUC)
	link spi_init function
#define	DRIVER_ADS1118_LINK_SPI_DEINIT(HANDLE, FUC)
	link spi_deinit function
#define	DRIVER_ADS1118_LINK_SPI_TRANSMIT(HANDLE, FUC)
	link spi_transmit function
#define	DRIVER_ADS1118_LINK_DELAY_MS(HANDLE, FUC)
	link delay_ms function
#define	DRIVER_ADS1118_LINK_DEBUG_PRINT(HANDLE, FUC)
	link debug_print function

Typedefs
typedef struct ads1118_handle_s	ads1118_handle_t
	ads1118 handle structure definition
typedef struct ads1118_info_s	ads1118_info_t
	ads1118 information structure definition

Enumerations
enum	ads1118_bool_t { ADS1118_BOOL_FALSE = 0x00 , ADS1118_BOOL_TRUE = 0x01 }
	ads1118 bool enumeration definition More...
enum	ads1118_range_t { ADS1118_RANGE_6P144V = 0x00 , ADS1118_RANGE_4P096V = 0x01 , ADS1118_RANGE_2P048V = 0x02 , ADS1118_RANGE_1P024V = 0x03 , ADS1118_RANGE_0P512V = 0x04 , ADS1118_RANGE_0P256V = 0x05 }
	ads1118 range enumeration definition More...
enum	ads1118_rate_t { ADS1118_RATE_8SPS = 0x00 , ADS1118_RATE_16SPS = 0x01 , ADS1118_RATE_32SPS = 0x02 , ADS1118_RATE_64SPS = 0x03 , ADS1118_RATE_128SPS = 0x04 , ADS1118_RATE_250SPS = 0x05 , ADS1118_RATE_475SPS = 0x06 , ADS1118_RATE_860SPS = 0x07 }
	ads1118 channel rate enumeration definition More...
enum	ads1118_channel_t { ADS1118_CHANNEL_AIN0_AIN1 = 0x00 , ADS1118_CHANNEL_AIN0_AIN3 = 0x01 , ADS1118_CHANNEL_AIN1_AIN3 = 0x02 , ADS1118_CHANNEL_AIN2_AIN3 = 0x03 , ADS1118_CHANNEL_AIN0_GND = 0x04 , ADS1118_CHANNEL_AIN1_GND = 0x05 , ADS1118_CHANNEL_AIN2_GND = 0x06 , ADS1118_CHANNEL_AIN3_GND = 0x07 }
	ads1118 channel enumeration definition More...
enum	ads1118_mode_t { ADS1118_MODE_ADC = 0x00 , ADS1118_MODE_TEMPERATURE = 0x01 }
	ads1118 mode enumeration definition More...

Functions
uint8_t	ads1118_info (ads1118_info_t *info)
	get chip's information
uint8_t	ads1118_init (ads1118_handle_t *handle)
	initialize the chip
uint8_t	ads1118_deinit (ads1118_handle_t *handle)
	close the chip
uint8_t	ads1118_single_read (ads1118_handle_t handle, int16_t raw, float *v)
	read data from the chip once
uint8_t	ads1118_continuous_read (ads1118_handle_t handle, int16_t raw, float *v)
	read data from the chip continuously
uint8_t	ads1118_start_continuous_read (ads1118_handle_t *handle)
	start the chip reading
uint8_t	ads1118_stop_continuous_read (ads1118_handle_t *handle)
	stop the chip reading
uint8_t	ads1118_temperature_convert (ads1118_handle_t handle, int16_t raw, float deg)
	temperature convert
uint8_t	ads1118_set_channel (ads1118_handle_t *handle, ads1118_channel_t channel)
	set the adc channel
uint8_t	ads1118_get_channel (ads1118_handle_t handle, ads1118_channel_t channel)
	get the adc channel
uint8_t	ads1118_set_range (ads1118_handle_t *handle, ads1118_range_t range)
	set the adc range
uint8_t	ads1118_get_range (ads1118_handle_t handle, ads1118_range_t range)
	get the adc range
uint8_t	ads1118_set_rate (ads1118_handle_t *handle, ads1118_rate_t rate)
	set the sample rate
uint8_t	ads1118_get_rate (ads1118_handle_t handle, ads1118_rate_t rate)
	get the sample rate
uint8_t	ads1118_set_mode (ads1118_handle_t *handle, ads1118_mode_t mode)
	set the chip mode
uint8_t	ads1118_get_mode (ads1118_handle_t handle, ads1118_mode_t mode)
	get the chip mode
uint8_t	ads1118_set_dout_pull_up (ads1118_handle_t *handle, ads1118_bool_t enable)
	enable or disable dout pull up
uint8_t	ads1118_get_dout_pull_up (ads1118_handle_t handle, ads1118_bool_t enable)
	get dout pull up status
uint8_t	ads1118_transmit (ads1118_handle_t handle, uint8_t tx, uint8_t *rx, uint16_t len)
	chip transmit

Detailed Description

driver ads1118 header file

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: 1.0.0

Author: Shifeng Li

Date: 2024-02-28

history

Date	Version	Author	Description
2024/02/28	1.0	Shifeng Li	first upload

Definition in file driver_ads1118.h.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

history