Difference between revisions of "Component: Dashboard Text (Runtime Tools)"

From Flowcode Help
Jump to navigationJump to search
 
(13 intermediate revisions by the same user not shown)
Line 14: Line 14:
 
==Dashboard Text component==
 
==Dashboard Text component==
 
A simulation only text box that can be used to display text and numbers.
 
A simulation only text box that can be used to display text and numbers.
 +
 +
==Component Source Code==
 +
 +
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Dashboard_Text.fcfx FC_Comp_Source_Dashboard_Text.fcfx]
 +
 +
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Dashboard_Text.fcfx FC_Comp_Source_Dashboard_Text.fcfx]
  
 
==Detailed description==
 
==Detailed description==
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
  
  
Line 22: Line 48:
  
 
==Examples==
 
==Examples==
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
  
  
Line 29: Line 75:
  
  
−
==Downloadable macro reference==
 
  
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
==Macro reference==
 +
 +
===Clear===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 44: Line 101:
  
  
 +
===PrintLine===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PrintString'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PrintLine'''
 
|-
 
|-
−
| colspan="2" | Add the given text to the display immediately after the most recent character and without beginning a new line. 
+
| colspan="2" | DIsplay the given string on a new line.  If the display is full, it will scroll upwards to make space. 
 
|-
 
|-
 
|-
 
|-
Line 62: Line 120:
  
  
 +
===PrintNumber===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 70: Line 129:
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" | [[File:]] -  
+
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 
| width="90%" | Number
 
| width="90%" | Number
 
|-
 
|-
Line 85: Line 144:
  
  
 +
===PrintString===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PrintLine'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PrintString'''
 
|-
 
|-
−
| colspan="2" | DIsplay the given string on a new line.  If the display is full, it will scroll upwards to make space. 
+
| colspan="2" | Add the given text to the display immediately after the most recent character and without beginning a new line. 
 
|-
 
|-
 
|-
 
|-
Line 101: Line 161:
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| 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="90%" style="border-top: 2px solid #000;" | ''Return''
 
−
|}
 
−
 
−
 
  
  
Line 247: Line 169:
 
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
 
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
 +
|-
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Text
 
|-
 
|-
 
|-
 
|-
Line 273: Line 199:
 
|-
 
|-
 
| colspan="2" | Choose whether text will be aligned wih the top, bottom or middle of the box height. 
 
| colspan="2" | Choose whether text will be aligned wih the top, bottom or middle of the box height. 
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Colors
 +
|-
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
Line 288: Line 218:
 
|-
 
|-
 
| colspan="2" | Color for the bezel (3D border) 
 
| colspan="2" | Color for the bezel (3D border) 
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Bezel
 +
|-
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
Line 298: Line 232:
 
|-
 
|-
 
| colspan="2" | 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. 
 
| colspan="2" | 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. 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections'''
 
−
|-
 
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations'''
 
−
|-
 
 
|}
 
|}

Latest revision as of 13:09, 7 February 2023

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.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_Dashboard_Text.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_Dashboard_Text.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples







Macro reference

Clear

Fc9-comp-macro.png Clear
Remove all text from the display. 
Fc9-void-icon.png - VOID Return


PrintLine

Fc9-comp-macro.png PrintLine
DIsplay the given string on a new line. If the display is full, it will scroll upwards to make space. 
Fc9-string-icon.png - STRING Text
The text to add to the display. 
Fc9-void-icon.png - VOID Return


PrintNumber

Fc9-comp-macro.png 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. 
Fc9-f32-icon.png - FLOAT Number
 
Fc9-u8-icon.png - BYTE Places
 
Fc9-void-icon.png - VOID Return


PrintString

Fc9-comp-macro.png PrintString
Add the given text to the display immediately after the most recent character and without beginning a new line. 
Fc9-string-icon.png - STRING Text
The text to add to the display. 
Fc9-void-icon.png - VOID Return


Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Text
Fc9-type-11-icon.png Start Text
Set the text that will appear when the component is initialised. 
Fc9-type-14-icon.png 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. 
Fc9-type-3-icon.png 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. 
Fc9-type-16-icon.png Horizontal Align
Choose whether text will be aligned to the left, right or centre of the box width. 
Fc9-type-16-icon.png Vertical Align
Choose whether text will be aligned wih the top, bottom or middle of the box height. 
Fc9-conn-icon.png Colors
Fc9-type-1-icon.png Text
Color for the text characters. 
Fc9-type-1-icon.png Background
Color for the box background. 
Fc9-type-1-icon.png Bezel
Color for the bezel (3D border) 
Fc9-conn-icon.png Bezel
Fc9-type-15-icon.png Thickness
The thickness of the bezel (3D border). This thickness will be maintained even when the component is resized. 
Fc9-type-15-icon.png 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. 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Dashboard_Text_(Runtime_Tools)&oldid=37914"