Component: Input ADC (DSP)

Author	Matrix Ltd
Version	1.2
Category	DSP

Input ADC component

Allows the values from a buffer to be assigned driectly from an analog enabled pin. Either a single sample at a time or a number of samples. Auto scales the digital value to fill the entire range of the specified buffer type.

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Downloadable macro reference

	AddSample
Adds a single ADC sample to the current location in the specified buffer. If Auto Scale is enabled then the sample will be scaled to correctly fit inside the buffer. Auto increments current location.
- VOID	Return

	AddSampleArray
Adds a single ADC sample to the current location in the specified buffer. If Auto Scale is enabled then the sample will be scaled to correctly fit inside the buffer. Auto increments current location.
- UINT	SampleDelay
Number of us in between each sample.
- VOID	Return

	Initialise
Configures the UART serial interface.
- VOID	Return

	Send
Send the Character
- UINT	Char
The Character to send
- VOID	Return

	GetConsoleHandle
[[File:]] -	Return

	SendByteArray
Transmits an array of bytes via the UART peripheral
- BYTE	Data
Data to transmit
- UINT	NumBytes
Number of bytes to send from the array
- VOID	Return

	Init
Initialize the component with the specified properties
- VOID	Return

	Uninit
Un-initialize the UART and release the resources
- VOID	Return

	ReceiveByteArray
Receives an array of bytes and returns the number of bytes received.
- BYTE	Data
A byte array variable to hold the received data
- UINT	NumBytes
Maximum number of bytes to try and receive
- UINT	Timeout
Max amount of time in ms to wait between bytes
- UINT	Return

	ReceiveString
Receives a string of bytes and returns the number of bytes received.
- STRING	StringData
- UINT	NumBytes
Maximum number of bytes to try and receive
- UINT	Timeout
Max amount of time in ms to wait between bytes
- BYTE	Return

	Start
Startup routine required by the hardware device. Automatically clears the display after initialising.
- VOID	Return

	SetLEDState
Sets the state of a single LED
- BYTE	Port
0 = PortA, 1 = PortB
- BYTE	LED
0 = LED0, 7 = LED7
- BYTE	State
- VOID	Return

	GetRxIdent
Gets the Rx ID as a Integer Standard and Extended IDs.
- BYTE	Buffer
- ULONG	Return

	Initialise
Must be called before any other CAN component macros to enable and initialise the CAN peripheral.
- VOID	Return

Property reference

	Properties
	Buffer Size
Number of individual elements the buffer can store, default 1.
	Buffer Type
Sets the buffer data type, data is automatically scaled to fit and make full use of the data type.
	VRef option
Defines what is used as the ADC maximum reference. ADC Range = GND to VRef Voltage VDD - Defines the microcontrollers power supply pin as the max reference, VREF+ Pin - Dedicated pin on the microcontroller to allow for a variable reference voltage.
	Conversion speed
Clock setting to select how fast the ADC peripheral will perform an ADC conversion. The FRC setting is based on a RC time base and so will vary with temperature and pressure. Other settings are generally based on divisions of the master clock.
	Acquisition cycles
Number of micro seconds to wait for the ADC input to charge before starting the analogue sample.
	Bit Depth
Maximum number of digital bits the ADC can sample. 8 bit = ADC range 0 - 255 10 bit = ADC range 0 - 1023 12 bit = ADC range 0 - 4095
	Connections
	Channel
Analogue Input Channel - Which pin is the analogue input connected to?
	Simulations