Installation

Limitations of v5dbg

Please keep the following limitations in mind while using v5dbg.

• Every function must begin with $function
• Variables accessible by the debugger must be fed into $expose
• If your program has a fatal crash v5dbg cannot suspend the program.
  • Try using Symbolizer for VEX V5 in combination with v5dbg.
• Line-by-line stepping is not possible

Requirements

Please read through the requirements carefully

• Your user program is developed using PROS
• PROS toolchain is installed and up-to-date
  • The easiest way to do this is to use the VSCode extension

Downloading the release archive

Download the latest v5dbg_server.zip from the releases page on GitHub, now extract this archive into your project folder.

Pick the correct file!

Make sure to download v5dbg_server.zip, and not v5dbg_debugger.zip.

Debugger vs Debug Server

The debug server is the program that executes on the brain and performs all of the internal debug logic.

The debugger is the program that executes on your computer and serves as a frontend to the debug server over USB serial.

Copy server source code

Inside the newly created v5dbg folder copy

• v5dbg/include/v5dbg into include
• v5dbg/src/v5dbg into src

Build your program

Using either the VSCode extension, or by calling pros make from the terminal make sure that your program builds properly, all v5dbg source code files should automatically be detected and compiled in.