Jump to content

Component: Gearbox (Mechatronics): Difference between revisions

From Flowcode Help
Newer edit →

Wiki bot (talk | contribs)

3 user groups
14,227 edits
XML import
 
No edit summary
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
|}
|}




==Gearbox component==
A simple component to couple together two rotating shafts via a gearbox. The gearbox can be used to scale the input rotational speed and optionally reverse the output direction.


==[[File:Component Icon bfa45502_f9d6_4b53_a239_b5731f9288d5.png|Image]] Gearbox component==
==Detailed description==
A simple component to couple together two rotating shafts via a gearbox.
 
The gearbox can be used to scale the input rotational speed and optionally reverse the output direction.
''No detailed description exists yet for this component''


==Examples==
==Examples==
''<span style="color:red;">No additional examples</span>''
''<span style="color:red;">No additional examples</span>''


Line 25: Line 27:
==Downloadable macro reference==
==Downloadable macro reference==


''This component does not contain any downloadable macros''
{| 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" | &nbsp;
|-
|-
| width="10%" align="center" | [[File:]] -
| width="90%" | Angle
|-
| colspan="2" | &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''
|}


==Simulation macro reference==


===<span style="font-weight: normal;"><u><tt>Rotate</tt></u></span>===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
''<span style="color:red;">No additional information</span>''
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Stop'''
|-
| colspan="2" | Stops both motors&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''
|}




{| 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;" | '''LEDOff'''
|-
| colspan="2" | Switches off a single LED on the front of the Formula Flowcode.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | LED
|-
| colspan="2" | &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''
|}


'''Parameters'''


:[[Variable Types|FLOAT]] ''Angle''
{| 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.&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] -
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}




'''Return value'''
{| 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.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Switch
|-
| colspan="2" | &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''
|}


:''This call does not return a value''


{| 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.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Power
|-
| colspan="2" | &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''
|}




{| 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.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Power
|-
| colspan="2" | &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==
<span style="font-weight: normal;"><u>Gear Ratio</u></span>


This property is of type ''Floating point'' and can be referenced with the variable name ''Ratio''.
{| 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.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Sensor
|-
| colspan="2" | &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''
|}


Sets the input to output gear ratio.


For example a ratio of 2:1 would be 0.5, a ratio of 1:5 would be 5.0.
{| 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.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Power
|-
| colspan="2" | &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''
|}


Negative ratio values allow the input direction to be reversed.


<span style="font-weight: normal;"><u>Input</u></span>
{| 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.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Sensor
|-
| colspan="2" | &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''
|}


This property is of type ''Panel object'' and can be referenced with the variable name ''Input''.


Input connection for example a motor or other active component or primitive.
{| 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.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Sensor
|-
| colspan="2" | &nbsp;
|-
| 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''
|}


<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''.
{| 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.&nbsp;
|-
|-
| width="10%" align="center" | [[File:]] -
| width="90%" | Left_Power
|-
| colspan="2" | Valid Range = -255 to 255&nbsp;
|-
| width="10%" align="center" | [[File:]] -
| width="90%" | Right_Power
|-
| colspan="2" | Valid Range = -255 to 255&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''
|}


Output connection for example a primitive or a component such as a linear slide or gearbox.


<span style="font-weight: normal;"><u>Input Offset</u></span>
{| 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.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Power
|-
| colspan="2" | &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 ''Floating point'' and can be referenced with the variable name ''InputOffset''.


Distance along the shaft from the center of the input object to the center of the coupling.
{| 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.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Switch
|-
| colspan="2" | &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>Output Offset</u></span>


This property is of type ''Floating point'' and can be referenced with the variable name ''OutputOffsetZ''.
{| 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.&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] -
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


Distance along the shaft from the center of the coupling to the center of the output object.


<span style="font-weight: normal;"><u>Output Translation X</u></span>
{| 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.&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | LED_Byte
|-
| colspan="2" | &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 ''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.
{| 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&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>Output Translation 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>Width</u></span>
==Property reference==


This property is of type ''Floating point'' and can be referenced with the variable name ''Width''.
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
''<span style="color:red;">No additional information</span>''
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
 
|-
 
|-
<span style="font-weight: normal;"><u>Height</u></span>
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 
| width="90%" | Gear Ratio
This property is of type ''Floating point'' and can be referenced with the variable name ''Height''.
|-
 
| colspan="2" | Sets the input to output gear ratio. For example a ratio of 2:1 would be 0.5, a ratio of 1:5 would be 5.0. Negative ratio values allow the input direction to be reversed. &nbsp;
''<span style="color:red;">No additional information</span>''
|-
 
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 
| width="90%" | Width
 
|-
<span style="font-weight: normal;"><u>Depth</u></span>
| colspan="2" | &nbsp;
 
|-
This property is of type ''Floating point'' and can be referenced with the variable name ''Depth''.
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 
| width="90%" | Height
''<span style="color:red;">No additional information</span>''
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Depth
|-
| colspan="2" | &nbsp;
|-
| 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%" | Input
|-
| colspan="2" | Input connection for example a motor or other active component or primitive.&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-17-icon.png]]
| width="90%" | Output
|-
| colspan="2" | Output connection for example a primitive or a component such as a linear slide or gearbox.&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Input Offset
|-
| colspan="2" | Distance along the shaft from the center of the input object to the center of the coupling.&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Output Offset
|-
| colspan="2" | Distance along the shaft 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 Translation 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 Translation 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" 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


Gearbox component

A simple component to couple together two rotating shafts via a gearbox. The gearbox can be used to scale the input rotational speed and optionally reverse the output direction.

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Downloadable macro reference

Rotate
 
[[File:]] - Angle
 
- VOID Return


Stop
Stops both motors 
- VOID Return


LEDOff
Switches off a single LED on the front of the Formula Flowcode. 
- BYTE LED
 
- VOID 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. 
- BYTE Switch
 
- BYTE Return


SpinLeft
Spins the formula flowcode on the spot in an anticlockwise direction as seen from above. 
- BYTE Power
 
- VOID Return


Forward
Drives both motors of the formula flowcode forwards with the power specified. 
- BYTE Power
 
- VOID Return


ReadLineSensor
Returns the digital value from the line sensor specified. 
- BYTE Sensor
 
- BYTE Return


SpinRight
Spins the formula flowcode on the spot in a clockwise direction as seen from above. 
- BYTE Power
 
- VOID Return


CheckIR
Checks to see if a IR sensor is within the master threshold distance. 
- BYTE Sensor
 
- BYTE Return


ReadIRSensor
Reads the analogue value from the specified IR distance sensor. 
- BYTE Sensor
 
- UINT 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 
- VOID Return


Reverse
Drives both motors of the formula flowcode backwards with the power specified. 
- BYTE Power
 
- VOID Return


WaitForSwitch
Waits for the specified switch to be pressed. 
- BYTE Switch
 
- VOID 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. 
- BYTE LED_Byte
 
- VOID Return


Initialise
Starts up the formula flowcode PWM for motor control and performs the wait for button press 
- VOID Return



Property reference

Properties
Gear Ratio
Sets the input to output gear ratio. For example a ratio of 2:1 would be 0.5, a ratio of 1:5 would be 5.0. Negative ratio values allow the input direction to be reversed.  
Width
 
Height
 
Depth
 
Connections
Input
Input connection for example a motor or other active component or primitive. 
Output
Output connection for example a primitive or a component such as a linear slide or gearbox. 
Input Offset
Distance along the shaft from the center of the input object to the center of the coupling. 
Output Offset
Distance along the shaft from the center of the coupling to the center of the output object. 
Output Translation X
Distance along the X axis from the center of the coupling to the center of the output object. 
Output Translation Y
Distance along the X axis from the center of the coupling to the center of the output object. 
Simulations
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Gearbox_(Mechatronics)&oldid=25823"