Difference between revisions of "Component: Linear Actuator (Mechatronics)"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
 
(15 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
+
{| style="width:50%"
 
 
{| width="50%"
 
 
|-
 
|-
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| Matrix TSL
 
| Matrix TSL
 
|-
 
|-
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
| 1.0 (Release)
+
| 1.0
 
|-
 
|-
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| Mechatronics
 
| Mechatronics
 
|}
 
|}
  
  
 
+
==Linear Actuator component==
==[[File:Component Icon 15921536_cf92_4cd3_88e4_207c251ab775.png|Image]] Linear Actuator component==
 
 
Creates a linear actuator that can be used with the various motor components via a coupling or gearbox.
 
Creates a linear actuator that can be used with the various motor components via a coupling or gearbox.
  
==Examples==
+
==Component Source Code==
''<span style="color:red;">No additional examples</span>''
 
  
 +
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_LinearActuator.fcfx FC_Comp_Source_LinearActuator.fcfx]
  
==Downloadable macro reference==
+
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_LinearActuator.fcfx FC_Comp_Source_LinearActuator.fcfx]
  
===<span style="font-weight: normal;"><u><tt>CheckLimits</tt></u></span>===
+
==Detailed description==
Checks to see if either limit switch is active.
 
  
Returns 1 if min switch is active, 2 if max switch is active, 3 if both switches are active
 
  
else returns 0.
 
  
'''Parameters'''
 
  
:''This macro has no parameters''
 
  
  
'''Return value'''
 
  
:[[Variable Types|BYTE]]
 
  
  
  
==Simulation macro reference==
 
  
===<span style="font-weight: normal;"><u><tt>Rotate</tt></u></span>===
 
Simulation Rotate function to allow accurate rotation during simulation.
 
  
Automatically called by any attached coupling or gearbox component.
 
  
'''Parameters'''
 
  
:[[Variable Types|FLOAT]] ''Angle''
 
::Amount to rotate the shaft input in degrees
 
  
  
'''Return value'''
 
  
:''This call does not return a value''
 
  
  
  
  
==Property reference==
 
<span style="font-weight: normal;"><u>Translation Per Rev</u></span>
 
  
This property is of type ''Floating point'' and can be referenced with the variable name ''Ratio''.
 
  
Sets the amount of translation for each revolution of the input shaft.
+
''No detailed description exists yet for this component''
  
M4 = 0.7mm
+
==Examples==
  
M5 = 0.8mm
 
  
M6 = 1.0mm
 
  
M8 = 1.25mm
 
  
M10 = 1.5mm
 
  
<span style="font-weight: normal;"><u>Travel</u></span>
 
  
This property is of type ''Floating point'' and can be referenced with the variable name ''Length''.
 
  
Amount of travel in the linear actuator before hitting the end stops
 
  
<span style="font-weight: normal;"><u>Revolutions</u></span>
 
  
This property is of type ''Floating point'' and can be referenced with the variable name ''NumRevs''.
 
  
Number of revolutions the actuator can travel
 
  
<span style="font-weight: normal;"><u>Colour</u></span>
 
  
This property is of type ''Color picker'' and can be referenced with the variable name ''Colour''.
 
  
Sets the colour of the actuator and end stops
 
  
<span style="font-weight: normal;"><u>Output</u></span>
 
  
This property is of type ''Panel object'' and can be referenced with the variable name ''Output''.
 
  
Output connection for example an end tool or another linear slide and motor group.
 
  
<span style="font-weight: normal;"><u>Output Offset X</u></span>
 
  
This property is of type ''Floating point'' and can be referenced with the variable name ''OutputOffsetX''.
 
  
Distance along the X axis from the center of the coupling to the center of the output object.
 
  
<span style="font-weight: normal;"><u>Output Offset Y</u></span>
 
  
This property is of type ''Floating point'' and can be referenced with the variable name ''OutputOffsetY''.
 
  
Distance along the X axis from the center of the coupling to the center of the output object.
 
  
<span style="font-weight: normal;"><u>Output Offset Z</u></span>
 
  
This property is of type ''Floating point'' and can be referenced with the variable name ''OutputOffsetZ''.
+
''<span style="color:red;">No additional examples</span>''
  
Distance along the shaft from the center of the coupling to the center of the output object.
 
  
<span style="font-weight: normal;"><u>Limit Type</u></span>
 
  
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''LimitType''.
 
  
Controls if limit switches are available on the linear actuator.
 
  
<span style="font-weight: normal;"><u>Switch Polarity</u></span>
 
  
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''SwitchPolarity''.
 
  
Sets the active polarity of the input switches.
 
  
Active low are often used to help reduce noise on the switch inputs.
 
  
<span style="font-weight: normal;"><u>Min Switch Pin</u></span>
 
  
This property is of type ''Single digital pin'' and can be referenced with the variable name ''MinPin''.
 
  
Pin connection used for the minimum limit switch
 
  
<span style="font-weight: normal;"><u>Max Switch Pin</u></span>
+
==Macro reference==
  
This property is of type ''Single digital pin'' and can be referenced with the variable name ''MaxPin''.
+
===CheckLimits===
 +
{| 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;" | '''CheckLimits'''
 +
|-
 +
| colspan="2" | Checks to see if either limit switch is active. Returns 1 if min switch is active, 2 if max switch is active, 3 if both switches are active else returns 0.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
Pin connection used for the maximum limit switch
+
 
 +
===Rotate===
 +
{| 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;" | '''Rotate'''
 +
|-
 +
| colspan="2" | Simulation Rotate function to allow accurate rotation during simulation. Automatically called by any attached coupling or gearbox component.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" | Angle
 +
|-
 +
| colspan="2" | Amount to rotate the shaft input in degrees&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''
 +
|}
 +
 
 +
 
 +
==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;" | Actuator Properties
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 +
| width="90%" | Translation Per Rev
 +
|-
 +
| colspan="2" | Sets the amount of translation for each revolution of the input shaft. M4 = 0.7mm M5 = 0.8mm M6 = 1.0mm M8 = 1.25mm M10 = 1.5mm&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 +
| width="90%" | Travel
 +
|-
 +
| colspan="2" | Amount of travel in the linear actuator before hitting the end stops&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 +
| width="90%" | Revolutions
 +
|-
 +
| colspan="2" | Number of revolutions the actuator can travel&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Colour
 +
|-
 +
| colspan="2" | Sets the colour of the actuator and end stops&nbsp;
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-17-icon.png]]
 +
| width="90%" | Output
 +
|-
 +
| colspan="2" | Output connection for example an end tool or another linear slide and motor group.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 +
| width="90%" | Output Offset X
 +
|-
 +
| colspan="2" | Distance along the X axis from the center of the coupling to the center of the output object.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 +
| width="90%" | Output Offset Y
 +
|-
 +
| colspan="2" | Distance along the X axis from the center of the coupling to the center of the output object.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 +
| width="90%" | Output Offset Z
 +
|-
 +
| colspan="2" | Distance along the shaft from the center of the coupling to the center of the output object.&nbsp;
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Limits
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Limit Type
 +
|-
 +
| colspan="2" | Controls if limit switches are available on the linear actuator.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Switch Polarity
 +
|-
 +
| colspan="2" | Sets the active polarity of the input switches. Active low are often used to help reduce noise on the switch inputs.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | Min Switch Pin
 +
|-
 +
| colspan="2" | Pin connection used for the minimum limit switch&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | Max Switch Pin
 +
|-
 +
| colspan="2" | Pin connection used for the maximum limit switch&nbsp;
 +
|}

Latest revision as of 13:11, 7 February 2023

Author Matrix TSL
Version 1.0
Category Mechatronics


Linear Actuator component

Creates a linear actuator that can be used with the various motor components via a coupling or gearbox.

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples







Macro reference

CheckLimits

Fc9-comp-macro.png CheckLimits
Checks to see if either limit switch is active. Returns 1 if min switch is active, 2 if max switch is active, 3 if both switches are active else returns 0. 
Fc9-u8-icon.png - BYTE Return


Rotate

Fc9-comp-macro.png Rotate
Simulation Rotate function to allow accurate rotation during simulation. Automatically called by any attached coupling or gearbox component. 
Fc9-f32-icon.png - FLOAT Angle
Amount to rotate the shaft input in degrees 
Fc9-void-icon.png - VOID Return


Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Actuator Properties
Fc9-type-15-icon.png Translation Per Rev
Sets the amount of translation for each revolution of the input shaft. M4 = 0.7mm M5 = 0.8mm M6 = 1.0mm M8 = 1.25mm M10 = 1.5mm 
Fc9-type-15-icon.png Travel
Amount of travel in the linear actuator before hitting the end stops 
Fc9-type-15-icon.png Revolutions
Number of revolutions the actuator can travel 
Fc9-type-1-icon.png Colour
Sets the colour of the actuator and end stops 
Fc9-conn-icon.png Connections
Fc9-type-17-icon.png Output
Output connection for example an end tool or another linear slide and motor group. 
Fc9-type-15-icon.png Output Offset X
Distance along the X axis from the center of the coupling to the center of the output object. 
Fc9-type-15-icon.png Output Offset Y
Distance along the X axis from the center of the coupling to the center of the output object. 
Fc9-type-15-icon.png Output Offset Z
Distance along the shaft from the center of the coupling to the center of the output object. 
Fc9-conn-icon.png Limits
Fc9-type-16-icon.png Limit Type
Controls if limit switches are available on the linear actuator. 
Fc9-type-16-icon.png Switch Polarity
Sets the active polarity of the input switches. Active low are often used to help reduce noise on the switch inputs. 
Fc9-type-5-icon.png Min Switch Pin
Pin connection used for the minimum limit switch 
Fc9-type-5-icon.png Max Switch Pin
Pin connection used for the maximum limit switch