ARDUINO MEGA Functions Debug

From ROBOTC API Guide
Jump to: navigation, search
 
(One intermediate revision by one user not shown)
Line 1: Line 1:
−
{{DISPLAYTITLE:2560 Debug}}
+
{{DISPLAYTITLE:2560 (MEGA) Debug Functions}}
−
<yambe:breadcrumb self="Debug">ARDUINO_MEGA_Functions_and_Variables|Functions and Variables</yambe:breadcrumb>
+
<yambe:breadcrumb self="2560 (MEGA) Debug">ARDUINO_MEGA_Functions_and_Variables|Functions and Variables</yambe:breadcrumb>
 
<br />
 
<br />
  

Latest revision as of 13:48, 11 May 2012

ARDUINO → Functions and Variables → 2560 (MEGA) Debug


The debugger in ROBOTC allows you to see all of your sensor, motor and variables while running your program. ROBOTC also has a debug terminal called the "Debug Stream" that you can use to output a terminal-like stream of information to have an additional way to monitor your program.

The debug stream is buffered directly in memory on the Arduino platform - You can store 300 bytes of debug stream data on the Arduino when running away from the PC. Once the Arduino is connected to the PC, you can open the debug stream and the entire buffer will be written to the "Debug Stream" debugger window.

You can open this debugger window from the "Robot -> Debugger Windows -> Debug Stream" window when in Expert or Super User mode.

DebugStream.png

Contents
Color Key
Function:
Variable:


writeDebugStream

void writeDebugStream(const string sFormatString, ...)
(void) The Debug Stream functionality allow the user to output formatted text to a debug terminal. This command works similar to a print to LCD command, but displays the information to the "Debug Stream" ROBOTC debugger window.
Parameter Explanation Data Type
sFormatString A formatted string following standard C-Style convention for showing data inline. void 
  int fooBarVar = 503;                       //Create a Variable to Display
  writeDebugStream("Value: %d", fooBarVar);  //Write the string "Value: 503" to the Debug Stream


writeDebugStreamLine

void writeDebugStreamLine(const string sFormatString, ...)
(void) The Debug Stream functionality allow the user to output formatted text to a debug terminal. This command works similar to a print to LCD command, but displays the information to the "Debug Stream" ROBOTC debugger window.

The only difference between this function and "writeDebugStream" is that a new line character is added after every call of "writeDebugStreamLine".

Parameter Explanation Data Type
sFormatString A formatted string following standard C-Style convention for showing data inline. void 
  int fooBarVar = 503;                       //Create a Variable to Display
  writeDebugStream("Value: %d", fooBarVar);  //Write the string "Value: 503" to the Debug Stream


getAvailSpaceInDebugStream

intrinsic short getAvailSpaceInDebugStream()
(short) Variable will return the current amount of space available in the debug stream. For the Arduino platform, the maximum size of the debug stream is 300 bytes. 
  while(true)
  {
    if(getAvailSpaceInDebugStream() == 0)              //Check if there is still room available
      wait1Msec(50);                                   //No Room: Wait for a while.
    else
      writeDebugStream("Still Have Room!", fooBarVar); //Got room, let's write some data!
  }


bFloatConversionErrors

intrinsic bool bFloatConversionErrors
(bool) When true, this variable will generate an exception if an out of range error occurs when converting a "float" value to an integer. ROBOTC will convert out of range exceptions into the largest possible integer number.


Retrieved from "http://www.robotc.net/w/index.php?title=ARDUINO_MEGA_Functions_Debug&oldid=3276"
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox