Importing External Libraries

Importing External Libraries

Note

Integrate pre-built libraries that simplify working with peripherals and timing on the TM4C1294XL LaunchPad.

We have prepared several libraries to help you use the board peripherals more easily and modularly. These libraries allow you to write cleaner code without having to configure all registers manually.

---

Available Libraries

Library	Description
buttonsDriver	Manages hardware buttons with debouncing, and supports click, double click, and long press callbacks.
display	Includes Texas Instruments drivers for the Crystalfontz 128×128 ST7735 LCD display.
timerLib	Initializes a hardware timer to control time-based events without using SysTick. Ideal for periodic tasks.
elapsedTime	Works with timerLib to measure elapsed time between events easily using one timer source.
HAL_TM4C1294XL	Defines pin names and mappings for the TM4C1294XL to make code clearer and portable.
joystickDriver	Simplifies joystick input: provides Cartesian and polar coordinates, plus callbacks for directional events (N, S, E, W).
PLL	Calculates the actual MCU frequency after PLL configuration so timing values stay accurate.

---

Folder Organization

When you open your workspace, you will find two main folders:

• DirectoryLab_x

  • DirectoryLab_x_workspace

    • …
  • Directorylibraries

    • DirectorybuttonsDriver

      • …
    • Directorydisplay

      • …
    • DirectorytimerLib

      • …
    • DirectoryelapsedTime

      • …
    • DirectoryHAL_TM4C1294XL

      • …
    • DirectoryjoystickDriver

      • …
    • DirectoryPLL

      • …

Tip

The libraries folder should always remain outside your project workspace folder. Keep all library files together in this single location.

---

Importing the Libraries into Code Composer Studio

1. Open your CCS workspace.
2. Drag the entire libraries folder into the CCS Project Explorer panel.

_{Drag the libraries folder into Code Composer Studio}

3. When the import dialog appears, choose:
   • ✅ Link to files and recreate folder structure with virtual folders
   • ✅ Create link location relative to PROJECT_LOC

_{Always link files relative to PROJECT_LOC}

Caution

⚠️ This step is crucial. Always link libraries this way when adding them to any project. Do not copy them into the project directly.

4. CCS will then ask if you want to add include paths automatically. Select:
   • ✅ Do this for all header files currently being added
   • ✅ Yes

_{Confirm include path for all header files}

---

Verify Project Structure

After importing, your project should look like this:

_{Project structure with linked libraries folder}

---

Verify Include Paths

To confirm everything is correctly linked:

1. Right-click your project → Properties
2. Navigate to:

   Build → ARM Compiler → Include Options

3. You should see entries similar to:

   ${PROJECT_LOC}/libraries/buttonsDriver
   ${PROJECT_LOC}/libraries/display
   ${PROJECT_LOC}/libraries/timerLib
   ${PROJECT_LOC}/libraries/elapsedTime
   ${PROJECT_LOC}/libraries/HAL_TM4C1294XL
   ${PROJECT_LOC}/libraries/joystickDriver
   ${PROJECT_LOC}/libraries/PLL

_{Include paths confirmation in CCS project properties}

Tip

💡 If any path is missing, click Add…, navigate to your libraries folder, and ensure the path is relative to ${PROJECT_LOC}.

---

✅ Once all libraries are linked and visible in Project Explorer, you can include them in your code normally:

#include "buttonDriver.h"
#include "timerLib.h"
#include "elapsedTime.h"
#include "HAL_TM4C1294XL.h"

You are now ready to use modular drivers and utilities for your Lab development!

---