Component: Matrix Cap Touch Display (Development): Difference between revisions
Appearance
No edit summary |
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder"" |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 101: | Line 101: | ||
===BluetoothConnectionStatus=== | ===BluetoothConnectionStatus=== | ||
{| 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" | '''BluetoothConnectionStatus''' | ||
|- | |- | ||
| colspan="2" | Checks to see if the Bluetooth is connected to a master device | | colspan="2" | Checks to see if the Bluetooth is connected to a master device | ||
| Line 115: | Line 115: | ||
===BluetoothInit=== | ===BluetoothInit=== | ||
{| 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" | '''BluetoothInit''' | ||
|- | |- | ||
| colspan="2" | Startup up Bluetooth communications and assigns a friendly name | | colspan="2" | Startup up Bluetooth communications and assigns a friendly name | ||
| Line 134: | Line 134: | ||
===BluetoothReceiveArray=== | ===BluetoothReceiveArray=== | ||
{| 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" | '''BluetoothReceiveArray''' | ||
|- | |- | ||
| colspan="2" | Read an array of bytes from the Bluetooth connection Returns the number of bytes read from the file | | colspan="2" | Read an array of bytes from the Bluetooth connection Returns the number of bytes read from the file | ||
| Line 158: | Line 158: | ||
===BluetoothSendArray=== | ===BluetoothSendArray=== | ||
{| 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" | '''BluetoothSendArray''' | ||
|- | |- | ||
| colspan="2" | Send an array of bytes via Bluetooth | | colspan="2" | Send an array of bytes via Bluetooth | ||
| Line 182: | Line 182: | ||
===BluetoothUninit=== | ===BluetoothUninit=== | ||
{| 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" | '''BluetoothUninit''' | ||
|- | |- | ||
| colspan="2" | Shots down Bluetooth communications | | colspan="2" | Shots down Bluetooth communications | ||
| Line 196: | Line 196: | ||
===ClearDisplay=== | ===ClearDisplay=== | ||
{| 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" | '''ClearDisplay''' | ||
|- | |- | ||
| colspan="2" | Clears the display and resets the button count | | colspan="2" | Clears the display and resets the button count | ||
| Line 210: | Line 210: | ||
===DrawArc=== | ===DrawArc=== | ||
{| 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" | '''DrawArc''' | ||
|- | |- | ||
| colspan="2" | Draws an arc either as an outline or as a filled object. | | colspan="2" | Draws an arc either as an outline or as a filled object. | ||
| Line 264: | Line 264: | ||
===DrawBitmap=== | ===DrawBitmap=== | ||
{| 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" | '''DrawBitmap''' | ||
|- | |- | ||
| colspan="2" | Draws a bitmap image loaded from the SD card FileInit must be called first to ensure the File System is setup. | | colspan="2" | Draws a bitmap image loaded from the SD card FileInit must be called first to ensure the File System is setup. | ||
| Line 308: | Line 308: | ||
===DrawButton=== | ===DrawButton=== | ||
{| 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" | '''DrawButton''' | ||
|- | |- | ||
| colspan="2" | Draws a button or slider that can be touched | | colspan="2" | Draws a button or slider that can be touched | ||
| Line 367: | Line 367: | ||
===DrawEllipse=== | ===DrawEllipse=== | ||
{| 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" | '''DrawEllipse''' | ||
|- | |- | ||
| colspan="2" | Draws a ellipse centered around X,Y with radius X2,Y2 | | colspan="2" | Draws a ellipse centered around X,Y with radius X2,Y2 | ||
| Line 411: | Line 411: | ||
===DrawGraph=== | ===DrawGraph=== | ||
{| 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" | '''DrawGraph''' | ||
|- | |- | ||
| colspan="2" | Draws a line graph area on the display with or without grids. Uses the current foreground / background colours | | colspan="2" | Draws a line graph area on the display with or without grids. Uses the current foreground / background colours | ||
| Line 500: | Line 500: | ||
===DrawLine=== | ===DrawLine=== | ||
{| 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" | '''DrawLine''' | ||
|- | |- | ||
| colspan="2" | Draws a single pixel thickness line | | colspan="2" | Draws a single pixel thickness line | ||
| Line 534: | Line 534: | ||
===DrawPixel=== | ===DrawPixel=== | ||
{| 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" | '''DrawPixel''' | ||
|- | |- | ||
| colspan="2" | Draws a single pixel in the foreground colour at X,Y | | colspan="2" | Draws a single pixel in the foreground colour at X,Y | ||
| Line 558: | Line 558: | ||
===DrawQRCode=== | ===DrawQRCode=== | ||
{| 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" | '''DrawQRCode''' | ||
|- | |- | ||
| colspan="2" | Draws a QR code with the specified data string embedded. Default size for the QR code is 33 x 33 @ a scaler of 1. Can be used to store up to 78 characters Recommend a scaler of 3 or 4. QR code should be drawn with a decent clear border around it to make it easier to scan. | | colspan="2" | Draws a QR code with the specified data string embedded. Default size for the QR code is 33 x 33 @ a scaler of 1. Can be used to store up to 78 characters Recommend a scaler of 3 or 4. QR code should be drawn with a decent clear border around it to make it easier to scan. | ||
| Line 592: | Line 592: | ||
===DrawRectangle=== | ===DrawRectangle=== | ||
{| 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" | '''DrawRectangle''' | ||
|- | |- | ||
| colspan="2" | Draws a rectangle from X1,Y1 to X2,Y2 | | colspan="2" | Draws a rectangle from X1,Y1 to X2,Y2 | ||
| Line 636: | Line 636: | ||
===DrawRoundedRectangle=== | ===DrawRoundedRectangle=== | ||
{| 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" | '''DrawRoundedRectangle''' | ||
|- | |- | ||
| colspan="2" | Draws a rectangle with rounded corners | | colspan="2" | Draws a rectangle with rounded corners | ||
| Line 685: | Line 685: | ||
===DrawString=== | ===DrawString=== | ||
{| 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" | '''DrawString''' | ||
|- | |- | ||
| colspan="2" | Draws a string at the specified location in the specified font | | colspan="2" | Draws a string at the specified location in the specified font | ||
| Line 729: | Line 729: | ||
===FileCreate=== | ===FileCreate=== | ||
{| 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" | '''FileCreate''' | ||
|- | |- | ||
| colspan="2" | Creates an empty file on the file system | | colspan="2" | Creates an empty file on the file system | ||
| Line 748: | Line 748: | ||
===FileDelete=== | ===FileDelete=== | ||
{| 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" | '''FileDelete''' | ||
|- | |- | ||
| colspan="2" | Deletes a file from the file system | | colspan="2" | Deletes a file from the file system | ||
| Line 767: | Line 767: | ||
===FileInit=== | ===FileInit=== | ||
{| 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" | '''FileInit''' | ||
|- | |- | ||
| colspan="2" | Starts up the FAT file system access function for the SD card 0=OK | | colspan="2" | Starts up the FAT file system access function for the SD card 0=OK | ||
| Line 781: | Line 781: | ||
===FileOpen=== | ===FileOpen=== | ||
{| 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" | '''FileOpen''' | ||
|- | |- | ||
| colspan="2" | Opens a file ready for reading or writing | | colspan="2" | Opens a file ready for reading or writing | ||
| Line 800: | Line 800: | ||
===FileReadArray=== | ===FileReadArray=== | ||
{| 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" | '''FileReadArray''' | ||
|- | |- | ||
| colspan="2" | Read an array of bytes from the current open file Returns the number of bytes read from the file | | colspan="2" | Read an array of bytes from the current open file Returns the number of bytes read from the file | ||
| Line 824: | Line 824: | ||
===FileWriteArray=== | ===FileWriteArray=== | ||
{| 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" | '''FileWriteArray''' | ||
|- | |- | ||
| colspan="2" | Write an array of bytes to the current open file | | colspan="2" | Write an array of bytes to the current open file | ||
| Line 848: | Line 848: | ||
===FolderOpen=== | ===FolderOpen=== | ||
{| 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" | '''FolderOpen''' | ||
|- | |- | ||
| colspan="2" | Navigates the current directory to a folder We can use ",," to go up a level or "root" to go back to the root. | | colspan="2" | Navigates the current directory to a folder We can use ",," to go up a level or "root" to go back to the root. | ||
| Line 867: | Line 867: | ||
===GetAPIVersion=== | ===GetAPIVersion=== | ||
{| 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" | '''GetAPIVersion''' | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
| Line 881: | Line 881: | ||
===GetCardPresent=== | ===GetCardPresent=== | ||
{| 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" | '''GetCardPresent''' | ||
|- | |- | ||
| colspan="2" | Checks to see if a SD card is inserted 1=Card Present, 0=No Card Present | | colspan="2" | Checks to see if a SD card is inserted 1=Card Present, 0=No Card Present | ||
| Line 895: | Line 895: | ||
===GetLastButtonPress=== | ===GetLastButtonPress=== | ||
{| 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" | '''GetLastButtonPress''' | ||
|- | |- | ||
| colspan="2" | Gets the button index of the last valid button press. 255 = No new touch detected | | colspan="2" | Gets the button index of the last valid button press. 255 = No new touch detected | ||
| Line 909: | Line 909: | ||
===GetLastRawTouchCoordinate=== | ===GetLastRawTouchCoordinate=== | ||
{| 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" | '''GetLastRawTouchCoordinate''' | ||
|- | |- | ||
| colspan="2" | Gets the coordinates of the last touch. -1 = no new touch data available. | | colspan="2" | Gets the coordinates of the last touch. -1 = no new touch data available. | ||
| Line 928: | Line 928: | ||
===GetSliderValue=== | ===GetSliderValue=== | ||
{| 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" | '''GetSliderValue''' | ||
|- | |- | ||
| colspan="2" | Gets the value of one of the slider buttons | | colspan="2" | Gets the value of one of the slider buttons | ||
| Line 947: | Line 947: | ||
===Initialise=== | ===Initialise=== | ||
{| 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" | '''Initialise''' | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
| Line 961: | Line 961: | ||
===ListenForTouch=== | ===ListenForTouch=== | ||
{| 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" | '''ListenForTouch''' | ||
|- | |- | ||
| colspan="2" | Enables a screen touch to interrupt the microcontroller using a UART RX interrupt. The master microcontroller must call this function and then enable UART RX interrupt. | | colspan="2" | Enables a screen touch to interrupt the microcontroller using a UART RX interrupt. The master microcontroller must call this function and then enable UART RX interrupt. | ||
| Line 985: | Line 985: | ||
===SetBackgroundColour=== | ===SetBackgroundColour=== | ||
{| 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" | '''SetBackgroundColour''' | ||
|- | |- | ||
| colspan="2" | Sets the background draw colour | | colspan="2" | Sets the background draw colour | ||
| Line 1,014: | Line 1,014: | ||
===SetBacklightBrightness=== | ===SetBacklightBrightness=== | ||
{| 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" | '''SetBacklightBrightness''' | ||
|- | |- | ||
| colspan="2" | Sets the brightness of the backlight | | colspan="2" | Sets the brightness of the backlight | ||
| Line 1,033: | Line 1,033: | ||
===SetBitmapTransparencyColour=== | ===SetBitmapTransparencyColour=== | ||
{| 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" | '''SetBitmapTransparencyColour''' | ||
|- | |- | ||
| colspan="2" | Sets the RGB colour to use as a transparent mask when drawing bitmaps | | colspan="2" | Sets the RGB colour to use as a transparent mask when drawing bitmaps | ||
| Line 1,062: | Line 1,062: | ||
===SetButtonIntervalPeriod=== | ===SetButtonIntervalPeriod=== | ||
{| 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" | '''SetButtonIntervalPeriod''' | ||
|- | |- | ||
| colspan="2" | Sets the button repress interval in steps of 10ms | | colspan="2" | Sets the button repress interval in steps of 10ms | ||
| Line 1,081: | Line 1,081: | ||
===SetColourPallet=== | ===SetColourPallet=== | ||
{| 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" | '''SetColourPallet''' | ||
|- | |- | ||
| colspan="2" | Sets the colour pallet for drawing buttons | | colspan="2" | Sets the colour pallet for drawing buttons | ||
| Line 1,160: | Line 1,160: | ||
===SetFontScaler=== | ===SetFontScaler=== | ||
{| 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" | '''SetFontScaler''' | ||
|- | |- | ||
| colspan="2" | Sets the brightness of the backlight | | colspan="2" | Sets the brightness of the backlight | ||
| Line 1,184: | Line 1,184: | ||
===SetForegroundColour=== | ===SetForegroundColour=== | ||
{| 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" | '''SetForegroundColour''' | ||
|- | |- | ||
| colspan="2" | Sets the foreground draw colour | | colspan="2" | Sets the foreground draw colour | ||
| Line 1,213: | Line 1,213: | ||
===SetGraphData=== | ===SetGraphData=== | ||
{| 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" | '''SetGraphData''' | ||
|- | |- | ||
| colspan="2" | Draws a line graph area on the display with or without grids. Uses the current foreground / background colours | | colspan="2" | Draws a line graph area on the display with or without grids. Uses the current foreground / background colours | ||
| Line 1,242: | Line 1,242: | ||
===SetOrientation=== | ===SetOrientation=== | ||
{| 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" | '''SetOrientation''' | ||
|- | |- | ||
| colspan="2" | Sets the display orientation | | colspan="2" | Sets the display orientation | ||
| Line 1,261: | Line 1,261: | ||
===SetSliderValue=== | ===SetSliderValue=== | ||
{| 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" | '''SetSliderValue''' | ||
|- | |- | ||
| colspan="2" | Sets the value of one of the slider buttons | | colspan="2" | Sets the value of one of the slider buttons | ||
| Line 1,285: | Line 1,285: | ||
===UpdateButtonText=== | ===UpdateButtonText=== | ||
{| 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" | '''UpdateButtonText''' | ||
|- | |- | ||
| colspan="2" | Redraws the selected button with the new text | | colspan="2" | Redraws the selected button with the new text | ||
| Line 1,309: | Line 1,309: | ||
===UpdateButtonTheme=== | ===UpdateButtonTheme=== | ||
{| 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" | '''UpdateButtonTheme''' | ||
|- | |- | ||
| colspan="2" | Redraws the selected button in a new theme | | colspan="2" | Redraws the selected button in a new theme | ||
| Line 1,333: | Line 1,333: | ||
===WifiAcceptClose=== | ===WifiAcceptClose=== | ||
{| 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" | '''WifiAcceptClose''' | ||
|- | |- | ||
| colspan="2" | Stops incoming socket requests from being accepted | | colspan="2" | Stops incoming socket requests from being accepted | ||
| Line 1,347: | Line 1,347: | ||
===WifiAcceptOpen=== | ===WifiAcceptOpen=== | ||
{| 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" | '''WifiAcceptOpen''' | ||
|- | |- | ||
| colspan="2" | Allows incoming socket requests to be accepted | | colspan="2" | Allows incoming socket requests to be accepted | ||
| Line 1,361: | Line 1,361: | ||
===WifiConnectToSSID=== | ===WifiConnectToSSID=== | ||
{| 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" | '''WifiConnectToSSID''' | ||
|- | |- | ||
| colspan="2" | Connects to a remote WIFI network | | colspan="2" | Connects to a remote WIFI network | ||
| Line 1,385: | Line 1,385: | ||
===WifiCreateAccessPoint=== | ===WifiCreateAccessPoint=== | ||
{| 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" | '''WifiCreateAccessPoint''' | ||
|- | |- | ||
| colspan="2" | Creates a local access point | | colspan="2" | Creates a local access point | ||
| Line 1,419: | Line 1,419: | ||
===WifiDisconnect=== | ===WifiDisconnect=== | ||
{| 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" | '''WifiDisconnect''' | ||
|- | |- | ||
| colspan="2" | Disconnect from the current socket | | colspan="2" | Disconnect from the current socket | ||
| Line 1,433: | Line 1,433: | ||
===WifiInit=== | ===WifiInit=== | ||
{| 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" | '''WifiInit''' | ||
|- | |- | ||
| colspan="2" | Startup up WIFI communications | | colspan="2" | Startup up WIFI communications | ||
| Line 1,447: | Line 1,447: | ||
===WifiReadIP=== | ===WifiReadIP=== | ||
{| 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" | '''WifiReadIP''' | ||
|- | |- | ||
| colspan="2" | Collects the IP address from the WIFI as a string. | | colspan="2" | Collects the IP address from the WIFI as a string. | ||
| Line 1,461: | Line 1,461: | ||
===WifiReceiveArray=== | ===WifiReceiveArray=== | ||
{| 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" | '''WifiReceiveArray''' | ||
|- | |- | ||
| colspan="2" | Read an array of bytes from the WIFI connection Returns the number of bytes read from the file | | colspan="2" | Read an array of bytes from the WIFI connection Returns the number of bytes read from the file | ||
| Line 1,485: | Line 1,485: | ||
===WifiScan=== | ===WifiScan=== | ||
{| 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" | '''WifiScan''' | ||
|- | |- | ||
| colspan="2" | Scans the WIFI network and returns the number of networks detected | | colspan="2" | Scans the WIFI network and returns the number of networks detected | ||
| Line 1,499: | Line 1,499: | ||
===WifiScanEncryptionMode=== | ===WifiScanEncryptionMode=== | ||
{| 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" | '''WifiScanEncryptionMode''' | ||
|- | |- | ||
| colspan="2" | Collects the encryption mode from one of the results of the Scan. 0=Open, 1=WEP, 2=WPA_PSK, 3=WPA2_PSK, 4=WPA_WPA2_PSK | | colspan="2" | Collects the encryption mode from one of the results of the Scan. 0=Open, 1=WEP, 2=WPA_PSK, 3=WPA2_PSK, 4=WPA_WPA2_PSK | ||
| Line 1,518: | Line 1,518: | ||
===WifiScanSSID=== | ===WifiScanSSID=== | ||
{| 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" | '''WifiScanSSID''' | ||
|- | |- | ||
| colspan="2" | Collects the SSID network name from one of the results of the Scan. | | colspan="2" | Collects the SSID network name from one of the results of the Scan. | ||
| Line 1,537: | Line 1,537: | ||
===WifiScanSigStrength=== | ===WifiScanSigStrength=== | ||
{| 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" | '''WifiScanSigStrength''' | ||
|- | |- | ||
| colspan="2" | Collects the signal strength from one of the results of the Scan | | colspan="2" | Collects the signal strength from one of the results of the Scan | ||
| Line 1,556: | Line 1,556: | ||
===WifiSendArray=== | ===WifiSendArray=== | ||
{| 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" | '''WifiSendArray''' | ||
|- | |- | ||
| colspan="2" | Send an array of bytes via WIFI | | colspan="2" | Send an array of bytes via WIFI | ||
| Line 1,580: | Line 1,580: | ||
===WifiSocketClose=== | ===WifiSocketClose=== | ||
{| 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" | '''WifiSocketClose''' | ||
|- | |- | ||
| colspan="2" | Close a socket | | colspan="2" | Close a socket | ||
| Line 1,594: | Line 1,594: | ||
===WifiSocketConnect=== | ===WifiSocketConnect=== | ||
{| 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" | '''WifiSocketConnect''' | ||
|- | |- | ||
| colspan="2" | Connect to a remote socket | | colspan="2" | Connect to a remote socket | ||
| Line 1,618: | Line 1,618: | ||
===WifiSocketListen=== | ===WifiSocketListen=== | ||
{| 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" | '''WifiSocketListen''' | ||
|- | |- | ||
| colspan="2" | Listens to a socket for incoming data | | colspan="2" | Listens to a socket for incoming data | ||
| Line 1,637: | Line 1,637: | ||
===WifiSocketOpen=== | ===WifiSocketOpen=== | ||
{| 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" | '''WifiSocketOpen''' | ||
|- | |- | ||
| colspan="2" | Opens a socket | | colspan="2" | Opens a socket | ||
| Line 1,651: | Line 1,651: | ||
===WifiUninit=== | ===WifiUninit=== | ||
{| 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" | '''WifiUninit''' | ||
|- | |- | ||
| colspan="2" | Shots down Wifi communications | | colspan="2" | Shots down Wifi communications | ||
| Line 1,666: | Line 1,666: | ||
==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,682: | Line 1,682: | ||
| colspan="2" | Amount of time to wait for each return byte | | colspan="2" | Amount of time to wait for each return byte | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-propfolder" | Connections | ||
|- | |- | ||
|- | |- | ||
| Line 1,711: | Line 1,711: | ||
| colspan="2" | Allows the hardware receive pin to be configured from a list of available pins based on your target device, | | colspan="2" | Allows the hardware receive pin to be configured from a list of available pins based on your target device, | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-propfolder" | Simulation | ||
|- | |- | ||
|- | |- | ||
Latest revision as of 14:36, 13 July 2026
| Author | Matrix TSL |
| Version | 1.0 |
| Category | Development |
Matrix Cap Touch Display component
A component to drive the capacitive touch display module as used in EM, 3PH PSU, CNC
Detailed description
No detailed description exists yet for this component
Examples
Auto Detect Port Number
This example auto detects and opens a COM Port based on preassigned USB Identifiers VID/PID.
For a known device the VID and PID can be found via Windows device manager.
Macro reference
BluetoothConnectionStatus
| BluetoothConnectionStatus | |
| Checks to see if the Bluetooth is connected to a master device | |
| Return | |
BluetoothInit
| BluetoothInit | |
| Startup up Bluetooth communications and assigns a friendly name | |
| Name | |
| Friendly device name | |
| Return | |
BluetoothReceiveArray
| BluetoothReceiveArray | |
| Read an array of bytes from the Bluetooth connection Returns the number of bytes read from the file | |
| Data | |
| Count | |
| Return | |
BluetoothSendArray
| BluetoothSendArray | |
| Send an array of bytes via Bluetooth | |
| Data | |
| Count | |
| Return | |
BluetoothUninit
| BluetoothUninit | |
| Shots down Bluetooth communications | |
| Return | |
ClearDisplay
| ClearDisplay | |
| Clears the display and resets the button count | |
| Return | |
DrawArc
DrawBitmap
DrawButton
DrawEllipse
DrawGraph
DrawLine
| DrawLine | |
| Draws a single pixel thickness line | |
| X1 | |
| Y1 | |
| X2 | |
| Y2 | |
| Return | |
DrawPixel
| DrawPixel | |
| Draws a single pixel in the foreground colour at X,Y | |
| X1 | |
| Y1 | |
| Return | |
DrawQRCode
DrawRectangle
DrawRoundedRectangle
DrawString
FileCreate
| FileCreate | |
| Creates an empty file on the file system | |
| Filename | |
| Text label to draw on the button | |
| Return | |
FileDelete
| FileDelete | |
| Deletes a file from the file system | |
| Filename | |
| Text label to draw on the button | |
| Return | |
FileInit
| FileInit | |
| Starts up the FAT file system access function for the SD card 0=OK | |
| Return | |
FileOpen
| FileOpen | |
| Opens a file ready for reading or writing | |
| Filename | |
| Text label to draw on the button | |
| Return | |
FileReadArray
| FileReadArray | |
| Read an array of bytes from the current open file Returns the number of bytes read from the file | |
| Data | |
| Count | |
| Return | |
FileWriteArray
| FileWriteArray | |
| Write an array of bytes to the current open file | |
| Data | |
| Count | |
| Return | |
FolderOpen
| FolderOpen | |
| Navigates the current directory to a folder We can use ",," to go up a level or "root" to go back to the root. | |
| Filename | |
| Text label to draw on the button | |
| Return | |
GetAPIVersion
| GetAPIVersion | |
| Return | |
GetCardPresent
| GetCardPresent | |
| Checks to see if a SD card is inserted 1=Card Present, 0=No Card Present | |
| Return | |
GetLastButtonPress
| GetLastButtonPress | |
| Gets the button index of the last valid button press. 255 = No new touch detected | |
| Return | |
GetLastRawTouchCoordinate
| GetLastRawTouchCoordinate | |
| Gets the coordinates of the last touch. -1 = no new touch data available. | |
| XY | |
| Return | |
GetSliderValue
| GetSliderValue | |
| Gets the value of one of the slider buttons | |
| ButtonID | |
| the ID of the slider button you want to read | |
| Return | |
Initialise
| Initialise | |
| Return | |
ListenForTouch
SetBackgroundColour
| SetBackgroundColour | |
| Sets the background draw colour | |
| R | |
| G | |
| B | |
| Return | |
SetBacklightBrightness
| SetBacklightBrightness | |
| Sets the brightness of the backlight | |
| Brightness | |
| 0=Off, 255=Max | |
| Return | |
SetBitmapTransparencyColour
| SetBitmapTransparencyColour | |
| Sets the RGB colour to use as a transparent mask when drawing bitmaps | |
| R | |
| G | |
| B | |
| Return | |
SetButtonIntervalPeriod
| SetButtonIntervalPeriod | |
| Sets the button repress interval in steps of 10ms | |
| Period | |
| Multiple of 10ms, default 50 = 500ms | |
| Return | |
SetColourPallet
SetFontScaler
| SetFontScaler | |
| Sets the brightness of the backlight | |
| XScaler | |
| Width Multiplier Range: 1 to x | |
| YScaler | |
| Height Multiplier Range: 1 to x | |
| Return | |
SetForegroundColour
| SetForegroundColour | |
| Sets the foreground draw colour | |
| R | |
| G | |
| B | |
| Return | |
SetGraphData
SetOrientation
| SetOrientation | |
| Sets the display orientation | |
| Orientation | |
| Range: 0 - 3 | |
| Return | |
SetSliderValue
| SetSliderValue | |
| Sets the value of one of the slider buttons | |
| ButtonID | |
| the ID of the slider button you want to read | |
| Value | |
| Range: 0 to 1 | |
| Return | |
UpdateButtonText
| UpdateButtonText | |
| Redraws the selected button with the new text | |
| ButtonIndex | |
| Range: 0 to NumButtons -1 | |
| Text | |
| Return | |
UpdateButtonTheme
| UpdateButtonTheme | |
| Redraws the selected button in a new theme | |
| ButtonIndex | |
| Range: 0 to NumButtons -1 | |
| ThemeIndex | |
| Range: 0 to 9 | |
| Return | |
WifiAcceptClose
| WifiAcceptClose | |
| Stops incoming socket requests from being accepted | |
| Return | |
WifiAcceptOpen
| WifiAcceptOpen | |
| Allows incoming socket requests to be accepted | |
| Return | |
WifiConnectToSSID
| WifiConnectToSSID | |
| Connects to a remote WIFI network | |
| SSID | |
| Text label to draw on the button | |
| Password | |
| Return | |
WifiCreateAccessPoint
WifiDisconnect
| WifiDisconnect | |
| Disconnect from the current socket | |
| Return | |
WifiInit
| WifiInit | |
| Startup up WIFI communications | |
| Return | |
WifiReadIP
| WifiReadIP | |
| Collects the IP address from the WIFI as a string. | |
| Return | |
WifiReceiveArray
| WifiReceiveArray | |
| Read an array of bytes from the WIFI connection Returns the number of bytes read from the file | |
| Data | |
| Count | |
| Return | |
WifiScan
| WifiScan | |
| Scans the WIFI network and returns the number of networks detected | |
| Return | |
WifiScanEncryptionMode
WifiScanSSID
| WifiScanSSID | |
| Collects the SSID network name from one of the results of the Scan. | |
| Index | |
| Range: 0 - (Num Returned By WifiSSIDScan) - 1 | |
| Return | |
WifiScanSigStrength
| WifiScanSigStrength | |
| Collects the signal strength from one of the results of the Scan | |
| Index | |
| Range: 0 - (Num Returned By WifiSSIDScan) - 1 | |
| Return | |
WifiSendArray
| WifiSendArray | |
| Send an array of bytes via WIFI | |
| Data | |
| Count | |
| Return | |
WifiSocketClose
| WifiSocketClose | |
| Close a socket | |
| Return | |
WifiSocketConnect
| WifiSocketConnect | |
| Connect to a remote socket | |
| Address | |
| Port | |
| Return | |
WifiSocketListen
| WifiSocketListen | |
| Listens to a socket for incoming data | |
| Port | |
| Return | |
WifiSocketOpen
| WifiSocketOpen | |
| Opens a socket | |
| Return | |
WifiUninit
| WifiUninit | |
| Shots down Wifi communications | |
| Return | |
Property reference
Component Source Code
Please click here to download the component source project: FC_Comp_Source_CapTouchDIsplay.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_CapTouchDIsplay.fcfx