Difference between pages "Creating an RBC file" and "File:RBC Tab Name.png"

From ROBOTC API Guide
(Difference between pages)
Jump to: navigation, search
(How to create an RBC file)
 
 
Line 1: Line 1:
<yambe:breadcrumb self="Creating an RBC file">Main|Main page</yambe:breadcrumb>
 
  
{{tl|1|}}
 
 
== What is an RBC file? ==
 
{| style="font-family:Verdana, Geneva, sans-serif; color:black; background-color:#FFFFFF; text-align:left; font-size:100%;" width="100%" cellpadding="5%" cellspacing="0" border="0"
 
|-
 
|An RBC file is a special type of XML file that can be used with ROBOTC v3.52 or later. Once an RBC file is created properly, you will be able to configure ROBOTC's Platform Type, Compiler Target, Menu Level, and other important settings all with the click of a button. You can even configure the RBC program to load a user program and automatically download it to a robot or Virtual World of your choosing.
 
|-
 
|}
 
 
== How to create an RBC file ==
 
{| style="font-family:Verdana, Geneva, sans-serif; color:black; background-color:#FFFFFF; text-align:left; font-size:100%;" width="100%" cellpadding="5%" cellspacing="0" border="0"
 
|-
 
|There are several steps required in order to create a working RBC file. You will need an activated installation of ROBOTC and a text file editor installed on the computer. For this demonstration, we used ROBOTC for VEX Robotics 4.0 and Notepad++ as our text file editor.
 
|-
 
|'''1)''' Create a new file in your text file editor (generally found under the 'File -> New' menu option).
 
|-
 
|[[File:RBC_New_File.png]]
 
|-
 
|'''2)''' Save the file with a custom name and a '.rbc' file extension. You may also need to change the 'File Type' dropdown menu to 'All Files', depending on the text editor settings.
 
|-
 
|[[File:RBC_File_SaveAs.png]]
 
|-
 
|[[File:RBC_File_Name.png]]
 
|-
 
|'''3)''' Add the following parameters to the file:
 
*<?xml version="1.0" encoding="UTF-8"?>
 
*<RBCVersion>1.0.0</RBCVersion>
 
*<Platform></Platform>
 
*<CortexDLMethod></CortexDLMethod>
 
*<CircuitBoard></CircuitBoard>
 
*<MenuLevel></MenuLevel>
 
*<CompilerMode></CompilerMode>
 
*<CompileAndDownload></CompileAndDownload>
 
*<VirtualWorldIndex></VirtualWorldIndex>
 
*<SourceFileName>.c</SourceFileName>
 
*<RVWParameters></RVWParameters>
 
*<SourceCode></SourceCode>
 
|-
 
|[[File:RBC_File_Params.png]]
 
|-
 
|'''4)''' Modify the parameters to fit the settings for the program. For a full listing of all of the available parameters, see the 'XML Parameters' section below.
 
|-
 
|'''5)''' Save the RBC file.
 
|-
 
|'''6)''' Manually open the RBC file icon by double clicking on it. If the file is configured correctly, ROBOTC should open with the specified parameters using the specified source code. If the program does not open correctly (or opens with the wrong settings), double check the parameters for accuracy.
 
|}
 
 
== XML parameters ==
 
===XML Version===
 
{| style="font-family:Verdana, Geneva, sans-serif; color:black; background-color:#FFFFFF; text-align:left; font-size:100%;" width="100%" cellpadding="5%" cellspacing="0" border="0"
 
|-
 
| The XML Version parameter will identify the document as valid XML. This must always be at the top of the RBC document.
 
*'''<?xml version="1.0" encoding="UTF-8"?>'''
 
|-
 
|}
 
===RBC Version===
 
{| style="font-family:Verdana, Geneva, sans-serif; color:black; background-color:#FFFFFF; text-align:left; font-size:100%;" width="100%" cellpadding="5%" cellspacing="0" border="0"
 
|-
 
| Identifies the current RBC specification being used.  As of today, this value should be specified as 1.0.0.
 
*'''<RBCVersion>1.0.0</RBCVersion>'''
 
|-
 
|}
 
===Platform Type===
 
{| style="font-family:Verdana, Geneva, sans-serif; color:black; background-color:#FFFFFF; text-align:left; font-size:100%;" width="100%" cellpadding="5%" cellspacing="0" border="0"
 
|-
 
| Sets the platform type in ROBOTC. Requires the ROBOTC installation to have an appropriate license activated and valid in order to work properly.
 
*'''<Platform>PlatformType</Platform>'''
 
|-
 
|}
 
{| class="wikitable"
 
|-
 
|'''To set the Platform Type to...'''
 
|'''Use this parameter'''
 
|-
 
|VEX PIC
 
|VEX
 
|-
 
|VEX Cortex
 
|VEX2
 
|-
 
|LEGO NXT
 
|NXT
 
|-
 
|LEGO NXT + TETRIX
 
|TETRIX
 
|-
 
|Arduino
 
|ARDUINO
 
|}
 
 
===Cortex Download Method (VEX Cortex only)===
 
{| style="font-family:Verdana, Geneva, sans-serif; color:black; background-color:#FFFFFF; text-align:left; font-size:100%;" width="100%" cellpadding="5%" cellspacing="0" border="0"
 
|-
 
| Sets the Cortex Download Method – used to modify the cortex download method to allow the Cortex to either require a VEXnet/USB cable in order to run, or to allow “standalone” mode to run a user’s program without searching for a COMM link. If the Cortex is using the VEXNet system or will be physically tethered to a Joystick Controller using the USB A-to-A cable, the VEXNet option should be used. Otherwise, use the USB-Only mode
 
*'''<CortexDLMethod>DownloadMode</CortexDLMethod>'''
 
|-
 
|}
 
{| class="wikitable"
 
|-
 
|'''To set the Download Method to...'''
 
|'''Use this parameter'''
 
|-
 
|USB Only
 
|USBOnly
 
|-
 
|USB or VEXNet
 
|USBorWifi
 
|-
 
|Competition (VEXNet)
 
|Competition
 
|-
 
|}
 
 
===Circuit Board===
 
{| style="font-family:Verdana, Geneva, sans-serif; color:black; background-color:#FFFFFF; text-align:left; font-size:100%;" width="100%" cellpadding="5%" cellspacing="0" border="0"
 
|-
 
| This specifies the circuit board to be used. Has only real application with Arduino to differentiate between different board models (Uno,1280,2560,etc). Default value of blank (no value) for all other platforms.
 
*'''<CircuitBoard></CircuitBoard>'''
 
|-
 
|}
 
===Menu Level===
 
{| style="font-family:Verdana, Geneva, sans-serif; color:black; background-color:#FFFFFF; text-align:left; font-size:100%;" width="100%" cellpadding="5%" cellspacing="0" border="0"
 
|-
 
| Sets the ROBOTC GUI Menu Level. Used to show/hide functionality by adjusting the menu level types (Basic, Advanced, and Super User)
 
*'''<MenuLevel>Level</MenuLevel>'''
 
|-
 
|}
 
{| class="wikitable"
 
|-
 
|'''To set the Menu Level to...'''
 
|'''Use this parameter'''
 
|-
 
|Basic
 
|Basic
 
|-
 
|Expert
 
|Expert
 
|-
 
|Super User
 
|SuperUser
 
|-
 
|}
 
 
===Compiler Mode===
 
{| style="font-family:Verdana, Geneva, sans-serif; color:black; background-color:#FFFFFF; text-align:left; font-size:100%;" width="100%" cellpadding="5%" cellspacing="0" border="0"
 
|-
 
| Sets ROBOTC’s compiler mode (Compiler Target) – used to switch between real robots, the PC-based emulator, and Virtual Worlds compiling targets.
 
*'''<CompilerMode>CompilerTarget</CompilerMode>'''
 
|-
 
|}
 
{| class="wikitable"
 
|-
 
|'''To set the Compiler Target to...'''
 
|'''Use this parameter'''
 
|-
 
|Physical Robot
 
|Real
 
|-
 
|PC-based Emulator
 
|Emulator
 
|-
 
|Virtual Worlds
 
|VirtualWorlds
 
|-
 
|}
 
 
===Compile and Download===
 
{| style="font-family:Verdana, Geneva, sans-serif; color:black; background-color:#FFFFFF; text-align:left; font-size:100%;" width="100%" cellpadding="5%" cellspacing="0" border="0"
 
|-
 
| Flag to specify if the source code should be “compiled” or “compiled and downloaded”. If set to “YES”, the code will automatically be downloaded to the robot or Virtual World. Otherwise ("NO"), it will only be compiled.
 
*'''<CompileAndDownload>Yes</CompileAndDownload>'''
 
|-
 
|}
 
{| class="wikitable"
 
|-
 
|'''To set the Compile and Download option to...'''
 
|'''Use this parameter'''
 
|-
 
|Compile and download program automatically
 
|YES
 
|-
 
|Do not compile and download program automatically
 
|NO
 
|-
 
|}
 
 
===Virtual World Index===
 
{| style="font-family:Verdana, Geneva, sans-serif; color:black; background-color:#FFFFFF; text-align:left; font-size:100%;" width="100%" cellpadding="5%" cellspacing="0" border="0"
 
|-
 
| Sets the numerical type of the RVW Level Pack Index that should be launched. – This is only a numerical number that references the RVW Level Pack “ID” number.
 
*'''<VirtualWorldIndex>IndexNumber</VirtualWorldIndex>'''
 
|-
 
|}
 
{| class="wikitable"
 
|-
 
|'''To set this Virtual World'''
 
|'''Use this index parameter'''
 
|-
 
|Learning ROBOTC Tables Preview
 
|2
 
|-
 
|Curriculum Companion
 
|3
 
|-
 
|FTC Block Party!
 
|8
 
|-
 
|VEX Toss Up
 
|9
 
|-
 
|FTC Ring It Up!
 
|10
 
|-
 
|VEX Sack Attack
 
|11
 
|-
 
|Robots to the Rescue: Operation Reset
 
|12
 
|-
 
|Palm Island: Luau Edition
 
|14
 
|-
 
|Ruins of Atlantis
 
|15
 
|-
 
|RVW Level Builder
 
|18
 
|-
 
|}
 
 
===Source File Name===
 
{| style="font-family:Verdana, Geneva, sans-serif; color:black; background-color:#FFFFFF; text-align:left; font-size:100%;" width="100%" cellpadding="5%" cellspacing="0" border="0"
 
|-
 
| Name of the file that will be saved/displayed on the ROBOTC tab-bar at compile time – Note this file only is used if SourceCode is provided.
 
*'''<SourceFileName>Name_Of_Program.c</SourceFileName>'''
 
|-
 
|}
 
===RVW Parameters===
 
{| style="font-family:Verdana, Geneva, sans-serif; color:black; background-color:#FFFFFF; text-align:left; font-size:100%;" width="100%" cellpadding="5%" cellspacing="0" border="0"
 
|-
 
| Command Line Parameters that will be passed the next time Robot Virtual Worlds is launched. If the “CompileAndDownload” flag is set to “NO”, these parameters will be stored for the next execution. After the Virtual Worlds has been executed once, these parameters are discarded.
 
*'''<RVWParameters>parameter1 parameter2 parameter3</RVWParameters>'''
 
|-
 
|}
 
===Source Code===
 
{| style="font-family:Verdana, Geneva, sans-serif; color:black; background-color:#FFFFFF; text-align:left; font-size:100%;" width="100%" cellpadding="5%" cellspacing="0" border="0"
 
|-
 
| Source Code of program to be open/compiled/downloaded. This is not a reference to an existing file but rather the actual contents of the file.
 
*'''<SourceCode></SourceCode>
 
|-
 
|Because the RBC file uses XML formatting, the file cannot contain any XML escape markups in the Source Code section. Instead, the escape markups must be replaced with the characters below:
 
|-
 
|}
 
{| class="wikitable"
 
|-
 
|'''Character Name'''
 
|'''Replace this character..'''
 
|'''With this character
 
|-
 
|Ampersand
 
|&
 
|&amp;
 
|-
 
|Quotation Mark
 
|"
 
|&quot;
 
|-
 
|Apostrophe
 
|'
 
|&apos;
 
|-
 
|Less Than
 
|<
 
|&lt;
 
|-
 
|Greater Than
 
|>
 
|&gt;
 
|-
 
|}
 

Latest revision as of 17:47, 8 April 2014