Difference between revisions of "Component: Linear Actuator (Mechatronics)"
From Flowcode Help
Jump to navigationJump to search (XML import) |
|||
| Line 1: | Line 1: | ||
| − | + | {| style="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 | + | | 1.0 |
|- | |- | ||
| − | | width="20%" style="color: gray;" | Category | + | | width="20%" style="color:gray;" | Category |
| Mechatronics | | Mechatronics | ||
|} | |} | ||
| − | + | ==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. | ||
| − | == | + | ==Detailed description== |
| − | |||
| + | ''No detailed description exists yet for this component'' | ||
| − | == | + | ==Examples== |
| − | |||
| − | |||
| − | + | ''<span style="color:red;">No additional examples</span>'' | |
| − | |||
| − | + | ==Downloadable 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;" | '''Rotate''' | ||
| + | |- | ||
| + | | colspan="2" | Simulation Rotate function to allow accurate rotation during simulation. Automatically called by any attached coupling or gearbox component. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:]] - | ||
| + | | width="90%" | Angle | ||
| + | |- | ||
| + | | colspan="2" | Amount to rotate the shaft input in degrees | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| − | '''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;" | '''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. | ||
| + | |- | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| − | |||
| + | {| 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;" | '''ReadMic''' | ||
| + | |- | ||
| + | | colspan="2" | Reads the current audio signal level from the on-board microphone. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] - | ||
| + | | 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;" | '''ReadSwitch''' | ||
| + | |- | ||
| + | | colspan="2" | Reads the value of one of the switches from the front of the Formula Flowcode. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Switch | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| − | |||
| − | |||
| − | + | {| 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;" | '''SpinLeft''' | ||
| + | |- | ||
| + | | colspan="2" | Spins the formula flowcode on the spot in an anticlockwise direction as seen from above. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Power | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | 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;" | '''Forward''' | ||
| + | |- | ||
| + | | colspan="2" | Drives both motors of the formula flowcode forwards with the power specified. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Power | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | 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;" | '''ReadLineSensor''' | ||
| + | |- | ||
| + | | colspan="2" | Returns the digital value from the line sensor specified. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Sensor | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| − | |||
| + | {| 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;" | '''SpinRight''' | ||
| + | |- | ||
| + | | colspan="2" | Spins the formula flowcode on the spot in a clockwise direction as seen from above. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Power | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | 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;" | '''CheckIR''' | ||
| + | |- | ||
| + | | colspan="2" | Checks to see if a IR sensor is within the master threshold distance. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Sensor | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| − | |||
| − | |||
| − | + | {| 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;" | '''ReadIRSensor''' | ||
| + | |- | ||
| + | | colspan="2" | Reads the analogue value from the specified IR distance sensor. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Sensor | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT | ||
| + | | 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;" | '''SetMotors''' | ||
| + | |- | ||
| + | | colspan="2" | Sets the speed and direction of the Formula Flowcode motors. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:]] - | ||
| + | | width="90%" | Left_Power | ||
| + | |- | ||
| + | | colspan="2" | Valid Range = -255 to 255 | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:]] - | ||
| + | | width="90%" | Right_Power | ||
| + | |- | ||
| + | | colspan="2" | Valid Range = -255 to 255 | ||
| + | |- | ||
| + | | 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;" | '''Reverse''' | ||
| + | |- | ||
| + | | colspan="2" | Drives both motors of the formula flowcode backwards with the power specified. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Power | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | 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;" | '''WaitForSwitch''' | ||
| + | |- | ||
| + | | colspan="2" | Waits for the specified switch to be pressed. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Switch | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | 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;" | '''ReadLDR''' | ||
| + | |- | ||
| + | | colspan="2" | Reads the current audio signal level from the on-board light sensor. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] - | ||
| + | | 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;" | '''WriteLEDs''' | ||
| + | |- | ||
| + | | colspan="2" | Allows control of all 8-LEDs on the front of the Formula Flowcode. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | LED_Byte | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | 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;" | '''Initialise''' | ||
| + | |- | ||
| + | | colspan="2" | Starts up the formula flowcode PWM for motor control and performs the wait for button press | ||
| + | |- | ||
| + | |- | ||
| + | | 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" | [[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 | |
| − | + | |- | |
| − | + | | 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 | |
| − | + | |- | |
| − | + | | width="10%" align="center" | [[File:Fc9-type-15-icon.png]] | |
| − | + | | width="90%" | Revolutions | |
| − | + | |- | |
| − | + | | colspan="2" | Number of revolutions the actuator can travel | |
| − | + | |- | |
| − | + | | width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | |
| − | + | | width="90%" | Colour | |
| − | + | |- | |
| − | + | | colspan="2" | Sets the colour of the actuator and end stops | |
| − | + | |- | |
| − | Controls if limit switches are available on the linear actuator. | + | | 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. | |
| − | + | |- | |
| − | + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | |
| − | Sets the active polarity of the input switches. | + | | width="90%" | Switch Polarity |
| − | + | |- | |
| − | Active low are often used to help reduce noise on the switch inputs. | + | | colspan="2" | Sets the active polarity of the input switches. Active low are often used to help reduce noise on the switch inputs. |
| − | + | |- | |
| − | + | | 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 | |
| − | Pin connection used for the | + | |- |
| − | + | | 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 | |
| − | + | |- | |
| − | + | | width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]] | |
| + | | width="90%" style="background-color:#D8C9D8; 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. | ||
| + | |- | ||
| + | | 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. | ||
| + | |- | ||
| + | | 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. | ||
| + | |- | ||
| + | | 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. | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations''' | ||
| + | |- | ||
| + | |} | ||
Revision as of 21:05, 16 November 2021
| Author | Matrix TSL |
| Version | 1.0 |
| Category | Mechatronics |
Contents
Linear Actuator component
Creates a linear actuator that can be used with the various motor components via a coupling or gearbox.
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Downloadable macro reference
| 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. | |
| Return | |
| ReadMic | |
| Reads the current audio signal level from the on-board microphone. | |
| [[File:]] - | Return |
| ReadSwitch | |
| Reads the value of one of the switches from the front of the Formula Flowcode. | |
| Switch | |
| Return | |
| SpinLeft | |
| Spins the formula flowcode on the spot in an anticlockwise direction as seen from above. | |
| Power | |
| Return | |
| Forward | |
| Drives both motors of the formula flowcode forwards with the power specified. | |
| Power | |
| Return | |
| ReadLineSensor | |
| Returns the digital value from the line sensor specified. | |
| Sensor | |
| Return | |
| SpinRight | |
| Spins the formula flowcode on the spot in a clockwise direction as seen from above. | |
| Power | |
| Return | |
| CheckIR | |
| Checks to see if a IR sensor is within the master threshold distance. | |
| Sensor | |
| Return | |
| ReadIRSensor | |
| Reads the analogue value from the specified IR distance sensor. | |
| Sensor | |
| Return | |
| SetMotors | |
| Sets the speed and direction of the Formula Flowcode motors. | |
| [[File:]] - | Left_Power |
| Valid Range = -255 to 255 | |
| [[File:]] - | Right_Power |
| Valid Range = -255 to 255 | |
| Return | |
| Reverse | |
| Drives both motors of the formula flowcode backwards with the power specified. | |
| Power | |
| Return | |
| WaitForSwitch | |
| Waits for the specified switch to be pressed. | |
| Switch | |
| Return | |
| ReadLDR | |
| Reads the current audio signal level from the on-board light sensor. | |
| [[File:]] - | Return |
| WriteLEDs | |
| Allows control of all 8-LEDs on the front of the Formula Flowcode. | |
| LED_Byte | |
| Return | |
| Initialise | |
| Starts up the formula flowcode PWM for motor control and performs the wait for button press | |
| Return | |