FDC1004Q.h

Go to the documentation of this file.

#ifndef __FDC1004Q_H__
    #define __FDC1004Q_H__
    
    #include "FDC1004Q_Defs.h"
    #include "project.h"
    
    // ===========================================================
    //                 INITIALIZATION FUNCTIONS
    // ===========================================================
    
    uint8_t FDC_Start(void);
    
    void FDC_Stop(void);
    
    uint8_t FDC_Reset(void);
    
    uint8_t FDC_IsDeviceConnected(void);
    
    // ===========================================================
    //                 CONFIGURATION FUNCTIONS
    // ===========================================================
    
    uint8_t FDC_SetSampleRate(uint8_t sampleRate);
    
    uint8_t FDC_ReadSampleRate(uint8_t* sampleRate);
    
    uint8_t FDC_ReadOffsetCalibration(uint8_t channel, float* offset);
    
    uint8_t FDC_ReadRawOffsetCalibration(uint8_t channel, int16_t* offset);
    
    uint8_t FDC_SetOffsetCalibration(uint8_t channel, float offset);
    
    uint8_t FDC_SetRawOffsetCalibration(uint8_t channel, int16_t offset);
    
    uint8_t FDC_ReadGainCalibration(uint8_t channel, float* gain);
    
    uint8_t FDC_ReadRawGainCalibration(uint8_t channel, uint16_t* gain);
    
    uint8_t FDC_SetGainCalibration(uint8_t channel, float gain);
    
    uint8_t FDC_SetRawGainCalibration(uint8_t channel, uint16_t gain);

    // ===========================================================
    //                MEASUREMENTS CONFIGURATIONS
    // ===========================================================
    
    uint8_t FDC_InitMeasurement(uint8_t channel);
    
    uint8_t FDC_StopMeasurement(uint8_t channel);
    
    uint8_t FDC_IsMeasurementDone(uint8_t channel, uint8_t* done);
    
    uint8_t FDC_EnableRepeatMeasurement(uint8_t channel_flags);
    
    uint8_t FDC_DisableRepeatMeasurement(void);
    
    uint8_t FDC_ConfigureMeasurementInput(uint8_t meas_channel,
                                    uint8_t pos_channel, 
                                    uint8_t neg_channel,
                                    uint8_t capdac);
    
    uint8_t FDC_ConfigureMeasurement(uint8_t meas_channel,
                                    uint8_t pos_channel, 
                                    uint8_t neg_channel,
                                    uint8_t capdac,
                                    int16_t offset,
                                    uint16_t gain);
    
    uint8_t FDC_ReadRawCapdacSetting(uint8_t channel, uint8_t* capdac);
    
    uint8_t FDC_ReadCapdacSetting(uint8_t channel, float* capdac);
    
    uint8_t FDC_ReadPositiveChannelSetting(uint8_t channel, uint8_t* input);
    
    uint8_t FDC_ReadNegativeChannelSetting(uint8_t channel, uint8_t* input);
    

    // ===========================================================
    //                 READOUT CAPACITANCE VALUES
    // ===========================================================
    
    uint8_t FDC_ReadRawMeasurement(uint8_t channel, uint32_t* capacitance);
    
    uint8_t FDC_ReadMeasurement(uint8_t channel, double* capacitance);
    
    double FDC_ConvertRawMeasurement(uint32_t capacitance);

    uint8_t FDC_HasNewData(uint8_t* done);
    
    // ===========================================================
    //             MANUFACTURER / DEVICE ID REGISTERS
    // ===========================================================
    
    uint8_t FDC_ReadManufacturerId(uint16_t* id);
    
    uint8_t FDC_ReadDeviceId(uint16_t* id);
    
    // ===========================================================
    //             READ / WRITE REGISTERS
    // ===========================================================
    
    uint8_t FDC_ReadRegister(uint8_t reg_addr, uint8_t* data);
    
    uint8_t FDC_WriteRegister(uint8_t reg_addr, uint8_t* data);
    
    
#endif
/* [] END OF FILE */