HalSingleInput.h File Reference

Detailed Description

This file defines a hardware abstraction layer (HAL) for sampling a single Analog input source.

NOTE: NO 'Initialization' method is provided/defined in this interface - this is intentional! The initialization left to the target's platform specific code and/or BSP. The application is RESPONSIBLE for making sure that the platform specific initialization happens BEFORE any of the drivers are started/used.

#include "colony_map.h"

Include dependency graph for HalSingleInput.h:

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

Go to the source code of this file.

Macros
#define	DriverAIOHalSingleInput_T   DriverAIOHalSingleInput_T_MAP
	This data type defines the platform specific 'handle' to a analog input.
#define	Driver_AIO_HalSingleInput_sample   Driver_AIO_HalSingleInput_sample_MAP
	This method samples the ADC channel/signal/pin.
#define	Driver_AIO_HalSingle_setADCSize   Driver_AIO_HalSingleInput_setADCSize_MAP
	Sets the number of bits/resolution of the ADC when sampling when using Driver_HalSingle_sample().

Macro Definition Documentation

Driver_AIO_HalSingle_setADCSize

#define Driver_AIO_HalSingle_setADCSize   Driver_AIO_HalSingleInput_setADCSize_MAP

Sets the number of bits/resolution of the ADC when sampling when using Driver_HalSingle_sample().

The method returns the new/current ADC resolution. NOTE: The actual number of ADC Bits/resolution is platform dependent, i.e may not be able to support the requested resolution. The application is ENCOURRAGED to verify that the method returns the same value that was request.

Prototype: uint8_t Driver_AIO_HalSingleInput_setADCSize( DriverAIOHalSingleInput_T inputToSampleHdl, uint8_t numADCBits );

Driver_AIO_HalSingleInput_sample

#define Driver_AIO_HalSingleInput_sample   Driver_AIO_HalSingleInput_sample_MAP

This method samples the ADC channel/signal/pin.

The number of ADC bits is returned via the 'dstADCBits' argument. The method returns true when a successful reading was taken; else false is returned.

The number of bits in 'dstADCBits' is platform specific and/or is set by the Driver_AIO_HalSingle_setADCSize() method.

Prototype: bool Driver_AIO_HalSingleInput_sample( DriverAIOHalSingleInput_T inputToSampleHdl, uint32_t& dstADCBits );

DriverAIOHalSingleInput_T

#define DriverAIOHalSingleInput_T   DriverAIOHalSingleInput_T_MAP

This data type defines the platform specific 'handle' to a analog input.