// -----------------------------------------------------------------------------
/// @file  ADConverter.h
/// @brief File description
// -----------------------------------------------------------------------------
//  Micro-Key bv
//  Industrieweg 28, 9804 TG Noordhorn
//  Postbus 92, 9800 AB Zuidhorn
//  The Netherlands
//  Tel: +31 594 503020
//  Fax: +31 594 505825
//  Email: support@microkey.nl
//  Web: www.microkey.nl
// -----------------------------------------------------------------------------
/// $Revision$
/// $Author$
/// $Date$
//  (c) 2015 Micro-Key bv
// -----------------------------------------------------------------------------

/**
 * ADConverter implementation
 * \defgroup ADConverter Package ADConverter
 * \ingroup hsb-mrts
 * @{
 */

#ifndef ADCONVERTER_H_
#define ADCONVERTER_H_


// -----------------------------------------------------------------------------
// Include files 
// -----------------------------------------------------------------------------

#include <stdbool.h>

#include "stm32f10x.h"

#include "ADCDevice.h"
// -----------------------------------------------------------------------------
// Constant and macro definitions 
// -----------------------------------------------------------------------------



// -----------------------------------------------------------------------------
// Type definitions. 
// -----------------------------------------------------------------------------

struct ADConverter
{
   bool initialized;
   int minVoltage;
   int maxVoltage;
   struct ADCDevice* adcDevice;
};

// -----------------------------------------------------------------------------
// Function declarations 
// -----------------------------------------------------------------------------

/** ----------------------------------------------------------------------------
 * ADConverter_construct
 * Description of function
 *
 * @param   self
 * @param
 * @return  ErrorStatus
 *
 * @todo
 * -----------------------------------------------------------------------------
 */
extern ErrorStatus ADConverter_construct(struct ADConverter* self, int minVoltage, int maxVoltage, struct ADCDevice* adcDevice);


/** ----------------------------------------------------------------------------
 * ADConverter_destruct
 * Description of function
 *
 * @param   self
 *
 * @return  void
 *
 * @todo
 * -----------------------------------------------------------------------------
 */
extern void ADConverter_destruct(struct ADConverter* self);


/** ----------------------------------------------------------------------------
 * ADConverter_setOutputVoltage
 * Description of function
 *
 * @param   self
 *
 * @return  int
 *
 * @todo
 * -----------------------------------------------------------------------------
 */
extern int ADConverter_getInputVoltage(const struct ADConverter* self);


extern unsigned int ADConverter_getInputConverterValue(const struct ADConverter* self);

#endif /* ADCONVERTER_H_ */

/** @} */