-
Notifications
You must be signed in to change notification settings - Fork 0
Using SUBLIBinal
This wiki page will guide you through the process of implementing SUBLIBinal and MPLABX assuming that you have a fresh install of linux (or any other operating system) on your computer.
- Step 1: Install MPLABX
- Step 2: Download the Source Code or Clone SUBLIBinal
- Step 3: Configure MPLABX Projects
- Step 4: Verify Functionality
The first thing you must to is install MPLABX development environment. MPLABX is used for programming PIC microcontrollers and has been developed by Microchip.
Install MPLABX from here.
It is also necessary to install the XC32 Compiler v1.40.
SUBLIBinal source code and library object file can be easily downloaded through GitHub releases! Simply download the release by downloading the object file and the source code. Place the source code and the object file into an easy to access directory, as you will include this directory in your MPLABX projects.
Instead of the library object file, feel free to include the library project folder included in the proj/ folder of the repository. This project file should be included in the "library" folder within your MPLABX project.
Alternatively, you can simply use the source code to create your own project within MPLABX. Simply download the source code and create a new library project in MPLABX. Include all source and header files and build the library project. Then, in all subsequent projects that use the library, include your library project in the "library" folder. This replaces the need for an object file.
Clone the SUBLIBinal repository onto a directory in your computer using any git tool of your choice. The repository contains project files for MPLABX to use as configuration. On windows, Git Extensions can be a great tool for working with git repositories.
On linux, navigate to your desired directory in the command line and type the command (git must be installed)
git clone git@github.com:PalouseRobosub/SUBLIBinal.git
This will create a repository of the code on your own local machine so that you may build your own library project. Please refer to downloading the source code for information about how to create a library project.
The next step will walk through how to configure an MPLABX project to utilize the SUBLIBinal library. Create a new MPLABX project (File->New Project).
- Select Standalone Project -> Next.
- Select the PIC32MX250F128B for the Device parameter, then select Next.
- Select the Licensed Debugger, then select Next.
- Select the XC32 Compiler, then select next.
- Enter a project name and select Finish.
Now, configure the project for SUBLIBinal.
- Right click the project and select Project Properties.
- Navigate down to xc32-gcc and select (underneath Conf->XC32 sub-menus)
- Set Option categories to "Preprocessing and messages"
- Modify "Include directories" to include the include/ folder of the SUBLIBinal repository.
- Select Apply, then OK.
Now, you may either include the library project file or the binary file in your project. Right click the "library" folder in your project and select "Add Library Project" to add the project file included in the repository or select "Add Library/Object File" to add the object file included in the release. Either of these methods will add SUBLIBinal library functionality to your project.
Your project should now be configured to properly use SUBLIBinal!
Please refer to the library usage documentation for examples of basic implementation of SUBLIBinal.
SUBLIBinal was created by the Palouse Robosub Club.