Jump to content

Component: PWM (CAL) (Misc): Difference between revisions

From Flowcode Help
← Older edit

SteveT (talk | contribs)

4 user groups
6,424 edits
No edit summary
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder""
 
(14 intermediate revisions by 3 users not shown)
Line 15: Line 15:
CAL = Code Abstraction Layer - Allows one code base to run on a wide range of chips. A low level implementation giving direct access to the Pulse Width Modulation peripheral.  
CAL = Code Abstraction Layer - Allows one code base to run on a wide range of chips. A low level implementation giving direct access to the Pulse Width Modulation peripheral.  


==Component Source Code==
==Version information==
 
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_PWM.fcfx FC_Comp_Source_PWM.fcfx]


Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_PWM.fcfx FC_Comp_Source_PWM.fcfx]
Library Version, Component Version, Date, Author, Info
10, 2.2, 04-11-24, BR, Added pin caption to the remap port pin selection property
11, 2.2, 04-11-24, BR, Cleaned up pin caption from none remap port pin property
12, 2.2, 08-07-25, BR, Allowed the component to skip over unimplemented PWM channels
12, 2.2, 08-07-25, BR, Added a bubble sort to the Remap Pin property to better present the Port/Pin data
13, 2.2, 18-07-25, BR, Moved bubble sort to a timer to avoid it triggering multiple times


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


The ChangePeriod macro must be called at least once before calling the Enable macro to configure and start the PWM timer resource.


==Examples==




Line 33: Line 38:




''No detailed description exists yet for this component''


==Examples==


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




Line 47: Line 51:




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




Line 55: Line 58:
==Macro reference==
==Macro reference==


===GetValue===
===ChangeFrequency===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetValue'''
| width="90%" class="mtx-class-macrohead" | '''ChangeFrequency'''
|-
|-
| colspan="2" | Returns Named property Value &nbsp;
| colspan="2" | Advanced function for the ESP32 hardware to set the PWM output frequency.&nbsp;
|-
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
| width="90%" | Name
| width="90%" | Frequency
|-
|-
| colspan="2" | &nbsp;
| colspan="2" | New PWM desired frequency in Hz&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
| 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''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}
Line 75: Line 78:


===ChangePeriod===
===ChangePeriod===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ChangePeriod'''
| width="90%" class="mtx-class-macrohead" | '''ChangePeriod'''
|-
|-
| colspan="2" | Change the Period (and prescaler) for this PWM Channel&nbsp;
| colspan="2" | Change the Period (and prescaler) for this PWM Channel&nbsp;
Line 99: Line 102:


===Disable===
===Disable===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Disable'''
| width="90%" class="mtx-class-macrohead" | '''Disable'''
|-
|-
| colspan="2" | Disable this PWM Channel&nbsp;
| colspan="2" | Disable this PWM Channel&nbsp;
Line 112: Line 115:




===SetDuty8Bit===
===Enable===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| class="mtx-class-macrotable wikitable"
|-
| 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&nbsp;
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''Enable'''
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| colspan="2" | Enable this PWM Channel, note the ChangePeriod macro must be called at least once before calling this function  &nbsp;
| width="90%" | duty
|-
|-
| colspan="2" | duty value 0 - 255&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 131: Line 129:




===Enable===
===GetList===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''GetList'''
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| colspan="2" | Returns CHANNEL or PRESCALE list from the FCD and updates the internal property &nbsp;
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Enable'''
|-
|-
| colspan="2" | Enable this PWM Channel&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Name
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| colspan="2" | &nbsp;
|-
| 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''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




===ChangeFrequency===
===GetValue===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ChangeFrequency'''
| width="90%" class="mtx-class-macrohead" | '''GetValue'''
|-
|-
| colspan="2" | Advanced function for the ESP32 hardware to set the PWM output frequency.&nbsp;
| colspan="2" | Returns Named property Value &nbsp;
|-
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Frequency
| width="90%" | Name
|-
|-
| colspan="2" | New PWM desired frequency in Hz&nbsp;
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| 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''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




===SetValue===
===SetDuty10Bit===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetValue'''
| width="90%" class="mtx-class-macrohead" | '''SetDuty10Bit'''
|-
|-
| colspan="2" | Sets the Value of the property PERIOD, PRESCALE or CHANNEL (if CHANNEL also updates the PORT from FCD) &nbsp;
| colspan="2" | Set the Duty Cycle for this PWM Channel. PIC/AVR - Range: 0-1023 16-bit PIC - Range: 0-65535&nbsp;
|-
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Name
| width="90%" | duty
|-
|-
| colspan="2" | &nbsp;
| colspan="2" | Duty value 0 - 1023&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Value
|-
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 188: Line 186:




===SetDuty10Bit===
===SetDuty8Bit===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetDuty10Bit'''
| width="90%" class="mtx-class-macrohead" | '''SetDuty8Bit'''
|-
|-
| colspan="2" | Set the Duty Cycle for this PWM Channel. PIC/AVR - Range: 0-1023 16-bit PIC - Range: 0-65535&nbsp;
| colspan="2" | Set the Duty cycle (0-255) for this PWM Channel&nbsp;
|-
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | duty
| width="90%" | duty
|-
|-
| colspan="2" | Duty value 0 - 1023&nbsp;
| colspan="2" | duty value 0 - 255&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 208: Line 206:


===SetDutyFloat===
===SetDutyFloat===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetDutyFloat'''
| width="90%" class="mtx-class-macrohead" | '''SetDutyFloat'''
|-
|-
| colspan="2" | Advanced function for the ESP32 hardware to set the PWM duty as a percentage between 0.0 and 100.0&nbsp;
| colspan="2" | Advanced function for the ESP32 hardware to set the PWM duty as a percentage between 0.0 and 100.0&nbsp;
Line 226: Line 224:




===GetList===
===SetValue===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetList'''
| width="90%" class="mtx-class-macrohead" | '''SetValue'''
|-
|-
| colspan="2" | Returns CHANNEL or PRESCALE list from the FCD and updates the internal property &nbsp;
| colspan="2" | Sets the Value of the property PERIOD, PRESCALE or CHANNEL (if CHANNEL also updates the PORT from FCD) &nbsp;
|-
|-
|-
|-
Line 240: Line 238:
| colspan="2" | &nbsp;
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Value
|-
| 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''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




==Property reference==
==Property reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
| width="90%" class="mtx-class-macrohead" | '''Properties'''  
|-
|-
|-
|-
Line 260: Line 261:
| colspan="2" | &nbsp;
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
| width="90%" class="mtx-class-propfolder" | Connections
|-
|-
|-
|-
Line 279: Line 280:
| colspan="2" | &nbsp;
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Configuration
| width="90%" class="mtx-class-propfolder" | Configuration
|-
|-
|-
|-
Line 323: Line 324:
| colspan="2" | &nbsp;
| colspan="2" | &nbsp;
|}
|}
==Component Source Code==
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_PWM.fcfx FC_Comp_Source_PWM.fcfx]
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_PWM.fcfx FC_Comp_Source_PWM.fcfx]

Latest revision as of 14:37, 13 July 2026

Author Matrix TSL
Version 2.2
Category Misc


PWM component

CAL = Code Abstraction Layer - Allows one code base to run on a wide range of chips. A low level implementation giving direct access to the Pulse Width Modulation peripheral.

Version information

Library Version, Component Version, Date, Author, Info
10, 2.2, 04-11-24, BR, Added pin caption to the remap port pin selection property
11, 2.2, 04-11-24, BR, Cleaned up pin caption from none remap port pin property
12, 2.2, 08-07-25, BR, Allowed the component to skip over unimplemented PWM channels
12, 2.2, 08-07-25, BR, Added a bubble sort to the Remap Pin property to better present the Port/Pin data
13, 2.2, 18-07-25, BR, Moved bubble sort to a timer to avoid it triggering multiple times

Detailed description

The ChangePeriod macro must be called at least once before calling the Enable macro to configure and start the PWM timer resource.

Examples

No additional examples








Macro reference

ChangeFrequency

ChangeFrequency
Advanced function for the ESP32 hardware to set the PWM output frequency. 
- ULONG Frequency
New PWM desired frequency in Hz 
- VOID Return


ChangePeriod

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
Disable this PWM Channel 
- VOID Return


Enable

Enable
Enable this PWM Channel, note the ChangePeriod macro must be called at least once before calling this function  
- VOID Return


GetList

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


GetValue

GetValue
Returns Named property Value  
- STRING Name
 
- STRING Return


SetDuty10Bit

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


SetDuty8Bit

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


SetDutyFloat

SetDutyFloat
Advanced function for the ESP32 hardware to set the PWM duty as a percentage between 0.0 and 100.0 
- FLOAT Duty
 
- VOID Return


SetValue

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


Property reference

Properties
Enable
 
Connections
Channel
PWM Channel selector 
Alt Pin Enable
Alternative Pin Enable (if available on target device) 
Port
 
Configuration
Period Register
Allows the user to change the number of counts for the whole PWM period. Note that all PWM channels based on the same timer will share the same period overflow. PIC/AVR Range: 0 - 255 16-bit PIC Range: 0 - 65535 
Prescaler Divide
Allows the user to change the number of program cycles per PWM cycle count. Note that all PWM channels based on the same timer will share the same prescaler. 
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)
 
Frequency (Hz)
 
Master Divider
 

Component Source Code

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

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

Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_PWM_(CAL)_(Misc)&oldid=48031"