Difference between revisions of "Component: Solenoid Template (Mechatronics)"

From Flowcode Help
Jump to navigationJump to search
Line 17: Line 17:
 
==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_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_temp/solenoid_base.fcfx FC_Comp_Source_temp/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]
+
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_temp/solenoid_base.fcfx FC_Comp_Source_temp/solenoid_base.fcfx]
  
 
==Detailed description==
 
==Detailed description==
Line 56: Line 56:
  
 
''<span style="color:red;">No additional examples</span>''
 
''<span style="color:red;">No additional examples</span>''
 +
 +
  
  
Line 63: Line 65:
 
==Macro reference==
 
==Macro reference==
  
−
===SetTarget===
+
===SetState===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetTarget'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 82: Line 84:
  
  
−
===TurnOn===
+
===SetTarget===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''TurnOn'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetTarget'''
 +
|-
 +
| colspan="2" | Choose an extermal object to move along with the solenoid's actuator&nbsp;
 +
|-
 
|-
 
|-
−
| colspan="2" | Activate the solenoid&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
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 96: Line 103:
  
  
−
===SetState===
+
===TurnOff===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetState'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 115: Line 117:
  
  
−
===TurnOff===
+
===TurnOn===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''TurnOff'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''TurnOn'''
 
|-
 
|-
−
| colspan="2" | De-activate the solenoid&nbsp;
+
| colspan="2" | Activate the solenoid&nbsp;
 
|-
 
|-
 
|-
 
|-

Revision as of 12:04, 3 February 2023

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_temp/solenoid_base.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_temp/solenoid_base.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples




Macro reference

SetState

Fc9-comp-macro.png SetState
Trun the solenoid on or off using a boolean value. 
Fc9-bool-icon.png - BOOL State
The new state for the solenoid to take. 
Fc9-void-icon.png - VOID Return


SetTarget

Fc9-comp-macro.png SetTarget
Choose an extermal object to move along with the solenoid's actuator 
Fc9-h32-icon.png - HANDLE Object
An object to be moved by the solenoid 
Fc9-void-icon.png - VOID Return


TurnOff

Fc9-comp-macro.png TurnOff
De-activate the solenoid 
Fc9-void-icon.png - VOID Return


TurnOn

Fc9-comp-macro.png TurnOn
Activate the solenoid 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Connection
Fc9-type-5-icon.png Pin
Chip pin to connect the solenoid circuit to. NB) Solenoid cannot be moved unless there is a valid connection. 
Fc9-conn-icon.png Simulation
Fc9-type-17-icon.png Moving part
A panel object to be moved back and forth when the solenoid is activated. 
Fc9-type-17-icon.png Pivot object
A position to rotate around when the solenoid type is set to 'Rotate' Not required for linear solenoids. 
Fc9-type-16-icon.png Type
The type of motion of the solenoid actuator. 
Fc9-type-16-icon.png Axis
For linear solenoids, the axis along which the actuator will move. For rotary solenoids, the axis around which it will rotate. 
Fc9-type-15-icon.png Distance
For linear solenoids, the distance between the 'off and 'on' states in model units. For rotary solenoids, the rotation in degrees. 
Fc9-type-21-icon.png 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. 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Solenoid_Template_(Mechatronics)&oldid=36988"