Component: IntOsc Helper (Matrix Tools)

Author	MatrixTSL
Version	1.0
Category	Matrix Tools

IntOsc Helper component

A component to help configure the speed of the internal oscillator. Currently only supports 8-bit PIC devices.

Detailed description

No detailed description exists yet for this component

Examples

The INT OSC helper component is designed to help you configure the rate of the internal oscillator on-board your microcontroller.

It can be found under the Runtime -> Matrix Tools component category.

The oscillator speed drop down menu shows you what speeds are available on your device. Use this to select a speed.

Once you have chosen your required internal oscillator speed copy the code from the Code property.

Paste the configuration code into a C icon at the top of your main macro.

Next change the clock speed in the project options to match your oscillator speed. This will ensure that delays and baud rates are calculated correctly.

Finally you need to enable the internal oscillator in the configuration settings.

If everything is correct then the Info field should confirm that the project options clock speed matches the current speed selection.

Downloadable macro reference

	Initialise
Called to set the internal oscillator speed to the specified value.
- VOID	Return

	CheckBuffer
Returns the number of values in the transmit or receive buffer
[[File:]] -	Buffer
0=Transmit / 1=Receive
- UINT	Return

	ReceiveString
Gets a string from the receive buffer
- UINT	MaxChars
- UINT	Timeout
Time in milliseconds to wait for data
- STRING	Return

	Initialise
Initialises the UART component pins ready to send and receive data
- 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

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

	GetList
Gets Named property List
- STRING	Name
- STRING	Return

	Delay
Software UART Bit Delay
- VOID	Return

	SetValue
set Value of Named property
- STRING	Name
- STRING	Value
- VOID	Return

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

	GetList
Gets Named property List
- STRING	Name
- STRING	Return

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

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

	GetList
returns Named property list
- STRING	Name
- STRING	Return

Property reference

	Properties
	Oscillator Speed
Shows what internal oscillator speeds are available on the device and allows the user to select an option.
	Info
General info to the user, checks to see if the selected oscillator speed matches the project oscillator speed.
	Code
Code to configure the internal oscillator module. This code must be added to a C icon which should be placed at the top of main.
	Connections
	Simulations