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