Difference between revisions of "ARDUINO MEGA Functions Debug"

From ROBOTC API Guide
Jump to: navigation, search
(writeDebugStream)
Line 8: Line 8:
 
{| style="color:black;" width="100%" cellpadding="5%" cellspacing="0" border="0"
 
{| style="color:black;" width="100%" cellpadding="5%" cellspacing="0" border="0"
 
|-
 
|-
| class="functionType"| <span class="bigKeywordBI">void </span><span class="bigKeywordB">writeDebugStream</span><span class="bigCodePunc">(</span><span class="bigKeywordBI">void </span><span class="bigCodeBasic">&pToBuffer</span><span class="bigCodePunc">, </span><span class="bigKeywordBI">const void </span><span class="bigCodeBasic">&pFromBuffer</span><span class="bigCodePunc">, </span><span class="bigKeywordBI">const short </span><span class="bigCodeBasic">nNumbOfBytes</span><span class="bigCodePunc">)</span>
+
| class="functionType"| <span class="bigKeywordBI">void </span><span class="bigKeywordB">writeDebugStream</span><span class="bigCodePunc">(</span><span class="bigKeywordBI">const string</span><span class="bigCodeBasic">sFormatString</span><span class="bigCodePunc">)</span>
 
|-
 
|-
| style="font-family:Verdana, Geneva, sans-serif; color:black; background-color:#FFFFFF; text-align:left; font-size:100%;"|([[Data_Types#dataType_void|void]]) Function copies characters from <span class="codeBasic">pFromBuffer</span> to <span class="codeBasic">pToBuffer</span>. <span class="codeBasic">nBytesToCopy</span> is the number of bytes to copy. Identical to the function found in conventional C 'string.h' library.
+
| style="font-family:Verdana, Geneva, sans-serif; color:black; background-color:#FFFFFF; text-align:left; font-size:100%;"|([[Data_Types#dataType_void|void]]) The Debug Stream functionality allow the user to output formatted text to a debug terminal, similar to a printf statement in a command line terminal window.
 
|-
 
|-
 
|
 
|
Line 18: Line 18:
 
   ! width="20%" style="border-style: solid; border-width: 0px 0px 1px 0px"|Data Type
 
   ! width="20%" style="border-style: solid; border-width: 0px 0px 1px 0px"|Data Type
 
   |-
 
   |-
   | style="border-style: solid; border-width: 1px 0px 1px 0px"|''pToBuffer''  
+
   | style="border-style: solid; border-width: 1px 0px 1px 0px"|''sFormatString''  
   | style="border-style: solid; border-width: 1px 0px 1px 0px"|buffer to copy to
+
   | style="border-style: solid; border-width: 1px 0px 1px 0px"|A formatted String
 
   | style="border-style: solid; border-width: 1px 0px 1px 0px"|[[Data_Types#dataType_void|void]]
 
   | style="border-style: solid; border-width: 1px 0px 1px 0px"|[[Data_Types#dataType_void|void]]
  |-
 
  | style="border-style: solid; border-width: 0px 0px 1px 0px"|''pFromBuffer''
 
  | style="border-style: solid; border-width: 0px 0px 1px 0px"|buffer to copy from
 
  | style="border-style: solid; border-width: 0px 0px 1px 0px"|[[Data_Types#dataType_void|void]]
 
  |-
 
  | style="border-style: solid; border-width: 0px 0px 0px 0px"|''nNumbOfBytes''
 
  | style="border-style: solid; border-width: 0px 0px 0px 0px"|number of bytes to copy
 
  | style="border-style: solid; border-width: 0px 0px 0px 0px"|[[Data_Types#dataType_short|short]]
 
 
   |-
 
   |-
 
   |}
 
   |}

Revision as of 00:29, 10 May 2012

ARDUINOFunctions and Variables → ARDUINO MEGA Functions Debug


Color Key
Function:
Variable:


writeDebugStream

void writeDebugStream(const stringsFormatString)
(void) The Debug Stream functionality allow the user to output formatted text to a debug terminal, similar to a printf statement in a command line terminal window.
Parameter Explanation Data Type
sFormatString A formatted String void
string sTemp = "ROBOTC";               // create a string, 'sTemp' to be "ROBOTC"
char sArray[20];                       // create a char array, 'sArray' of size 20
memcpy(sArray, sTemp, sizeof(sTemp));  // copy characters from 'sTemp' to 'sArray'


memset

void memset(void &pToBuffer, const short nValue, const short nNumbOfBytes)
(void) Sets a block of memory at pToBuffer to the value nValue. nNumbOfBytes is the number of bytes to set. This is a useful function for initializing the value of an array to all zeros. Identical to the function found in conventional C 'string.h' library.
Parameter Explanation Data Type
pToBuffer buffer to set void
nValue value to set buffer to short
nNumbOfBytes number of bytes to set short
int kSendSize = 1;                                   // we will be sending 1 byte
ubyte BytesToSend[kSendSize];                        // create a ubyte array of size 1
short nMsgXmit = 0;                                  // we will be setting them to 0
memset(BytesToSend, nMsgXmit, sizeof(BytesToSend));  // set the Byte Array to 0


nVexMasterVersion

const word nVexMasterVersion
(word) Variable contains the firmware version for the VEX master CPU.
int MasterFirmwareVer = nVexMasterVersion; // stores the value of the Master Firmware to a variable


version

const word version
(word) Contains the firmware version number.
displayNextLCDNumber(version);  // display the current firmware version on the LCD