Flowcode Help - User contributions [en]

Component: Switch ( Control)

2026-02-25T11:01:59Z

Wiki bot:

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| MatrixTSL
|-
| width="20%" style="color:gray;" | Version
| 1.1
|-
| width="20%" style="color:gray;" | Category
| Control
|}

==Switch component==
Creates an on/off type toggle switch control.

==Version information==

Library Version, Component Version, Date, Author, Info
2, 1.0, 17-02-25, ST, Changed generated CSS to ensure visible/disabled switch has appropriate features
3, 1.1, 19-02-26, ST, Added to Ev_Initialise to ensure properties are updated when project loads

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

''No additional examples''

==Macro reference==

===GetState===
{| 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;" | '''GetState'''
|-
| colspan="2" | Returns the current state of the switch 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===SetState===
{| 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;" | '''SetState'''
|-
| colspan="2" | Sets the current state of the switch 
|-
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | bState
|-
| colspan="2" | The state to set (true = on) 
|-
| 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''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| 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;" | Behaviour
|-
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | State
|-
| colspan="2" | The initial state of the switch 
|-
| width="10%" align="center" | [[File:Fc9-type-24-icon.png]]
| width="90%" | OnClick Macro
|-
| colspan="2" | The macro to call when the user clicks this switch 
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Cursor
|-
| colspan="2" | The cursor shape when the user hovers the mouse over this switch 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Transition Speed
|-
| colspan="2" | The animation speed (in ms) when the switch is pressed 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Auto Return
|-
| colspan="2" | Set true to automatically return the switch to its default state 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Appearance
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | On Label
|-
| colspan="2" | The text to show when the switch is in the on state 
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Off Label
|-
| colspan="2" | The text to show when the switch is in the off state 
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Style
|-
| colspan="2" | The colour style of the switch 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Show Thumb
|-
| colspan="2" | Show or hide the thumb of the switch 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Outline Size
|-
| colspan="2" | The outline size in pixels 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Border Radius
|-
| colspan="2" | The curvature radius of the corners of the switch 
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Border Colour
|-
| colspan="2" | The outline colour of the switch 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Font
|-
|-
| width="10%" align="center" | [[File:Fc9-type-3-icon.png]]
| width="90%" | Font
|-
| colspan="2" | Specifies the font style for the switch 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Font Size
|-
| colspan="2" | The font size in pixels 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Bold
|-
| colspan="2" | Make the caption text bold 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Italic
|-
| colspan="2" | Make the caption text italicised 
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Colour
|-
| colspan="2" | The fill colour of the switch when off 
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Gradient
|-
| colspan="2" | The secondary fill colour of the switch when off 
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Gradient Style
|-
| colspan="2" | The gradient fill type of the switch when off 
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Text
|-
| colspan="2" | The font colour for the switch when off 
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Colour
|-
| colspan="2" | The fill colour of the switch when on 
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Gradient
|-
| colspan="2" | The secondary fill colour of the switch when on 
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Gradient Style
|-
| colspan="2" | The gradient fill type of the switch when on 
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Text
|-
| colspan="2" | The font colour for the switch when on 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Advanced
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Custom Attributes
|-
| colspan="2" | Text here will be added to the html tag of this component to allow advanced customisation 
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_WEBEXP_Switch.fcsx FC_Comp_Source_WEBEXP_Switch.fcsx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_WEBEXP_Switch.fcsx FC_Comp_Source_WEBEXP_Switch.fcsx]

Component: TextUrl ( Web Primitives)

2026-02-25T11:01:59Z

Wiki bot:

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| MatrixTSL
|-
| width="20%" style="color:gray;" | Version
| 1.1
|-
| width="20%" style="color:gray;" | Category
| Web Primitives
|}

==TextUrl component==
Creates a text link that opens a web page when clicked.

==Version information==

Library Version, Component Version, Date, Author, Info

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

''No additional examples''

==Macro reference==

===SetParameters===
{| 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;" | '''SetParameters'''
|-
| colspan="2" | Set the parameters to append to the target URL link. (e.g. "?param1=5&param2=red") 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | s
|-
| colspan="2" | Text to set 
|-
| 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''
|}

===SetText===
{| 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;" | '''SetText'''
|-
| colspan="2" | Set the text displayed for the link 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | s
|-
| colspan="2" | Text to set 
|-
| 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''
|}

===SetURL===
{| 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;" | '''SetURL'''
|-
| colspan="2" | Set the target URL for the link 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | s
|-
| colspan="2" | Text to set 
|-
| 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''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Text
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | URL
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Open in new tab
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Style
|-
|-
| width="10%" align="center" | [[File:Fc9-type-3-icon.png]]
| width="90%" | Font
|-
| colspan="2" | Specifies the font style for the item 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Font Size
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Horizontal Alignment
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Bold
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Italic
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Underline
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Strikethrough
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Colour
|-
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Text
|-
| colspan="2" | Specifies the font colour for the item 
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Background
|-
| colspan="2" | Specifies the background colour value 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Advanced
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Custom Attributes
|-
| colspan="2" |  
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_WEBEXP_TextUrl.fcsx FC_Comp_Source_WEBEXP_TextUrl.fcsx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_WEBEXP_TextUrl.fcsx FC_Comp_Source_WEBEXP_TextUrl.fcsx]

Component: Slider ( Control)

2026-02-25T11:01:58Z

Wiki bot:

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| MatrixTSL
|-
| width="20%" style="color:gray;" | Version
| 1.0
|-
| width="20%" style="color:gray;" | Category
| Control
|}

==Slider component==
Creates an analogue slide control

==Version information==

Library Version, Component Version, Date, Author, Info

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

''No additional examples''

==Macro reference==

===GetValue===
{| 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;" | '''GetValue'''
|-
| colspan="2" | Returns the current value of the slider 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===SetEnabled===
{| 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;" | '''SetEnabled'''
|-
| colspan="2" | Make this component enabled or disabled 
|-
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | Enable
|-
| colspan="2" | Set false to make this component read-only 
|-
| 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''
|}

===SetValue===
{| 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;" | '''SetValue'''
|-
| colspan="2" | Set the current value of the slider 
|-
|-
| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
| width="90%" | Value
|-
| colspan="2" | The value for the slider 
|-
| 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''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| 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;" | Scale
|-
|-
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
| width="90%" | Min
|-
| colspan="2" | The minimum (lowest) value for the slider 
|-
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
| width="90%" | Max
|-
| colspan="2" | The maximum (highest) value for the slider 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Step
|-
| colspan="2" | The value of each discrete step when the slider is changed 
|-
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
| width="90%" | Default
|-
| colspan="2" | The default value of the slider 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Thumb Appearance
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Style
|-
| colspan="2" | The shape of the slider thumb 
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Fill Colour
|-
| colspan="2" | Specifies the fill colour of the thumb 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Border Width
|-
| colspan="2" | The outline size of the thumb in pixels 
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Border Colour
|-
| colspan="2" | The outline colour of the thumb 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Shadow Size
|-
| colspan="2" | The size of the thumb shadow 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Auto Colour
|-
| colspan="2" | Set to override the default colours of the thumb 
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Hover Colour
|-
| colspan="2" | Custom colour for the thumb when the user hovers the mouse over the slider 
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Focus Colour
|-
| colspan="2" | Custom colour for the thumb when the slider is selected 
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Shadow Colour
|-
| colspan="2" | Custom colour for the thumb shadow 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Track Appearance
|-
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Fill Colour
|-
| colspan="2" | The fill colour of the slider track 
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Fill 2nd Colour
|-
| colspan="2" | The secondary fill colour of the slider track 
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Fill Gradient Style
|-
| colspan="2" | The colour gradient style of the slider track 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Border Width
|-
| colspan="2" | The outline size of the track in pixels 
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Border Colour
|-
| colspan="2" | The outline colour of the track 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Advanced
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Custom Attributes
|-
| colspan="2" | Text here will be added to the html tag of this component to allow advanced customisation 
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_WEBEXP_Slider.fcsx FC_Comp_Source_WEBEXP_Slider.fcsx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_WEBEXP_Slider.fcsx FC_Comp_Source_WEBEXP_Slider.fcsx]

Component: Indicator ( Indicator)

2026-02-25T11:01:57Z

Wiki bot:

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| MatrixTSL
|-
| width="20%" style="color:gray;" | Version
| 1.1
|-
| width="20%" style="color:gray;" | Category
| Indicator
|}

==Indicator component==
Creates an LED style on/off indicator

==Version information==

Library Version, Component Version, Date, Author, Info

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

''No additional examples''

==Macro reference==

===FlashDisable===
{| 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;" | '''FlashDisable'''
|-
| colspan="2" | Stops the indicator flashing 
|-
|-
| 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''
|}

===FlashEnable===
{| 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;" | '''FlashEnable'''
|-
| colspan="2" | Sets the indicator to flash at the selected rate 
|-
|-
| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
| width="90%" | Rate
|-
| colspan="2" | The flash speed (in ms) 
|-
| 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''
|}

===SetState===
{| 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;" | '''SetState'''
|-
| colspan="2" | Sets the state of the indicator 
|-
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | State
|-
| colspan="2" | 1 = on, 0 = off 
|-
| 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''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
|-
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Colour
|-
| colspan="2" | The colour of the indicator 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Shape
|-
| colspan="2" | The shape of the indicator 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Outline Size
|-
| colspan="2" | The size of the shape border 
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_WEBEXP_Indicator.fcsx FC_Comp_Source_WEBEXP_Indicator.fcsx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_WEBEXP_Indicator.fcsx FC_Comp_Source_WEBEXP_Indicator.fcsx]

Component: Label ( Web Primitives)

2026-02-25T11:01:57Z

Wiki bot:

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| MatrixTSL
|-
| width="20%" style="color:gray;" | Version
| 1.0
|-
| width="20%" style="color:gray;" | Category
| Web Primitives
|}

==Label component==
Creates a Javascript compatible label object.

==Version information==

Library Version, Component Version, Date, Author, Info
3, 1.0, 19-02-26, ST, Fixed font size property during Ev_Initialising

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

''No additional examples''

==Macro reference==

===SetText===
{| 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;" | '''SetText'''
|-
| colspan="2" |  
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | s
|-
| colspan="2" | Text to set 
|-
| 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''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Text
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Style
|-
|-
| width="10%" align="center" | [[File:Fc9-type-3-icon.png]]
| width="90%" | Font
|-
| colspan="2" | Specifies the font style for the item 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Font Size
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Horizontal Alignment
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Bold
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Italic
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Underline
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Strikethrough
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Colour
|-
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Text
|-
| colspan="2" | Specifies the font colour for the item 
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Background
|-
| colspan="2" | Specifies the background colour value 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Advanced
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Custom Attributes
|-
| colspan="2" |  
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_WEBEXP_Label.fcsx FC_Comp_Source_WEBEXP_Label.fcsx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_WEBEXP_Label.fcsx FC_Comp_Source_WEBEXP_Label.fcsx]

Component: Combo Box ( Control)

2026-02-25T11:01:56Z

Wiki bot:

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| MatrixTSL
|-
| width="20%" style="color:gray;" | Version
| 1.3
|-
| width="20%" style="color:gray;" | Category
| Control
|}

==Combo Box component==
Creates a user selectable combo box for selecting between various options.

==Version information==

Library Version, Component Version, Date, Author, Info
3, 1.1, 14-06-24, ST, Corrected the select element id tag, and fixed SplitString use
4, 1.2, 18-06-24, ST, Added macros to clear and set entries and fixed TypeIn version
5, 1.3, 02-02-26, ST, Added SetSelectedIndex macro

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

''No additional examples''

==Macro reference==

===AddEntry===
{| 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;" | '''AddEntry'''
|-
| colspan="2" | Adds a text entry to the combobox 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | NewEntry
|-
| colspan="2" | The new text entry to add 
|-
| 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''
|}

===ClearEntries===
{| 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;" | '''ClearEntries'''
|-
| colspan="2" | Clears the list of entries in the combobox 
|-
|-
| 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''
|}

===GetSelectedIndex===
{| 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;" | '''GetSelectedIndex'''
|-
| colspan="2" | Returns the index of the selected item 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===GetSelectedText===
{| 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;" | '''GetSelectedText'''
|-
| colspan="2" | Returns the text for the currently selected item 
|-
|-
| 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''
|}

===SetSelectedIndex===
{| 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;" | '''SetSelectedIndex'''
|-
| colspan="2" | Sets the index of the selected item 
|-
|-
| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
| width="90%" | idx
|-
| colspan="2" | The item to select 
|-
| 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''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| 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;" | ComboBox
|-
|-
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
| width="90%" | Options
|-
| colspan="2" | A list of choices available in the combobox 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Type In
|-
| colspan="2" | Set to allow the user to type directly into this combobox 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Show Lines
|-
| colspan="2" | If this is greater than 1, this many options will be shown as a selectable list 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Style
|-
|-
| width="10%" align="center" | [[File:Fc9-type-3-icon.png]]
| width="90%" | Font
|-
| colspan="2" | Specifies the font style for the item 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Font Size
|-
| colspan="2" | The font size in pixels 
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Horizontal Alignment
|-
| colspan="2" | Aligns the caption text on the button 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Bold
|-
| colspan="2" | Make the caption text bold 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Italic
|-
| colspan="2" | Make the caption text italicised 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Underline
|-
| colspan="2" | Make the caption text underlined 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Strikethrough
|-
| colspan="2" | Make the caption text crossed-out 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Colour
|-
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Text
|-
| colspan="2" | Specifies the font colour for the item 
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Background
|-
| colspan="2" | Specifies the background colour value 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Advanced
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Custom Attributes
|-
| colspan="2" | Text here will be added to the html tag of this component to allow advanced customisation 
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_WEBEXP_ComboBox.fcsx FC_Comp_Source_WEBEXP_ComboBox.fcsx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_WEBEXP_ComboBox.fcsx FC_Comp_Source_WEBEXP_ComboBox.fcsx]

Component: Gauge ( Indicator)

2026-02-25T11:01:56Z

Wiki bot:

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| MatrixTSL
|-
| width="20%" style="color:gray;" | Version
| 1.2
|-
| width="20%" style="color:gray;" | Category
| Indicator
|}

==Gauge component==
Creates a circular gauge used to visually indicate a numeric value.

==Version information==

Library Version, Component Version, Date, Author, Info
3, 1.1, 27-01-26, ST, Charts and Gauges now consolidated into single load function
4, 1.2, 13-02-26, ST, Added Ev_Initialising to correctly set properties when loading

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

''No additional examples''

==Macro reference==

===GetValue===
{| 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;" | '''GetValue'''
|-
| colspan="2" |  
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===SetValue===
{| 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;" | '''SetValue'''
|-
| colspan="2" |  
|-
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | value
|-
| 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''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| 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;" | Data
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Title
|-
| colspan="2" | Caption for the gauge 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Value
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Scale
|-
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Lower Bound
|-
| colspan="2" | Minimum value for the scale 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Upper Bound
|-
| colspan="2" | Maximum value for the scale 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Major Ticks
|-
| colspan="2" | The number of major ticks on the scale 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Minor Ticks
|-
| colspan="2" | The number of minor ticks per major tick 
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Show Labels
|-
| colspan="2" | Show values for the labels 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Decimals
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Style
|-
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Style
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Outline
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Frame
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Inner Frame
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Face
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Minor Ticks
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Major Ticks
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Pointer Outline
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Pointer Fill
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Cap Outline
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Cap Fill
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Caption
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Value
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Scale
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Coloured Ranges
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Number of Ranges
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Advanced
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Custom Attributes
|-
| colspan="2" |  
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_WEBEXP_Gauge.fcsx FC_Comp_Source_WEBEXP_Gauge.fcsx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_WEBEXP_Gauge.fcsx FC_Comp_Source_WEBEXP_Gauge.fcsx]

Component: Pie Chart ( Charts)

2026-02-25T11:01:55Z

Wiki bot:

Component: Column Chart ( Charts)

2026-02-25T11:01:54Z

Wiki bot:

Component: Line Chart ( Charts)

2026-02-25T11:01:54Z

Wiki bot:

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
|
|-
| width="20%" style="color:gray;" | Version
| 1.2
|-
| width="20%" style="color:gray;" | Category
| Charts
|}

==Line Chart component==

==Version information==

Library Version, Component Version, Date, Author, Info
4, 1.0, 18-02-25, ST, Max series now 8, plus several new macros
5, 1.1, 27-01-26, ST, Charts and Gauges now consolidated into single load function
6, 1.2, 13-02-26, ST, Added Ev_Initialising to correctly set properties when loading

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

''No additional examples''

==Macro reference==

===AddPoint===
{| 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;" | '''AddPoint'''
|-
| colspan="2" | Add to the chart 
|-
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | x
|-
| colspan="2" | X value to plot 
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | y
|-
| colspan="2" | Y value to plot 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | index
|-
| colspan="2" | Series index (1-8) 
|-
| 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''
|}

===ClearData===
{| 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;" | '''ClearData'''
|-
| colspan="2" | Remove all data from the chart 
|-
|-
| 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''
|}

===ClearSeries===
{| 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;" | '''ClearSeries'''
|-
| colspan="2" | Remove all data from a series in the chart 
|-
|-
| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
| width="90%" | SeriesId
|-
| colspan="2" | The id of the series (1 - 8) 
|-
| 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''
|}

===Redraw===
{| 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;" | '''Redraw'''
|-
| colspan="2" | Redraw the chart 
|-
|-
| 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''
|}

===SetChartTitle===
{| 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;" | '''SetChartTitle'''
|-
| colspan="2" | Sets the title text for the chart 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Text
|-
| colspan="2" | The new title for the chart 
|-
| 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''
|}

===SetSeriesName===
{| 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;" | '''SetSeriesName'''
|-
| colspan="2" | Sets the name for a series 
|-
|-
| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
| width="90%" | SeriesId
|-
| colspan="2" | The number of series to rename 
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | SeriesName
|-
| colspan="2" | The new name for the series 
|-
| 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''
|}

===SetSeriesNames===
{| 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;" | '''SetSeriesNames'''
|-
| colspan="2" | Sets the number of series and all of their names 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | SeriesCount
|-
| colspan="2" | The number of series to plot (1-8) 
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | SeriesNames
|-
| colspan="2" | Comma-separated list of series names 
|-
| 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''
|}

===SetSeriesVisible===
{| 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;" | '''SetSeriesVisible'''
|-
| colspan="2" | Shows or hides a series 
|-
|-
| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
| width="90%" | SeriesId
|-
| colspan="2" | The number of the series to show or hide (1-8) 
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | Show
|-
| colspan="2" | True to show, false to hide 
|-
| 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''
|}

===SetXAxis===
{| 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;" | '''SetXAxis'''
|-
| colspan="2" | Sets the X axis name and bounds 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Text
|-
| colspan="2" | The new name for the axis (pass empty string to keep existing name) 
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | Autoscale
|-
| colspan="2" | Set true to autoscale the axis (ignores the Max and Min values) 
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | Min
|-
| colspan="2" | New minimum value for the axis (ignored if Autoscale is true) 
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | Max
|-
| colspan="2" | New maximum value for the axis (ignored if Autoscale is true) 
|-
| 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''
|}

===SetYAxis===
{| 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;" | '''SetYAxis'''
|-
| colspan="2" | Sets the Y axis name and bounds 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Text
|-
| colspan="2" | The new name for the axis (pass empty string to keep existing name) 
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | Autoscale
|-
| colspan="2" | Set true to autoscale the axis (ignores the Max and Min values) 
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | Min
|-
| colspan="2" | New minimum value for the axis (ignored if Autoscale is true) 
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | Max
|-
| colspan="2" | New maximum value for the axis (ignored if Autoscale is true) 
|-
| 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''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| 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;" | Chart
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Title
|-
| colspan="2" | Chart title 
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Legend
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Style
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | X-axis
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Name
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Auto-scale
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Start
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | End
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Logarithmic
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Scalable
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Y-axis
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Name
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Auto-scale
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Start
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | End
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Logarithmic
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Scalable
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Advanced
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Custom Attributes
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Custom Options
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Series
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Series Count
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Series 1
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Series 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_WEBEXP_Chart_Line.fcsx FC_Comp_Source_WEBEXP_Chart_Line.fcsx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_WEBEXP_Chart_Line.fcsx FC_Comp_Source_WEBEXP_Chart_Line.fcsx]

Component: Bar Chart ( Charts)

2026-02-25T11:01:53Z

Wiki bot:

Component: ID cb997a87 2257 4fed 917f 89732d879150

2026-02-25T11:01:52Z

Wiki bot: Redirected page to Component: Bluetooth ( Comms)

#REDIRECT [[Component: Bluetooth ( Comms)]]

Component: Area Chart ( Charts)

2026-02-25T11:01:52Z

Wiki bot:

Component: Bluetooth ( Comms)

2026-02-25T11:01:51Z

Wiki bot: Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | MatrixTSL |- | width="20%" style="color:gray;" | Version | 0.1 |- | width="20%" style="color:gray;..."

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| MatrixTSL
|-
| width="20%" style="color:gray;" | Version
| 0.1
|-
| width="20%" style="color:gray;" | Category
| Comms
|}

==Bluetooth component==
Allows connection to a bluetooth device from the browser.

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

Example takes an inpt from a slider and outputs the number to a seven segment display. The display prints Err if the number is out of range.

{{Fcfile|7segtest.fcsx|Web 7 Segment Display Example}}

[https://www.flowcode.co.uk/wiki/WebDevExamples/7segtest.html Web 7 Segment Display Example]

==Macro reference==

===Disconnect===
{| 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;" | '''Disconnect'''
|-
| colspan="2" | Disconnects from the remote BLE device 
|-
|-
| 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''
|}

===RequestDevice===
{| 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;" | '''RequestDevice'''
|-
| colspan="2" | Attempts to connect with a Bluetooth BLE device. 
|-
|-
| 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''
|}

===WriteString===
{| 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;" | '''WriteString'''
|-
| colspan="2" | Writes a string value to GATT Characteristic on a connected BLE device 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | sText
|-
| 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''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
|-
|-
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
| width="90%" | Filters
|-
| colspan="2" | Limits the list of available Bluetooth devices, for example: filters: [ { services: [0x1802, 0x1803] } ] filters: [ { name: "My Cool Device" } ] filters: [ { namePrefix: "Mtx" } ] filters: [ { services: ["heart_rate"] } ], optionalServices: ["battery_service"] (leave blank for all devices)  
|-
| width="10%" align="center" | [[File:Fc9-type-24-icon.png]]
| width="90%" | OnDisconnect
|-
| colspan="2" | Called when the Bluetooth device is disconnected 
|-
| width="10%" align="center" | [[File:Fc9-type-24-icon.png]]
| width="90%" | OnValueChanged
|-
| colspan="2" | Called when the Bluetooth characteristic value changes 
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Service
|-
| colspan="2" | The Primary Service of the Bluetooth GATT Server 
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Characteristic
|-
| colspan="2" | The Bluetooth GATT Characteristic 
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_WEBEXP_Bluetooth.fcweb FC_Comp_Source_WEBEXP_Bluetooth.fcweb]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_WEBEXP_Bluetooth.fcweb FC_Comp_Source_WEBEXP_Bluetooth.fcweb]

Component: RTD (MAX31865) (Environmental)

2026-02-25T11:01:50Z

Wiki bot: Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix TSL |- | width="20%" style="color:gray;" | Version | 1.0 |- | width="20%" style="color:gray..."

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix TSL
|-
| width="20%" style="color:gray;" | Version
| 1.0
|-
| width="20%" style="color:gray;" | Category
| Environmental
|}

==RTD (MAX31865) component==
Component to interface the MAX31865 RTD-to-digital converter IC. Uses a standard SPI interface to connect to the IC and measure RTD resistance / temperature. Compatible with PT100 and PT1000 temperature sensors.

==Version information==

Library Version, Component Version, Date, Author, Info
1, 1.0, 23-12-24, BR, Initial MAX31865 RTD component implementation

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

''No additional examples''

==Macro reference==

===AutoConvert===
{| 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;" | '''AutoConvert'''
|-
| colspan="2" | Enables or disables automatic continuous conversion. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Enable
|-
| colspan="2" | 0 = One-shot, 1 = Continuous 
|-
| 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''
|}

===ClearFault===
{| 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;" | '''ClearFault'''
|-
| colspan="2" | Clears any latched fault flags in the MAX31865. 
|-
|-
| 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''
|}

===EnableBias===
{| 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;" | '''EnableBias'''
|-
| colspan="2" | Enables or disables the MAX31865 bias current. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Enable
|-
| colspan="2" | 0 = Off, 1 = On 
|-
| 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''
|}

===Initialise===
{| 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 SPI bus and basic MAX31865 configuration. 
|-
|-
| 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''
|}

===ReadFault===
{| 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;" | '''ReadFault'''
|-
| colspan="2" | Reads the MAX31865 fault status register. 
|-
|-
| 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''
|}

===ReadTemperature===
{| 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;" | '''ReadTemperature'''
|-
| colspan="2" | Performs a sample and returns temperature in Degrees C. 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===Sample===
{| 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;" | '''Sample'''
|-
| colspan="2" | Performs a single MAX31865 conversion and returns the raw sensor reading. 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===SetNotchFilter===
{| 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;" | '''SetNotchFilter'''
|-
| colspan="2" | Sets the notch filter to 50Hz (1) or 60Hz (0). 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Mode
|-
| colspan="2" | 0 = 50Hz, 1 = 60Hz 
|-
| 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''
|}

===SetWires===
{| 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;" | '''SetWires'''
|-
| colspan="2" | Sets the RTD wiring mode (2/3/4-wire). 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Wires
|-
| colspan="2" | 2, 3 or 4 wires 
|-
| 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''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| 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;" | RTD Properties
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | RTD Type
|-
| colspan="2" | Selects the RTD type used with the MAX31865. 
|-
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
| width="90%" | Reference Resistor (Ohms)
|-
| colspan="2" | Reference resistor value used on the MAX31865 breakout (default 430 Ohms). 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Notch Filter
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Bias Current
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Auto Convert
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | RTD Wiring Mode
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | SPI Properties
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Channel
|-
| colspan="2" | SPI Channel selector 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Prescale
|-
| colspan="2" | Prescale option selector 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | MOSI
|-
| colspan="2" | SPI Data Out pin (MOSI). 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | MISO
|-
| colspan="2" | SPI Data In pin (MISO). 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | CLK
|-
| colspan="2" | SPI Clock pin (SCK). 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | CS / SS
|-
| colspan="2" | Chip Select / Slave Select pin used to enable the MAX31865. 
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_ThermocoupleMAX31865.fcfx FC_Comp_Source_ThermocoupleMAX31865.fcfx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_ThermocoupleMAX31865.fcfx FC_Comp_Source_ThermocoupleMAX31865.fcfx]

Component: ID e3b5f8d2 6f4a 4fbc a4f9 9c7f5a1a3b65

2026-02-25T11:01:50Z

Wiki bot: Redirected page to Component: RTD (MAX31865) (Environmental)

#REDIRECT [[Component: RTD (MAX31865) (Environmental)]]

Component: ST3215 Servo Motor (Mechatronics)

2026-02-25T11:01:49Z

Wiki bot: Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix TSL |- | width="20%" style="color:gray;" | Version | 2.0 |- | width="20%" style="color:gray..."

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix TSL
|-
| width="20%" style="color:gray;" | Version
| 2.0
|-
| width="20%" style="color:gray;" | Category
| Mechatronics
|}

==ST3215 Servo Motor component==
Control ST3215 servo motors via serial UART communication using the STS protocol.

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

''No additional examples''

==Macro reference==

===ChangeBaudrate===
{| 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;" | '''ChangeBaudrate'''
|-
| colspan="2" | Change the servo baud rate. Baud rate values: 0=9600, 1=57600, 2=115200, 3=1000000. EEPROM must be unlocked. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ServoID
|-
| colspan="2" | Servo ID 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Baudrate
|-
| colspan="2" | Baud rate value: 0=9600, 1=57600, 2=115200, 3=1000000 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===ChangeID===
{| 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;" | '''ChangeID'''
|-
| colspan="2" | Change the servo ID. New ID must be 0-253. EEPROM must be unlocked. Note: New ID takes effect after power cycle. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ServoID
|-
| colspan="2" | Current servo ID 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | NewID
|-
| colspan="2" | New servo ID (0-253) 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===DefineMiddle===
{| 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;" | '''DefineMiddle'''
|-
| colspan="2" | Define the 2048 position by setting torque to 128. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ServoID
|-
| colspan="2" | Servo ID 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===Initialise===
{| 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" |  
|-
|-
| 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''
|}

===IsMoving===
{| 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;" | '''IsMoving'''
|-
| colspan="2" | Check if the servo is currently moving. Returns True if moving, False otherwise. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ServoID
|-
| colspan="2" | Servo ID 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===ListServos===
{| 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;" | '''ListServos'''
|-
| colspan="2" | Scan and return a list of all responsive servos. Returns number of servos found. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ServoList
|-
| colspan="2" | Array to store found servo IDs 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | MaxCount
|-
| colspan="2" | Max number of servos to try and return. 0=Don't limit 
|-
| 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''
|}

===LockEEPROM===
{| 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;" | '''LockEEPROM'''
|-
| colspan="2" | Lock EEPROM to prevent writes from being saved after power loss. IMPORTANT: Use the NEW servo ID after ChangeID. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ServoID
|-
| colspan="2" | Servo ID (use NEW ID after ChangeID) 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===PingServo===
{| 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;" | '''PingServo'''
|-
| colspan="2" | Check if a servo is responding. Returns True if successful, False otherwise. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ServoID
|-
| colspan="2" | Servo ID to ping (0-253) 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===ReadAcceleration===
{| 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;" | '''ReadAcceleration'''
|-
| colspan="2" | Read current acceleration value in steps per second squared. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ServoID
|-
| colspan="2" | Servo ID 
|-
| 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''
|}

===ReadAngle===
{| 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;" | '''ReadAngle'''
|-
| colspan="2" | Read current position of servo. Returns position in steps (0-4095). 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ServoID
|-
| colspan="2" | Servo ID 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===ReadCorrection===
{| 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;" | '''ReadCorrection'''
|-
| colspan="2" | Read position correction value in steps. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ServoID
|-
| colspan="2" | Servo ID 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===ReadCurrent===
{| 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;" | '''ReadCurrent'''
|-
| colspan="2" | Read current in milliamps (6.5mA resolution). Returns current / 6.5. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ServoID
|-
| colspan="2" | Servo ID 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===ReadID===
{| 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;" | '''ReadID'''
|-
| colspan="2" | Read the servo ID from EEPROM. Returns the stored ID value. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ServoID
|-
| colspan="2" | Servo ID to query 
|-
| 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''
|}

===ReadLoad===
{| 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;" | '''ReadLoad'''
|-
| colspan="2" | Read motor load in percentage. Returns load percentage. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ServoID
|-
| colspan="2" | Servo ID 
|-
| 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''
|}

===ReadMode===
{| 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;" | '''ReadMode'''
|-
| colspan="2" | Read current operational mode. Returns: 0=position, 1=speed, 2=PWM, 3=step 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ServoID
|-
| colspan="2" | Servo ID 
|-
| 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''
|}

===ReadPosition===
{| 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;" | '''ReadPosition'''
|-
| colspan="2" | Read current position of servo. Returns position in steps (0-4095). 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ServoID
|-
| colspan="2" | Servo ID 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===ReadSpeed===
{| 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;" | '''ReadSpeed'''
|-
| colspan="2" | Read current speed of servo. Returns speed in steps per second. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ServoID
|-
| colspan="2" | Servo ID 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===ReadStatus===
{| 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;" | '''ReadStatus'''
|-
| colspan="2" | Read servo status flags. Returns status byte with bits: Voltage, Sensor, Temperature, Current, Angle, Overload 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ServoID
|-
| colspan="2" | Servo ID 
|-
| 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''
|}

===ReadTemperature===
{| 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;" | '''ReadTemperature'''
|-
| colspan="2" | Read temperature in degrees Celsius. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ServoID
|-
| colspan="2" | Servo ID 
|-
| 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''
|}

===ReadTorqueLimit===
{| 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;" | '''ReadTorqueLimit'''
|-
| colspan="2" | Read torque limit value (0-1000). 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ServoID
|-
| colspan="2" | Servo ID 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===ReadVoltage===
{| 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;" | '''ReadVoltage'''
|-
| colspan="2" | Read voltage in volts (0.1V resolution). Returns voltage * 10. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ServoID
|-
| colspan="2" | Servo ID 
|-
| 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''
|}

===Rotate===
{| 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;" | '''Rotate'''
|-
| colspan="2" | Rotate servo continuously in specified direction. Speed range: 50-1000. Direction: 0=forward, 1=reverse. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ServoID
|-
| colspan="2" | Servo ID 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Speed
|-
| colspan="2" | Rotation speed (50-1000) 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Direction
|-
| colspan="2" | Direction: 0=forward, 1=reverse 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===SetAcceleration===
{| 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;" | '''SetAcceleration'''
|-
| colspan="2" | Set servo acceleration in steps per second squared. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ServoID
|-
| colspan="2" | Servo ID 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Acceleration
|-
| colspan="2" | Acceleration value (0-254) 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===SetAngle===
{| 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;" | '''SetAngle'''
|-
| colspan="2" | Move servo to a target angle. Angle range: -180 to 180 degrees. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ServoID
|-
| colspan="2" | Servo ID 
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | Angle
|-
| colspan="2" | Angle range: -180 to 180 degrees. 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===SetCorrection===
{| 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;" | '''SetCorrection'''
|-
| colspan="2" | Set position correction value in steps. Adds correction to position. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ServoID
|-
| colspan="2" | Servo ID 
|-
| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
| width="90%" | Correction
|-
| colspan="2" | Correction value in steps 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===SetMode===
{| 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;" | '''SetMode'''
|-
| colspan="2" | Set operational mode. Mode: 0=position, 1=speed, 2=PWM, 3=step 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ServoID
|-
| colspan="2" | Servo ID 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Mode
|-
| colspan="2" | Mode: 0=position, 1=speed, 2=PWM, 3=step 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===SetPosition===
{| 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;" | '''SetPosition'''
|-
| colspan="2" | Move servo to a target position. Position range: -30719 to 30719 steps. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ServoID
|-
| colspan="2" | Servo ID 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Position
|-
| colspan="2" | Target position in steps (0 to 4095) 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===SetSpeed===
{| 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;" | '''SetSpeed'''
|-
| colspan="2" | Set servo speed in steps per second. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ServoID
|-
| colspan="2" | Servo ID 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Speed
|-
| colspan="2" | Speed in steps per second (0-3400) 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===SetTorqueLimit===
{| 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;" | '''SetTorqueLimit'''
|-
| colspan="2" | Set torque limit value (0-1000). Controls maximum torque output. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ServoID
|-
| colspan="2" | Servo ID 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | TorqueLimit
|-
| colspan="2" | Torque limit value (0-1000) 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===StartServo===
{| 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;" | '''StartServo'''
|-
| colspan="2" | Enable torque (start servo). 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ServoID
|-
| colspan="2" | Servo ID 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===StopServo===
{| 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;" | '''StopServo'''
|-
| colspan="2" | Disable torque (stop servo). 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ServoID
|-
| colspan="2" | Servo ID 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===UnlockEEPROM===
{| 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;" | '''UnlockEEPROM'''
|-
| colspan="2" | Unlock EEPROM to allow writes to be saved after power loss. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ServoID
|-
| colspan="2" | Servo ID 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| 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;" | Connections
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Channel
|-
| colspan="2" | UART Channel selector Software channels are bit banged using generic I/O pins but are not as reliable as hardware channels. Hardware channels use the selected peripheral on-board the target microcontroller. 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | TX
|-
| colspan="2" | Pin to be used for Transmit data 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | RX
|-
| colspan="2" | Pin to be used for Receive data 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Use Flow Control
|-
| colspan="2" | Flow Control (Handshake) enable or disable. On: Two I/O pins are used to control the flow of data in and out of the device. Off: Flow control is disabled. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Baud Options
|-
| colspan="2" | Baud rate option selector 
|-
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
| width="90%" | Baud Rate
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Label
|-
| colspan="2" | Textual label shown on the component I/O flasher 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Scope Traces
|-
| colspan="2" | Selects if the scope traces are automatically added to the data recorder window or not. 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Console Data
|-
| colspan="2" | Selects if the console data is automatically generated or not 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Console Columns
|-
| colspan="2" | Number of characters that can be displayed on a single line of the console. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Data Source
|-
| colspan="2" | Simulation data source used to allow the component to connect to various remote devices 
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_ST3215.fcfx FC_Comp_Source_ST3215.fcfx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_ST3215.fcfx FC_Comp_Source_ST3215.fcfx]

Component: ID 7b03c836 c1f9 4ab5 8bf2 787a55e792e0

2026-02-25T11:01:49Z

Wiki bot: Redirected page to Component: ST3215 Servo Motor (Mechatronics)

#REDIRECT [[Component: ST3215 Servo Motor (Mechatronics)]]

Component: Barometer (BME280) (Environmental)

2026-02-25T11:01:48Z

Wiki bot:

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix TSL
|-
| width="20%" style="color:gray;" | Version
| 1.3
|-
| width="20%" style="color:gray;" | Category
| Environmental
|}

==Barometer (BME280) component==
A small PCB surface mount barometric pressure sensor with a I2C bus interface. Pressure range 300 to 1100 hPa. Temperature range -40 to +85 °C. Works with I2C interface only.

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

{{Fcfile|BME280 Barometer plus Altitude v1.0.fcfx|BME280 Barometer plus Altitude v1.0}}
This example reads and displays the pressure, temperature & humidity.
If the pressure is increasing then Rise will be displayed.

Alternatively if the pressure is falling, then Fall will be displayed.

The altitude displayed is calculated based on the current pressure reading.

What makes the altitude useful is the ability to tare it,
then after going up or downstairs for example the feet & meters are displayed.

Note since the altitude is calculated based on pressure, then if the sensor is left at the same height,
the height displayed can be different each day.

==Circuit Diagram==
[[File:BME280 Circuit Diagram.png]]

==Macro reference==

===Forced_Read===
{| 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;" | '''Forced_Read'''
|-
| 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''
|}

===I2C_Read_Register===
{| 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;" | '''I2C_Read_Register'''
|-
| colspan="2" | Reads a byte value from a register on the device 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Address
|-
| colspan="2" |  
|-
| 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''
|}

===I2C_Write_Register===
{| 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;" | '''I2C_Write_Register'''
|-
| colspan="2" | Writes a byte value to a register on the device 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Address
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Value
|-
| 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''
|}

===Initialise===
{| 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" | Starts up the I2C bus and initialises the pressure sensor ready for use. Returns 1 for a sucessful startup. Returns 0 for a failed startup or no device detected. 
|-
|-
| 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''
|}

===ReadHumidityFloat===
{| 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;" | '''ReadHumidityFloat'''
|-
| colspan="2" | Reads the humidity as a floating point value in percentage 0-100%. Calls the ReadHumidityRaw function and then converts to a meaningful value. 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===ReadPressureFloat===
{| 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;" | '''ReadPressureFloat'''
|-
| colspan="2" | Reads the pressure as a floating point value in Bars. Calls the ReadPressureRaw function and then converts to a meaningful value. 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===ReadTemperatureFloat===
{| 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;" | '''ReadTemperatureFloat'''
|-
| colspan="2" | Reads the temperature as a floating point value in °C. Resultion sets the return bit value and conversion time. Calls the ReadTemperatureRaw function and then converts to a meaningful value. 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===Reset===
{| 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;" | '''Reset'''
|-
| colspan="2" | Resets the device 
|-
|-
| 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''
|}

===Uninit===
{| 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;" | '''Uninit'''
|-
| colspan="2" | Uninitialse and release I2C resources 
|-
|-
| 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''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| 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;" | Connections
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Slave Address
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Channel
|-
| colspan="2" | Channel selection 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Baud Select
|-
| colspan="2" | Baud rate option selector 
|-
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
| width="90%" | Baud Rate
|-
| colspan="2" | Baud rate to be used 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Stop Delay
|-
| colspan="2" | On older microcontroller devices there is a potential for the I2C hardware channel to lock up if there is not a 10ms delay between an I2C stop event and the next I2C start event. Most modern microcontrollers will not have a problem so this property can be disabled to speed up the I2C communications.  
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | SDA
|-
| colspan="2" | Pin used for SDA (data signal) 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | SCL
|-
| colspan="2" | Pin used for SCL (clock signal) 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Sensor Options
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Compensation
|-
| colspan="2" | Compensation formulas in double precision floating point or 32 bit fixed point 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Humidity Oversampling
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Pressure Oversampling
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Temperature Oversampling
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Mode
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Standby Normal Mode (ms)
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Filter Coefficient
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
|-
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Simulate Comms
|-
| colspan="2" | Allows the simulation data to come from the panel GUI or relayed via an injector component. 
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Pressure_Sensor_BME280.fcfx FC_Comp_Source_Pressure_Sensor_BME280.fcfx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Pressure_Sensor_BME280.fcfx FC_Comp_Source_Pressure_Sensor_BME280.fcfx]

Component: ID 118ff995 d306 4ae3 8d5e 454a85a77750

2026-02-25T11:01:47Z

Wiki bot: Redirected page to Component: Modified Moving Average 32-bit (Calculation)

#REDIRECT [[Component: Modified Moving Average 32-bit (Calculation)]]

Component: Modified Moving Average Float (Calculation)

2026-02-25T11:01:47Z

Wiki bot:

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix TSL
|-
| width="20%" style="color:gray;" | Version
| 1.0
|-
| width="20%" style="color:gray;" | Category
| Calculation
|}

==Modified Moving Average Float component==
Allows a value from a sensor to be averaged out filtering out high frequencies and removing noise. Modified moving average means we maintain a sum of the last n number of samples. On each new sample we subtract the previous result and then add in the latest raw sample.

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

''No additional examples''

==Macro reference==

===Filter===
{| 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;" | '''Filter'''
|-
| colspan="2" | Performs the filtering function, passing in the latest sampled value and outputting the latest filtered value. 
|-
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | Value
|-
| colspan="2" | Latest sample to add to the filter 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===InitialiseFilter===
{| 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;" | '''InitialiseFilter'''
|-
| colspan="2" | Preload the filter with the specified value and sets the number of samples to average over. Must be called before calling the filter macro. 
|-
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | FilterValue
|-
| colspan="2" | Initial value to load into the filter, e.g. 0 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | NumSamples
|-
| colspan="2" | Specifies the number of samples to average over. 
|-
| 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''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
|-
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_ModifiedMovingAverageFloat.fcfx FC_Comp_Source_ModifiedMovingAverageFloat.fcfx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_ModifiedMovingAverageFloat.fcfx FC_Comp_Source_ModifiedMovingAverageFloat.fcfx]

Component: Modified Moving Average 16-bit (Calculation)

2026-02-25T11:01:46Z

Wiki bot:

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix TSL
|-
| width="20%" style="color:gray;" | Version
| 1.0
|-
| width="20%" style="color:gray;" | Category
| Calculation
|}

==Modified Moving Average 16-bit component==
Allows a value from a sensor to be averaged out filtering out high frequencies and removing noise. Modified moving average means we maintain a sum of the last n number of samples. On each new sample we subtract the previous result and then add in the latest raw sample.

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

''No additional examples''

==Macro reference==

===Filter===
{| 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;" | '''Filter'''
|-
| colspan="2" | Performs the filtering function, passing in the latest sampled value and outputting the latest filtered value. 
|-
|-
| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
| width="90%" | Value
|-
| colspan="2" | Latest sample to add to the filter 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===InitialiseFilter===
{| 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;" | '''InitialiseFilter'''
|-
| colspan="2" | Preload the filter with the specified value and sets the number of samples to average over. Must be called before calling the filter macro. 
|-
|-
| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
| width="90%" | FilterValue
|-
| colspan="2" | Initial value to load into the filter, e.g. 0 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | NumSamples
|-
| colspan="2" | Specifies the number of samples to average over. 
|-
| 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''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
|-
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_ModifiedMovingAverage16.fcfx FC_Comp_Source_ModifiedMovingAverage16.fcfx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_ModifiedMovingAverage16.fcfx FC_Comp_Source_ModifiedMovingAverage16.fcfx]

Component: Modified Moving Average 32-bit (Calculation)

2026-02-25T11:01:46Z

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix TSL
|-
| width="20%" style="color:gray;" | Version
| 1.0
|-
| width="20%" style="color:gray;" | Category
| Calculation
|}

==Modified Moving Average 32-bit component==
Allows a value from a sensor to be averaged out filtering out high frequencies and removing noise. Modified moving average means we maintain a sum of the last n number of samples. On each new sample we subtract the previous result and then add in the latest raw sample.

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

''No additional examples''

==Macro reference==

===Filter===
{| 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;" | '''Filter'''
|-
| colspan="2" | Performs the filtering function, passing in the latest sampled value and outputting the latest filtered value. 
|-
|-
| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
| width="90%" | Value
|-
| colspan="2" | Latest sample to add to the filter 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s32-icon.png]] - LONG
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===InitialiseFilter===
{| 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;" | '''InitialiseFilter'''
|-
| colspan="2" | Preload the filter with the specified value and sets the number of samples to average over. Must be called before calling the filter macro. 
|-
|-
| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
| width="90%" | FilterValue
|-
| colspan="2" | Initial value to load into the filter, e.g. 0 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | NumSamples
|-
| colspan="2" | Specifies the number of samples to average over. 
|-
| 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''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
|-
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_ModifiedMovingAverage32.fcfx FC_Comp_Source_ModifiedMovingAverage32.fcfx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_ModifiedMovingAverage32.fcfx FC_Comp_Source_ModifiedMovingAverage32.fcfx]

Component: Modbus Slave (Comms: System)

2026-02-25T11:01:45Z

Wiki bot:

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix Ltd.
|-
| width="20%" style="color:gray;" | Version
| 2.0
|-
| width="20%" style="color:gray;" | Category
| Comms: System
|}

==Modbus Slave component==
Modbus component for creating Modbus compatible slave hardware via RS232 or RS485.

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

Example master program to control the slave. The example reads the 8 switches connected to PortD. If the switch values change then the new value is send to the slave.

{{Fcfile|ModBus_Master_Example1.fcfx|Modbus Master Example}}

Example slave program to react to the signals from the master. The example listens for Modbus commands from the master and outputs the current coils 0-7 state to eight LEDs connected to PortD.

{{Fcfile|ModBus_Slave_Example1.fcfx|Modbus Slave Example}}

===Master and Slave example using vNet===

Example of communicating using Modbus Master and Slave using two instances of Flowcode and the vNet injector component.

{{Fcfile|ModbusMasterDemo.fcfx|ModbusMasterDemo}}

{{Fcfile|ModBusSlaveDemo.fcfx|ModBusSlaveDemo}}

===Addressing===

In Modbus the addressing protocol looks like this.

{| width="80%"
|'''Data Type'''
|'''Common name'''
|'''Starting address'''
|'''Ending Address'''
|'''Flowcode Start Address'''
|'''Flowcode End Address'''
|-
|Modbus Coils
|Bits, binary values, flags
|00001
|10000
|0
|9999
|-
|Digital Inputs
|Binary inputs
|10001
|30000
|0
|19999
|-
|Analog Inputs
|Binary inputs
|30001
|40000
|0
|9999
|-
|Modbus Registers
|Analog values, variables
|40001
|60000
|0
|19999
|}

In Flowcode each section starts from 0 so the address range is as shown.

==Macro reference==

===ChangeBaud===
{| 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;" | '''ChangeBaud'''
|-
| colspan="2" | Changes the UART Baud rate. 1 = 1200 / 2 = 2400 / 3 = 4800 / 4 = 9600 / 5 = 19200 / 6 = 31250 7 = 38400 / 8 = 57600 / 9 = 115200 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Baud
|-
| colspan="2" | The new baud rate (0=1200, 9=115200) 
|-
| 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''
|}

===ChangeFrameType===
{| 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;" | '''ChangeFrameType'''
|-
| colspan="2" | Default frame type is the type set in the component properties. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Type
|-
| colspan="2" | 0 = Modbus RTU / 1 = Modbus ASCII 
|-
| 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''
|}

===CheckForIncoming===
{| 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;" | '''CheckForIncoming'''
|-
| colspan="2" | Checks for an incoming message and if the data address is within range then also automatically replies with the correct reply. Returns 0 if no comms received, 1 for a succesful transaction, 255 for an error. 
|-
|-
| 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''
|}

===GetLastIncoming===
{| 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;" | '''GetLastIncoming'''
|-
| colspan="2" | Gets a value from the last incoming command. Index 0 = 0 Read / 1 Write Index 1 = 0 Coils / 1 DigInput / 2 AnInput / 3 Register Index 2 = Address Index 3 = Number 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Index
|-
| colspan="2" | Range: 0-3 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===Initialise===
{| 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" | Starts up the UART to allow communications and initialises the states of the various Modbus Coils, Inputs and Registers to 0. 
|-
|-
| 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''
|}

===ReadAnalogInput===
{| 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;" | '''ReadAnalogInput'''
|-
| colspan="2" | Reads the value of a single analogue input. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Address
|-
| colspan="2" | Coil Address 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===ReadCoils===
{| 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;" | '''ReadCoils'''
|-
| colspan="2" | Reads the state of up to eight digital coils. Can pack a max of 8-bits together in a single operation 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | StartAddress
|-
| colspan="2" | Coil Address Range 0 to (NumCoils - 1) 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | AddressCount
|-
| colspan="2" | Range 1-8 
|-
| 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''
|}

===ReadDigitalInputs===
{| 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;" | '''ReadDigitalInputs'''
|-
| colspan="2" | Reads the state of up to eight digital inputs. Can pack a max of 8-bits together in a single operation 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | StartAddress
|-
| colspan="2" | Coil Address Range 0 to (NumCoils - 1) 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | AddressCount
|-
| colspan="2" | Range 1-8 
|-
| 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''
|}

===ReadHoldingRegister===
{| 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;" | '''ReadHoldingRegister'''
|-
| colspan="2" | Reads the value of a single holding register. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Address
|-
| colspan="2" | Coil Address 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===SetAnalogInput===
{| 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;" | '''SetAnalogInput'''
|-
| colspan="2" | Sets the state of a single analogue input. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Address
|-
| colspan="2" | Coil Address 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Value
|-
| colspan="2" | Analogue Value range 0 - 65535 
|-
| 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''
|}

===SetBaudRate===
{| 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;" | '''SetBaudRate'''
|-
| colspan="2" | Allows the Baud Rate to be controlled dynamically overriding the default rate specified by the Baud component property. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Rate
|-
| colspan="2" | 0=1200, 1=2400, 2=4800, 3=9600, 4=19200, 5=38400, 6=57600, 7=115200 
|-
| 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''
|}

===SetCoil===
{| 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;" | '''SetCoil'''
|-
| colspan="2" | Sets the state of a single digital coil. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Address
|-
| colspan="2" | Coil Address 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | State
|-
| colspan="2" | 0=off, 1=on 
|-
| 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''
|}

===SetDigitalInput===
{| 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;" | '''SetDigitalInput'''
|-
| colspan="2" | Sets the state of a single digital input. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Address
|-
| colspan="2" | Coil Address 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | State
|-
| colspan="2" | 0=off, 1=on 
|-
| 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''
|}

===SetHoldingRegister===
{| 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;" | '''SetHoldingRegister'''
|-
| colspan="2" | Sets the state of a single holding register. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Address
|-
| colspan="2" | Coil Address 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Value
|-
| colspan="2" | Analogue Value range 0 - 65535 
|-
| 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''
|}

===SetSlaveAddress===
{| 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;" | '''SetSlaveAddress'''
|-
| colspan="2" | Allows the slave address to be overridden from the default slave address specified in the component property. The number of bytes used for the address is fixed by the Slave ID Bytes property to save on RAM usage. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | SlaveAddress
|-
| 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''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| 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;" | UART Properties
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Channel
|-
| colspan="2" | UART Channel selector Software channels are bit banged using generic I/O pins but are not as reliable as hardware channels. Hardware channels use the selected peripheral on-board the target microcontroller. 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | TX
|-
| colspan="2" | Pin to be used for Transmit data 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | RX
|-
| colspan="2" | Pin to be used for Receive data 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Baud Options
|-
| colspan="2" | Baud rate option selector 
|-
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
| width="90%" | Baud Rate
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Bus
|-
| colspan="2" | Specifies the bus mode being used, RS232 allows you to connect a single master node to a single slave node. RS485 allows you to connect a single master node to multiple slave nodes. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Timeout
|-
| colspan="2" | Timeout in milliseconds used to dictate the maximum time to wait in milliseconds between bytes in a packet. Range: 1 - 255 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Modbus Properties
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Frame Type
|-
| colspan="2" | Switches between RTU and ASCII forms of Modbus 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Receive Buffer Size
|-
| colspan="2" | Maximum number of bytes the receive buffer can hold 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Slave ID Bytes
|-
| colspan="2" | Number of bytes used when passing a slave ID, usually 1 but sometimes 2 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Slave Address
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Reply Delay
|-
| colspan="2" | Delay in micro seconds to wait before transmitting a reply 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Maintain Stats
|-
| colspan="2" | Controls if the last command from the master is logged allowing for easier value updates. No - Do not log commands Yes - Commands are logged and available via the GetLastIncoming macro 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation Properties
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Label
|-
| colspan="2" | A text label to appear on the Modbus panel object. 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Scope Traces
|-
| colspan="2" | Selects if the scope traces are automatically added to the data recorder window or not. Simulation - draws an approximation of the UART data onto the scope trace. ICT - sets up the scope trace for incoming data and adds UART packet decoding at the correct BAUD. 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Console Data
|-
| colspan="2" | Selects if the console data is automatically generated or not 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Console Columns
|-
| colspan="2" | Number of characters that can be displayed on a single line of the console. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Data Source
|-
| colspan="2" | Simulation data source used to allow the component to connect to various remote devices Nothing - Simulation data is ignored COM port - Routes the communication data to and from a physical or virtual COM port API - Routes the communication data via a data API component on the Panel. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | API
|-
| colspan="2" | Selects which API component to route the communication data via. Add API components to the panel before they will be available in this list. API components are available from the Comms component category. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Modbus Coils - Single bit values
|-
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Starting Address
|-
| colspan="2" | Start address of the Modbus coils. Referenced from 0. For example Slave 1 might have 100 coils addressed 0-99 Start Address = 0 Slave 2 might have 100 coils addressed 100-199 Start Address = 100 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Number of Addresses
|-
| colspan="2" | Specifies how many Coils are available on the slave. Each address consumes a single bit of RAM, 8 Addresses are packed together into a single RAM Byte. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Digital Inputs - Single bit values
|-
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Starting Address
|-
| colspan="2" | Start address of the Modbus digital inputs. Referenced from 0. For example Slave 1 might have 100 inputs addressed 0-99 Start Address = 0 Slave 2 might have 100 inputs addressed 100-199 Start Address = 100 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Number of Addresses
|-
| colspan="2" | Specifies how many Digital Inputs are available on the slave. Each address consumes a single bit of RAM, 8 Addresses are packed together into a single RAM Byte. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Analog Inputs - 16-bit values
|-
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Starting Address
|-
| colspan="2" | Start address of the Modbus analogue inputs. Referenced from 0. For example Slave 1 might have 100 inputs addressed 0-99 Start Address = 0 Slave 2 might have 100 inputs addressed 100-199 Start Address = 100 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Number of Addresses
|-
| colspan="2" | Specifies how many 16-bit analogue inputs are available on the slave. Each address consumes two RAM Bytes. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Holding Registers - 16-bit values
|-
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Starting Address
|-
| colspan="2" | Start address of the Modbus registers. Referenced from 0. For example Slave 1 might have 100 registers addressed 0-99 Start Address = 0 Slave 2 might have 100 registers addressed 100-199 Start Address = 100 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Number of Addresses
|-
| colspan="2" | Specifies how many 16-bit holding registers are available on the slave. Each address consumes two RAM Bytes. 
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_ModbusSlave.fcfx FC_Comp_Source_ModbusSlave.fcfx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_ModbusSlave.fcfx FC_Comp_Source_ModbusSlave.fcfx]

Component: Lookup tables (Utility)

2026-02-25T11:01:44Z

Wiki bot:

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix Ltd
|-
| width="20%" style="color:gray;" | Version
| 1.8
|-
| width="20%" style="color:gray;" | Category
| Utility
|}

==Lookup tables component==
A lookup-table component allowing an easy way to place arrays of static data into ROM memory. The LUT data is accessed directly allowing very low overhead when collecting the data.

==Version information==

Library Version, Component Version, Date, Author, Info
13, 1.7, 24-07-24, BR, Fixed LUT to allow more then 65535 values to be stored and used by the sim
14, 1.8, 11-09-24, BR, Added system watchdog disable around elements of code that could take a long time for a large LUT

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

A look up table component is useful when including data into a program which may not be linear and therefore hard to calculate.

One example of this is a sine wave or working out a temperature based on the resistance of a thermistor.

For a simple example lets say we want to store a sine wave on board the microcontroller.

First of all we use Excel to generate the data for a sine wave to do this we work out the angles in degrees we want to reproduce, then convert the degrees to radians and then generate the Sine wave for the angle. the angle returned will be between -1 and 1 so we need to convert this to fit into the microcontroller's memory. The most efficient way is to store the value as a byte which means scaling up the output to 0 - 255 and removing the real portion of the number to give integer values.

[[File:SineWaveLUT.xlsx]]

Then using the file -> Save as menu in Excel we can export the data as a raw .CSV file.

[[File:SineWaveLUT.csv]]

The line in the CSV file we are interested in is the Integer Offset Data. We can then copy and paste this data into the integer property of the look up table component.

[[File:LUT.jpg]]

In this example Flowcode file we display the LUT data onto a graphical LCD display
{{Fcfile|LUT.fcfx|LUT}}
Here is what you should expect to see on the glcd after running the simulation.

[[File:LUTdata.jpg]]

==Macro reference==

===GetFloat===
{| 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;" | '''GetFloat'''
|-
| colspan="2" | Gets a float from the LUT 
|-
|-
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
| width="90%" | Index
|-
| colspan="2" |  
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===GetInt===
{| 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;" | '''GetInt'''
|-
| colspan="2" | Gets an integer from the LUT 
|-
|-
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
| width="90%" | Index
|-
| 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''
|}

===GetLUTCount===
{| 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;" | '''GetLUTCount'''
|-
| colspan="2" | Gets the number of individual data entries stored in the LUT. 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
|-
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Enabled
|-
| colspan="2" | Determines if the LUT component is active. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Storage Type
|-
| colspan="2" | Controls the data type stored by the component. 
|-
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
| width="90%" | Floats
|-
| colspan="2" | Comma seperated float data which is used to create the C code which is inserted into the ROM. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Num Values
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Embed Into C
|-
| colspan="2" | Flag to decide if code should be generated to C or not If this is false then the LUT is simulation only  
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_LUT.fcfx FC_Comp_Source_LUT.fcfx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_LUT.fcfx FC_Comp_Source_LUT.fcfx]

Component: Modbus Master (Comms: System)

2026-02-25T11:01:44Z

Wiki bot:

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix Ltd.
|-
| width="20%" style="color:gray;" | Version
| 2.1
|-
| width="20%" style="color:gray;" | Category
| Comms: System
|}

==Modbus Master component==
Modbus component for talking to Modbus compatible hardware via RS232 or RS485.

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

===CT-2EA Modbus Electronic kWh Meter===

Example to talk to a CT-2EA Modbus Electronic kWh Meter

{{Fcfile|ModbusDemo.fcfx|ModbusDemo}}

Setup to communicate via Embedded UART1 or Simulated COM3

[[File:ModbusConns.jpg]]

Console data generated by the working example running in the simulation and communicating via the COM port.

[[File:ModbusConsole.jpg]]

===Master and Slave example using vNet===

Example of communicating using Modbus Master and Slave using two instances of Flowcode and the vNet injector component.

{{Fcfile|ModbusMasterDemo.fcfx|ModbusMasterDemo}}

{{Fcfile|ModBusSlaveDemo.fcfx|ModBusSlaveDemo}}

===Addressing===

In Modbus the addressing protocol looks like this.

{| width="80%"
|'''Data Type'''
|'''Common name'''
|'''Starting address'''
|'''Ending Address'''
|'''Flowcode Start Address'''
|'''Flowcode End Address'''
|-
|Modbus Coils
|Bits, binary values, flags
|00001
|10000
|0
|9999
|-
|Digital Inputs
|Binary inputs
|10001
|30000
|0
|19999
|-
|Analog Inputs
|Binary inputs
|30001
|40000
|0
|9999
|-
|Modbus Registers
|Analog values, variables
|40001
|60000
|0
|19999
|}

In Flowcode each section starts from 0 so the address range is as shown.

==Macro reference==

===ChangeBaud===
{| 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;" | '''ChangeBaud'''
|-
| colspan="2" | Changes the UART Baud rate. 1 = 1200 / 2 = 2400 / 3 = 4800 / 4 = 9600 / 5 = 19200 / 6 = 31250 7 = 38400 / 8 = 57600 / 9 = 115200 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Baud
|-
| colspan="2" | The new baud rate (0=1200, 9=115200) 
|-
| 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''
|}

===ChangeFrameType===
{| 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;" | '''ChangeFrameType'''
|-
| colspan="2" | Default frame type is the type set in the component properties. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Type
|-
| colspan="2" | 0 = Modbus RTU / 1 = Modbus ASCII 
|-
| 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''
|}

===GetResponse===
{| 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;" | '''GetResponse'''
|-
| colspan="2" | Collects as much incoming data as possible and stored into the response buffer. The number of bytes received will be stored into location 0 of the response buffer. Return value indicates validity of incoming CRC. 0 = OK, 1 = CRC fail, 255 = No Data 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | NumBytes
|-
| colspan="2" |  
|-
| 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''
|}

===GetResponseByte===
{| 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;" | '''GetResponseByte'''
|-
| colspan="2" | Reads a byte from the last received response. The Index parametes specifies which byte to read back.  
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Index
|-
| colspan="2" | 0=NumBytes, 1=SlaveAddress, 2=FunctionCode/ExceptionCode, 3=DataBytes, 4=data0, 5=data1, .. 
|-
| 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''
|}

===GetResponseInt===
{| 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;" | '''GetResponseInt'''
|-
| colspan="2" | Reads a 16-bit value from the last received response. The Index parametes specifies the byte index of the value to read back.  
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Index
|-
| colspan="2" | 4=data0, 6=data1, 8=data2, .. 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===Initialise===
{| 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" | Starts up the UART to allow communications 
|-
|-
| 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''
|}

===ReadAnalogInput===
{| 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;" | '''ReadAnalogInput'''
|-
| colspan="2" | This command requests the analogue input register values starting from the start RegAddress and going through to RegAddress plus RegCount. Returns 0 for success, 1 for CRC fail and 255 for no reply. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | SlaveID
|-
| colspan="2" | The ID of the MODBUS slave 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | RegAddress
|-
| colspan="2" | Input Address: 0=10001, 1=10002, 2=10003, ... 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | RegCount
|-
| colspan="2" | Number of consecutive inputs to read, starting from RegAddress 
|-
| 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''
|}

===ReadCoil===
{| 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;" | '''ReadCoil'''
|-
| colspan="2" | This command requests the ON/OFF status of discrete coils starting from the start CoilAddress and going through to CoilAddress plus CoilCount. Returns 0 for success, 1 for CRC fail and 255 for no reply. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | SlaveID
|-
| colspan="2" | The ID of the MODBUS slave 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | CoilAddress
|-
| colspan="2" | Coil Address: 0=Coil1, 1=Coil2, 2=Coil3, ... 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | CoilCount
|-
| colspan="2" | Number of consecutive coils to try and read 
|-
| 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''
|}

===ReadDigitalInput===
{| 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;" | '''ReadDigitalInput'''
|-
| colspan="2" | This command requests the ON/OFF status of discrete inputs starting from the start DataAddress and going through to DataAddress plus DataCount. Returns 0 for success, 1 for CRC fail and 255 for no reply. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | SlaveID
|-
| colspan="2" | The ID of the MODBUS slave 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | DataAddress
|-
| colspan="2" | Input Address: 0=10001, 1=10002, 2=10003, ... 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | DataCount
|-
| colspan="2" | Number of consecutive inputs to read, starting from RegAddress 
|-
| 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''
|}

===ReadHoldingRegister===
{| 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;" | '''ReadHoldingRegister'''
|-
| colspan="2" | This command requests the analogue holding register values starting from the start RegAddress and going through to RegAddress plus RegCount. Returns 0 for success, 1 for CRC fail and 255 for no reply. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | SlaveID
|-
| colspan="2" | The ID of the MODBUS slave 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | RegAddress
|-
| colspan="2" | Address: 0=40001, 1=40002, ... 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | RegCount
|-
| colspan="2" | Number of consecutive registers to read, starting from RegAddress 
|-
| 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''
|}

===SetCoil===
{| 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;" | '''SetCoil'''
|-
| colspan="2" | This command writes the contents of a discrete coil at the location CoilAddress. Returns 0 for success, 1 for CRC fail and 255 for no reply. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | SlaveID
|-
| colspan="2" | The ID of the MODBUS slave 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | CoilAddress
|-
| colspan="2" | Coil Address: 0=Coil1, 1=Coil2, 2=Coil3, ... 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | CoilState
|-
| colspan="2" | 0=Off, 1=On 
|-
| 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''
|}

===SetCoils===
{| 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;" | '''SetCoils'''
|-
| colspan="2" | This command writes the contents of a series of discrete coils at the location starting at CoilAddress through to CoilAddress + CoilCount. Returns 0 for success, 1 for CRC fail and 255 for no reply. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | SlaveID
|-
| colspan="2" | The ID of the MODBUS slave 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | CoilAddress
|-
| colspan="2" | Coil Address: 0=Coil1, 1=Coil2, 2=Coil3, ... 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | CoilCount
|-
| colspan="2" | Number of consecutive coils to try and read 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | CoilData
|-
| colspan="2" | An array of bytes each containing 8 1-bit coil values 
|-
| 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''
|}

===SetHoldingRegister===
{| 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;" | '''SetHoldingRegister'''
|-
| colspan="2" | This command writes the contents of a holding register at the location RegAddress. Returns 0 for success, 1 for CRC fail and 255 for no reply. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | SlaveID
|-
| colspan="2" | The ID of the MODBUS slave 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | RegAddress
|-
| colspan="2" | Address: 0=40001, 1=40002, ... 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | RegValue
|-
| colspan="2" | Value to send to the selected register 
|-
| 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''
|}

===SetHoldingRegisters===
{| 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;" | '''SetHoldingRegisters'''
|-
| colspan="2" | This command writes the contents of several holding registers starting at the location RegAddress through to location RegAddress + RegCount . Returns 0 for success, 1 for CRC fail and 255 for no reply. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | SlaveID
|-
| colspan="2" | The ID of the MODBUS slave 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | RegAddress
|-
| colspan="2" | Address: 0=40001, 1=40002, ... 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | RegCount
|-
| colspan="2" | Number of consecutive registers to write, starting from RegAddress 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | RegValue
|-
| colspan="2" | Array of values to send to the registers 
|-
| 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''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| 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;" | UART Properties
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Channel
|-
| colspan="2" | UART Channel selector Software channels are bit banged using generic I/O pins but are not as reliable as hardware channels. Hardware channels use the selected peripheral on-board the target microcontroller. 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | TX
|-
| colspan="2" | Pin to be used for Transmit data 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | RX
|-
| colspan="2" | Pin to be used for Receive data 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Baud Options
|-
| colspan="2" | Baud rate option selector 
|-
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
| width="90%" | Baud Rate
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Bus
|-
| colspan="2" | Specifies the bus mode being used, RS232 allows you to connect a single master node to a single slave node. RS485 allows you to connect a single master node to multiple slave nodes. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Modbus Properties
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Frame Type
|-
| colspan="2" | Switches between RTU and ASCII forms of Modbus 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Receive Buffer Size
|-
| colspan="2" | Maximum number of bytes the receive buffer can hold 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Slave ID Bytes
|-
| colspan="2" | Number of bytes used when passing a slave ID, usually 1 but sometimes 2 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Silent Interval
|-
| colspan="2" | Configures how much time to wait after each master modbus command before another command can be sent. A silent interval of 60ms minimum is required in order to guarentee successful reception of the next transmission. 0=No Delay 60 = 60mS - Default Range : 0 - 65535 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | UART Receive Timeout
|-
| colspan="2" | Amount of time to wait before timing out when listening for a slave's response. Range: 0 - 255. 0 = Don't Wait 1 - 254 = X ms 255 = Wait Forever 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Receive Timeout Count
|-
| colspan="2" | Number of timeouts in a row to wait for until we decide the slave is not responding or finished responding to a message. Range: 0 - 255 0 = First Timeout Only 1 = First Timeout + 1 2 = First Timeout + 2 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation Properties
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Label
|-
| colspan="2" | A text label to appear on the Modbus panel object. 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Scope Traces
|-
| colspan="2" | Selects if the scope traces are automatically added to the data recorder window or not. Simulation - draws an approximation of the UART data onto the scope trace. ICT - sets up the scope trace for incoming data and adds UART packet decoding at the correct BAUD. 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Console Data
|-
| colspan="2" | Selects if the console data is automatically generated or not 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Console Columns
|-
| colspan="2" | Number of characters that can be displayed on a single line of the console. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Data Source
|-
| colspan="2" | Simulation data source used to allow the component to connect to various remote devices Nothing - Simulation data is ignored COM port - Routes the communication data to and from a physical or virtual COM port API - Routes the communication data via a data API component on the Panel. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | COM Port
|-
| colspan="2" | Lists all the current available COM port hardware on your PC. 
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Modbus.fcfx FC_Comp_Source_Modbus.fcfx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Modbus.fcfx FC_Comp_Source_Modbus.fcfx]

Component: ID ee11c499 8a22 4987 ba57 c7d5d2224a39

2026-02-25T11:01:42Z

Wiki bot: Redirected page to Component: ADC 24bit ADS1220 (Analog Input)

#REDIRECT [[Component: ADC 24bit ADS1220 (Analog Input)]]

Component: ADC 24bit ADS1220 (Analog Input)

2026-02-25T11:01:42Z

Wiki bot:

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix TSL
|-
| width="20%" style="color:gray;" | Version
| 1.0
|-
| width="20%" style="color:gray;" | Category
| Analog Input
|}

==ADC 24bit ADS1220 component==
A Precision Low power 24Bit SPI ADC 4 channel device with Programmable Gain Amplifier (PGA) and Data Rates up to 2 kSPS

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

''No additional examples''

==Macro reference==

===Initialise===
{| 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" | Initialize the ADS1220 ADC with default settings 
|-
|-
| 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''
|}

===ReadRTDResistance===
{| 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;" | '''ReadRTDResistance'''
|-
| colspan="2" | Reads the RTD sensor and returns resistance in ohms 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===ReadRTDTemperature===
{| 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;" | '''ReadRTDTemperature'''
|-
| colspan="2" | Reads the RTD sensor and returns temperature in degrees Celsius using linear approximation - matches GitHub library get_temperature_from_rtd_ohms_with_linear_approx 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===SampleDiffRAW===
{| 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;" | '''SampleDiffRAW'''
|-
| colspan="2" | Performs a differential ADC sample between two channels and returns 24-bit raw value. Not all channel combinations are possible, see datasheet p40 section MUX. Returns 0 if the channel selection is invalid. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ChannelA
|-
| colspan="2" | Positive channel: 0-3 (AN0-AN3) 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ChannelB
|-
| colspan="2" | Negative channel: 0-3 (AN0-AN3) 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Gain
|-
| colspan="2" | PGA Gain: 0=1x, 1=2x, 2=4x, 3=8x, 4=16x, 5=32x, 6=64x, 7=128x 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s32-icon.png]] - LONG
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===SampleDiffVolts===
{| 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;" | '''SampleDiffVolts'''
|-
| colspan="2" | Performs a differential ADC sample and returns voltage in volts 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ChannelA
|-
| colspan="2" | Positive channel: 0-3 (AN0-AN3) 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ChannelB
|-
| colspan="2" | Negative channel: 0-3 (AN0-AN3) 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Gain
|-
| colspan="2" | PGA Gain: 0=1x, 1=2x, 2=4x, 3=8x, 4=16x, 5=32x, 6=64x, 7=128x 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===SampleSglRaw===
{| 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;" | '''SampleSglRaw'''
|-
| colspan="2" | Performs a single-ended ADC sample on the selected channel and returns 24-bit raw value 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | Range: 0-3 (AN0-AN3) 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Gain
|-
| colspan="2" | PGA Gain: 0=1x, 1=2x, 2=4x, 3=8x, 4=16x, 5=32x, 6=64x, 7=128x 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s32-icon.png]] - LONG
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===SampleSglVolts===
{| 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;" | '''SampleSglVolts'''
|-
| colspan="2" | Performs a single-ended ADC sample and returns voltage in volts 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | Range: 0-3 (AN0-AN3) 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Gain
|-
| colspan="2" | PGA Gain: 0=1x, 1=2x, 2=4x, 3=8x, 4=16x, 5=32x, 6=64x, 7=128x 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| 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;" | Connections
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Channel
|-
| colspan="2" | SPI Channel selector 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Prescale
|-
| colspan="2" | Prescale option selector 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | MOSI
|-
| colspan="2" | SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | MOSI Remap Pin
|-
| colspan="2" | Select which the target pin to assign the MOSI hardware pin functionality. 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | MISO
|-
| colspan="2" | SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | MISO Remap Pin
|-
| colspan="2" | Select which the target pin to assign the MISO hardware pin functionality. 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | CLK
|-
| colspan="2" | SPI Clock Pin CLK - The Clock signal is driven by the SPI master. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | CLK Remap Pin
|-
| colspan="2" | Select which the target pin to assign the CLK hardware pin functionality. 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | CS / SS
|-
| colspan="2" | Chip Select / Slave Select Pin Master Mode: General purpose output pin used to select the remote SPI device. Slave Mode: Hardware chip select pin input used to select the SPI device.  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Use Ready Pin
|-
| colspan="2" | Use DRDY pin to detect when conversion is complete. If disabled, polling will be used. 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | DRDY Pin
|-
| colspan="2" | Data Ready pin - goes low when conversion is complete 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Configuration
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Data Rate
|-
| colspan="2" | Programmable Data Rate (SPS) 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Operating Mode
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Conversion Mode
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | PGA Gain
|-
| colspan="2" | Programmable Gain Amplifier (PGA) gain setting 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Voltage Reference
|-
| colspan="2" | Voltage reference source 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Reference Voltage
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | FIR Filter
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | IDAC Current (uA)
|-
| colspan="2" | IDAC excitation current in microamperes. Typical values: 100, 250, 500, 750, 1000. Default: 250uA 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | I1MUX
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | I2MUX
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | RTD Configuration
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | RTD Type
|-
| colspan="2" | RTD sensor type - determines base resistance at 0°C 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | RTD Configuration
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
| width="90%" | Reference Resistor
|-
| colspan="2" | High precision reference resistor value in ohms. Typically 400Ω for PT100 or 4000Ω for PT1000 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Temperature Coefficient
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
|-
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Simulate Comms
|-
| colspan="2" | Allows the communications to be simulated overriding the value on the panel slider controls. 
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_External_ADC24Bit_ADS1220_1.fcfx FC_Comp_Source_External_ADC24Bit_ADS1220_1.fcfx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_External_ADC24Bit_ADS1220_1.fcfx FC_Comp_Source_External_ADC24Bit_ADS1220_1.fcfx]

Component: ADC 24bit ADS1220 (Analog Input)

2026-02-25T11:01:41Z

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix TSL
|-
| width="20%" style="color:gray;" | Version
| 1.0
|-
| width="20%" style="color:gray;" | Category
| Analog Input
|}

==ADC 24bit ADS1220 component==
A Precision Low power 24Bit SPI ADC 4 channel device with Programmable Gain Amplifier (PGA) and Data Rates up to 2 kSPS

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

''No additional examples''

==Macro reference==

===Initialise===
{| 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" | Initialize the ADS1220 ADC with default settings 
|-
|-
| 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''
|}

===ReadRTDResistance===
{| 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;" | '''ReadRTDResistance'''
|-
| colspan="2" | Reads the RTD sensor and returns resistance in ohms 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===ReadRTDTemperature===
{| 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;" | '''ReadRTDTemperature'''
|-
| colspan="2" | Reads the RTD sensor and returns temperature in degrees Celsius using linear approximation - matches GitHub library get_temperature_from_rtd_ohms_with_linear_approx 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===SampleDiffRAW===
{| 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;" | '''SampleDiffRAW'''
|-
| colspan="2" | Performs a differential ADC sample between two channels and returns 24-bit raw value. Not all channel combinations are possible, see datasheet p40 section MUX. Returns 0 if the channel selection is invalid. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ChannelA
|-
| colspan="2" | Positive channel: 0-3 (AN0-AN3) 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ChannelB
|-
| colspan="2" | Negative channel: 0-3 (AN0-AN3) 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Gain
|-
| colspan="2" | PGA Gain: 0=1x, 1=2x, 2=4x, 3=8x, 4=16x, 5=32x, 6=64x, 7=128x 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s32-icon.png]] - LONG
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===SampleDiffVolts===
{| 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;" | '''SampleDiffVolts'''
|-
| colspan="2" | Performs a differential ADC sample and returns voltage in volts 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ChannelA
|-
| colspan="2" | Positive channel: 0-3 (AN0-AN3) 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ChannelB
|-
| colspan="2" | Negative channel: 0-3 (AN0-AN3) 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Gain
|-
| colspan="2" | PGA Gain: 0=1x, 1=2x, 2=4x, 3=8x, 4=16x, 5=32x, 6=64x, 7=128x 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===SampleSglRaw===
{| 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;" | '''SampleSglRaw'''
|-
| colspan="2" | Performs a single-ended ADC sample on the selected channel and returns 24-bit raw value 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | Range: 0-3 (AN0-AN3) 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Gain
|-
| colspan="2" | PGA Gain: 0=1x, 1=2x, 2=4x, 3=8x, 4=16x, 5=32x, 6=64x, 7=128x 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s32-icon.png]] - LONG
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===SampleSglVolts===
{| 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;" | '''SampleSglVolts'''
|-
| colspan="2" | Performs a single-ended ADC sample and returns voltage in volts 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | Range: 0-3 (AN0-AN3) 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Gain
|-
| colspan="2" | PGA Gain: 0=1x, 1=2x, 2=4x, 3=8x, 4=16x, 5=32x, 6=64x, 7=128x 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| 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;" | Connections
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Channel
|-
| colspan="2" | SPI Channel selector 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Prescale
|-
| colspan="2" | Prescale option selector 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | MOSI
|-
| colspan="2" | SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | MOSI Remap Pin
|-
| colspan="2" | Select which the target pin to assign the MOSI hardware pin functionality. 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | MISO
|-
| colspan="2" | SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | MISO Remap Pin
|-
| colspan="2" | Select which the target pin to assign the MISO hardware pin functionality. 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | CLK
|-
| colspan="2" | SPI Clock Pin CLK - The Clock signal is driven by the SPI master. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | CLK Remap Pin
|-
| colspan="2" | Select which the target pin to assign the CLK hardware pin functionality. 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | CS / SS
|-
| colspan="2" | Chip Select / Slave Select Pin Master Mode: General purpose output pin used to select the remote SPI device. Slave Mode: Hardware chip select pin input used to select the SPI device.  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Use Ready Pin
|-
| colspan="2" | Use DRDY pin to detect when conversion is complete. If disabled, polling will be used. 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | DRDY Pin
|-
| colspan="2" | Data Ready pin - goes low when conversion is complete 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Configuration
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Data Rate
|-
| colspan="2" | Programmable Data Rate (SPS) 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Operating Mode
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Conversion Mode
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | PGA Gain
|-
| colspan="2" | Programmable Gain Amplifier (PGA) gain setting 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Voltage Reference
|-
| colspan="2" | Voltage reference source 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Reference Voltage
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | FIR Filter
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | IDAC Current (uA)
|-
| colspan="2" | IDAC excitation current in microamperes. Typical values: 100, 250, 500, 750, 1000. Default: 250uA 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | I1MUX
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | I2MUX
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | RTD Configuration
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | RTD Type
|-
| colspan="2" | RTD sensor type - determines base resistance at 0°C 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | RTD Configuration
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
| width="90%" | Reference Resistor
|-
| colspan="2" | High precision reference resistor value in ohms. Typically 400Ω for PT100 or 4000Ω for PT1000 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Temperature Coefficient
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
|-
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Simulate Comms
|-
| colspan="2" | Allows the communications to be simulated overriding the value on the panel slider controls. 
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_External_ADC24Bit_ADS1220.fcfx FC_Comp_Source_External_ADC24Bit_ADS1220.fcfx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_External_ADC24Bit_ADS1220.fcfx FC_Comp_Source_External_ADC24Bit_ADS1220.fcfx]

Component: Circular Slider (Graphical Manager Primitives)

2026-02-25T11:01:40Z

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix TSL
|-
| width="20%" style="color:gray;" | Version
| 1.0
|-
| width="20%" style="color:gray;" | Category
| Graphical Manager Primitives
|}

==Circular Slider component==
A circular slider widget used with the Graphical Manager on the GLCD Layout Editor panel.

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

''No additional examples''

==Macro reference==

===GetID===
{| 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;" | '''GetID'''
|-
| colspan="2" | Returns the assigned object/widget ID. 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===GetSliderValue===
{| 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;" | '''GetSliderValue'''
|-
| colspan="2" | Reads the value of one of the sliders ranging between 0-1 or Custom range Min-Max. 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===ModifyColour===
{| 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;" | '''ModifyColour'''
|-
| colspan="2" | Changes the theme index of the selected Object or Widget. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Index
|-
| colspan="2" | 0=Thumb, 1=Background, 2=Low Line, 3=High Line 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | R
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | G
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | B
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | Redraw
|-
| 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''
|}

===ModifyPosition===
{| 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;" | '''ModifyPosition'''
|-
| colspan="2" | Moves an existing object or Widget to absolute coordinates on the screen. 
|-
|-
| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
| width="90%" | X
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
| width="90%" | Y
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | Relative
|-
| colspan="2" | 0=Absolute Positioning, 1=Relative Positioning 
|-
| 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''
|}

===ModifyScale===
{| 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;" | '''ModifyScale'''
|-
| colspan="2" | Changes the width and height of the selected Object or Widget. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Width
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Height
|-
| 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''
|}

===SetSliderValue===
{| 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;" | '''SetSliderValue'''
|-
| colspan="2" | Sets the value of one of the sliders and optionally redraws the slider to reflect the value change. 
|-
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | Value
|-
| colspan="2" | Range: 0 to 1 - Or Custom Range Min to Max 
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | RedrawSlider
|-
| colspan="2" | 0=Do not redraw, 1=Redraw 
|-
| 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''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| 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;" | Appearance
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Orientation
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Line Width
|-
| colspan="2" | Width of the line in pixels 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | ThumbShape
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Thumb Width
|-
| colspan="2" | Width of the thumb in pixels 
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Thumb Colour
|-
| colspan="2" | The colour of the outer border line 
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Background Colour
|-
| colspan="2" | The fill colour of the shape 
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Low Line Colour
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | High Line Colour
|-
| colspan="2" | The colour of the drop shadow 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Touch
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Value Range
|-
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Custom Range
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Minimum Value
|-
| colspan="2" | The minimum value of the slider. 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Maximum Value
|-
| colspan="2" | The maximum value of the slider. 
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_DC_CircularSlider.fcfx FC_Comp_Source_DC_CircularSlider.fcfx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_DC_CircularSlider.fcfx FC_Comp_Source_DC_CircularSlider.fcfx]

Component: ID 534a9915 a70f 4f65 8309 e13fedf445e4

2026-02-25T11:01:40Z

Wiki bot: Redirected page to Component: Circular Slider (Graphical Manager Primitives)

#REDIRECT [[Component: Circular Slider (Graphical Manager Primitives)]]

Component: Potentiometer (Colour) ()

2026-01-27T21:17:04Z

Wiki bot:

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix Ltd
|-
| width="20%" style="color:gray;" | Version
| 1.3
|-
| width="20%" style="color:gray;" | Category
|
|}

==Potentiometer (Colour) component==
Potentiometer with black plastic knob with coloured cap. Cap and pointer colours can be changed in component properties.

==Version information==

Library Version, Component Version, Date, Author, Info
6, 6.0, 05-12-24, MW,Icon edited so compatible with dark theme

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

A simple example that shows how to use some common functions of the potentiometer in conjunction with an LCD.

{{Fcfile|Potentiometer Example.fcfx|Potentiometer Example}}

==Macro reference==

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| 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;" | Simulation
|-
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Start Angle
|-
| colspan="2" | Angle the control points to at its lowest setting. Measured counter-clockwise from the positive x-axis. 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Sweep Angle
|-
| colspan="2" | Angle through which the control sweeps as it turns from minimum to maximum. 
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Cap Color
|-
| colspan="2" | Colour of the knob cap. 
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Pointer Color
|-
| colspan="2" | Colour of the knob pointer. 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Scope Traces
|-
| colspan="2" | Selects if the scope traces are automatically generated or not 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Retain Value
|-
| colspan="2" | If yes is slected After saving your project, the ADC value will be retained when your project is reloaded. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
|-
|-
| width="10%" align="center" | [[File:Fc9-type-6-icon.png]]
| width="90%" | Channel
|-
| colspan="2" | Analogue input channel - which pin is the analogue input conected to? 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Settings
|-
|-
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
| width="90%" | VRef voltage
|-
| colspan="2" | Used by the GetVoltage or GetString component macros to take an ADC reading and convert it into a Voltage. +VRef voltage x 10mV Default 500 = 5.0V  
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | VRef option
|-
| colspan="2" | Defines what is used as the ADC maximum reference. ADC Range = GND to VRef Voltage. VDD - Defines the microcontrollers power supply pin as the max reference, VREF+ Pin - Dedicated pin on the microcontroller to allow for a variable reference voltage.  
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Conversion speed
|-
| colspan="2" | Clock setting to select how fast the ADC peripheral will perform an ADC conversion. The FRC setting is based on a RC time base and so will vary with temperature and pressure. Other settings are generally based on divisions of the master clock. 
|-
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
| width="90%" | Acquisition cycles
|-
| colspan="2" | Number of micro seconds to wait for the ACD input to charge before starting the analogue sample. 
|-
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
| width="90%" | Bit Depth
|-
| colspan="2" | Maximum number of digital bits the ADC can sample. 8 bit = ADC range 0 - 255 10 bit = ADC range 0 - 1023 12 bit = ADC range 0 - 4095  
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_pot_Colour.fcfx FC_Comp_Source_pot_Colour.fcfx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_pot_Colour.fcfx FC_Comp_Source_pot_Colour.fcfx]

Component: Potentiometer (Trimmer) ()

2026-01-27T21:17:04Z

Wiki bot:

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix Ltd
|-
| width="20%" style="color:gray;" | Version
| 1.4
|-
| width="20%" style="color:gray;" | Category
|
|}

==Potentiometer (Trimmer) component==
Trim Pot for 0.1mm pitch PCB. With finger dial knob. Pointer colour can be changed from component properties.

==Version information==

Library Version, Component Version, Date, Author, Info
6, 6.0, 05-12-24, MW,Icon edited so compatible with dark theme

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

A simple example that shows how to use some common functions of the potentiometer in conjunction with an LCD.

{{Fcfile|Potentiometer Example.fcfx|Potentiometer Example}}

==Macro reference==

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| 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;" | Simulation
|-
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Start Angle
|-
| colspan="2" | Angle the control points to at its lowest setting. Measured counter-clockwise from the positive x-axis. 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Sweep Angle
|-
| colspan="2" | Angle through which the control sweeps as it turns from minimum to maximum. 
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Color
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Scope Traces
|-
| colspan="2" | Selects if the scope traces are automatically generated or not 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Retain Value
|-
| colspan="2" | If yes is slected After saving your project, the ADC value will be retained when your project is reloaded. 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Set Value
|-
| colspan="2" | Angle through which the control sweeps as it turns from minimum to maximum. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
|-
|-
| width="10%" align="center" | [[File:Fc9-type-6-icon.png]]
| width="90%" | Channel
|-
| colspan="2" | Analogue input channel - which pin is the analogue input conected to? 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Settings
|-
|-
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
| width="90%" | VRef voltage
|-
| colspan="2" | Used by the GetVoltage or GetString component macros to take an ADC reading and convert it into a Voltage. +VRef voltage x 10mV Default 500 = 5.0V  
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | VRef option
|-
| colspan="2" | Defines what is used as the ADC maximum reference. ADC Range = GND to VRef Voltage. VDD - Defines the microcontrollers power supply pin as the max reference, VREF+ Pin - Dedicated pin on the microcontroller to allow for a variable reference voltage.  
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Conversion speed
|-
| colspan="2" | Clock setting to select how fast the ADC peripheral will perform an ADC conversion. The FRC setting is based on a RC time base and so will vary with temperature and pressure. Other settings are generally based on divisions of the master clock. 
|-
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
| width="90%" | Acquisition cycles
|-
| colspan="2" | Number of micro seconds to wait for the ACD input to charge before starting the analogue sample. 
|-
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
| width="90%" | Bit Depth
|-
| colspan="2" | Maximum number of digital bits the ADC can sample. 8 bit = ADC range 0 - 255 10 bit = ADC range 0 - 1023 12 bit = ADC range 0 - 4095  
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_pot_Trimmer.fcfx FC_Comp_Source_pot_Trimmer.fcfx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_pot_Trimmer.fcfx FC_Comp_Source_pot_Trimmer.fcfx]

Component: WLAN (ESP-12S) (Comms: Networking)

2026-01-27T21:17:03Z

Wiki bot:

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix Ltd.
|-
| width="20%" style="color:gray;" | Version
| 8.0
|-
| width="20%" style="color:gray;" | Category
| Comms: Networking
|}

==WLAN (ESP-12S) component==
Wireless LAN component designed to work with the ESP-12S module. Provides a very simple interface to allow webpages to be hosted from hardware or simulation. Also available in the form of the BL0136 WIFI E-block.

==Version information==

Library Version, Component Version, Date, Author, Info
8, 8.0, 07-01-25, MW, initialised return value within ControlTCPServer to prevent ESP error

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

''No additional examples''

==Macro reference==

===CheckForPageRequests===
{| 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;" | '''CheckForPageRequests'''
|-
| colspan="2" | To be called periodically. Returns non-zero if a request has been processed 
|-
|-
| 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''
|}

===CheckTCPServerIP===
{| 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;" | '''CheckTCPServerIP'''
|-
| colspan="2" | Collects the local IP address of the active TCP server. 
|-
|-
| 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''
|}

===ClientConnect===
{| 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;" | '''ClientConnect'''
|-
| colspan="2" | Creates a TCP or UDP connection to a remote server. Returns the state of the connection. 0=Connection failed 1=Connection active 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Type
|-
| colspan="2" | 0 = TCP, 1 = UDP 
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | IPAddress
|-
| colspan="2" | e.g. "192.168.1.20" 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Port
|-
| colspan="2" | Remote port number to connect to, HTTP comms = Port 80 
|-
| 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''
|}

===ClientSendArray===
{| 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;" | '''ClientSendArray'''
|-
| colspan="2" | Sends out an array of data bytes with the required AT+CIPSEND=Length$(Request) initialiser. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Data
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | NumBytes
|-
| 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''
|}

===ClientSendRequest===
{| 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;" | '''ClientSendRequest'''
|-
| colspan="2" | Sends out a string with the required AT+CIPSEND=Length$(Request) initialiser. 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Request
|-
| colspan="2" | e.g. "GET / HTTP/1.0\r\n\r\n" 
|-
| 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''
|}

===ConnectToSSID===
{| 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;" | '''ConnectToSSID'''
|-
| colspan="2" | Attempts to connect to the given SSID and Key values. Returns 1 if the SSID has been connected.  
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | SSID
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Key
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Timeout
|-
| colspan="2" | Number of seconds to wait for the connection, default 20 
|-
| 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''
|}

===ControlTCPServer===
{| 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;" | '''ControlTCPServer'''
|-
| colspan="2" | Allows a TCP web page server to be switched on and off on the selected port. Returns 1 if the command was completed correctly. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Enable
|-
| colspan="2" | 0 = Stop Server, 1 = Start Server 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Port
|-
| colspan="2" | Server port to listen for incoming TCP/IP data requests 
|-
| 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''
|}

===CreateAccessPoint===
{| 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;" | '''CreateAccessPoint'''
|-
| colspan="2" | Sets up the wireless LAN module into AP mode to host a wireless network. Other WIFI enabled devices can then connect to the module. Returns 1 for success. 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | SSID
|-
| colspan="2" | Name of the wireless network to create 
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Password
|-
| colspan="2" | Password used to gain access to the network 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | 802.11 Channel Range 1-14 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Encryption
|-
| colspan="2" | 0=Open, 1=WEP, 2=WPA_PSK, 3=WPA2_PSK, 4=WPA_WPA2_PSK 
|-
| 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''
|}

===DisconnectFromSSID===
{| 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;" | '''DisconnectFromSSID'''
|-
| colspan="2" | Disconnects from the current SSID. Returns 1 if the command was accepted and returned an "OK" 
|-
|-
| 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''
|}

===EndServerConnection===
{| 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;" | '''EndServerConnection'''
|-
| colspan="2" | Disconnects from the current active TCP/IP pipe. 
|-
|-
| 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''
|}

===GetByteWithTimeout===
{| 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;" | '''GetByteWithTimeout'''
|-
| colspan="2" | Attempts to receive a byte from the circular buffer. If nothing is available then waits up to 200 ms for data to become available. 
|-
|-
| 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''
|}

===GetFirmwareVersion===
{| 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;" | '''GetFirmwareVersion'''
|-
| colspan="2" | Collects the firmware version from the ESP8266 module and returns it as a string. 
|-
|-
| 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''
|}

===GetInValue===
{| 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;" | '''GetInValue'''
|-
| colspan="2" | Returns the string value of a Request parameter 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | index
|-
| colspan="2" | Index of the request paramter, starting at zero Range 0-2 
|-
| 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''
|}

===GetRxArray===
{| 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;" | '''GetRxArray'''
|-
| colspan="2" | Attempts to receive a number of bytes from the remote connection If nothing is available then waits up to 200 ms for data to become available. Returns the number of bytes received,. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Data
|-
| colspan="2" | Byte array to store the incoming data 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | MaxBytes
|-
| colspan="2" | Maximum number of bytes to try and receive 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===Initialise===
{| 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" | Initialise the device with the property data. Returns 1 if "ready" message successfully received Returns 0 if no reply from module 
|-
|-
| 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''
|}

===ReadEncryptionModeFromScan===
{| 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;" | '''ReadEncryptionModeFromScan'''
|-
| colspan="2" | Collects one of the encryption modes from the last SSID Scan. The ScanForSSID macro must be called first. 0=Open, 1=WEP, 2=WPA_PSK, 3=WPA2_PSK, 4=WPA_WPA2_PSK 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Index
|-
| colspan="2" | SSID Index 
|-
| 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''
|}

===ReadSSIDFromScan===
{| 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;" | '''ReadSSIDFromScan'''
|-
| colspan="2" | Collects one of the SSID name strings from the last SSID Scan. The ScanForSSID macro must be called first. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Index
|-
| colspan="2" | SSID Index 
|-
| 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''
|}

===ReadSignalStrengthFromScan===
{| 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;" | '''ReadSignalStrengthFromScan'''
|-
| colspan="2" | Collects the signal strength from the last SSID Scan. The ScanForSSID macro must be called first. Value returned is in negative dB, smaller value = better signal 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Index
|-
| colspan="2" | SSID Index 
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===ScanForSSID===
{| 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;" | '''ScanForSSID'''
|-
| colspan="2" | Checks for wireless networks in the local area which are broadcasting their SSID. Must not be connected to a network to allow this to function. Returns the number of wireless networks found, max 8. 
|-
|-
| 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''
|}

===SendString===
{| 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;" | '''SendString'''
|-
| colspan="2" | Sends the given Text with no preappendment. Useful for sending preformatted command strings. Appends a CR to the end of the string if SendCR is greater than 0. 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Text
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | SendCR
|-
| 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''
|}

===Send_Embedded_HTML_Page1===
{| 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;" | '''Send_Embedded_HTML_Page1'''
|-
| 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''
|}

===Send_Embedded_HTML_Page2===
{| 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;" | '''Send_Embedded_HTML_Page2'''
|-
| 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''
|}

===Send_Embedded_HTML_Page3===
{| 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;" | '''Send_Embedded_HTML_Page3'''
|-
| 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''
|}

===Send_Embedded_HTML_Page4===
{| 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;" | '''Send_Embedded_HTML_Page4'''
|-
| 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''
|}

===SetOutValue===
{| 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;" | '''SetOutValue'''
|-
| colspan="2" | Set the value of an outbound substitution string 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | index
|-
| colspan="2" | Range 0-4 
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | value
|-
| 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''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| 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;" | WIFI Properties
|-
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Receive Buffer Size
|-
| colspan="2" | Buffer used to store incoming data ready for processing. Default 128 Bytes. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Scan Buffer Size
|-
| colspan="2" | Buffer used to hold SSID names when performing a SSID network scan. Default 100 Bytes. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Reset Mode
|-
| colspan="2" | The initialise automatically resets the WIFI module before establishing communications. Software reset uses an AT command to preform the reset Hardware reset uses an extra I/O pin to toggle the signal to the reset pin on the module. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Command Termination
|-
| colspan="2" | Older versions of the firmware require \r to terminate a AT command string. Newer versions of the firmware have changed to use \r\n termination. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Channel
|-
| colspan="2" | UART Channel selector Software channels are bit banged using generic I/O pins but are not as reliable as hardware channels. Hardware channels use the selected peripheral on-board the target microcontroller. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Baud Options
|-
| colspan="2" | Baud rate option selector 
|-
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
| width="90%" | Baud Rate
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | TX
|-
| colspan="2" | Pin to be used for Transmit data 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | TX Remap Pin
|-
| colspan="2" | Allows the hardware transmit pin to be configured from a list of available pins based on your target device, 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | RX
|-
| colspan="2" | Pin to be used for Receive data 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | RX Remap Pin
|-
| 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" | [[File:Fc9-type-5-icon.png]]
| width="90%" | Reset
|-
| colspan="2" | WLAN module reset pin connection 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Use Flow Control
|-
| colspan="2" | Flow Control (Handshake) enable or disable. On: Two I/O pins are used to control the flow of data in and out of the device. Off: Flow control is disabled. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | HTML Source
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Max Web Pages
|-
| colspan="2" | Maximum number of individual webpages we can serve up with the component. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Web Page Timeout
|-
| colspan="2" | Number of cycles to try and send / receive a webpage before timing out. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Line Delay
|-
| colspan="2" | Fixed delay in microseconds sent in between sending a HTML line when running as a web page server. 
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Name Page 1
|-
| colspan="2" | HTML name of webpage 1 
|-
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
| width="90%" | HTML Page 1
|-
| colspan="2" | HTML content for webpage 1 
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Name Page 2
|-
| colspan="2" | HTML name of webpage 2 
|-
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
| width="90%" | HTML Page 2
|-
| colspan="2" | HTML content for webpage 2 
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Name Page 3
|-
| colspan="2" | HTML name of webpage 3 
|-
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
| width="90%" | HTML Page 3
|-
| colspan="2" | HTML content for webpage 3  
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Name Page 4
|-
| colspan="2" | HTML name of webpage 4 
|-
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
| width="90%" | HTML Page 4
|-
| colspan="2" | HTML content for webpage 4 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Substitutions
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Outgoing
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Count
|-
| colspan="2" | Maximum number of outbound string substitutions 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Length 0
|-
| colspan="2" | Number of bytes to reserve for data string. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Incoming
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Count
|-
| colspan="2" | Maximum number of inbound string substitutions 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Length 0
|-
| colspan="2" | Number of bytes to reserve for data string. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Label
|-
| colspan="2" | Text label used to help identify the component on the panel. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Simulation Method
|-
| colspan="2" | Decides how to handle the simulation of the component. TCP Base - Allows simulation of the network communications using the TCP Base component and DLL. COM/Injector - Allows the simulation to connect to real hardware or injectors. 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Console Data
|-
| colspan="2" | Decides if simulation TCP data is available via a console tab 
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_WLAN_ESP12S.fcfx FC_Comp_Source_WLAN_ESP12S.fcfx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_WLAN_ESP12S.fcfx FC_Comp_Source_WLAN_ESP12S.fcfx]

Component: RF Transceiver (nRF24L01) (Wireless)

2026-01-27T21:17:03Z

Wiki bot:

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix Ltd.
|-
| width="20%" style="color:gray;" | Version
| 9.0
|-
| width="20%" style="color:gray;" | Category
| Wireless
|}

==RF Transceiver (nRF24L01) component==
A simple RF communications module based on the 2.4GHz nRF24L01 transceivermodules.

==Version information==

Library Version, Component Version, Date, Author, Info
9, 9.0, 08-11-24, MW, added missing icon

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

Example program transmitting a count value, echoing the count and TX status to the UART for debugging.

{{Fcfile|nRFTest.fcfx|RF Test TX}}

Example program receiving a value, echoing any received values to the UART for debugging.

{{Fcfile|nRFTestRX.fcfx|RF Test RX}}

==Macro reference==

===CheckRX===
{| 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;" | '''CheckRX'''
|-
| colspan="2" | Check the Rx FIFO status register for any new data. Returns 0 = No data Returns 1 = New data available 
|-
|-
| 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''
|}

===FlushRx===
{| 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;" | '''FlushRx'''
|-
| colspan="2" | Tells the RF module to flush the contents of the receive buffer. Returns the status from sending the command. 
|-
|-
| 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''
|}

===FlushTx===
{| 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;" | '''FlushTx'''
|-
| colspan="2" | Tells the RF module to flush the contents of the transmit buffer. Returns the status from sending the command. 
|-
|-
| 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''
|}

===Initialise===
{| 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" | Starts up and configures the RF module ready for use. The macro will return a value greater then 0 if the module has been started correctly, otherwise the macro will return a 0. 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===ReadRegister===
{| 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;" | '''ReadRegister'''
|-
| colspan="2" | Reads a single bytes from the selected register. Directly returns the value read back from the register. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Reg
|-
| colspan="2" | Register address to access 
|-
| 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''
|}

===ReadRxArray===
{| 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;" | '''ReadRxArray'''
|-
| colspan="2" | Reads an array of bytes back from the local Rx buffer. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Data
|-
| colspan="2" | Byte array to store the received data 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | NumBytes
|-
| colspan="2" | Range: 1-32 
|-
| 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''
|}

===ReadRxByte===
{| 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;" | '''ReadRxByte'''
|-
| colspan="2" | Reads a single byte back from the local Rx buffer. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Index
|-
| colspan="2" | Byte to read, range 0 - 31 
|-
| 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''
|}

===ReadRxFifo===
{| 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;" | '''ReadRxFifo'''
|-
| colspan="2" | Reads the Rx FIFO buffer into a local buffer. Use the ReadBuffer/ReadArray macros to collect the individual data bytes. 
|-
|-
| 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''
|}

===SetRxMode===
{| 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;" | '''SetRxMode'''
|-
| colspan="2" | Sets up the module up ready to receive data. Assigns the 5-byte pipe listen address. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | PA0
|-
| colspan="2" | Pipe Address Bytes 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | PA1
|-
| colspan="2" | Pipe Address Bytes 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | PA2
|-
| colspan="2" | Pipe Address Bytes 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | PA3
|-
| colspan="2" | Pipe Address Bytes 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | PA4
|-
| colspan="2" | Pipe Address Bytes 
|-
| 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''
|}

===SetTxMode===
{| 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;" | '''SetTxMode'''
|-
| colspan="2" | Sets the module up ready to transmit data. Assigns the 5-byte pipe transmit address. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | PA0
|-
| colspan="2" | Pipe Address Bytes 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | PA1
|-
| colspan="2" | Pipe Address Bytes 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | PA2
|-
| colspan="2" | Pipe Address Bytes 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | PA3
|-
| colspan="2" | Pipe Address Bytes 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | PA4
|-
| colspan="2" | Pipe Address Bytes 
|-
| 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''
|}

===WriteRegister===
{| 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;" | '''WriteRegister'''
|-
| colspan="2" | Writes a single byte to the selected register. Returns the status of the write command. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Reg
|-
| colspan="2" | Register address to access 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Value
|-
| colspan="2" |  
|-
| 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''
|}

===WriteTxArray===
{| 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;" | '''WriteTxArray'''
|-
| colspan="2" | Writes an array of bytes to the local Tx buffer. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Data
|-
| colspan="2" | Byte array to write. 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | NumBytes
|-
| colspan="2" | Range: 1-32 
|-
| 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''
|}

===WriteTxByte===
{| 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;" | '''WriteTxByte'''
|-
| colspan="2" | Writes a single byte to the local Tx buffer. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Index
|-
| colspan="2" | Byte to read, range 0 - 31 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Value
|-
| 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''
|}

===WriteTxFifo===
{| 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;" | '''WriteTxFifo'''
|-
| colspan="2" | Writes the contents of the local Tx buffer to the Transmit FIFO and transmits. Returns 1 if transmission was sucessful. 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| 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;" | RF Settings
|-
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | RF Channel
|-
| colspan="2" | Sets the RF channel from 0 - 127 = 2.4000GHz - 2.525GHz Both the transmitter and receiver should be on the same channel to receive data. Default 76 is a relatively free channel meaning there should be little interference here. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | TX Power
|-
| colspan="2" | Amount of power used for the transmitter circuit. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Data Rate
|-
| colspan="2" | Sets the data throughput rate. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Channel
|-
| colspan="2" | SPI Channel selector 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Prescale
|-
| colspan="2" | Prescale option selector 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | MOSI
|-
| colspan="2" | SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | MOSI Remap Pin
|-
| colspan="2" | Select which the target pin to assign the MOSI hardware pin functionality. 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | MISO
|-
| colspan="2" | SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | MISO Remap Pin
|-
| colspan="2" | Select which the target pin to assign the MISO hardware pin functionality. 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | CLK
|-
| colspan="2" | SPI Clock Pin CLK - The Clock signal is driven by the SPI master. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | CLK Remap Pin
|-
| colspan="2" | Select which the target pin to assign the CLK hardware pin functionality. 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | CS / SS
|-
| colspan="2" | Chip Select / Slave Select Pin Master Mode: General purpose output pin used to select the remote SPI device. Slave Mode: Hardware chip select pin input used to select the SPI device.  
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | CE Pin
|-
| colspan="2" | Chip enable, configures RX or TX mode 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Label
|-
| colspan="2" | Label used to help identify the component on the panel. 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Scope Traces
|-
| colspan="2" | Selects if the scope traces are automatically generated or not 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Console Data
|-
| colspan="2" | Selects if the console data is automatically generated or not 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | API
|-
| colspan="2" |  
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_nRF24L01.fcfx FC_Comp_Source_nRF24L01.fcfx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_nRF24L01.fcfx FC_Comp_Source_nRF24L01.fcfx]

Component: Input Text ( Control)

2026-01-27T21:17:02Z

Wiki bot:

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| MatrixTSL
|-
| width="20%" style="color:gray;" | Version
| 1.0
|-
| width="20%" style="color:gray;" | Category
| Control
|}

==Input Text component==
Creates a text field that can be highlighted and edited by the user.

==Version information==

Library Version, Component Version, Date, Author, Info
2, 0.1, 27-01-25, BR, Added extra macros to set and get the value
3, 1.0, 14-02-25, ST, Changed generated CSS to ensure disabled control has grey text

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

''No additional examples''

==Macro reference==

===GetFloat===
{| 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;" | '''GetFloat'''
|-
| colspan="2" | Returns the floating point numeric value entered into the text field 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===GetText===
{| 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;" | '''GetText'''
|-
| colspan="2" | Returns the text currently entered into this text field 
|-
|-
| 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''
|}

===GetValue===
{| 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;" | '''GetValue'''
|-
| colspan="2" | Returns the numeric value entered into the text field 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s32-icon.png]] - LONG
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===SetFloat===
{| 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;" | '''SetFloat'''
|-
| colspan="2" | Sets the numeric floating point value displayed in this text field 
|-
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | Value
|-
| colspan="2" | float value to set 
|-
| 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''
|}

===SetText===
{| 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;" | '''SetText'''
|-
| colspan="2" | Sets the text displayed in this text field 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | sText
|-
| colspan="2" | Text to set 
|-
| 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''
|}

===SetValue===
{| 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;" | '''SetValue'''
|-
| colspan="2" | Sets the numeric value displayed in this text field 
|-
|-
| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
| width="90%" | Value
|-
| colspan="2" | integer value to set 
|-
| 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''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| 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
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Text
|-
| colspan="2" | The initial text of the component 
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Type
|-
| colspan="2" | Allows the input to be restricted to numbers or hidden 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Limit Length
|-
| colspan="2" | Sets a limit on how many characters can be entered 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Max Length
|-
| colspan="2" | The maximum number of characters 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Style
|-
|-
| width="10%" align="center" | [[File:Fc9-type-3-icon.png]]
| width="90%" | Font
|-
| colspan="2" | Specifies the font style for the text 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Font Size
|-
| colspan="2" | The font size in pixels 
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Horizontal Alignment
|-
| colspan="2" | Aligns the text entered 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Bold
|-
| colspan="2" | Make the caption text bold 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Italic
|-
| colspan="2" | Make the caption text italicised 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Underline
|-
| colspan="2" | Make the caption text underlined 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Strikethrough
|-
| colspan="2" | Make the caption text crossed-out 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Colour
|-
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Text
|-
| colspan="2" | Specifies the font colour for the item 
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Background
|-
| colspan="2" | Specifies the background colour value 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Advanced
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Custom Attributes
|-
| colspan="2" | Text here will be added to the html tag of this component to allow advanced customisation 
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_WEBEXP_InputText.fcsx FC_Comp_Source_WEBEXP_InputText.fcsx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_WEBEXP_InputText.fcsx FC_Comp_Source_WEBEXP_InputText.fcsx]

Component: Switch ( Control)

2026-01-27T21:17:02Z

Wiki bot:

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| MatrixTSL
|-
| width="20%" style="color:gray;" | Version
| 1.0
|-
| width="20%" style="color:gray;" | Category
| Control
|}

==Switch component==
Creates an on/off type toggle switch control.

==Version information==

Library Version, Component Version, Date, Author, Info
2, 1.0, 17-02-25, ST, Changed generated CSS to ensure visible/disabled switch has appropriate features

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

''No additional examples''

==Macro reference==

===GetState===
{| 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;" | '''GetState'''
|-
| colspan="2" | Returns the current state of the switch 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===SetState===
{| 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;" | '''SetState'''
|-
| colspan="2" | Sets the current state of the switch 
|-
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | bState
|-
| colspan="2" | The state to set (true = on) 
|-
| 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''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| 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;" | Behaviour
|-
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | State
|-
| colspan="2" | The initial state of the switch 
|-
| width="10%" align="center" | [[File:Fc9-type-24-icon.png]]
| width="90%" | OnClick Macro
|-
| colspan="2" | The macro to call when the user clicks this switch 
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Cursor
|-
| colspan="2" | The cursor shape when the user hovers the mouse over this switch 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Transition Speed
|-
| colspan="2" | The animation speed (in ms) when the switch is pressed 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Auto Return
|-
| colspan="2" | Set true to automatically return the switch to its default state 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Appearance
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | On Label
|-
| colspan="2" | The text to show when the switch is in the on state 
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Off Label
|-
| colspan="2" | The text to show when the switch is in the off state 
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Style
|-
| colspan="2" | The colour style of the switch 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Show Thumb
|-
| colspan="2" | Show or hide the thumb of the switch 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Outline Size
|-
| colspan="2" | The outline size in pixels 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Border Radius
|-
| colspan="2" | The curvature radius of the corners of the switch 
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Border Colour
|-
| colspan="2" | The outline colour of the switch 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Font
|-
|-
| width="10%" align="center" | [[File:Fc9-type-3-icon.png]]
| width="90%" | Font
|-
| colspan="2" | Specifies the font style for the switch 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Font Size
|-
| colspan="2" | The font size in pixels 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Bold
|-
| colspan="2" | Make the caption text bold 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Italic
|-
| colspan="2" | Make the caption text italicised 
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Colour
|-
| colspan="2" | The fill colour of the switch when off 
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Gradient
|-
| colspan="2" | The secondary fill colour of the switch when off 
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Gradient Style
|-
| colspan="2" | The gradient fill type of the switch when off 
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Text
|-
| colspan="2" | The font colour for the switch when off 
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Colour
|-
| colspan="2" | The fill colour of the switch when on 
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Gradient
|-
| colspan="2" | The secondary fill colour of the switch when on 
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Gradient Style
|-
| colspan="2" | The gradient fill type of the switch when on 
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Text
|-
| colspan="2" | The font colour for the switch when on 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Advanced
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Custom Attributes
|-
| colspan="2" | Text here will be added to the html tag of this component to allow advanced customisation 
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_WEBEXP_Switch.fcsx FC_Comp_Source_WEBEXP_Switch.fcsx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_WEBEXP_Switch.fcsx FC_Comp_Source_WEBEXP_Switch.fcsx]

Component: Gauge ( Indicator)

2026-01-27T21:17:01Z

Wiki bot:

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| MatrixTSL
|-
| width="20%" style="color:gray;" | Version
| 1.1
|-
| width="20%" style="color:gray;" | Category
| Indicator
|}

==Gauge component==
Creates a circular gauge used to visually indicate a numeric value.

==Version information==

Library Version, Component Version, Date, Author, Info
3, 1.1, 27-01-26, ST, Charts and Gauges now consolidated into single load function

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

''No additional examples''

==Macro reference==

===GetValue===
{| 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;" | '''GetValue'''
|-
| colspan="2" |  
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===SetValue===
{| 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;" | '''SetValue'''
|-
| colspan="2" |  
|-
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | value
|-
| 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''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| 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;" | Data
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Title
|-
| colspan="2" | Caption for the gauge 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Value
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Scale
|-
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Lower Bound
|-
| colspan="2" | Minimum value for the scale 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Upper Bound
|-
| colspan="2" | Maximum value for the scale 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Major Ticks
|-
| colspan="2" | The number of major ticks on the scale 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Minor Ticks
|-
| colspan="2" | The number of minor ticks per major tick 
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Show Labels
|-
| colspan="2" | Show values for the labels 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Decimals
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Style
|-
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Style
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Outline
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Frame
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Inner Frame
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Face
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Minor Ticks
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Major Ticks
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Pointer Outline
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Pointer Fill
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Cap Outline
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Cap Fill
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Caption
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Value
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Scale
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Coloured Ranges
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Number of Ranges
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Advanced
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Custom Attributes
|-
| colspan="2" |  
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_WEBEXP_Gauge.fcsx FC_Comp_Source_WEBEXP_Gauge.fcsx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_WEBEXP_Gauge.fcsx FC_Comp_Source_WEBEXP_Gauge.fcsx]

Component: Line Chart ( Charts)

2026-01-27T21:17:00Z

Wiki bot:

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
|
|-
| width="20%" style="color:gray;" | Version
| 1.1
|-
| width="20%" style="color:gray;" | Category
| Charts
|}

==Line Chart component==

==Version information==

Library Version, Component Version, Date, Author, Info
4, 1.0, 18-02-25, ST, Max series now 8, plus several new macros
5, 1.1, 27-01-26, ST, Charts and Gauges now consolidated into single load function

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

''No additional examples''

==Macro reference==

===AddPoint===
{| 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;" | '''AddPoint'''
|-
| colspan="2" | Add to the chart 
|-
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | x
|-
| colspan="2" | X value to plot 
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | y
|-
| colspan="2" | Y value to plot 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | index
|-
| colspan="2" | Series index (1-8) 
|-
| 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''
|}

===ClearData===
{| 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;" | '''ClearData'''
|-
| colspan="2" | Remove all data from the chart 
|-
|-
| 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''
|}

===ClearSeries===
{| 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;" | '''ClearSeries'''
|-
| colspan="2" | Remove all data from a series in the chart 
|-
|-
| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
| width="90%" | SeriesId
|-
| colspan="2" | The id of the series (1 - 8) 
|-
| 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''
|}

===Redraw===
{| 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;" | '''Redraw'''
|-
| colspan="2" | Redraw the chart 
|-
|-
| 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''
|}

===SetChartTitle===
{| 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;" | '''SetChartTitle'''
|-
| colspan="2" | Sets the title text for the chart 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Text
|-
| colspan="2" | The new title for the chart 
|-
| 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''
|}

===SetSeriesName===
{| 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;" | '''SetSeriesName'''
|-
| colspan="2" | Sets the name for a series 
|-
|-
| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
| width="90%" | SeriesId
|-
| colspan="2" | The number of series to rename 
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | SeriesName
|-
| colspan="2" | The new name for the series 
|-
| 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''
|}

===SetSeriesNames===
{| 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;" | '''SetSeriesNames'''
|-
| colspan="2" | Sets the number of series and all of their names 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | SeriesCount
|-
| colspan="2" | The number of series to plot (1-8) 
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | SeriesNames
|-
| colspan="2" | Comma-separated list of series names 
|-
| 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''
|}

===SetSeriesVisible===
{| 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;" | '''SetSeriesVisible'''
|-
| colspan="2" | Shows or hides a series 
|-
|-
| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
| width="90%" | SeriesId
|-
| colspan="2" | The number of the series to show or hide (1-8) 
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | Show
|-
| colspan="2" | True to show, false to hide 
|-
| 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''
|}

===SetXAxis===
{| 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;" | '''SetXAxis'''
|-
| colspan="2" | Sets the X axis name and bounds 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Text
|-
| colspan="2" | The new name for the axis (pass empty string to keep existing name) 
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | Autoscale
|-
| colspan="2" | Set true to autoscale the axis (ignores the Max and Min values) 
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | Min
|-
| colspan="2" | New minimum value for the axis (ignored if Autoscale is true) 
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | Max
|-
| colspan="2" | New maximum value for the axis (ignored if Autoscale is true) 
|-
| 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''
|}

===SetYAxis===
{| 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;" | '''SetYAxis'''
|-
| colspan="2" | Sets the Y axis name and bounds 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Text
|-
| colspan="2" | The new name for the axis (pass empty string to keep existing name) 
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | Autoscale
|-
| colspan="2" | Set true to autoscale the axis (ignores the Max and Min values) 
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | Min
|-
| colspan="2" | New minimum value for the axis (ignored if Autoscale is true) 
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | Max
|-
| colspan="2" | New maximum value for the axis (ignored if Autoscale is true) 
|-
| 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''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| 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;" | Chart
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Title
|-
| colspan="2" | Chart title 
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Legend
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Style
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | X-axis
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Name
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Auto-scale
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Start
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | End
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Logarithmic
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Scalable
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Y-axis
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Name
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Auto-scale
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Start
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | End
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Logarithmic
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Scalable
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Advanced
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Custom Attributes
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Custom Options
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Series
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Series Count
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Series 1
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Series 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_WEBEXP_Chart_Line.fcsx FC_Comp_Source_WEBEXP_Chart_Line.fcsx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_WEBEXP_Chart_Line.fcsx FC_Comp_Source_WEBEXP_Chart_Line.fcsx]

Component: Pie Chart ( Charts)

2026-01-27T21:17:00Z

Wiki bot:

Component: Bar Chart ( Charts)

2026-01-27T21:16:59Z

Wiki bot:

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
|
|-
| width="20%" style="color:gray;" | Version
| 1.0
|-
| width="20%" style="color:gray;" | Category
| Charts
|}

==Bar Chart component==

==Version information==

Library Version, Component Version, Date, Author, Info

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

''No additional examples''

==Macro reference==

===AddPoint===
{| 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;" | '''AddPoint'''
|-
| colspan="2" | Add to the chart 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | name
|-
| colspan="2" | Category name 
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | value
|-
| colspan="2" | Plotted value 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | index
|-
| colspan="2" | Series index (1-8) 
|-
| 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''
|}

===ClearData===
{| 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;" | '''ClearData'''
|-
| colspan="2" | Remove all data from the chart 
|-
|-
| 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''
|}

===Redraw===
{| 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;" | '''Redraw'''
|-
| colspan="2" | Redraw the chart 
|-
|-
| 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''
|}

===SetSeriesNames===
{| 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;" | '''SetSeriesNames'''
|-
| colspan="2" | Sets the names for each series 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | SeriesCount
|-
| colspan="2" | The number of series to plot (1-8) 
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | SeriesNames
|-
| colspan="2" | Comma-separated list of series names 
|-
| 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''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| 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;" | Chart
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Title
|-
| colspan="2" | Chart title 
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Stacking
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Legend
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Style
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | X-axis
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Name
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Y-axis
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Name
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Auto-scale
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Start
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | End
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Logarithmic
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Scalable
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Advanced
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Custom Attributes
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Custom Options
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Series
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Series Count
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Series 1
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Series 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_WEBEXP_Chart_Bar.fcsx FC_Comp_Source_WEBEXP_Chart_Bar.fcsx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_WEBEXP_Chart_Bar.fcsx FC_Comp_Source_WEBEXP_Chart_Bar.fcsx]

Component: Column Chart ( Charts)

2026-01-27T21:16:59Z

Wiki bot:

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
|
|-
| width="20%" style="color:gray;" | Version
| 1.0
|-
| width="20%" style="color:gray;" | Category
| Charts
|}

==Column Chart component==

==Version information==

Library Version, Component Version, Date, Author, Info

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

''No additional examples''

==Macro reference==

===AddPoint===
{| 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;" | '''AddPoint'''
|-
| colspan="2" | Add to the chart 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | name
|-
| colspan="2" | Category name 
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | value
|-
| colspan="2" | Plotted value 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | index
|-
| colspan="2" | Series index (1-8) 
|-
| 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''
|}

===ClearData===
{| 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;" | '''ClearData'''
|-
| colspan="2" | Remove all data from the chart 
|-
|-
| 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''
|}

===Redraw===
{| 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;" | '''Redraw'''
|-
| colspan="2" | Redraw the chart 
|-
|-
| 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''
|}

===SetSeriesNames===
{| 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;" | '''SetSeriesNames'''
|-
| colspan="2" | Sets the names for each series 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | SeriesCount
|-
| colspan="2" | The number of series to plot (1-8) 
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | SeriesNames
|-
| colspan="2" | Comma-separated list of series names 
|-
| 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''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| 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;" | Chart
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Title
|-
| colspan="2" | Chart title 
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Stacking
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Legend
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Style
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | X-axis
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Name
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Y-axis
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Name
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Auto-scale
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Start
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | End
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Logarithmic
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Scalable
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Advanced
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Custom Attributes
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Custom Options
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Series
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Series Count
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Series 1
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Series 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_WEBEXP_Chart_Column.fcsx FC_Comp_Source_WEBEXP_Chart_Column.fcsx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_WEBEXP_Chart_Column.fcsx FC_Comp_Source_WEBEXP_Chart_Column.fcsx]

Component: Button ( Control)

2026-01-27T21:16:58Z

Wiki bot:

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| MatrixTSL
|-
| width="20%" style="color:gray;" | Version
| 1.0
|-
| width="20%" style="color:gray;" | Category
| Control
|}

==Button component==
Creates a momentary or latching button.

==Version information==

Library Version, Component Version, Date, Author, Info
2, 1.0, 14-02-25, ST, Changed generated CSS to ensure disabled button has appropriate features

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

''No additional examples''

==Macro reference==

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| 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;" | Caption
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Text
|-
| colspan="2" | The caption displayed on the button 
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Horizontal Alignment
|-
| colspan="2" | Aligns the caption text on the button 
|-
| width="10%" align="center" | [[File:Fc9-type-3-icon.png]]
| width="90%" | Font
|-
| colspan="2" | Specifies the font style for the item 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Font Size
|-
| colspan="2" | The font size in pixels 
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Colour
|-
| colspan="2" | Specifies the font colour for the item 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Bold
|-
| colspan="2" | Make the caption text bold 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Italic
|-
| colspan="2" | Make the caption text italicised 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Underline
|-
| colspan="2" | Make the caption text underlined 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Strikethrough
|-
| colspan="2" | Make the caption text crossed-out 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Shape
|-
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Colour
|-
| colspan="2" | Specifies the fill colour of the button 
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Style
|-
| colspan="2" | The shape of the button 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Outline Size
|-
| colspan="2" | The outline size in pixels 
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Colour
|-
| colspan="2" | The outline colour of the button 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Shadow
|-
| colspan="2" | Add a shadow to the button to provide a 3d look 
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Shadow Colour
|-
| colspan="2" | Specifies the fill colour of the shadow 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Interaction
|-
|-
| width="10%" align="center" | [[File:Fc9-type-24-icon.png]]
| width="90%" | OnClick Macro
|-
| colspan="2" | The macro to call when the user clicks this button 
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Cursor
|-
| colspan="2" | The cursor shape when the user hovers the mouse over the button 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Show Press
|-
| colspan="2" | Offset the button when the user presses it 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Auto-colour
|-
| colspan="2" | Use default colour changes when the user hovers and presses the button 
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Hover Colour
|-
| colspan="2" | The colour of the button when the user hovers the mouse over it 
|-
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
| width="90%" | Click Colour
|-
| colspan="2" | The colour of the button when the user presses it 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Advanced
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Custom Attributes
|-
| colspan="2" | Text here will be added to the html tag of this component to allow advanced customisation 
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_WEBEXP_Button.fcsx FC_Comp_Source_WEBEXP_Button.fcsx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_WEBEXP_Button.fcsx FC_Comp_Source_WEBEXP_Button.fcsx]

Component: Area Chart ( Charts)

2026-01-27T21:16:58Z

Wiki bot:

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
|
|-
| width="20%" style="color:gray;" | Version
| 1.0
|-
| width="20%" style="color:gray;" | Category
| Charts
|}

==Area Chart component==

==Version information==

Library Version, Component Version, Date, Author, Info

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

''No additional examples''

==Macro reference==

===AddPoint===
{| 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;" | '''AddPoint'''
|-
| colspan="2" | Add to the chart 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | name
|-
| colspan="2" | Category name 
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | value
|-
| colspan="2" | Plotted value 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | index
|-
| colspan="2" | Series index (1-8) 
|-
| 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''
|}

===ClearData===
{| 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;" | '''ClearData'''
|-
| colspan="2" | Remove all data from the chart 
|-
|-
| 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''
|}

===Redraw===
{| 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;" | '''Redraw'''
|-
| colspan="2" | Redraw the chart 
|-
|-
| 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''
|}

===SetSeriesNames===
{| 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;" | '''SetSeriesNames'''
|-
| colspan="2" | Sets the names for each series 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | SeriesCount
|-
| colspan="2" | The number of series to plot (1-8) 
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | SeriesNames
|-
| colspan="2" | Comma-separated list of series names 
|-
| 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''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| 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;" | Chart
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Title
|-
| colspan="2" | Chart title 
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Stacking
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Legend
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-12-icon.png]]
| width="90%" | Style
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | X-axis
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Name
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Y-axis
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Name
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Auto-scale
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Start
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | End
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Logarithmic
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Scalable
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Advanced
|-
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Custom Attributes
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Custom Options
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Series
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Series Count
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Series 1
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Series 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_WEBEXP_Chart_Area.fcsx FC_Comp_Source_WEBEXP_Chart_Area.fcsx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_WEBEXP_Chart_Area.fcsx FC_Comp_Source_WEBEXP_Chart_Area.fcsx]

Component: Timer (Timing)

2026-01-27T21:16:57Z

Wiki bot:

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix TSL
|-
| width="20%" style="color:gray;" | Version
| 14.0
|-
| width="20%" style="color:gray;" | Category
| Timing
|}

==Timer component==
Allows you to measure the passage of time via the use of a hardware timer peripheral. Works like a stopwatch with macros to start, stop and reset the timer counter. Returns time as integer Seconds, Milliseconds, Microseconds and also Floating Point and String.

==Version information==

Library Version, Component Version, Date, Author, Info
14, 14.0, 10-07-24, MW, Fixed a bug to reset simulation timer value when TimerReset() is called
18, 14.0, 07-02-25, BR, Hidden Postscaler property as it will cause issues with reported timings if used
19, 14.0, 07-02-25, BR, Changed default to TMR0 with 1:1 prescaler
20, 14.0, 07-02-25, BR, Added timer resolution property to show what resolution of timings can be acheived
21, 14.0, 07-02-25, BR, Hidden some of the less useful properties from the user
22, 14.0, 07-02-25, BR, Fixed a bug where the timer wouldn't correctly report the time when stopped

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

Here is a basic example showing the operation of the timer component used to time a section of code or the duration of a specific event.

{{Fcfile|TimerExample.fcfx|Timer Example}}

==Macro reference==

===GetCountMicroSeconds===
{| 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;" | '''GetCountMicroSeconds'''
|-
| colspan="2" | Returns the count value as a number of whole microseconds, rounded down to the nearest microsecond 
|-
|-
| 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''
|}

===GetCountMilliseconds===
{| 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;" | '''GetCountMilliseconds'''
|-
| colspan="2" | Returns the count value as a number of whole milliseconds, rounded down to the nearest millisecond 
|-
|-
| 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''
|}

===GetCountReal===
{| 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;" | '''GetCountReal'''
|-
| colspan="2" | Returns the count value as a floating point value in seconds. 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===GetCountSeconds===
{| 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;" | '''GetCountSeconds'''
|-
| colspan="2" | Returns the count value as a number of whole seconds, rounded down to the nearest second 
|-
|-
| 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''
|}

===GetCountString===
{| 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;" | '''GetCountString'''
|-
| colspan="2" | Returns the count value as a floating point string in seconds. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Precision
|-
| colspan="2" | Number of decimal places to display in string 
|-
| 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''
|}

===GetRawCount===
{| 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;" | '''GetRawCount'''
|-
| colspan="2" | Efficient command to collect the integer number of instructions since the timer was started. 
|-
|-
| 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''
|}

===ResetCounter===
{| 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;" | '''ResetCounter'''
|-
| 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''
|}

===StartCounter===
{| 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;" | '''StartCounter'''
|-
| colspan="2" | Starts the timer counting. 
|-
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | ResetCounters
|-
| colspan="2" | Range: 0-1 where 0=Do Not Reset and 1=Reset 
|-
| 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''
|}

===StopCounter===
{| 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;" | '''StopCounter'''
|-
| colspan="2" | Stops the timer counting. 
|-
|-
| 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''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Timer
|-
| colspan="2" | Timer Peripheral to use to monitor the passage of time. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Prescaler
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Bit Depth
|-
| colspan="2" | Number of bits in the timer peripheral. 8-bit timers can count from 0-255 before overflowing. 16-bit timers can count from 0 to 65535 before overflowing. 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Instruction Rate
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Timer Resolution (ms)
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Max Time Measurement (s)
|-
| colspan="2" | Max time in seconds that we can measure before rolling over and starting again. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
|-
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Timer Delay (ms)
|-
| colspan="2" | Number of milliseconds between timer events which increment the simulated timer counter variable. 10ms will yield the highest resolution. Values less than this will likely just increase the error and making the timer run slow. Higher delays will yield greater accuracy. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Decimal Points
|-
| colspan="2" |  
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_TimerComponent.fcfx FC_Comp_Source_TimerComponent.fcfx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_TimerComponent.fcfx FC_Comp_Source_TimerComponent.fcfx]

Component: Timer Interrupt (Timing )

2026-01-27T21:16:57Z

Wiki bot:

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix TSL
|-
| width="20%" style="color:gray;" | Version
| 1.1
|-
| width="20%" style="color:gray;" | Category
| Timing
|}

==Timer Interrupt component==
The timer interrupt can be set to trigger a specifed User macro evey time a set time has elapsed. Time units that can be selected are: Milliseconds, Seconds, Minutes, Hours or Days Maximum milliseconds = 4294967295 Maximum seconds = 4294967. Maximum minutes = 71582, Maximum hours = 1193, Maximum days = 49 Times can be changed on the fly

==Version information==

Library Version, Component Version, Date, Author, Info
1, 1.0, 06-03-25, MW, Component created

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

''No additional examples''

==Macro reference==

===ChangeTimeDays===
{| 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;" | '''ChangeTimeDays'''
|-
| colspan="2" | Change the interrupt time to a new time in days. Maximum days = 49 Timer interrupt will continue at the new rate, until TimerStop or the simuation is stopped. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Days
|-
| colspan="2" | Maximum days = 49 
|-
| 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''
|}

===ChangeTimeHours===
{| 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;" | '''ChangeTimeHours'''
|-
| colspan="2" | Change the interrupt time to a new time in hours. Maximum hours = 1193 Timer interrupt will continue at the new rate, until TimerStop or the simuation is stopped.  
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Hours
|-
| colspan="2" | Maximum hours = 1193 
|-
| 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''
|}

===ChangeTimeMilliseconds===
{| 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;" | '''ChangeTimeMilliseconds'''
|-
| colspan="2" | Change the interrupt time to a new time in milliseconds. Maximum milliseconds = 4294967295 Timer interrupt will continue at the new rate, until TimerStop or the simuation is stopped. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
| width="90%" | Milliseconds
|-
| colspan="2" | Maximum milliseconds = 4294967295 
|-
| 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''
|}

===ChangeTimeMinutes===
{| 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;" | '''ChangeTimeMinutes'''
|-
| colspan="2" | Change the interrupt time to a new time in minutes. Maximum minutes = 71582 Timer interrupt will continue at the new rate, until TimerStop or the simuation is stopped. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
| width="90%" | Minutes
|-
| colspan="2" | Maximum minutes = 71582 
|-
| 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''
|}

===ChangeTimeSeconds===
{| 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;" | '''ChangeTimeSeconds'''
|-
| colspan="2" | Change the interrupt time to a new time in seconds. Maximum seconds = 4294967 Timer interrupt will continue at the new rate, until TimerStop or the simuation is stopped. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
| width="90%" | Seconds
|-
| colspan="2" | Maximum seconds = 4294967 
|-
| 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''
|}

===StartTimer===
{| 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;" | '''StartTimer'''
|-
| colspan="2" | Start timer interrupt running 
|-
|-
| 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''
|}

===StopTimer===
{| 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;" | '''StopTimer'''
|-
| colspan="2" | Stop the timer interrupt running. Stopping the simulation, also stops the timer interrupt. 
|-
|-
| 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''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| 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;" | Timer Interrupt
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Time Unit
|-
| colspan="2" | The unit of time to measure 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Time Period
|-
| colspan="2" | Maximum milliseconds = 4294967295 Maximum seconds = 4294967. Maximum minutes = 71582, Maximum hours = 1193, Maximum days = 49 
|-
| width="10%" align="center" | [[File:Fc9-type-24-icon.png]]
| width="90%" | Call Macro
|-
| colspan="2" | User macro to be triggered every time the interrupt is triggered.  
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_TimerInterruptPCDev.fcsx FC_Comp_Source_TimerInterruptPCDev.fcsx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_TimerInterruptPCDev.fcsx FC_Comp_Source_TimerInterruptPCDev.fcsx]

Component: Ultrasonic (HCSR04) (Audio)

2026-01-27T21:16:57Z

Wiki bot:

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix TSL
|-
| width="20%" style="color:gray;" | Version
| 9.0
|-
| width="20%" style="color:gray;" | Category
| Audio
|}

==Ultrasonic component==
This board has both an ultrasonic transmitter and receiver. When the Trig pin is set high for 10uS, the transmitter sends eight 40KHz pulses. The Echo pin goes high about 2ms later. The duration of the Echo pin is measure when it goes high, and a distance is then calculated based on the high duration. The distance of objects in a range of around 3cm to 2.75m can be determined.

==Version information==

Library Version, Component Version, Date, Author, Info
9, 9.0, 30-07-24, MW, Fixed a (499) undefined symbol error

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

{{Fcfile|HC-SR04 Distance Sensor Demo.fcfx|HC-SR04 Distance Sensor Demo.fcfx}}

==Macro reference==

===GetDistance===
{| 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;" | '''GetDistance'''
|-
| colspan="2" | Sends a pulse and processes the echo. Returns a object distance in cm 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Type
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Use Timer Interrupt
|-
| colspan="2" | For 8bit PICs resuls the timer interrupt is recomened for increased accuracy 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | OutputTrig Pin
|-
| colspan="2" | Pin used for controlling the output pulse 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | Input Echo Pin
|-
| colspan="2" | ADC channel used to monitor the echo 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Rollover Time
|-
| colspan="2" | Maximim rollover time in seconds. Make sure its the lowest value posisble without going below 0.018 0.018 = 18ms which equates to a distance of 310 cm 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Timer Settings
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Timer
|-
| colspan="2" | Timer Peripheral to use to monitor the passage of time. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Bit Depth
|-
| colspan="2" | Number of bits in the timer peripheral. 8-bit timers can count from 0-255 before overflowing. 16-bit timers can count from 0 to 65535 before overflowing. 
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Ultrasonic_HC_SR04.fcfx FC_Comp_Source_Ultrasonic_HC_SR04.fcfx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Ultrasonic_HC_SR04.fcfx FC_Comp_Source_Ultrasonic_HC_SR04.fcfx]

Component: Thermocouple (MAX31855 / BL0126) (Environmental)

2026-01-27T21:16:56Z

Wiki bot:

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix TSL
|-
| width="20%" style="color:gray;" | Version
| 1.0
|-
| width="20%" style="color:gray;" | Category
| Environmental
|}

==Thermocouple (MAX31855 / BL0126) component==
Component to interface the MAX31855 IC from MAXIM. Uses a standard 3-wire SPI interface to connect to the IC and collect the temperature. IC available in different versions to suit different thermocouple types.

==Version information==

Library Version, Component Version, Date, Author, Info
8, 1.0, 08-05-25, BR, Added autodetect port on Ev_PostInitialise

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

Example program showing how to use the Thermocouple component.
{{Fcfile|MAX31855_Example.fcfx|MAX31855_Example}}

==Macro reference==

===Initialise===
{| 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" | Configures the SPI bus ready for communications. 
|-
|-
| 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''
|}

===ReadReference_Float===
{| 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;" | '''ReadReference_Float'''
|-
| colspan="2" | Returns the reference temperature from the last sample as a floating point value in Degrees C. 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===ReadReference_Int===
{| 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;" | '''ReadReference_Int'''
|-
| colspan="2" | Returns the reference temperature from the last sample as an integer value in Degrees C. 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===ReadThermocouple_Float===
{| 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;" | '''ReadThermocouple_Float'''
|-
| colspan="2" | Returns the thermocouple temperature from the last sample as a floating point value in Degrees C. 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===ReadThermocouple_Int===
{| 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;" | '''ReadThermocouple_Int'''
|-
| colspan="2" | Returns the thermocouple temperature from the last sample as an integer value in Degrees C. 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===Sample===
{| 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;" | '''Sample'''
|-
| colspan="2" | Reads the memory of the MAX31855 IC and checks for errors. Must be called before any of the Read functions. Returns: 0=OK, 1=Open Circuit, 2=Short GND, 3=Short VCC 
|-
|-
| 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''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| 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;" | Thermocouple Properties
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Thermocouple Type
|-
| colspan="2" | Specified at the end of the MAX part number MAX31855X where X is the Thermocouple type. Selects which type of thermocouple the IC works with. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | SPI Properties
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Channel
|-
| colspan="2" | SPI Channel selector 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Prescale
|-
| colspan="2" | Prescale option selector 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | MOSI
|-
| colspan="2" | SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode. 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | MISO
|-
| colspan="2" | SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode. 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | CLK
|-
| colspan="2" | SPI Clock Pin CLK - The Clock signal is driven by the SPI master. 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | CS / SS
|-
| colspan="2" | Chip Select / Slave Select Pin Master Mode: General purpose output pin used to select the remote SPI device. Slave Mode: Hardware chip select pin input used to select the SPI device.  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
|-
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Simulate Comms
|-
| colspan="2" |  
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_ThermocoupleMAX31855.fcfx FC_Comp_Source_ThermocoupleMAX31855.fcfx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_ThermocoupleMAX31855.fcfx FC_Comp_Source_ThermocoupleMAX31855.fcfx]

Component: Thermocouple (MCP960X) (Environmental)

2026-01-27T21:16:56Z

Wiki bot:

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix TSL
|-
| width="20%" style="color:gray;" | Version
| 6.0
|-
| width="20%" style="color:gray;" | Category
| Environmental
|}

==Thermocouple (MCP960X) component==
Component to interface the MCP960X IC from Microchip. Uses a standard 2-wire I2C interface to connect to the IC and collect the temperature. IC available in different versions to suit different thermocouple types.

==Version information==

Library Version, Component Version, Date, Author, Info
6.0, 6.0, 02-07-24, MW, As requested By Stefan. Exposed ReadRegister/s, WriteRegister and renamed with underscore. Added Write_N_Registers.

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

Here is a basic example to display both the thermocouple temperature and IC surface temperature.

{{Fcfile|MCP960X Demo.fcfx|MCP960X Demo}}

Sim Demo

[[File:Sim Demo.png]]

==Macro reference==

===Initialise===
{| 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" | Configures the I2C bus ready for communications. 
|-
|-
| 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''
|}

===ReadReference_Float===
{| 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;" | '''ReadReference_Float'''
|-
| colspan="2" | Returns the reference (IC die) temperature from the last sample as a floating point. Use Sample first, which samples both reference & themocouple temperatures. 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===ReadReference_Int===
{| 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;" | '''ReadReference_Int'''
|-
| colspan="2" | Returns the Reference (IC die) temperature from the last sample as an integer value. Use Sample first, which samples both reference & themocouple temperatures. 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===ReadThermocouple_Float===
{| 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;" | '''ReadThermocouple_Float'''
|-
| colspan="2" | Returns the thermocouple temperature from the last sample as a floating point value. Use Sample first, which samples both reference & themocouple temperatures. 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===ReadThermocouple_Int===
{| 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;" | '''ReadThermocouple_Int'''
|-
| colspan="2" | Returns the thermocouple temperature from the last sample as an integer value. Use Sample first, which samples both reference & themocouple temperatures. 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===Read_N_Registers===
{| 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;" | '''Read_N_Registers'''
|-
| colspan="2" | Reads a number of sequential bytes starting from the specified register 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Address
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Data
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Count
|-
| 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''
|}

===Read_Register===
{| 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;" | '''Read_Register'''
|-
| colspan="2" | Reads a byte from a register 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Address
|-
| colspan="2" |  
|-
| 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''
|}

===Sample===
{| 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;" | '''Sample'''
|-
| colspan="2" | Must be called before any of the Read functions. Reads the memory of the MCP9600/1 IC. Returns 0 for 9600. Checks for errors, MCP9601 only. Returns: 0 = OK, 1 = O/ C Themocouple & 2=S/C Themocouple. 
|-
|-
| 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''
|}

===Write_N_Registers===
{| 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;" | '''Write_N_Registers'''
|-
| colspan="2" | Writes a set of data values to a sequential registers on the accelerometer 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Start_Reg
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Num_Regs
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Data
|-
| 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''
|}

===Write_Register===
{| 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;" | '''Write_Register'''
|-
| colspan="2" | Writes a byte to a register 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Address
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Data
|-
| 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''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| 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;" | Thermocouple Properties
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Thermocouple Type
|-
| colspan="2" | Thermocouple type. Selects which type of thermocouple the IC works with. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Filter Coefficients
|-
| colspan="2" | Digitial filter selection. The higher the number the better the filter. Results more stable but take longer to update.  
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Unit
|-
| colspan="2" | Select Temperature results to be celsius or fahrenheit  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | I2C Properties
|-
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Address
|-
| colspan="2" | Address ranges 0x60 - 0x67 (96 - 103) 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Channel
|-
| colspan="2" | Channel selection 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | SDA
|-
| colspan="2" | Pin used for SDA (data signal) 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | SCL
|-
| colspan="2" | Pin used for SCL (clock signal) 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
|-
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Simulate Comms
|-
| colspan="2" |  
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_ThermocoupleMCP960X.fcfx FC_Comp_Source_ThermocoupleMCP960X.fcfx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_ThermocoupleMCP960X.fcfx FC_Comp_Source_ThermocoupleMCP960X.fcfx]

Component: 7Segment (Quad TM1637) (Segment)

2026-01-27T21:16:55Z

Wiki bot:

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix Ltd
|-
| width="20%" style="color:gray;" | Version
| 4.4
|-
| width="20%" style="color:gray;" | Category
| Segment
|}

==7Segment (Quad TM1637) component==
Quad seven segment display using an two pin communications bus to reduce the number of control pins. Driven using a TM1637 quad 7-segment display driver.

==Version information==

Library Version, Component Version, Date, Author, Info
3, 3.0, 09-12-24, MW, improved component simuulation
4, 4.0, 04-02-25, MW, Adding simulation and embedded SetBrightness function

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

''No additional examples''

==Macro reference==

===SetBrightness===
{| 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;" | '''SetBrightness'''
|-
| colspan="2" | Controls the brightness of the 7-seg displays 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Brightness
|-
| colspan="2" | Range: 0-7 - 0=Darkest, 7=Brightest 
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | On
|-
| colspan="2" | 0 = Display Off, 1 = Display On 
|-
| 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''
|}

===ShowDigit===
{| 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;" | '''ShowDigit'''
|-
| colspan="2" | Set the number to be displayed in the given digit of the display. The colon character can also be controlled when writing to digit 1. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Digit
|-
| colspan="2" | Which of the four digits to change. (0...3) 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Value
|-
| colspan="2" | The number value to set the digit to (0...15), 16=Clear 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Colon
|-
| colspan="2" | Whether to show the colon character. Digit 1 only. 
|-
| 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''
|}

===ShowDigits===
{| 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;" | '''ShowDigits'''
|-
| colspan="2" | Set the number and decimal point to be displayed in the given digit of the display. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Value0
|-
| colspan="2" | The number value to set the digit to (0...15), 16=Clear 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Value1
|-
| colspan="2" | The number value to set the digit to (0...15), 16=Clear 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Value2
|-
| colspan="2" | The number value to set the digit to (0...15), 16=Clear 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Value3
|-
| colspan="2" | The number value to set the digit to (0...15), 16=Clear 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Colon
|-
| colspan="2" | Whether to show the colon character. 
|-
| 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''
|}

===ShowSegments===
{| 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;" | '''ShowSegments'''
|-
| colspan="2" | Allows for manual control over the display segments. The colon character can also be controlled when writing to digit 1. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Digit
|-
| colspan="2" | Which of the four digits to change. (0...3) 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Segments
|-
| colspan="2" | The binary segment value to 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''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Display Type
|-
| colspan="2" | Set this according to the specification of your hardware display. Common Anode: Pin true -> LED Off, Pin false -> LED On Common Cathode: Pin true -> LED On, Pin false -> LED Off 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Show Seg Labels
|-
| colspan="2" | Show segment name labels overlayed over the component. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
|-
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | DIO
|-
| colspan="2" | Data Pin connection to TM1637 IC 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | CLK
|-
| colspan="2" | Clock Pin connection to TM1637 IC 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Colours
|-
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | LED Colour
|-
| colspan="2" | Color of the LED segments when truned on. When off, they use a much darker shade of the same hue. 
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Body Colour
|-
| colspan="2" | Color of the plastic casing containing the LEDs. 
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Label Colour
|-
| colspan="2" | Color for the optional LED segment labels. 
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_TM1637_7SEG_Quad_Driver_2dgi.fcfx FC_Comp_Source_TM1637_7SEG_Quad_Driver_2dgi.fcfx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_TM1637_7SEG_Quad_Driver_2dgi.fcfx FC_Comp_Source_TM1637_7SEG_Quad_Driver_2dgi.fcfx]