This repo is just a place to store documentation and library functions from ECE 376 - Embedded Systems (taught by Dr. Jacob Glower) so that I don't forget it. Specifically, this project uses the HI-TECH C Compiler for the PIC18F4620.
I also aimed to make the functions more readable by formatting the C files and adding better variable names and comments.
Right now the template.c file builds, and I know from ECE 376 that most of the functions work.
I haven't tested all the functions yet, though, so they may need some work to get right.
In order to build this project you need a few tools.
These tools can all be found on BisonAcademy
One thing to note is that the nbproject/configurations.xml file contains some build details by default such as:
- Microcontroller to build for (PIC18F4620)
- Compiler to use (HI-TECH C)
- Code Offset (0x800)
These should be good for everyone with the default installations of the above links, but you may need to verify that the settings are correct for you project and tools. I used MPLABX.pdf as a guide.
- Clone this repo or more properly create a new repo using this repo as a template
- Open MPLABX IDE
- Select File->Open Project (Ctrl + Shift + O)
- Select the folder where the repo is cloned
- Clean/Build the project
Doxygen style comments are used to create documentation for the helper functions in lib/. To generate html docs, install Doxygen (and add the Doxygen bin directory to the PATH) and run doxygen in the terminal to generate docs in docs/.