Difference between revisions of "Component: Servo Motor Template (Mechatronics)"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
 
(19 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
 
+
{| style="width:50%"
−
 
 
−
{| width="50%"
 
 
|-
 
|-
−
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| Matrix Ltd
 
| 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
 
| Mechatronics
 
|}
 
|}
 +
 +
 +
==Servo Motor Template component==
 +
Base component for creating custom servo motor simulations. Recieves messages  from the the 'Servo Controller' component.  Macro 'SetTarget' allows external objects to be moved by the servo for mechanical simulations.
 +
 +
==Component Source Code==
 +
 +
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Servo_Motor_Base.fcfx FC_Comp_Source_Servo_Motor_Base.fcfx]
 +
 +
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Servo_Motor_Base.fcfx FC_Comp_Source_Servo_Motor_Base.fcfx]
 +
 +
==Detailed description==
 +
 +
 +
 +
 +
 +
 +
 +
  
  
  
−
==[[File:Component Icon fbad3c39_8c38_49b7_a860_ae37e9b979a2.png|Image]] Servo Motor Template component==
 
−
Base component for creating custom servo motor simulations.
 
−
Recieves messages  from the the 'Servo Controller' component.
 
  
−
Macro 'SetTarget' allows external objects to be moved by the servo
 
−
for mechanical simulations.
 
  
−
This component can be used as a base to create ''child'' components
 
  
−
The following components all inherit the traits of Servo Motor Template:
 
  
−
{| class="wikitable" width="50%"
 
−
|+|-
 
−
|[[File:Component Icon b6fdc61f_7be2_49c7_925f_aea3dc284cba.png|Image]] Micro Servo (Tower Pro 9g)
 
−
|Small size 9g servo motor suitable for control by the 'Servo Controller' component.
 
−
Use the 'Link to...' property to attach other objects to the rotor for emulating
 
−
mechanical systems.
 
−
Send a virtual PWM signal to the servo by selecting it as a target of the 'Servo Controller' component.
 
−
|-
 
−
|[[File:Component Icon cc031290_2255_4e8d_b382_1998c8dda95a.png|Image]] Standard Servo
 
−
|Standard size servo motor suitable for control by the 'Servo Controller' component.
 
−
Use the 'Link to...' property to attach other objects to the rotor for emulating
 
−
mechanical systems.
 
−
Send a virtual PWM signal to the servo by selecting it as a target of the 'Servo Controller' component.
 
−
|}
 
  
−
==Examples==
 
−
''<span style="color:red;">No additional examples</span>''
 
  
 +
''No detailed description exists yet for this component''
  
−
==Downloadable macro reference==
+
==Examples==
  
−
''This component does not contain any downloadable macros''
 
  
−
==Simulation macro reference==
 
  
−
===<span style="font-weight: normal;"><u><tt>SetTarget</tt></u></span>===
 
−
Set a panel object to be 'connected' to the servo's.
 
  
−
The connected object will then move as if connected mechanically to
 
  
−
the servo's actuator.
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|HANDLE]] ''Target''
 
−
::Object to be moved by the motor
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
  
  
  
−
==Property reference==
 
−
<span style="font-weight: normal;"><u>Moving Part</u></span>
 
  
−
This property is of type ''Panel object'' and can be referenced with the variable name ''moving_object''.
 
  
−
Set an object on the System Panel to be the servo's actuator.
 
  
−
The object's position at the moment of selection is taken to be the 'rest' position of the actuator - the
+
''<span style="color:red;">No additional examples</span>''
  
−
maximum and minimum angles will be measured from this position.
 
  
−
<span style="font-weight: normal;"><u>Axis Object</u></span>
 
  
−
This property is of type ''Panel object'' and can be referenced with the variable name ''axis_object''.
 
  
−
Set a panel object to be the centre of rotation of the servo's actuator.
 
  
−
<span style="font-weight: normal;"><u>Move Around</u></span>
 
  
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''rot_axis''.
 
  
−
Set the axis around which the actuator will revolve.
 
  
−
If an 'Axis Object' is chosen, this will be a local axis of the chosen object, otherwise it will be the
 
  
−
current world axes.
 
  
−
<span style="font-weight: normal;"><u>Minimum (degrees)</u></span>
 
  
−
This property is of type ''Floating point'' and can be referenced with the variable name ''rot_min''.
 
  
−
Angle that the servo turns when the PWM signal is at its minimum.
 
  
−
Measured from the actuator object's 'rest' position, chosen at the time of connecting the object.
+
==Macro reference==
  
−
<span style="font-weight: normal;"><u>Maximum (degrees)</u></span>
+
===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" | Set a panel object to be 'connected' to the servo's. The connected object will then move as if connected mechanically to the servo's actuator.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | Target
 +
|-
 +
| colspan="2" | Object to be moved by the motor&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 ''rot_max''.
 
  
−
Angle that the servo turns when the PWM signal is at its maximum.
+
==Property reference==
  
−
Measured from the actuator object's 'rest' position, chosen at the time of connecting the object.
+
{| 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-17-icon.png]]
 +
| width="90%" | Moving Part
 +
|-
 +
| colspan="2" | Set an object on the System Panel to be the servo's actuator. The object's position at the moment of selection is taken to be the 'rest' position of the actuator - the maximum and minimum angles will be measured from this position.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-17-icon.png]]
 +
| width="90%" | Axis Object
 +
|-
 +
| colspan="2" | Set a panel object to be the centre of rotation of the servo's actuator.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Move Around
 +
|-
 +
| colspan="2" | Set the axis around which the actuator will revolve. If an 'Axis Object' is chosen, this will be a local axis of the chosen object, otherwise it will be the current world axes.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Movement Type
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 +
| width="90%" | Minimum (degrees)
 +
|-
 +
| colspan="2" | Angle that the servo turns when the PWM signal is at its minimum. Measured from the actuator object's 'rest' position, chosen at the time of connecting the object.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 +
| width="90%" | Maximum (degrees)
 +
|-
 +
| colspan="2" | Angle that the servo turns when the PWM signal is at its maximum. Measured from the actuator object's 'rest' position, chosen at the time of connecting the object.&nbsp;
 +
|}

Latest revision as of 11:57, 3 November 2023

Author Matrix Ltd
Version 1.1
Category Mechatronics


Servo Motor Template component

Base component for creating custom servo motor simulations. Recieves messages from the the 'Servo Controller' component. Macro 'SetTarget' allows external objects to be moved by the servo for mechanical simulations.

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples







Macro reference

SetTarget

Fc9-comp-macro.png SetTarget
Set a panel object to be 'connected' to the servo's. The connected object will then move as if connected mechanically to the servo's actuator. 
Fc9-h32-icon.png - HANDLE Target
Object to be moved by the motor 
Fc9-void-icon.png - VOID Return


Property reference

Fc9-prop-icon.png Properties
Fc9-type-17-icon.png Moving Part
Set an object on the System Panel to be the servo's actuator. The object's position at the moment of selection is taken to be the 'rest' position of the actuator - the maximum and minimum angles will be measured from this position. 
Fc9-type-17-icon.png Axis Object
Set a panel object to be the centre of rotation of the servo's actuator. 
Fc9-type-16-icon.png Move Around
Set the axis around which the actuator will revolve. If an 'Axis Object' is chosen, this will be a local axis of the chosen object, otherwise it will be the current world axes. 
Fc9-type-16-icon.png Movement Type
 
Fc9-type-15-icon.png Minimum (degrees)
Angle that the servo turns when the PWM signal is at its minimum. Measured from the actuator object's 'rest' position, chosen at the time of connecting the object. 
Fc9-type-15-icon.png Maximum (degrees)
Angle that the servo turns when the PWM signal is at its maximum. Measured from the actuator object's 'rest' position, chosen at the time of connecting the object. 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Servo_Motor_Template_(Mechatronics)&oldid=39800"