Component: Solenoid Template (Mechatronics): Difference between revisions
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_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] | 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== | ==Detailed description== | ||
| Line 32: | Line 40: | ||
==Examples== | ==Examples== | ||
| Line 43: | Line 57: | ||
''<span style="color:red;">No additional examples</span>'' | ''<span style="color:red;">No additional examples</span>'' | ||
{| class="wikitable | |||
==Macro reference== | |||
===SetState=== | |||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''SetState''' | ||
|- | |- | ||
| colspan="2" | Trun the solenoid on or off using a boolean value. | | colspan="2" | Trun the solenoid on or off using a boolean value. | ||
| Line 94: | Line 88: | ||
===SetTarget=== | |||
{| class="mtx-class-macrotable wikitable" | |||
| | |||
|- | |- | ||
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | |||
| width="10%" align="center" | | width="90%" class="mtx-class-macrohead" | '''SetTarget''' | ||
| width="90%" | |||
|- | |- | ||
| colspan="2" | Choose an extermal object to move along with the solenoid's actuator | | colspan="2" | Choose an extermal object to move along with the solenoid's actuator | ||
| Line 179: | Line 107: | ||
{| class="wikitable | ===TurnOff=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''TurnOff''' | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | De-activate the solenoid | ||
|- | |- | ||
|- | |- | ||
| Line 192: | Line 121: | ||
{| class="wikitable | ===TurnOn=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''TurnOn''' | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | Activate the solenoid | ||
|- | |- | ||
|- | |- | ||
| 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 | ||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
==Property reference== | ==Property reference== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''Properties''' | ||
|- | |- | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-propfolder" | Connection | ||
|- | |- | ||
|- | |- | ||
| Line 242: | Line 152: | ||
| colspan="2" | Chip pin to connect the solenoid circuit to. NB) Solenoid cannot be moved unless there is a valid connection. | | colspan="2" | Chip pin to connect the solenoid circuit to. NB) Solenoid cannot be moved unless there is a valid connection. | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-propfolder" | Simulation | ||
|- | |- | ||
|- | |- | ||
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. | |