Jump to content

Component: PWM Free (Peripheral CAL): Difference between revisions

From Flowcode Help
← Older editNewer edit →

Wiki bot (talk | contribs)

3 user groups
14,227 edits
No edit summary
No edit summary
Line 17: Line 17:
==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_PWM_Free.fcfx FC_Comp_Source_PWM_Free.fcfx]
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_PWM_Free.fcfx FC_Comp_Source_PWM_Free.fcfx]


Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_PWM_Free.fcfx FC_Comp_Source_PWM_Free.fcfx]
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_PWM_Free.fcfx FC_Comp_Source_PWM_Free.fcfx]


==Detailed description==
==Detailed description==




Line 46: Line 48:


==Examples==
==Examples==




Line 73: Line 77:


==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;" | '''GetValue'''
|-
| colspan="2" | Returns Named property Value  
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Name
|-
| colspan="2" |  
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
| 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;" | '''ChangePeriod'''
|-
| colspan="2" | Change the Period (and prescaler) for this PWM Channel 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | period
|-
| colspan="2" | period value PIC/AVR: 0-255 16-bit PIC: 0-65535 
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | prescaler
|-
| colspan="2" | prescaler 1,4,16,64 
|-
| 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 this PWM Channel 
|-
|-
| 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;" | '''SetDuty8Bit'''
|-
| colspan="2" | Set the Duty cycle (0-255) for this PWM Channel 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | duty
|-
| colspan="2" | duty value 0 - 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;" | '''Enable'''
|-
| colspan="2" | Enable this PWM Channel 
|-
|-
| 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;" | '''SetValue'''
|-
| colspan="2" | Sets the Value of the property PERIOD, PRESCALE or CHANNEL (if CHANNEL also updates the PORT from FCD)  
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Name
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Value
|-
| 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;" | '''SetDuty10Bit'''
|-
| colspan="2" | Set the Duty Cycle for this PWM Channel. PIC/AVR - Range: 0-1023 16-bit PIC - Range: 0-65535 
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | duty
|-
| colspan="2" | Duty value 0 - 1023 
|-
| 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;" | '''GetList'''
|-
| colspan="2" | Returns CHANNEL or PRESCALE list from the FCD and updates the internal property  
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Name
|-
| colspan="2" |  
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
| 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-16-icon.png]]
| width="90%" | Channel
|-
| colspan="2" | PWM Channel selector 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Alt Pin Enable
|-
| colspan="2" | Alternative Pin Enable (if available on target device) 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | Port
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
| width="90%" | Period Register
|-
| colspan="2" | PWM Period Register value 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Prescaler Divide
|-
| colspan="2" | Prescaler Divider value 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | PWM Timer
|-
| colspan="2" | Timer associated with PWM to drive the output.  Warning - All PWM channels linked to the same timer will share the same period and prescaler settings. 
|-
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
| width="90%" | Clock Speed
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Period (uS)
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Frequency (KHz)
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
| width="90%" | Master Divider
|-
| colspan="2" |  
|}==Macro reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"

Revision as of 09:59, 27 January 2023

Author Matrix Ltd
Version 1.3
Category Peripheral CAL


PWM Free component

A low level implementation giving direct access to the CAL

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

Example showing how to build a component using a CAL component Using CAL Components.


Macro reference

GetValue
Returns Named property Value  
- STRING Name
 
- STRING Return


ChangePeriod
Change the Period (and prescaler) for this PWM Channel 
- UINT period
period value PIC/AVR: 0-255 16-bit PIC: 0-65535 
- UINT prescaler
prescaler 1,4,16,64 
- VOID Return


Disable
Disable this PWM Channel 
- VOID Return


SetDuty8Bit
Set the Duty cycle (0-255) for this PWM Channel 
- BYTE duty
duty value 0 - 255 
- VOID Return


Enable
Enable this PWM Channel 
- VOID Return


SetValue
Sets the Value of the property PERIOD, PRESCALE or CHANNEL (if CHANNEL also updates the PORT from FCD)  
- STRING Name
 
- STRING Value
 
- VOID Return


SetDuty10Bit
Set the Duty Cycle for this PWM Channel. PIC/AVR - Range: 0-1023 16-bit PIC - Range: 0-65535 
- UINT duty
Duty value 0 - 1023 
- VOID Return


GetList
Returns CHANNEL or PRESCALE list from the FCD and updates the internal property  
- STRING Name
 
- STRING Return



Property reference

Properties
Channel
PWM Channel selector 
Alt Pin Enable
Alternative Pin Enable (if available on target device) 
Port
 
Period Register
PWM Period Register value 
Prescaler Divide
Prescaler Divider value 
PWM Timer
Timer associated with PWM to drive the output. Warning - All PWM channels linked to the same timer will share the same period and prescaler settings. 
Clock Speed
 
Period (uS)
 
Frequency (KHz)
 
Master Divider
 

==Macro reference==

GetValue
Returns Named property Value  
- STRING Name
 
- STRING Return


ChangePeriod
Change the Period (and prescaler) for this PWM Channel 
- UINT period
period value PIC/AVR: 0-255 16-bit PIC: 0-65535 
- UINT prescaler
prescaler 1,4,16,64 
- VOID Return


Disable
Disable this PWM Channel 
- VOID Return


SetDuty8Bit
Set the Duty cycle (0-255) for this PWM Channel 
- BYTE duty
duty value 0 - 255 
- VOID Return


Enable
Enable this PWM Channel 
- VOID Return


SetValue
Sets the Value of the property PERIOD, PRESCALE or CHANNEL (if CHANNEL also updates the PORT from FCD)  
- STRING Name
 
- STRING Value
 
- VOID Return


SetDuty10Bit
Set the Duty Cycle for this PWM Channel. PIC/AVR - Range: 0-1023 16-bit PIC - Range: 0-65535 
- UINT duty
Duty value 0 - 1023 
- VOID Return


GetList
Returns CHANNEL or PRESCALE list from the FCD and updates the internal property  
- STRING Name
 
- STRING Return



Property reference

Properties
Channel
PWM Channel selector 
Alt Pin Enable
Alternative Pin Enable (if available on target device) 
Port
 
Period Register
PWM Period Register value 
Prescaler Divide
Prescaler Divider value 
PWM Timer
Timer associated with PWM to drive the output. Warning - All PWM channels linked to the same timer will share the same period and prescaler settings. 
Clock Speed
 
Period (uS)
 
Frequency (KHz)
 
Master Divider
 

==Macro reference==

GetValue
Returns Named property Value  
- STRING Name
 
- STRING Return


ChangePeriod
Change the Period (and prescaler) for this PWM Channel 
- UINT period
period value PIC/AVR: 0-255 16-bit PIC: 0-65535 
- UINT prescaler
prescaler 1,4,16,64 
- VOID Return


Disable
Disable this PWM Channel 
- VOID Return


SetDuty8Bit
Set the Duty cycle (0-255) for this PWM Channel 
- BYTE duty
duty value 0 - 255 
- VOID Return


Enable
Enable this PWM Channel 
- VOID Return


SetValue
Sets the Value of the property PERIOD, PRESCALE or CHANNEL (if CHANNEL also updates the PORT from FCD)  
- STRING Name
 
- STRING Value
 
- VOID Return


SetDuty10Bit
Set the Duty Cycle for this PWM Channel. PIC/AVR - Range: 0-1023 16-bit PIC - Range: 0-65535 
- UINT duty
Duty value 0 - 1023 
- VOID Return


GetList
Returns CHANNEL or PRESCALE list from the FCD and updates the internal property  
- STRING Name
 
- STRING Return



Property reference

Properties
Channel
PWM Channel selector 
Alt Pin Enable
Alternative Pin Enable (if available on target device) 
Port
 
Period Register
PWM Period Register value 
Prescaler Divide
Prescaler Divider value 
PWM Timer
Timer associated with PWM to drive the output. Warning - All PWM channels linked to the same timer will share the same period and prescaler settings. 
Clock Speed
 
Period (uS)
 
Frequency (KHz)
 
Master Divider
 

==Macro reference==

GetValue
Returns Named property Value  
- STRING Name
 
- STRING Return


ChangePeriod
Change the Period (and prescaler) for this PWM Channel 
- UINT period
period value PIC/AVR: 0-255 16-bit PIC: 0-65535 
- UINT prescaler
prescaler 1,4,16,64 
- VOID Return


Disable
Disable this PWM Channel 
- VOID Return


SetDuty8Bit
Set the Duty cycle (0-255) for this PWM Channel 
- BYTE duty
duty value 0 - 255 
- VOID Return


Enable
Enable this PWM Channel 
- VOID Return


SetValue
Sets the Value of the property PERIOD, PRESCALE or CHANNEL (if CHANNEL also updates the PORT from FCD)  
- STRING Name
 
- STRING Value
 
- VOID Return


SetDuty10Bit
Set the Duty Cycle for this PWM Channel. PIC/AVR - Range: 0-1023 16-bit PIC - Range: 0-65535 
- UINT duty
Duty value 0 - 1023 
- VOID Return


GetList
Returns CHANNEL or PRESCALE list from the FCD and updates the internal property  
- STRING Name
 
- STRING Return



Property reference

Properties
Channel
PWM Channel selector 
Alt Pin Enable
Alternative Pin Enable (if available on target device) 
Port
 
Period Register
PWM Period Register value 
Prescaler Divide
Prescaler Divider value 
PWM Timer
Timer associated with PWM to drive the output. Warning - All PWM channels linked to the same timer will share the same period and prescaler settings. 
Clock Speed
 
Period (uS)
 
Frequency (KHz)
 
Master Divider
 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_PWM_Free_(Peripheral_CAL)&oldid=34452"