Component: Solenoid Template (Mechatronics): Difference between revisions

Latest revision as of 14:37, 13 July 2026

Author	Matrix Ltd
Version	1.1
Category	Mechatronics

Solenoid Template component

Base component for constructing solenoids. These take a single input pin and move an actuator between two positions depending on the pin state.

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

SetState

	SetState
Trun the solenoid on or off using a boolean value.
- BOOL	State
The new state for the solenoid to take.
- VOID	Return

SetTarget

	SetTarget
Choose an extermal object to move along with the solenoid's actuator
- HANDLE	Object
An object to be moved by the solenoid
- VOID	Return

TurnOff

	TurnOff
De-activate the solenoid
- VOID	Return

TurnOn

	TurnOn
Activate the solenoid
- VOID	Return

Property reference

	Properties
	Connection
	Pin
Chip pin to connect the solenoid circuit to. NB) Solenoid cannot be moved unless there is a valid connection.
	Simulation
	Moving part
A panel object to be moved back and forth when the solenoid is activated.
	Pivot object
A position to rotate around when the solenoid type is set to 'Rotate' Not required for linear solenoids.
	Type
The type of motion of the solenoid actuator.
	Axis
For linear solenoids, the axis along which the actuator will move. For rotary solenoids, the axis around which it will rotate.
	Distance
For linear solenoids, the distance between the 'off and 'on' states in model units. For rotary solenoids, the rotation in degrees.
	Time (ms)
The time taken for the solenoid to move between the on and off positions. Used only for the purpose of System Panel animations on screen.

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_solenoid_base.fcfx FC_Comp_Source_solenoid_base.fcfx]
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_solenoid_base.fcfx FC_Comp_Source_solenoid_base.fcfx]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_solenoid_base.fcfx FC_Comp_Source_solenoid_base.fcfx]
 ==Detailed description==
@@ Line 28: / Line 40: @@
 ==Examples==
@@ Line 35: / Line 57: @@
 ''<span style="color:red;">No additional examples</span>''
-==Downloadable macro reference==
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+==Macro reference==
+===SetState===
+{| 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;" | '''SetTarget'''
+| width="90%" class="mtx-class-macrohead" | '''SetState'''
 |-
-| colspan="2" | Choose an extermal object to move along with the solenoid's actuator&nbsp;
+| colspan="2" | Trun the solenoid on or off using a boolean value.&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
-| width="90%" | Object
+| width="90%" | State
 |-
-| colspan="2" | An object to be moved by the solenoid&nbsp;
+| colspan="2" | The new state for the solenoid to take.&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 55: / Line 88: @@
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+===SetTarget===
+{| 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;" | '''TurnOn'''
+| width="90%" class="mtx-class-macrohead" | '''SetTarget'''
 |-
-| colspan="2" | Activate the solenoid&nbsp;
+| colspan="2" | Choose an extermal object to move along with the solenoid's actuator&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Object
 |-
+| colspan="2" | An object to be moved by the solenoid&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 68: / Line 107: @@
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+===TurnOff===
+{| 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;" | '''SetState'''
+| width="90%" class="mtx-class-macrohead" | '''TurnOff'''
 |-
-| colspan="2" | Trun the solenoid on or off using a boolean value.&nbsp;
+| colspan="2" | De-activate the solenoid&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
-| width="90%" | State
 |-
-| colspan="2" | The new state for the solenoid to take.&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 86: / Line 121: @@
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+===TurnOn===
+{| 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;" | '''TurnOff'''
+| width="90%" class="mtx-class-macrohead" | '''TurnOn'''
 |-
-| colspan="2" | De-activate the solenoid&nbsp;
+| colspan="2" | Activate the solenoid&nbsp;
 |-
 |-
@@ Line 97: / Line 133: @@
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
 ==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'''
 |-
 |-
-| 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;" | Connection
+| width="90%" class="mtx-class-propfolder" | Connection
 |-
 |-
@@ Line 118: / Line 152: @@
 | colspan="2" | Chip pin to connect the solenoid circuit to. NB) Solenoid cannot be moved unless there is a valid connection.&nbsp;
 |-
-| 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;" | Simulation
+| width="90%" class="mtx-class-propfolder" | Simulation
 |-
 |-

SteveT (talk | contribs)