1.1.11 PIC32MK GP Development Kit: Building and Running the USB Device HID Bootloader Applications

Downloading and Building the Application

To clone or download this application from Github, go to the main page of this repository and then click Clone button to clone this repo or download as zip file. This content can be download using content manager by following these instructions.

Path of the application within the repository is apps/usb_device_hid_bootloader/.

To build the application, refer to the following table and open the project using its IDE.

Setting Up PIC32MK GP Development Kit

  • Connect a micro USB cable to the USB to UART port J25. This will enumerate as a COM port on the PC.
  • For programming, connect a micro USB cable to the USB DEBUG port J12
  • Use the micro-AB port J13, which is located on the bottom side of the board, to connect the USB device to the USB Host PC
  • Place the Switch S4 direction towards device
  • Jumper J28 must be open

Running the Application

  1. Open the test application project test_app/firmware/pic32mk_gp_db.X in the IDE.
  2. Build the project to generate the binary (Do not program the binary).
  3. Open the bootloader project bootloader/firmware/pic32mk_gp_db.X in the IDE.
  4. Build and program the application using the IDE.
  5. Once programming is completed and bootloader starts running:
    • LED1 will be turned-on
    • HID Custom device with product ID 3C will be enumerated on Host PC
  6. Open the Terminal application (e.g., Tera Term) on the computer to get test application messages through UART once bootloaded.
  7. Configure the serial port settings as follows:
    • Baud: 115200
    • Data: 8 Bits
    • Parity: None
    • Stop: 1 Bit
    • Flow Control: None
  8. Launch the Unified Host application from below path:
    • <harmony3_path>/bootloader/tools/UnifiedHost-*/UnifiedHost-*.jar
  9. Configure the Unified host application.
    • Select the Device Architecture and Protocol as shown below
    • Click the Configure button and select the USB Device as 3C
    • Load the test application hex file to be programmed using below option
      • <harmony3_path>/bootloader_apps_usb/apps/usb_device_hid_bootloader/test_app/firmware/pic32mk_gp_db.X/dist/pic32mk_gp_db/production/pic32mk_gp_db.X.production.hex
    • Open the Console window of the host application to view application bootloading sequence
  10. Click the Program Device button to program the loaded test application hex file on to the device.
  11. Following figure shows output of successfully programming the test application.
  12. If above step is successful then LED3 should start blinking and the user should see below output on the console.
  13. Press and hold the Switch S1 to trigger Bootloader from test application and the user should see below output.
  14. Repeat Steps 10-12 once and jump to Step 15.
    • This step is to verify that bootloader is running after triggering bootloader from test application in Step 13
  15. Press and hold the Switch S1 and then press MCLR button or Power cycle the device to force trigger bootloader at startup.
  16. Repeat Steps 10-12 once.
    • This step is to verify whether bootloader is triggered by switch press at reset
Note: Unified Host application has to be closed in order to program any application using MPLAB X IDE.