Component: PWM (CAL) (Misc)

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.

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.

Downloadable 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

	ChangeFrequency
Advanced function for the ESP32 hardware to set the PWM output frequency.
- ULONG	Frequency
New PWM desired frequency in Hz
- 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

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

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

	InitRXConfig
Initialization setting for RX Buffer Config
- BYTE	Buffer
Buffer Number (0 or 1)
- BYTE	Value
Config data byte
- VOID	Return

	Uninit
Uninitialises the CAN, freeing its connections for general use
- VOID	Return

	GetList
Get the Filter List of the Named Property
- STRING	Name
- STRING	Return

	GetRxIdent
Generic function to get the received message Identifier.
- BYTE	buffer
- ULONG	Return

	SetRxFilterStd
Sets the 16-bit filter as a bit-mask of the standard ID for received messages The messages are accepted if (StdID & Mask) == Filter
- BYTE	Filter
Filter number
- BYTE	Hi
The high byte (bits 8-15) of the ID
- BYTE	Lo
The low byte (bits 0-7) of the ID
- VOID	Return

	SetRxFilterExd
Sets the 32-bit filter as a bit-mask of the extended ID for received messages The messages are accepted if (ExtID & Mask) == Filter
- BYTE	Filter
Send filter: 0 to 3
- BYTE	ID3
The high byte (bits 24-31) of the ID
- BYTE	ID2
The mid-high byte (bits 16-23) of the ID
- BYTE	ID1
The mid-low byte (bits 8-15) of the ID
- BYTE	ID0
The low byte (bits 0-7) of the ID
- VOID	Return

Property reference

	Properties
	Channel
PWM Channel selector
	Alt Pin Enable
Alternative Pin Enable (if available on target device)
	Port
	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
	Connections
	Simulations