Component: Formula AllCode API (AllCode): Difference between revisions
m Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead"" |
|||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 14: | Line 14: | ||
==Formula AllCode API component== | ==Formula AllCode API component== | ||
A simulation only component to allow the Formula AllCode robot to be controlled via it's API interface and Bluetooth data connection without having to compile or re-program the robot. | A simulation only component to allow the Formula AllCode robot to be controlled via it's API interface and Bluetooth data connection without having to compile or re-program the robot. | ||
==Detailed description== | ==Detailed description== | ||
| Line 89: | Line 83: | ||
===Backwards=== | ===Backwards=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''Backwards''' | ||
|- | |- | ||
| colspan="2" | Drives the robot backwards - waits for the distance to be traversed before returning | | colspan="2" | Drives the robot backwards - waits for the distance to be traversed before returning | ||
| Line 108: | Line 102: | ||
===CardBitmap=== | ===CardBitmap=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''CardBitmap''' | ||
|- | |- | ||
| colspan="2" | Displays a monochrome bitmap read from the card on the LCD | | colspan="2" | Displays a monochrome bitmap read from the card on the LCD | ||
| Line 137: | Line 131: | ||
===CardCreate=== | ===CardCreate=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''CardCreate''' | ||
|- | |- | ||
| colspan="2" | Attempts to create a file on the SD card 255=Error, 1=File Already Exists, 0=Create OK | | colspan="2" | Attempts to create a file on the SD card 255=Error, 1=File Already Exists, 0=Create OK | ||
| Line 156: | Line 150: | ||
===CardErase=== | ===CardErase=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''CardErase''' | ||
|- | |- | ||
| colspan="2" | Attempts to delete an existing file on the SD card 255=Error, 1=File not found, 0=Delete OK | | colspan="2" | Attempts to delete an existing file on the SD card 255=Error, 1=File not found, 0=Delete OK | ||
| Line 175: | Line 169: | ||
===CardInit=== | ===CardInit=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''CardInit''' | ||
|- | |- | ||
| colspan="2" | Attempts to startup the SD card 255=No Card, 254=Init Fail, 0=Init OK | | colspan="2" | Attempts to startup the SD card 255=No Card, 254=Init Fail, 0=Init OK | ||
| Line 189: | Line 183: | ||
===CardOpen=== | ===CardOpen=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''CardOpen''' | ||
|- | |- | ||
| colspan="2" | Attempts to open an existing file on the SD card 255=Error, 1=File not found, 0=Open OK | | colspan="2" | Attempts to open an existing file on the SD card 255=Error, 1=File not found, 0=Open OK | ||
| Line 208: | Line 202: | ||
===CardPlayback=== | ===CardPlayback=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''CardPlayback''' | ||
|- | |- | ||
| colspan="2" | Plays back a .Wav file audio stream from the card | | colspan="2" | Plays back a .Wav file audio stream from the card | ||
| Line 227: | Line 221: | ||
===CardReadByte=== | ===CardReadByte=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''CardReadByte''' | ||
|- | |- | ||
| colspan="2" | Reads a byte from the currently open file. Starts at the beginning of the file and auto increments to the end | | colspan="2" | Reads a byte from the currently open file. Starts at the beginning of the file and auto increments to the end | ||
| Line 241: | Line 235: | ||
===CardRecordMic=== | ===CardRecordMic=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''CardRecordMic''' | ||
|- | |- | ||
| colspan="2" | Records an audio stream on the card from the microphone | | colspan="2" | Records an audio stream on the card from the microphone | ||
| Line 275: | Line 269: | ||
===CardWriteByte=== | ===CardWriteByte=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''CardWriteByte''' | ||
|- | |- | ||
| colspan="2" | Appends a byte to the end of the currently open file | | colspan="2" | Appends a byte to the end of the currently open file | ||
| Line 294: | Line 288: | ||
===EncoderRead=== | ===EncoderRead=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''EncoderRead''' | ||
|- | |- | ||
| colspan="2" | Reads one of the motor encoder counters. Approx 0.328296mm of travel per encoder unit. | | colspan="2" | Reads one of the motor encoder counters. Approx 0.328296mm of travel per encoder unit. | ||
| Line 313: | Line 307: | ||
===EncoderReset=== | ===EncoderReset=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''EncoderReset''' | ||
|- | |- | ||
| colspan="2" | Resets the motor encoder counters | | colspan="2" | Resets the motor encoder counters | ||
| Line 327: | Line 321: | ||
===Forwards=== | ===Forwards=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''Forwards''' | ||
|- | |- | ||
| colspan="2" | Drives the robot forwards - waits for the distance to be traversed before returning | | colspan="2" | Drives the robot forwards - waits for the distance to be traversed before returning | ||
| Line 346: | Line 340: | ||
===GetConsoleHandle=== | ===GetConsoleHandle=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''GetConsoleHandle''' | ||
|- | |- | ||
| colspan="2" | Gets the handle to the console allowing data displaying on the panel etc. | | colspan="2" | Gets the handle to the console allowing data displaying on the panel etc. | ||
| Line 360: | Line 354: | ||
===GetProp=== | ===GetProp=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''GetProp''' | ||
|- | |- | ||
| colspan="2" | Allows the property filter for the COM port list to be copied to a parent component. | | colspan="2" | Allows the property filter for the COM port list to be copied to a parent component. | ||
| Line 379: | Line 373: | ||
===LCDBacklight=== | ===LCDBacklight=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''LCDBacklight''' | ||
|- | |- | ||
| colspan="2" | Allows the LCD backlight brighntess to be adjusted | | colspan="2" | Allows the LCD backlight brighntess to be adjusted | ||
| Line 398: | Line 392: | ||
===LCDClear=== | ===LCDClear=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''LCDClear''' | ||
|- | |- | ||
| colspan="2" | Clears the LCD | | colspan="2" | Clears the LCD | ||
| Line 412: | Line 406: | ||
===LCDDrawLine=== | ===LCDDrawLine=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''LCDDrawLine''' | ||
|- | |- | ||
| colspan="2" | Allows a single pixel width line to be drawn on the LCD | | colspan="2" | Allows a single pixel width line to be drawn on the LCD | ||
| Line 446: | Line 440: | ||
===LCDDrawPixel=== | ===LCDDrawPixel=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''LCDDrawPixel''' | ||
|- | |- | ||
| colspan="2" | Allows a single pixel on the LCD to be set or cleared | | colspan="2" | Allows a single pixel on the LCD to be set or cleared | ||
| Line 475: | Line 469: | ||
===LCDDrawRect=== | ===LCDDrawRect=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''LCDDrawRect''' | ||
|- | |- | ||
| colspan="2" | Allows a rectangle to be drawn on the LCD | | colspan="2" | Allows a rectangle to be drawn on the LCD | ||
| Line 509: | Line 503: | ||
===LCDPrintNumber=== | ===LCDPrintNumber=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''LCDPrintNumber''' | ||
|- | |- | ||
| colspan="2" | Prints a 16-bit signed number to the LCD | | colspan="2" | Prints a 16-bit signed number to the LCD | ||
| Line 538: | Line 532: | ||
===LCDPrintString=== | ===LCDPrintString=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''LCDPrintString''' | ||
|- | |- | ||
| colspan="2" | Prints a string to the LCD | | colspan="2" | Prints a string to the LCD | ||
| Line 567: | Line 561: | ||
===LCDVerbose=== | ===LCDVerbose=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''LCDVerbose''' | ||
|- | |- | ||
| colspan="2" | Allows the LCD to automatically report the API commands as they get processed. Default - verbose on | | colspan="2" | Allows the LCD to automatically report the API commands as they get processed. Default - verbose on | ||
| Line 586: | Line 580: | ||
===LEDOff=== | ===LEDOff=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''LEDOff''' | ||
|- | |- | ||
| colspan="2" | Clears a single LED 0-7 | | colspan="2" | Clears a single LED 0-7 | ||
| Line 605: | Line 599: | ||
===LEDOn=== | ===LEDOn=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''LEDOn''' | ||
|- | |- | ||
| colspan="2" | Sets a single LED 0-7 | | colspan="2" | Sets a single LED 0-7 | ||
| Line 624: | Line 618: | ||
===LEDWrite=== | ===LEDWrite=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''LEDWrite''' | ||
|- | |- | ||
| colspan="2" | Sets the value of the LEDs as an 8-bit output | | colspan="2" | Sets the value of the LEDs as an 8-bit output | ||
| Line 643: | Line 637: | ||
===Left=== | ===Left=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''Left''' | ||
|- | |- | ||
| colspan="2" | Rotates the robot left - waits for the angle to be traversed before returning | | colspan="2" | Rotates the robot left - waits for the angle to be traversed before returning | ||
| Line 662: | Line 656: | ||
===PlayNote=== | ===PlayNote=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''PlayNote''' | ||
|- | |- | ||
| colspan="2" | Plays a note using the speaker on the FA | | colspan="2" | Plays a note using the speaker on the FA | ||
| Line 686: | Line 680: | ||
===ReadAllSensors=== | ===ReadAllSensors=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ReadAllSensors''' | ||
|- | |- | ||
| colspan="2" | Samples all of the robot's sensors at once, storing the values locally | | colspan="2" | Samples all of the robot's sensors at once, storing the values locally | ||
| Line 700: | Line 694: | ||
===ReadAllValue=== | ===ReadAllValue=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ReadAllValue''' | ||
|- | |- | ||
| colspan="2" | Reads a single value stored from the read all command Index dictates which sensor value to read | | colspan="2" | Reads a single value stored from the read all command Index dictates which sensor value to read | ||
| Line 719: | Line 713: | ||
===ReadAxis=== | ===ReadAxis=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ReadAxis''' | ||
|- | |- | ||
| colspan="2" | Reads a single X/Y/Z axis from the accelerometer sensor. | | colspan="2" | Reads a single X/Y/Z axis from the accelerometer sensor. | ||
| Line 738: | Line 732: | ||
===ReadBearing=== | ===ReadBearing=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ReadBearing''' | ||
|- | |- | ||
| colspan="2" | Reads the compass bearing based on the degrees clockwise from magnetic north. | | colspan="2" | Reads the compass bearing based on the degrees clockwise from magnetic north. | ||
| Line 752: | Line 746: | ||
===ReadIR=== | ===ReadIR=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ReadIR''' | ||
|- | |- | ||
| colspan="2" | Reads an IR sensor 0=Left, 1=FrontLeft, 2=Front, 3=FrontRight, 4=Right, 5=RearRight, 6=Rear, 7=RearLeft | | colspan="2" | Reads an IR sensor 0=Left, 1=FrontLeft, 2=Front, 3=FrontRight, 4=Right, 5=RearRight, 6=Rear, 7=RearLeft | ||
| Line 771: | Line 765: | ||
===ReadLight=== | ===ReadLight=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ReadLight''' | ||
|- | |- | ||
| colspan="2" | Reads the light sensor 0-4095 - 4095 = Max Brightness | | colspan="2" | Reads the light sensor 0-4095 - 4095 = Max Brightness | ||
| Line 785: | Line 779: | ||
===ReadLine=== | ===ReadLine=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ReadLine''' | ||
|- | |- | ||
| colspan="2" | Reads one of the IR line sensors 0-1 0=Left, 1=Right | | colspan="2" | Reads one of the IR line sensors 0-1 0=Left, 1=Right | ||
| Line 804: | Line 798: | ||
===ReadMic=== | ===ReadMic=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ReadMic''' | ||
|- | |- | ||
| colspan="2" | Reads the microphone sensor 0 - 4095 | | colspan="2" | Reads the microphone sensor 0 - 4095 | ||
| Line 818: | Line 812: | ||
===ReadSwitch=== | ===ReadSwitch=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ReadSwitch''' | ||
|- | |- | ||
| colspan="2" | Read the switch value | | colspan="2" | Read the switch value | ||
| Line 837: | Line 831: | ||
===Right=== | ===Right=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''Right''' | ||
|- | |- | ||
| colspan="2" | Rotates the robot right - waits for the angle to be traversed before returning | | colspan="2" | Rotates the robot right - waits for the angle to be traversed before returning | ||
| Line 856: | Line 850: | ||
===SampleAccel=== | ===SampleAccel=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''SampleAccel''' | ||
|- | |- | ||
| colspan="2" | Samples the accelerometer 0 = no new data, 1 = new data available | | colspan="2" | Samples the accelerometer 0 = no new data, 1 = new data available | ||
| Line 870: | Line 864: | ||
===SampleMag=== | ===SampleMag=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''SampleMag''' | ||
|- | |- | ||
| colspan="2" | Samples the magnetometer 0 = no new data, 1 = new data available | | colspan="2" | Samples the magnetometer 0 = no new data, 1 = new data available | ||
| Line 884: | Line 878: | ||
===ServoAutoMoveToPosition=== | ===ServoAutoMoveToPosition=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ServoAutoMoveToPosition''' | ||
|- | |- | ||
| colspan="2" | Allows one of the servo positions to move gradually to a new position | | colspan="2" | Allows one of the servo positions to move gradually to a new position | ||
| Line 908: | Line 902: | ||
===ServoDisable=== | ===ServoDisable=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ServoDisable''' | ||
|- | |- | ||
| colspan="2" | Allows one of the servo outputs 0-3 to be disabled | | colspan="2" | Allows one of the servo outputs 0-3 to be disabled | ||
| Line 927: | Line 921: | ||
===ServoEnable=== | ===ServoEnable=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ServoEnable''' | ||
|- | |- | ||
| colspan="2" | Allows one of the servo outputs 0-3 to be enabled | | colspan="2" | Allows one of the servo outputs 0-3 to be enabled | ||
| Line 946: | Line 940: | ||
===ServoSetAutoMoveSpeed=== | ===ServoSetAutoMoveSpeed=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ServoSetAutoMoveSpeed''' | ||
|- | |- | ||
| colspan="2" | Changes the speed of the auto movements Default - 1 | | colspan="2" | Changes the speed of the auto movements Default - 1 | ||
| Line 965: | Line 959: | ||
===ServoSetPosition=== | ===ServoSetPosition=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ServoSetPosition''' | ||
|- | |- | ||
| colspan="2" | Allows one of the servo positions to be assigned | | colspan="2" | Allows one of the servo positions to be assigned | ||
| Line 989: | Line 983: | ||
===SetLogoSpeed=== | ===SetLogoSpeed=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''SetLogoSpeed''' | ||
|- | |- | ||
| colspan="2" | Sets the speed of logo movements | | colspan="2" | Sets the speed of logo movements | ||
| Line 1,008: | Line 1,002: | ||
===SetMotors=== | ===SetMotors=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''SetMotors''' | ||
|- | |- | ||
| colspan="2" | Sets the motor speeds without feedback Range -100 to 100 | | colspan="2" | Sets the motor speeds without feedback Range -100 to 100 | ||
| Line 1,032: | Line 1,026: | ||
===SetProp=== | ===SetProp=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''SetProp''' | ||
|- | |- | ||
| colspan="2" | Allows the COM port property to be set from a parent component. | | colspan="2" | Allows the COM port property to be set from a parent component. | ||
| Line 1,057: | Line 1,051: | ||
==Property reference== | ==Property reference== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''Properties''' | ||
|- | |- | ||
|- | |- | ||
| Line 1,083: | Line 1,077: | ||
| colspan="2" | | | colspan="2" | | ||
|} | |} | ||
==Component Source Code== | |||
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_FormulaAllCode_API.fcsx FC_Comp_Source_FormulaAllCode_API.fcsx] | |||
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_FormulaAllCode_API.fcsx FC_Comp_Source_FormulaAllCode_API.fcsx] | |||
Latest revision as of 14:22, 13 July 2026
| Author | Matrix Ltd |
| Version | 1.2 |
| Category | AllCode |
Formula AllCode API component
A simulation only component to allow the Formula AllCode robot to be controlled via it's API interface and Bluetooth data connection without having to compile or re-program the robot.
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
Backwards
|
Backwards |
| Drives the robot backwards - waits for the distance to be traversed before returning | |
 - UINT
|
Distance |
| Distance in mm | |
 - VOID
|
Return |
CardBitmap
|
|
CardBitmap |
| Displays a monochrome bitmap read from the card on the LCD | |
 - BYTE
|
X |
| Range 0-127 | |
| - BYTE
|
Y |
| Range 0-31 | |
 - STRING
|
Filename |
| - BYTE
|
Return |
CardCreate
|
|
CardCreate |
| Attempts to create a file on the SD card 255=Error, 1=File Already Exists, 0=Create OK | |
| - STRING
|
Filename |
| - BYTE
|
Return |
CardErase
|
|
CardErase |
| Attempts to delete an existing file on the SD card 255=Error, 1=File not found, 0=Delete OK | |
| - STRING
|
Filename |
| - BYTE
|
Return |
CardInit
|
|
CardInit |
| Attempts to startup the SD card 255=No Card, 254=Init Fail, 0=Init OK | |
| - BYTE
|
Return |
CardOpen
|
|
CardOpen |
| Attempts to open an existing file on the SD card 255=Error, 1=File not found, 0=Open OK | |
| - STRING
|
Filename |
| - BYTE
|
Return |
CardPlayback
|
|
CardPlayback |
| Plays back a .Wav file audio stream from the card | |
| - STRING
|
Filename |
| - BYTE
|
Return |
CardReadByte
|
|
CardReadByte |
| Reads a byte from the currently open file. Starts at the beginning of the file and auto increments to the end | |
| - BYTE
|
Return |
CardRecordMic
|
|
CardRecordMic |
| Records an audio stream on the card from the microphone | |
| - BYTE
|
BitDepth |
| 0=8-bit, 1=16-bit | |
| - BYTE
|
SampleRate |
| Sample Rate 0=8KHz, 1=16KHz | |
| - UINT
|
RecordTime |
| Time to record for in seconds, Range 0-65535 | |
| - STRING
|
Filename |
| - BYTE
|
Return |
CardWriteByte
|
|
CardWriteByte |
| Appends a byte to the end of the currently open file | |
| - BYTE
|
Data |
| - VOID
|
Return |
EncoderRead
|
|
EncoderRead |
| Reads one of the motor encoder counters. Approx 0.328296mm of travel per encoder unit. | |
| - BYTE
|
index |
| 0=Left, 1=Right | |
| - UINT
|
Return |
EncoderReset
|
|
EncoderReset |
| Resets the motor encoder counters | |
| - VOID
|
Return |
Forwards
|
|
Forwards |
| Drives the robot forwards - waits for the distance to be traversed before returning | |
| - UINT
|
Distance |
| Distance in mm | |
| - VOID
|
Return |
GetConsoleHandle
|
|
GetConsoleHandle |
| Gets the handle to the console allowing data displaying on the panel etc. | |
 - HANDLE
|
Return |
GetProp
|
|
GetProp |
| Allows the property filter for the COM port list to be copied to a parent component. | |
| - STRING
|
PropName |
| - STRING
|
Return |
LCDBacklight
|
|
LCDBacklight |
| Allows the LCD backlight brighntess to be adjusted | |
| - BYTE
|
Intensity |
| Range 0-100, 0=Off, 1=Min Brightness, 100=Max Brightness | |
| - VOID
|
Return |
LCDClear
|
|
LCDClear |
| Clears the LCD | |
| - VOID
|
Return |
LCDDrawLine
|
|
LCDDrawLine |
| Allows a single pixel width line to be drawn on the LCD | |
| - BYTE
|
X1 |
| X Pixel 0-127 | |
| - BYTE
|
Y1 |
| Y Pixel 0-31 | |
| - BYTE
|
X2 |
| X Pixel 0-127 | |
| - BYTE
|
Y2 |
| Y Pixel 0-31 | |
| - VOID
|
Return |
LCDDrawPixel
|
|
LCDDrawPixel |
| Allows a single pixel on the LCD to be set or cleared | |
| - BYTE
|
X |
| X Pixel 0-127 | |
| - BYTE
|
Y |
| Y Pixel 0-31 | |
| - BYTE
|
State |
| 0=White (Off), 1=Black (On) | |
| - VOID
|
Return |
LCDDrawRect
|
|
LCDDrawRect |
| Allows a rectangle to be drawn on the LCD | |
| - BYTE
|
X1 |
| X Pixel 0-127 | |
| - BYTE
|
Y1 |
| Y Pixel 0-31 | |
| - BYTE
|
X2 |
| X Pixel 0-127 | |
| - BYTE
|
Y2 |
| Y Pixel 0-31 | |
| - VOID
|
Return |
LCDPrintNumber
|
|
LCDPrintNumber |
| Prints a 16-bit signed number to the LCD | |
| - BYTE
|
X |
| X Pixel 0-127 | |
| - BYTE
|
Y |
| LCD Y coordinate 0-31 | |
 - INT
|
Number |
| Range -32768 to 32767 | |
| - VOID
|
Return |
LCDPrintString
|
|
LCDPrintString |
| Prints a string to the LCD | |
| - BYTE
|
X |
| X Pixel 0-127 | |
| - BYTE
|
Y |
| LCD Y Coordinate 0-31 | |
| - STRING
|
Data |
| - VOID
|
Return |
LCDVerbose
|
|
LCDVerbose |
| Allows the LCD to automatically report the API commands as they get processed. Default - verbose on | |
| - BYTE
|
State |
| 0=Off 1=On | |
| - VOID
|
Return |
LEDOff
|
|
LEDOff |
| Clears a single LED 0-7 | |
| - BYTE
|
index |
| Range: 0-7 | |
| - VOID
|
Return |
LEDOn
|
|
LEDOn |
| Sets a single LED 0-7 | |
| - BYTE
|
index |
| Range: 0-7 | |
| - VOID
|
Return |
LEDWrite
|
|
LEDWrite |
| Sets the value of the LEDs as an 8-bit output | |
| - BYTE
|
Value |
| LED value 0=All Off, 255 = All On | |
| - VOID
|
Return |
Left
|
|
Left |
| Rotates the robot left - waits for the angle to be traversed before returning | |
| - UINT
|
Angle |
| Angle to turn in degrees | |
| - VOID
|
Return |
PlayNote
|
|
PlayNote |
| Plays a note using the speaker on the FA | |
| - UINT
|
Note |
| Range 1 to 65535 in Hz | |
| - UINT
|
Delay |
| Number of milliseconds to play the note for | |
| - VOID
|
Return |
ReadAllSensors
|
|
ReadAllSensors |
| Samples all of the robot's sensors at once, storing the values locally | |
| - VOID
|
Return |
ReadAllValue
|
|
ReadAllValue |
| Reads a single value stored from the read all command Index dictates which sensor value to read | |
| - BYTE
|
Index |
| 0=SW, 1-8=IR, 9-10=Line, 11=Light, 12=Mic, 13-15=Accel | |
| - UINT
|
Return |
ReadAxis
|
|
ReadAxis |
| Reads a single X/Y/Z axis from the accelerometer sensor. | |
| - BYTE
|
index |
| 0=X, 1=Y, 2=Z | |
| - INT
|
Return |
ReadBearing
|
|
ReadBearing |
| Reads the compass bearing based on the degrees clockwise from magnetic north. | |
| - INT
|
Return |
ReadIR
|
|
ReadIR |
| Reads an IR sensor 0=Left, 1=FrontLeft, 2=Front, 3=FrontRight, 4=Right, 5=RearRight, 6=Rear, 7=RearLeft | |
| - BYTE
|
index |
| 0=Left, 1=FrontLeft, 2=Front, 3=FrontRight, 4=Right, 5=RearRight, 6=Rear, 7=RearLeft | |
| - UINT
|
Return |
ReadLight
|
|
ReadLight |
| Reads the light sensor 0-4095 - 4095 = Max Brightness | |
| - UINT
|
Return |
ReadLine
|
|
ReadLine |
| Reads one of the IR line sensors 0-1 0=Left, 1=Right | |
| - BYTE
|
index |
| 0=Left, 1=Right | |
| - UINT
|
Return |
ReadMic
|
|
ReadMic |
| Reads the microphone sensor 0 - 4095 | |
| - UINT
|
Return |
ReadSwitch
|
|
ReadSwitch |
| Read the switch value | |
| - BYTE
|
index |
| 0 (left) or 1 (right) | |
| - BYTE
|
Return |
Right
|
|
Right |
| Rotates the robot right - waits for the angle to be traversed before returning | |
| - UINT
|
Angle |
| Angle to turn in degrees | |
| - VOID
|
Return |
SampleAccel
|
|
SampleAccel |
| Samples the accelerometer 0 = no new data, 1 = new data available | |
| - BYTE
|
Return |
SampleMag
|
|
SampleMag |
| Samples the magnetometer 0 = no new data, 1 = new data available | |
| - BYTE
|
Return |
ServoAutoMoveToPosition
|
|
ServoAutoMoveToPosition |
| Allows one of the servo positions to move gradually to a new position | |
| - BYTE
|
Channel |
| Range 0-3 | |
| - BYTE
|
Position |
| Range 0-255 | |
| - VOID
|
Return |
ServoDisable
|
|
ServoDisable |
| Allows one of the servo outputs 0-3 to be disabled | |
| - BYTE
|
Channel |
| Range 0-3 | |
| - VOID
|
Return |
ServoEnable
|
|
ServoEnable |
| Allows one of the servo outputs 0-3 to be enabled | |
| - BYTE
|
Channel |
| Range 0-3 | |
| - VOID
|
Return |
ServoSetAutoMoveSpeed
|
|
ServoSetAutoMoveSpeed |
| Changes the speed of the auto movements Default - 1 | |
| - BYTE
|
Speed |
| Range 1-50 | |
| - VOID
|
Return |
ServoSetPosition
|
|
ServoSetPosition |
| Allows one of the servo positions to be assigned | |
| - BYTE
|
Channel |
| Range 0-3 | |
| - BYTE
|
Position |
| Range 0-255 | |
| - VOID
|
Return |
SetLogoSpeed
|
|
SetLogoSpeed |
| Sets the speed of logo movements | |
| - BYTE
|
Speed |
| Logo Speed 1-100 - Default 40 | |
| - VOID
|
Return |
SetMotors
|
|
SetMotors |
| Sets the motor speeds without feedback Range -100 to 100 | |
| - INT
|
Left |
| Range -100 to 100 | |
| - INT
|
Right |
| Range -100 to 100 | |
| - VOID
|
Return |
SetProp
|
|
SetProp |
| Allows the COM port property to be set from a parent component. | |
| - STRING
|
PropName |
 - ULONG
|
PropVal |
| - VOID
|
Return |
Property reference
|
Properties |
|
COM Port |
| Selects which port to communicate with, only lists ports which are currently available. | |
|
Refresh COM Ports |
| When set to yes the COM port list is rescanned for newly connected or available ports. Note that refreshing the ports list may take a few seconds depending on the number of connected ports. | |
|
Baud |
| Baud rate passed to the COM port to control the rate of data. | |
|
Label |
Component Source Code
Please click here to download the component source project: FC_Comp_Source_FormulaAllCode_API.fcsx
Please click here to view the component source code (Beta): FC_Comp_Source_FormulaAllCode_API.fcsx