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/ | + | 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 36: | Line 38: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 50: | Line 54: | ||
==Macro reference== | ==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;" | '''SetTarget''' | ||
| + | |- | ||
| + | | colspan="2" | Choose an extermal object to move along with the solenoid's actuator | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | ||
| + | | width="90%" | Object | ||
| + | |- | ||
| + | | colspan="2" | An object to be moved by the solenoid | ||
| + | |- | ||
| + | | 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;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''TurnOn''' | ||
| + | |- | ||
| + | | colspan="2" | Activate the solenoid | ||
| + | |- | ||
| + | |- | ||
| + | | 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;" | ||
| + | |- | ||
| + | | 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" | Trun the solenoid on or off using a boolean value. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| + | | width="90%" | State | ||
| + | |- | ||
| + | | colspan="2" | The new state for the solenoid to take. | ||
| + | |- | ||
| + | | 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;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''TurnOff''' | ||
| + | |- | ||
| + | | colspan="2" | De-activate the solenoid | ||
| + | |- | ||
| + | |- | ||
| + | | 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;" | Connection | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-5-icon.png]] | ||
| + | | width="90%" | Pin | ||
| + | |- | ||
| + | | 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" 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-17-icon.png]] | ||
| + | | width="90%" | Moving part | ||
| + | |- | ||
| + | | colspan="2" | A panel object to be moved back and forth when the solenoid is activated. | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-17-icon.png]] | ||
| + | | width="90%" | Pivot object | ||
| + | |- | ||
| + | | colspan="2" | A position to rotate around when the solenoid type is set to 'Rotate' Not required for linear solenoids. | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
| + | | width="90%" | Type | ||
| + | |- | ||
| + | | colspan="2" | The type of motion of the solenoid actuator. | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
| + | | width="90%" | Axis | ||
| + | |- | ||
| + | | colspan="2" | For linear solenoids, the axis along which the actuator will move. For rotary solenoids, the axis around which it will rotate. | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-15-icon.png]] | ||
| + | | width="90%" | Distance | ||
| + | |- | ||
| + | | colspan="2" | For linear solenoids, the distance between the 'off'' and 'on' states in model units. For rotary solenoids, the rotation in degrees. | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | ||
| + | | width="90%" | Time (ms) | ||
| + | |- | ||
| + | | colspan="2" | 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. | ||
| + | |}==Macro reference== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
Revision as of 10:01, 27 January 2023
| Author | Matrix Ltd |
| Version | 1.1 |
| Category | Mechatronics |
Contents
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
|
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 |
|
|
TurnOn |
| Activate the solenoid | |
| - VOID
|
Return |
|
|
SetState |
| Trun the solenoid on or off using a boolean value. | |
 - BOOL
|
State |
| The new state for the solenoid to take. | |
| - VOID
|
Return |
|
|
TurnOff |
| De-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. | |
==Macro reference==
|
|
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 |
|
|
TurnOn |
| Activate the solenoid | |
| - VOID
|
Return |
|
|
SetState |
| Trun the solenoid on or off using a boolean value. | |
| - BOOL
|
State |
| The new state for the solenoid to take. | |
| - VOID
|
Return |
|
|
TurnOff |
| De-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. | |
==Macro reference==
|
|
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 |
|
|
TurnOn |
| Activate the solenoid | |
| - VOID
|
Return |
|
|
SetState |
| Trun the solenoid on or off using a boolean value. | |
| - BOOL
|
State |
| The new state for the solenoid to take. | |
| - VOID
|
Return |
|
|
TurnOff |
| De-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. | |
==Macro reference==
|
|
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 |
|
|
TurnOn |
| Activate the solenoid | |
| - VOID
|
Return |
|
|
SetState |
| Trun the solenoid on or off using a boolean value. | |
| - BOOL
|
State |
| The new state for the solenoid to take. | |
| - VOID
|
Return |
|
|
TurnOff |
| De-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. | |
