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

Revision as of 11:51, 3 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

GetValue

	GetValue
Returns Named property Value
- STRING	Name

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

SetDuty8Bit

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

Enable

	Enable
Enable this PWM Channel
- 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

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

GetList

	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

@@ Line 78: / Line 78: @@
 Example showing how to build a component using a CAL component [[Using_CAL_Components|Using CAL Components]].
@@ Line 84: / Line 86: @@
 ==Macro reference==
+===GetValue===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 102: / Line 105: @@
+===ChangePeriod===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 125: / Line 129: @@
+===Disable===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 138: / Line 143: @@
+===SetDuty8Bit===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 156: / Line 162: @@
+===Enable===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 169: / Line 176: @@
+===SetValue===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 192: / Line 200: @@
+===SetDuty10Bit===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 210: / Line 219: @@
+===GetList===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-