Difference between revisions of "Component: DC Motor (Mechatronics)"

From Flowcode Help
Jump to navigationJump to search
Line 16: Line 16:
  
 
==Component Source Code==
 
==Component Source Code==
 +
 +
Please click here to download the component source project: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_DCMotor_2d.fcfx FC_Comp_Source_DCMotor_2d.fcfx]
  
 
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_DCMotor_2d.fcfx FC_Comp_Source_DCMotor_2d.fcfx]
 
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_DCMotor_2d.fcfx FC_Comp_Source_DCMotor_2d.fcfx]
  
 
==Detailed description==
 
==Detailed description==
 +
 +
  
  
Line 36: Line 40:
  
 
==Examples==
 
==Examples==
 +
 +
  
  
Line 56: Line 62:
  
 
==Macro reference==
 
==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;" | '''Coast'''
 +
|-
 +
| colspan="2" | Turn off power to the motor by setting the pins according to the 'Coast Pattern' property. 
 +
|-
 +
|-
 +
| 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;" | '''Break'''
 +
|-
 +
| colspan="2" | Actively drives both ends of the motor by setting the pins according to the 'Brake Pattern' property. 
 +
|-
 +
|-
 +
| 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;" | '''Disable'''
 +
|-
 +
| colspan="2" | Disable the motor output 
 +
|-
 +
|-
 +
| 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;" | '''Forwards'''
 +
|-
 +
| colspan="2" | Set the motor turning in the forwards direction by setting the pins according to the 'Forwards Pattern' property. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Duty
 +
|-
 +
| colspan="2" | Sets the motor power for PWM or H-Bridge outputs 
 +
|-
 +
| 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;" | '''Enable'''
 +
|-
 +
| colspan="2" | Enables the motor output 
 +
|-
 +
|-
 +
| 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" | Set the motor turning in the reverse direction by setting the pins according to the 'Reverse Pattern' property. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Duty
 +
|-
 +
| colspan="2" | Sets the motor power for PWM or H-Bridge outputs 
 +
|-
 +
| 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;" | '''GetSimAngle'''
 +
|-
 +
| colspan="2" | Gets the angle of the simulated motor shaft in degrees. 
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| 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;" | Control Type
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Control Method
 +
|-
 +
| colspan="2" | Controls how the motor is controlled. On/Off requires output pins PWM requires a hardware PWM channel H-Bridge requires a hardware H-Bridge channel 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Bridge Type
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Enable Method
 +
|-
 +
| colspan="2" | Decides how the motor outputs are enabled. 
 +
|-
 +
| 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-5-icon.png]]
 +
| width="90%" | PinA
 +
|-
 +
| colspan="2" | First control pin - set 'pattern' properties below to set the pin's function. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | PinB
 +
|-
 +
| colspan="2" | Second control pin - set 'pattern' properties below to set the pin's function. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Forwards Pattern
 +
|-
 +
| colspan="2" | The state of pins A and B required to drive the motor in a forwards direction. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Reverse Pattern
 +
|-
 +
| colspan="2" | States of pins A and B required to drive the motor in a reverse direction. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Coast Pattern
 +
|-
 +
| colspan="2" | States of pins A and B required to stop the motor. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Brake Pattern
 +
|-
 +
| colspan="2" | States of pins A and B required to stop the motor. 
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation Settings
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-2-icon.png]]
 +
| width="90%" | Label Colour
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 +
| width="90%" | Speed
 +
|-
 +
| colspan="2" | Speed of the motor when turned on. Positive speed -> Counter-clockwsie Negative speed -> Clockwise  
 +
|}==Macro reference==
  
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"

Revision as of 15:20, 20 January 2023

Author Matrix TSL
Version 1.2
Category Mechatronics


DC Motor component

DC Motor that can be driven in one or both directions using digital output pins, PWM or HBRIDGE peripherals.

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

DALI Slave Example, listens for DALI messages and checks that the group is correct before attempting to process the request and if required reply to the master. FC6 Icon.png DALI Slave Example1


For a DALI Master example see: Component: DALI Master (Comms: System)

Macro reference

Fc9-comp-macro.png Coast
Turn off power to the motor by setting the pins according to the 'Coast Pattern' property. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Break
Actively drives both ends of the motor by setting the pins according to the 'Brake Pattern' property. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Disable
Disable the motor output 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Forwards
Set the motor turning in the forwards direction by setting the pins according to the 'Forwards Pattern' property. 
Fc9-u16-icon.png - UINT Duty
Sets the motor power for PWM or H-Bridge outputs 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Enable
Enables the motor output 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Reverse
Set the motor turning in the reverse direction by setting the pins according to the 'Reverse Pattern' property. 
Fc9-u16-icon.png - UINT Duty
Sets the motor power for PWM or H-Bridge outputs 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetSimAngle
Gets the angle of the simulated motor shaft in degrees. 
Fc9-f32-icon.png - FLOAT Return



Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Control Type
Fc9-type-16-icon.png Control Method
Controls how the motor is controlled. On/Off requires output pins PWM requires a hardware PWM channel H-Bridge requires a hardware H-Bridge channel 
Fc9-type-16-icon.png Bridge Type
 
Fc9-type-16-icon.png Enable Method
Decides how the motor outputs are enabled. 
Fc9-conn-icon.png Connections
Fc9-type-5-icon.png PinA
First control pin - set 'pattern' properties below to set the pin's function. 
Fc9-type-5-icon.png PinB
Second control pin - set 'pattern' properties below to set the pin's function. 
Fc9-type-16-icon.png Forwards Pattern
The state of pins A and B required to drive the motor in a forwards direction. 
Fc9-type-16-icon.png Reverse Pattern
States of pins A and B required to drive the motor in a reverse direction. 
Fc9-type-16-icon.png Coast Pattern
States of pins A and B required to stop the motor. 
Fc9-type-16-icon.png Brake Pattern
States of pins A and B required to stop the motor. 
Fc9-conn-icon.png Simulation Settings
Fc9-type-2-icon.png Label Colour
 
Fc9-type-15-icon.png Speed
Speed of the motor when turned on. Positive speed -> Counter-clockwsie Negative speed -> Clockwise  

==Macro reference==

Fc9-comp-macro.png Coast
Turn off power to the motor by setting the pins according to the 'Coast Pattern' property. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Break
Actively drives both ends of the motor by setting the pins according to the 'Brake Pattern' property. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Disable
Disable the motor output 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Forwards
Set the motor turning in the forwards direction by setting the pins according to the 'Forwards Pattern' property. 
Fc9-u16-icon.png - UINT Duty
Sets the motor power for PWM or H-Bridge outputs 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Enable
Enables the motor output 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Reverse
Set the motor turning in the reverse direction by setting the pins according to the 'Reverse Pattern' property. 
Fc9-u16-icon.png - UINT Duty
Sets the motor power for PWM or H-Bridge outputs 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetSimAngle
Gets the angle of the simulated motor shaft in degrees. 
Fc9-f32-icon.png - FLOAT Return



Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Control Type
Fc9-type-16-icon.png Control Method
Controls how the motor is controlled. On/Off requires output pins PWM requires a hardware PWM channel H-Bridge requires a hardware H-Bridge channel 
Fc9-type-16-icon.png Bridge Type
 
Fc9-type-16-icon.png Enable Method
Decides how the motor outputs are enabled. 
Fc9-conn-icon.png Connections
Fc9-type-5-icon.png PinA
First control pin - set 'pattern' properties below to set the pin's function. 
Fc9-type-5-icon.png PinB
Second control pin - set 'pattern' properties below to set the pin's function. 
Fc9-type-16-icon.png Forwards Pattern
The state of pins A and B required to drive the motor in a forwards direction. 
Fc9-type-16-icon.png Reverse Pattern
States of pins A and B required to drive the motor in a reverse direction. 
Fc9-type-16-icon.png Coast Pattern
States of pins A and B required to stop the motor. 
Fc9-type-16-icon.png Brake Pattern
States of pins A and B required to stop the motor. 
Fc9-conn-icon.png Simulation Settings
Fc9-type-2-icon.png Label Colour
 
Fc9-type-15-icon.png Speed
Speed of the motor when turned on. Positive speed -> Counter-clockwsie Negative speed -> Clockwise  

==Macro reference==

Fc9-comp-macro.png Coast
Turn off power to the motor by setting the pins according to the 'Coast Pattern' property. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Break
Actively drives both ends of the motor by setting the pins according to the 'Brake Pattern' property. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Disable
Disable the motor output 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Forwards
Set the motor turning in the forwards direction by setting the pins according to the 'Forwards Pattern' property. 
Fc9-u16-icon.png - UINT Duty
Sets the motor power for PWM or H-Bridge outputs 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Enable
Enables the motor output 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Reverse
Set the motor turning in the reverse direction by setting the pins according to the 'Reverse Pattern' property. 
Fc9-u16-icon.png - UINT Duty
Sets the motor power for PWM or H-Bridge outputs 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png GetSimAngle
Gets the angle of the simulated motor shaft in degrees. 
Fc9-f32-icon.png - FLOAT Return



Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Control Type
Fc9-type-16-icon.png Control Method
Controls how the motor is controlled. On/Off requires output pins PWM requires a hardware PWM channel H-Bridge requires a hardware H-Bridge channel 
Fc9-type-16-icon.png Bridge Type
 
Fc9-type-16-icon.png Enable Method
Decides how the motor outputs are enabled. 
Fc9-conn-icon.png Connections
Fc9-type-5-icon.png PinA
First control pin - set 'pattern' properties below to set the pin's function. 
Fc9-type-5-icon.png PinB
Second control pin - set 'pattern' properties below to set the pin's function. 
Fc9-type-16-icon.png Forwards Pattern
The state of pins A and B required to drive the motor in a forwards direction. 
Fc9-type-16-icon.png Reverse Pattern
States of pins A and B required to drive the motor in a reverse direction. 
Fc9-type-16-icon.png Coast Pattern
States of pins A and B required to stop the motor. 
Fc9-type-16-icon.png Brake Pattern
States of pins A and B required to stop the motor. 
Fc9-conn-icon.png Simulation Settings
Fc9-type-2-icon.png Label Colour
 
Fc9-type-15-icon.png Speed
Speed of the motor when turned on. Positive speed -> Counter-clockwsie Negative speed -> Clockwise  
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_DC_Motor_(Mechatronics)&oldid=33194"