Component: Dashboard Text (Runtime Tools): Difference between revisions
Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix Ltd |- | width="20%" style="color:gray;" | Version | 1.1 |- | width="20%" style="color:gray..." |
No edit summary |
||
| Line 16: | Line 16: | ||
==Detailed description== | ==Detailed description== | ||
''No detailed description exists yet for this component'' | ''No detailed description exists yet for this component'' | ||
==Examples== | ==Examples== | ||
| Line 93: | Line 97: | ||
|- | |- | ||
| colspan="2" | The text to add to the display. | | colspan="2" | The text to add to the display. | ||
|- | |||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | |||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | |||
|} | |||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | |||
|- | |||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | |||
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReceiveString''' | |||
|- | |||
| colspan="2" | Gets a string from the receive buffer | |||
|- | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT | |||
| width="90%" | MaxChars | |||
|- | |||
| colspan="2" | | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT | |||
| width="90%" | Timeout | |||
|- | |||
| colspan="2" | Time in milliseconds to wait for data | |||
|- | |||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING | |||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | |||
|} | |||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | |||
|- | |||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | |||
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise''' | |||
|- | |||
| colspan="2" | Initialises the UART component pins ready to send and receive data | |||
|- | |||
|- | |||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | |||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | |||
|} | |||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | |||
|- | |||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | |||
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReceiveString''' | |||
|- | |||
| colspan="2" | Receives a string of bytes and returns the number of bytes received. | |||
|- | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | |||
| width="90%" | StringData | |||
|- | |||
| colspan="2" | | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT | |||
| width="90%" | NumBytes | |||
|- | |||
| colspan="2" | Maximum number of bytes to try and receive | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT | |||
| width="90%" | Timeout | |||
|- | |||
| colspan="2" | Max amount of time in ms to wait between bytes | |||
|- | |||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE | |||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | |||
|} | |||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | |||
|- | |||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | |||
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Start''' | |||
|- | |||
| colspan="2" | Startup routine required by the hardware device. Automatically clears the display after initialising. | |||
|- | |||
|- | |||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | |||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | |||
|} | |||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | |||
|- | |||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | |||
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetLEDState''' | |||
|- | |||
| colspan="2" | Sets the state of a single LED | |||
|- | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | |||
| width="90%" | Port | |||
|- | |||
| colspan="2" | 0 = PortA, 1 = PortB | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | |||
| width="90%" | LED | |||
|- | |||
| colspan="2" | 0 = LED0, 7 = LED7 | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | |||
| width="90%" | State | |||
|- | |||
| colspan="2" | | |||
|- | |||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | |||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | |||
|} | |||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | |||
|- | |||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | |||
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetRxIdent''' | |||
|- | |||
| colspan="2" | Gets the Rx ID as a Integer Standard and Extended IDs. | |||
|- | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | |||
| width="90%" | Buffer | |||
|- | |||
| colspan="2" | | |||
|- | |||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG | |||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | |||
|} | |||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | |||
|- | |||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | |||
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise''' | |||
|- | |||
| colspan="2" | Must be called before any other CAN component macros to enable and initialise the CAN peripheral. | |||
|- | |||
|- | |- | ||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | ||
Revision as of 10:35, 17 November 2021
| Author | Matrix Ltd |
| Version | 1.1 |
| Category | Runtime Tools |
Dashboard Text component
A simulation only text box that can be used to display text and numbers.
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Downloadable macro reference
|
Clear |
| Remove all text from the display. | |
 - VOID
|
Return |
|
|
PrintString |
| Add the given text to the display immediately after the most recent character and without beginning a new line. | |
 - STRING
|
Text |
| The text to add to the display. | |
| - VOID
|
Return |
|
|
PrintNumber |
| Write the given number to the display. It will be placed immediately after the last character on the display without beginning a new line. | |
| [[File:]] - | Number |
 - BYTE
|
Places |
| - VOID
|
Return |
|
|
PrintLine |
| DIsplay the given string on a new line. If the display is full, it will scroll upwards to make space. | |
| - STRING
|
Text |
| The text to add to the display. | |
| - VOID
|
Return |
|
|
ReceiveString |
| Gets a string from the receive buffer | |
 - UINT
|
MaxChars |
| - UINT
|
Timeout |
| Time in milliseconds to wait for data | |
| - STRING
|
Return |
|
|
Initialise |
| Initialises the UART component pins ready to send and receive data | |
| - VOID
|
Return |
|
|
ReceiveString |
| Receives a string of bytes and returns the number of bytes received. | |
| - STRING
|
StringData |
| - UINT
|
NumBytes |
| Maximum number of bytes to try and receive | |
| - UINT
|
Timeout |
| Max amount of time in ms to wait between bytes | |
| - BYTE
|
Return |
|
|
Start |
| Startup routine required by the hardware device. Automatically clears the display after initialising. | |
| - VOID
|
Return |
|
|
SetLEDState |
| Sets the state of a single LED | |
| - BYTE
|
Port |
| 0 = PortA, 1 = PortB | |
| - BYTE
|
LED |
| 0 = LED0, 7 = LED7 | |
| - BYTE
|
State |
| - VOID
|
Return |
|
|
GetRxIdent |
| Gets the Rx ID as a Integer Standard and Extended IDs. | |
| - BYTE
|
Buffer |
 - ULONG
|
Return |
|
|
Initialise |
| Must be called before any other CAN component macros to enable and initialise the CAN peripheral. | |
| - VOID
|
Return |
Property reference
|
Properties |
|
Start Text |
| Set the text that will appear when the component is initialised. | |
|
Lines |
| Set the number of lines of text that the display will show. Lines will scroll off the top of the box once the display is full. | |
|
Font |
| Choose the font for the text. Any font installed on your PC can be used. If your file is opened on another computer which does not have the specified font, an alternative will automatically be chosen. | |
|
Horizontal Align |
| Choose whether text will be aligned to the left, right or centre of the box width. | |
|
|
Vertical Align |
| Choose whether text will be aligned wih the top, bottom or middle of the box height. | |
|
Text |
| Color for the text characters. | |
|
|
Background |
| Color for the box background. | |
|
|
Bezel |
| Color for the bezel (3D border) | |
|
Thickness |
| The thickness of the bezel (3D border). This thickness will be maintained even when the component is resized. | |
|
|
Margin |
| Set the margin size. This is used to insert a small blank space to the left and right of the text, so that characters are not placed right up against the bezel. | |
|
Connections |
|
|
Simulations |