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

Revision as of 12:02, 3 February 2023

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.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_temp/PWM.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_temp/PWM.fcfx

Detailed description

No detailed description exists yet for this component

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
- 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

@@ Line 17: / Line 17: @@
 ==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 download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_temp/PWM.fcfx FC_Comp_Source_temp/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]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_temp/PWM.fcfx FC_Comp_Source_temp/PWM.fcfx]
 ==Detailed description==
@@ Line 48: / Line 48: @@
 ''<span style="color:red;">No additional examples</span>''
@@ Line 55: / Line 57: @@
 ==Macro reference==
-===GetValue===
+===ChangeFrequency===
 {| 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'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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''
 |}
@@ Line 112: / Line 114: @@
-===SetDuty8Bit===
+===Enable===
 {| 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'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Enable'''
 |-
-| colspan="2" | Set the Duty cycle (0-255) for this PWM Channel&nbsp;
+| colspan="2" | Enable this PWM Channel&nbsp;
 |-
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| 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
@@ Line 131: / Line 128: @@
-===Enable===
+===GetList===
 {| 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'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetList'''
+|-
+| colspan="2" | Returns CHANNEL or PRESCALE list from the FCD and updates the internal property &nbsp;
+|-
 |-
-| colspan="2" | Enable this PWM Channel&nbsp;
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | Name
 |-
+| 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''
 |}
-===ChangeFrequency===
+===GetValue===
 {| 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;" | '''ChangeFrequency'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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''
 |}
-===SetValue===
+===SetDuty10Bit===
 {| 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'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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
@@ Line 188: / Line 185: @@
-===SetDuty10Bit===
+===SetDuty8Bit===
 {| 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'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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
 |-
-| 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
@@ Line 226: / Line 223: @@
-===GetList===
+===SetValue===
 {| 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'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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 237: @@
 | 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''
 |}