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

Latest revision as of 13:12, 7 February 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

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

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

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-Please click here for the component source code: [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]
 ==Detailed description==
@@ Line 38: / Line 50: @@
 ==Examples==
@@ Line 58: / Line 80: @@
-==Downloadable 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 &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-string-icon.png]] - STRING
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}
+==Macro reference==
+===ChangePeriod===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 101: / Line 116: @@
+===Disable===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 114: / Line 130: @@
+===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 132: / Line 144: @@
+===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''
 |}
+===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;" | '''SetValue'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetValue'''
 |-
-| colspan="2" | Sets the Value of the property PERIOD, PRESCALE or CHANNEL (if CHANNEL also updates the PORT from FCD) &nbsp;
+| colspan="2" | Returns Named property Value &nbsp;
 |-
 |-
@@ Line 158: / Line 177: @@
 | colspan="2" | &nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[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''
 |}
+===SetDuty10Bit===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 186: / Line 201: @@
+===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;" | '''GetList'''
+| 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" | [[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
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+===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;" | '''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 199: / Line 234: @@
 | 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''
 |}