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

	SampleMag
Samples the magnetometer 0 = no new data, 1 = new data available
- BYTE	Return

	CardCreate
Attempts to create a file on the SD card 255=Error, 1=File Already Exists, 0=Create OK
- STRING	Filename
- BYTE	Return

	LCDPrintNumber
Prints a 16-bit signed number to the LCD
- BYTE	X
X Pixel 0-127
- BYTE	Y
LCD Y coordinate 0-31
[[File:]] -	Number
Range -32768 to 32767
- VOID	Return

	LEDOff
Clears a single LED 0-7
- BYTE	index
Range: 0-7
- VOID	Return

	LEDWrite
Sets the value of the LEDs as an 8-bit output
- BYTE	Value
LED value 0=All Off, 255 = All On
- VOID	Return

	ReadAxis
Reads a single X/Y/Z axis from the accelerometer sensor.
- BYTE	index
0=X, 1=Y, 2=Z
[[File:]] -	Return

	ServoSetAutoMoveSpeed
Changes the speed of the auto movements Default - 1
- BYTE	Speed
Range 1-50
- VOID	Return

	CardPlayback
Plays back a .Wav file audio stream from the card
- STRING	Filename
- BYTE	Return

	ReadMic
Reads the microphone sensor 0 - 4095
- UINT	Return

	ReadSwitch
Read the switch value
- BYTE	index
0 (left) or 1 (right)
- BYTE	Return

	SampleAccel
Samples the accelerometer 0 = no new data, 1 = new data available
- BYTE	Return

	Left
Rotates the robot left - waits for the angle to be traversed before returning
- UINT	Angle
Angle to turn in degrees
- VOID	Return

	ReadIR
Reads an IR sensor 0=Left, 1=FrontLeft, 2=Front, 3=FrontRight, 4=Right, 5=RearRight, 6=Rear, 7=RearLeft
- BYTE	index
0=Left, 1=FrontLeft, 2=Front, 3=FrontRight, 4=Right, 5=RearRight, 6=Rear, 7=RearLeft
- UINT	Return

	LCDDrawPixel
Allows a single pixel on the LCD to be set or cleared
- BYTE	X
X Pixel 0-127
- BYTE	Y
Y Pixel 0-31
- BYTE	State
0=White (Off), 1=Black (On)
- VOID	Return

	ServoSetPosition
Allows one of the servo positions to be assigned
- BYTE	Channel
Range 0-3
- BYTE	Position
Range 0-255
- VOID	Return

	CardBitmap
Displays a monochrome bitmap read from the card on the LCD
- BYTE	X
Range 0-127
- BYTE	Y
Range 0-31
- STRING	Filename
- BYTE	Return

	CardRecordMic
Records an audio stream on the card from the microphone
- BYTE	BitDepth
0=8-bit, 1=16-bit
- BYTE	SampleRate
Sample Rate 0=8KHz, 1=16KHz
- UINT	RecordTime
Time to record for in seconds, Range 0-65535
- STRING	Filename
- BYTE	Return

	CardOpen
Attempts to open an existing file on the SD card 255=Error, 1=File not found, 0=Open OK
- STRING	Filename
- BYTE	Return

	Forwards
Drives the robot forwards - waits for the distance to be traversed before returning
- UINT	Distance
Distance in mm
- VOID	Return

	ReadBearing
Reads the compass bearing based on the degrees clockwise from magnetic north.
[[File:]] -	Return

	GetConsoleHandle
Gets the handle to the console allowing data displaying on the panel etc.
[[File:]] -	Return

	LCDDrawLine
Allows a single pixel width line to be drawn on the LCD
- BYTE	X1
X Pixel 0-127
- BYTE	Y1
Y Pixel 0-31
- BYTE	X2
X Pixel 0-127
- BYTE	Y2
Y Pixel 0-31
- VOID	Return

	ServoAutoMoveToPosition
Allows one of the servo positions to move gradually to a new position
- BYTE	Channel
Range 0-3
- BYTE	Position
Range 0-255
- VOID	Return

	ReadAllValue
Reads a single value stored from the read all command Index dictates which sensor value to read
- BYTE	Index
0=SW, 1-8=IR, 9-10=Line, 11=Light, 12=Mic, 13-15=Accel
- UINT	Return

	LCDBacklight
Allows the LCD backlight brighntess to be adjusted
- BYTE	Intensity
Range 0-100, 0=Off, 1=Min Brightness, 100=Max Brightness
- VOID	Return

	LCDDrawRect
Allows a rectangle to be drawn on the LCD
- BYTE	X1
X Pixel 0-127
- BYTE	Y1
Y Pixel 0-31
- BYTE	X2
X Pixel 0-127
- BYTE	Y2
Y Pixel 0-31
- VOID	Return

	ReadLine
Reads one of the IR line sensors 0-1 0=Left, 1=Right
- BYTE	index
0=Left, 1=Right
- UINT	Return

	ServoDisable
Allows one of the servo outputs 0-3 to be disabled
- BYTE	Channel
Range 0-3
- VOID	Return

	ServoEnable
Allows one of the servo outputs 0-3 to be enabled
- BYTE	Channel
Range 0-3
- VOID	Return

	CardReadByte
Reads a byte from the currently open file. Starts at the beginning of the file and auto increments to the end
- BYTE	Return

	CardErase
Attempts to delete an existing file on the SD card 255=Error, 1=File not found, 0=Delete OK
- STRING	Filename
- BYTE	Return

	CardWriteByte
Appends a byte to the end of the currently open file
- BYTE	Data
- VOID	Return

	EncoderRead
Reads one of the motor encoder counters. Approx 0.328296mm of travel per encoder unit.
- BYTE	index
0=Left, 1=Right
- UINT	Return

	SetMotors
Sets the motor speeds without feedback Range -100 to 100
[[File:]] -	Left
Range -100 to 100
[[File:]] -	Right
Range -100 to 100
- VOID	Return

	Backwards
Drives the robot backwards - waits for the distance to be traversed before returning
- UINT	Distance
Distance in mm
- VOID	Return

	EncoderReset
Resets the motor encoder counters
- VOID	Return

	LCDVerbose
Allows the LCD to automatically report the API commands as they get processed. Default - verbose on
- BYTE	State
0=Off 1=On
- VOID	Return

	SetProp
Allows the COM port property to be set from a parent component.
- STRING	PropName
- ULONG	PropVal
- VOID	Return

	CardInit
Attempts to startup the SD card 255=No Card, 254=Init Fail, 0=Init OK
- BYTE	Return

	GetProp
Allows the property filter for the COM port list to be copied to a parent component.
- STRING	PropName
- STRING	Return

	LCDClear
Clears the LCD
- VOID	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