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

Latest revision as of 13:14, 7 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_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.

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

Latest revision as of 13:14, 7 February 2023

Contents

Solenoid Template component

Component Source Code

Detailed description

Examples

Macro reference

SetState

SetTarget

TurnOff

TurnOn

Property reference

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

Tools

@@ Line 1: / Line 1: @@
+{| style="width:50%"
-{| width="50%"
 |-
-| width="20%" style="color: gray;" | Author
+| width="20%" style="color:gray;" | Author
 | Matrix Ltd
 |-
-| width="20%" style="color: gray;" | Version
+| width="20%" style="color:gray;" | Version
-| 1.1 (Release)
+| 1.1
 |-
-| width="20%" style="color: gray;" | Category
+| width="20%" style="color:gray;" | 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.
-==[[File:Component Icon eb1db17a_1c6c_44ef_84d0_d718549343c4.png|Image]] Solenoid Template component==
+==Component Source Code==
-Base component for constructing solenoids.
-These take a single input pin and move an actuator between two positions depending on
-the pin state.
-This component can be used as a base to create ''child'' components
+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]
-[[File:Component Icon 1ac8ae8b_bcd2_493f_b516_36dacb3695f9.png|Image]] The component Solenoid DC1 is inherited from this.
+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]
-==Examples==
+==Detailed description==
-A solenoid will likely require more current than a microcontroller device can supply to activate the mechanical mechanism.
-To amplify the current from the microcontroller simply use a NPN transistor or N channel FET.
-The diode is required as with any inductive loads to help protect the microcontroller from back EMF generated by the inductor as the control signal switches the current through the inductor on and off
-[[File:Solenoid.jpg]]
-==Downloadable macro reference==
-===<span style="font-weight: normal;"><u><tt>TurnOn</tt></u></span>===
-Activate the solenoid
-'''Parameters'''
-:''This macro has no parameters''
-'''Return value'''
-:''This call does not return a value''
-===<span style="font-weight: normal;"><u><tt>SetState</tt></u></span>===
-Trun the solenoid on or off using a boolean value.
-'''Parameters'''
+''No detailed description exists yet for this component''
-:[[Variable Types|BOOL]] ''State''
+==Examples==
-::The new state for the solenoid to take.
-'''Return value'''
-:''This call does not return a value''
-===<span style="font-weight: normal;"><u><tt>TurnOff</tt></u></span>===
-De-activate the solenoid
-'''Parameters'''
-:''This macro has no parameters''
-'''Return value'''
-:''This call does not return a value''
-==Simulation macro reference==
-===<span style="font-weight: normal;"><u><tt>SetTarget</tt></u></span>===
-Choose an extermal object to move along with the solenoid's actuator
-'''Parameters'''
+''<span style="color:red;">No additional examples</span>''
-:[[Variable Types|HANDLE]] ''Object''
-::An object to be moved by the solenoid
-'''Return value'''
-:''This call does not return a value''
-==Property reference==
-<span style="font-weight: normal;"><u>Pin</u></span>
-This property is of type ''Single digital pin'' and can be referenced with the variable name ''pin''.
-Chip pin to connect the solenoid circuit to.
-NB) Solenoid cannot be moved unless there is a valid connection.
+==Macro reference==
-<span style="font-weight: normal;"><u>Moving part</u></span>
+===SetState===
+{| 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.&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="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-This property is of type ''Panel object'' and can be referenced with the variable name ''int_target''.
-A panel object to be moved back and forth when the solenoid is activated.
+===SetTarget===
+{| 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&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="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-<span style="font-weight: normal;"><u>Pivot object</u></span>
-This property is of type ''Panel object'' and can be referenced with the variable name ''pivot''.
+===TurnOff===
+{| 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&nbsp;
+|-
+|-
+| 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''
+|}
-A position to rotate around when the solenoid type is set to 'Rotate'
-Not required for linear solenoids.
+===TurnOn===
+{| 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&nbsp;
+|-
+|-
+| 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''
+|}
-<span style="font-weight: normal;"><u>Type</u></span>
-This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''movetype''.
+==Property reference==
-The type of motion of the solenoid actuator.
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
-<span style="font-weight: normal;"><u>Axis</u></span>
+| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
-This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''axis''.
+|-
+|-
-For linear solenoids, the axis along which the actuator will move.
+| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connection
-For rotary solenoids, the axis around which it will rotate.
+|-
+|-
-<span style="font-weight: normal;"><u>Distance</u></span>
+| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
+| width="90%" | Pin
-This property is of type ''Floating point'' and can be referenced with the variable name ''move''.
+|-
+| colspan="2" | Chip pin to connect the solenoid circuit to. NB) Solenoid cannot be moved unless there is a valid connection.&nbsp;
-For linear solenoids, the distance between the 'off'' and 'on' states in model units.
+|-
+| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
-For rotary solenoids, the rotation in degrees.
+| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
+|-
-<span style="font-weight: normal;"><u>Time (ms)</u></span>
+|-
+| width="10%" align="center" | [[File:Fc9-type-17-icon.png]]
-This property is of type ''Unsigned integer'' and can be referenced with the variable name ''animate_time''.
+| width="90%" | Moving part
+|-
-The time taken for the solenoid to move between the on and off positions.
+| colspan="2" | A panel object to be moved back and forth when the solenoid is activated.&nbsp;
+|-
-Used only for the purpose of System Panel animations on screen.
+| 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.&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
+| width="90%" | Type
+|-
+| colspan="2" | The type of motion of the solenoid actuator.&nbsp;
+|-
+| 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.&nbsp;
+|-
+| 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.&nbsp;
+|-
+| 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.&nbsp;
+|}