[goggles] / project_information.txt

<Application Description for Project Goes Here>

Project Owner(s):
Author(s):
Hardware Platform:
Debuggers Used:
Programmers Used:
MPLAB Version:
C Compiler Version:
Final Checksum:

FILES INCLUDED IN THE PROJECT TREE:

system.h - Contains custom oscillator configuration function prototypes,
reset source evaluation function prototypes, and non-peripheral
microcontroller initialization function prototypes.  It also may contain
system level #define macros and variables.  This file is included
by system.c

user.h - Contains parameters and function prototypes used in user.c for user
level functions, for example, InitApp();

configuration_bits.c - Contains device configuration bit macros.  Refer to
the comments in configuration_bits.c for instructions on where to get
information about device configuration bits and their corresponding macros.

interrupts.c - This file contains example stubs for interrupts.  The user would
put the interrupt vectors for their application in interrupts.c.

main.c - This is the main code for the project.  global variables and the
main() function are located in main.c  The user would put their primary program
flow in main.c, and the operation should be contained in main.c with an
infinite loop.

system.c - Contains custom oscillator configuration functions, reset source
evaluation functions, and non-peripheral microcontroller initialization
functions.  Functions in system.c would often be called from main.c during
device initialization.

user.c - Custom user algorithms, user peripheral initialization, data
computation functions, and calculation functions would go here.  Prototypes for
user.c go in user.h.

FILES INCLUDED IN THE PROJECT BUT NOT IN THE PROJECT TREE:

#include <htc.h>             /* Global Header File */
#include <stdint.h>          /* For uint8_t definition */
#include <stdbool.h>         /* For true/false definition */

These files come with the HiTech compiler.  Check the compiler documentation for
more information on these files.
Commit	Line	Data
	1	<Application Description for Project Goes Here>
	2
	3	Project Owner(s):
	4	Author(s):
	5	Hardware Platform:
	6	Debuggers Used:
	7	Programmers Used:
	8	MPLAB Version:
	9	C Compiler Version:
	10	Final Checksum:
	11
	12	FILES INCLUDED IN THE PROJECT TREE:
	13
	14	system.h - Contains custom oscillator configuration function prototypes,
	15	reset source evaluation function prototypes, and non-peripheral
	16	microcontroller initialization function prototypes. It also may contain
	17	system level #define macros and variables. This file is included
	18	by system.c
	19
	20	user.h - Contains parameters and function prototypes used in user.c for user
	21	level functions, for example, InitApp();
	22
	23	configuration_bits.c - Contains device configuration bit macros. Refer to
	24	the comments in configuration_bits.c for instructions on where to get
	25	information about device configuration bits and their corresponding macros.
	26
	27	interrupts.c - This file contains example stubs for interrupts. The user would
	28	put the interrupt vectors for their application in interrupts.c.
	29
	30	main.c - This is the main code for the project. global variables and the
	31	main() function are located in main.c The user would put their primary program
	32	flow in main.c, and the operation should be contained in main.c with an
	33	infinite loop.
	34
	35	system.c - Contains custom oscillator configuration functions, reset source
	36	evaluation functions, and non-peripheral microcontroller initialization
	37	functions. Functions in system.c would often be called from main.c during
	38	device initialization.
	39
	40	user.c - Custom user algorithms, user peripheral initialization, data
	41	computation functions, and calculation functions would go here. Prototypes for
	42	user.c go in user.h.
	43
	44	FILES INCLUDED IN THE PROJECT BUT NOT IN THE PROJECT TREE:
	45
	46	#include <htc.h> /* Global Header File */
	47	#include <stdint.h> /* For uint8_t definition */
	48	#include <stdbool.h> /* For true/false definition */
	49
	50	These files come with the HiTech compiler. Check the compiler documentation for
	51	more information on these files.