Jump to content

Component: Hopper (Industrial): Difference between revisions

From Flowcode Help
No edit summary
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder""
 
(12 intermediate revisions by 2 users not shown)
Line 16: Line 16:


==Component Source Code==
==Component Source Code==
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Hopper.fcfx FC_Comp_Source_Hopper.fcfx]


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


==Detailed description==
==Detailed description==




Line 43: Line 51:




===Industrial Tanks===


A simple example showing the hoppers, valves and pipes working together. Each tank automatically empties in turn.


{{Fcfile|Industrial_Tanks.fcsx|Industrial Tanks}}


==Macro reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''AdjustLevel'''
|-
| colspan="2" | Allows the lelev in the hopper to be adjusted up or down. 
|-
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | Adjustment
|-
| colspan="2" |  
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===Industrial Tanks===
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
A simple example showing the hoppers, valves and pipes working together. Each tank automatically empties in turn.
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetLevel'''
 
|-
{{Fcfile|Industrial_Tanks.fcsx|Industrial Tanks}}
| colspan="2" | Returns the current amount of produce in the hopper. 
|-
|-
| 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''
|}




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''IsFull'''
|-
| colspan="2" | Check to see if the hopper is currently full. Returns 0 if not full or 1 if full. 
|-
|-
| 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''
|}




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''IsEmpty'''
|-
| colspan="2" | Check to see if the hopper is currently empty. Returns 0 if not empty or 1 if empty. 
|-
|-
| 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''
|}




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetLevel'''
|-
| colspan="2" | Sets the current amount of produce in the hopper. 
|-
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | Level
|-
| colspan="2" | The amount of produce in the hopper. 
|-
| 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;"
==Macro reference==
|-
| 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-15-icon.png]]
| width="90%" | Max Produce
|-
| colspan="2" | Maximum amount of produce that can be stored in the hopper. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Default State
|-
| colspan="2" | The initial state of the volume of produce in the hopper when the runtime starts 
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Plot Waveform
|-
| colspan="2" | Allows the current level of produce in the hopper to be automatically plotted using the data recorder window. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Title
|-
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Show Title
|-
| colspan="2" | Decides if the hopper title is shown 
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Title Colour
|-
| colspan="2" | Title Label Color 
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Title Text
|-
| colspan="2" | Title Label Text 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Title Scale
|-
| colspan="2" | Controls the size of the title text on the panel, default 1.2 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Title Offset
|-
| colspan="2" | Distance above component center to draw the title 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
|-
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Show Label
|-
| colspan="2" | Decides if a label is shown detailing current amount of produce in the hopper 
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Label Colour
|-
| colspan="2" | Sets the label colour 
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Label Units
|-
| colspan="2" | Adds a unit to the end of the label 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Label Decimal Points
|-
| colspan="2" | Number of decimal points to round the label value to. 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Label Scale
|-
| colspan="2" | Sets the size of the label on the panel, default 1.0 
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Label Offset
|-
| colspan="2" | Distance above component center to draw the value 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Scheme
|-
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Hopper Colour
|-
| colspan="2" | Sets the colour for the hopper 
|-
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
| width="90%" | Produce Colour
|-
| colspan="2" | Sets the colour for the produce 
|}==Macro reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===AdjustLevel===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''AdjustLevel'''
| width="90%" class="mtx-class-macrohead" | '''AdjustLevel'''
|-
|-
| colspan="2" | Allows the lelev in the hopper to be adjusted up or down. 
| colspan="2" | Allows the lelev in the hopper to be adjusted up or down. 
Line 247: Line 94:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===GetLevel===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetLevel'''
| width="90%" class="mtx-class-macrohead" | '''GetLevel'''
|-
|-
| colspan="2" | Returns the current amount of produce in the hopper. 
| colspan="2" | Returns the current amount of produce in the hopper. 
Line 260: Line 108:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===IsEmpty===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''IsFull'''
| width="90%" class="mtx-class-macrohead" | '''IsEmpty'''
|-
|-
| colspan="2" | Check to see if the hopper is currently full. Returns 0 if not full or 1 if full. 
| colspan="2" | Check to see if the hopper is currently empty. Returns 0 if not empty or 1 if empty. 
|-
|-
|-
|-
Line 273: Line 122:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===IsFull===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''IsEmpty'''
| width="90%" class="mtx-class-macrohead" | '''IsFull'''
|-
|-
| colspan="2" | Check to see if the hopper is currently empty. Returns 0 if not empty or 1 if empty. 
| colspan="2" | Check to see if the hopper is currently full. Returns 0 if not full or 1 if full. 
|-
|-
|-
|-
Line 286: Line 136:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===SetLevel===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetLevel'''
| width="90%" class="mtx-class-macrohead" | '''SetLevel'''
|-
|-
| colspan="2" | Sets the current amount of produce in the hopper. 
| colspan="2" | Sets the current amount of produce in the hopper. 
Line 302: Line 153:
| width="90%" style="border-top: 2px solid #000;" | ''Return''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




==Property reference==
==Property reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
| width="90%" class="mtx-class-macrohead" | '''Properties'''  
|-
|-
|-
|-
Line 329: Line 178:
| colspan="2" | Allows the current level of produce in the hopper to be automatically plotted using the data recorder window. 
| colspan="2" | Allows the current level of produce in the hopper to be automatically plotted using the data recorder window. 
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Title
| width="90%" class="mtx-class-propfolder" | Title
|-
|-
|-
|-
Line 358: Line 207:
| colspan="2" | Distance above component center to draw the title 
| colspan="2" | Distance above component center to draw the title 
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Label
| width="90%" class="mtx-class-propfolder" | Label
|-
|-
|-
|-
Line 392: Line 241:
| colspan="2" | Distance above component center to draw the value 
| colspan="2" | Distance above component center to draw the value 
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Scheme
| width="90%" class="mtx-class-propfolder" | Scheme
|-
|-
|-
|-

Latest revision as of 14:36, 13 July 2026

Author Matrix TSL
Version 1.0
Category Industrial


Hopper component

A simple hopper that can be used to store produce. The hopper has component macros to set and get the current level of produce. The hopper can be initialised to be full or empty when starting. Compatible with SCADA interconnecting pipe components.

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

Industrial Tanks

A simple example showing the hoppers, valves and pipes working together. Each tank automatically empties in turn.

Industrial Tanks






Macro reference

AdjustLevel

AdjustLevel
Allows the lelev in the hopper to be adjusted up or down. 
- FLOAT Adjustment
 
- VOID Return


GetLevel

GetLevel
Returns the current amount of produce in the hopper. 
- FLOAT Return


IsEmpty

IsEmpty
Check to see if the hopper is currently empty. Returns 0 if not empty or 1 if empty. 
- BOOL Return


IsFull

IsFull
Check to see if the hopper is currently full. Returns 0 if not full or 1 if full. 
- BOOL Return


SetLevel

SetLevel
Sets the current amount of produce in the hopper. 
- FLOAT Level
The amount of produce in the hopper. 
- VOID Return


Property reference

Properties
Max Produce
Maximum amount of produce that can be stored in the hopper. 
Default State
The initial state of the volume of produce in the hopper when the runtime starts 
Plot Waveform
Allows the current level of produce in the hopper to be automatically plotted using the data recorder window. 
Title
Show Title
Decides if the hopper title is shown 
Title Colour
Title Label Color 
Title Text
Title Label Text 
Title Scale
Controls the size of the title text on the panel, default 1.2 
Title Offset
Distance above component center to draw the title 
Label
Show Label
Decides if a label is shown detailing current amount of produce in the hopper 
Label Colour
Sets the label colour 
Label Units
Adds a unit to the end of the label 
Label Decimal Points
Number of decimal points to round the label value to. 
Label Scale
Sets the size of the label on the panel, default 1.0 
Label Offset
Distance above component center to draw the value 
Scheme
Hopper Colour
Sets the colour for the hopper 
Produce Colour
Sets the colour for the produce