isoadc5 2.0.0.0
isoadc5.h File Reference

This file contains API for ISO ADC 5 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"

Go to the source code of this file.

Data Structures

struct  isoadc5_t
 ISO ADC 5 Click context object. More...
 
struct  isoadc5_cfg_t
 ISO ADC 5 Click configuration object. More...
 
struct  isoadc5_burst_payload_t
 ISO ADC 5 Click burst payload structure object. More...
 

Macros

#define ISOADC5_REG_PROD_ID   0x00
 ISO ADC 5 Register Map.
 
#define ISOADC5_REG_ADC_1   0x01
 
#define ISOADC5_REG_ADC_2   0x02
 
#define ISOADC5_REG_ADC_3   0x03
 
#define ISOADC5_REG_ADC_4   0x04
 
#define ISOADC5_REG_FADC_1   0x05
 
#define ISOADC5_REG_FADC_2   0x06
 
#define ISOADC5_REG_FADC_3   0x07
 
#define ISOADC5_REG_FADC_4   0x08
 
#define ISOADC5_REG_COUNTHI_1   0x09
 
#define ISOADC5_REG_COUNTHI_2   0x0A
 
#define ISOADC5_REG_COUNTHI_3   0x0B
 
#define ISOADC5_REG_COUNTHI_4   0x0C
 
#define ISOADC5_REG_COUNTLO_1   0x0D
 
#define ISOADC5_REG_COUNTLO_2   0x0E
 
#define ISOADC5_REG_COUNTLO_3   0x0F
 
#define ISOADC5_REG_COUNTLO_4   0x10
 
#define ISOADC5_REG_COUT_STATUS   0x11
 
#define ISOADC5_REG_INTERRUPT_STATUS   0x12
 
#define ISOADC5_REG_INTERRUPT_ENABLE   0x13
 
#define ISOADC5_REG_CONTROL   0x14
 
#define ISOADC5_DEVICE_ID   0x00
 ISO ADC 5 PROD_ID register.
 
#define ISOADC5_NORMAL_OPERATION   0x00
 
#define ISOADC5_WAKE_UP_FROM_POR   0x80
 
#define ISOADC5_DEVICE_REV   0x01
 
#define ISOADC5_ADC_NOT_UPDATED   0x8000
 ISO ADC 5 ADC register.
 
#define ISOADC5_ADC_12BIT_MASK   0x0FFF
 
#define ISOADC5_CO_MODE_STATUS   0x80
 ISO ADC 5 COUTHI register.
 
#define ISOADC5_CO_IN_SEL_FILTERED_ADC   0x40
 
#define ISOADC5_STATUS_CO_4   0x08
 ISO ADC 5 COUT STATUS register.
 
#define ISOADC5_STATUS_CO_3   0x04
 
#define ISOADC5_STATUS_CO_2   0x02
 
#define ISOADC5_STATUS_CO_1   0x01
 
#define ISOADC5_INT_STATUS_EOC   0x1000
 ISO ADC 5 INTERRUPT STATUS register.
 
#define ISOADC5_INT_STATUS_ADCF   0x0800
 
#define ISOADC5_INT_STATUS_FLD   0x0400
 
#define ISOADC5_INT_STATUS_SPIFRM   0x0200
 
#define ISOADC5_INT_STATUS_SPICRC   0x0100
 
#define ISOADC5_INT_STATUS_CO_POS_4   0x0080
 
#define ISOADC5_INT_STATUS_CO_POS_3   0x0040
 
#define ISOADC5_INT_STATUS_CO_POS_2   0x0020
 
#define ISOADC5_INT_STATUS_CO_POS_1   0x0010
 
#define ISOADC5_INT_STATUS_CO_NEG_4   0x0008
 
#define ISOADC5_INT_STATUS_CO_NEG_3   0x0004
 
#define ISOADC5_INT_STATUS_CO_NEG_2   0x0002
 
#define ISOADC5_INT_STATUS_CO_NEG_1   0x0001
 
#define ISOADC5_EN_CRC   0x8000
 ISO ADC 5 CONTROL register.
 
#define ISOADC5_EN_COMMON_COMP   0x4000
 
#define ISOADC5_CLEAR_FLT_4   0x0080
 
#define ISOADC5_CLEAR_FLT_3   0x0040
 
#define ISOADC5_CLEAR_FLT_2   0x0020
 
#define ISOADC5_CLEAR_FLT_1   0x0010
 
#define ISOADC5_DISABLE_PWR   0x0008
 
#define ISOADC5_CLEAR_POR   0x0004
 
#define ISOADC5_SOFT_RESET   0x0002
 
#define ISOADC5_HARD_RESET   0x0001
 
#define ISOADC5_ADC_CHANNEL_1   0x01
 ISO ADC 5 ADC channel number.
 
#define ISOADC5_ADC_CHANNEL_2   0x02
 
#define ISOADC5_ADC_CHANNEL_3   0x03
 
#define ISOADC5_ADC_CHANNEL_4   0x04
 
#define ISOADC5_ADC_UNFILTERED   0x00
 ISO ADC 5 ADC filtered flag.
 
#define ISOADC5_ADC_FILTERED   0x01
 
#define ISOADC5_MAX_VOLTAGE   48.0
 ISO ADC 5 Maximal voltage input.
 
#define ISOADC5_SPI_READ   0x00
 ISO ADC 5 SPI mask.
 
#define ISOADC5_SPI_WRITE   0x02
 
#define ISOADC5_SPI_BURST   0x01
 
#define ISOADC5_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  isoadc5_return_value_t { ISOADC5_OK = 0 , ISOADC5_ERROR = -1 }
 ISO ADC 5 Click return value data. More...
 

Functions

void isoadc5_cfg_setup (isoadc5_cfg_t *cfg)
 ISO ADC 5 configuration object setup function.
 
err_t isoadc5_init (isoadc5_t *ctx, isoadc5_cfg_t *cfg)
 ISO ADC 5 initialization function.
 
err_t isoadc5_write_register (isoadc5_t *ctx, uint8_t reg, uint16_t data_in)
 ISO ADC 5 write register function.
 
err_t isoadc5_read_register (isoadc5_t *ctx, uint8_t reg, uint16_t *data_out)
 ISO ADC 5 read register function.
 
err_t isoadc5_read_register_burst (isoadc5_t *ctx, uint8_t filt, isoadc5_burst_payload_t *payload)
 ISO ADC 5 read register function.
 
err_t isoadc5_read_voltage (isoadc5_t *ctx, uint8_t filt, uint8_t ch, float *volt)
 ISO ADC 5 read voltage function.
 
uint8_t isoadc5_get_int_pin (isoadc5_t *ctx)
 ISO ADC 5 get int pin function.
 

Detailed Description

This file contains API for ISO ADC 5 Click Driver.

Enumeration Type Documentation

◆ isoadc5_return_value_t

ISO ADC 5 Click return value data.

Predefined enum values for driver return values.

Enumerator
ISOADC5_OK 
ISOADC5_ERROR