Skip to content

Commit cf8f065

Browse files
committed
Merge pull request #5 in MCU16CE/dspic33ck-power-pwm-phase-shift from ~A14426/dspic33ck-power-pwm-phase-shift:feature/initial_release to develop
* commit '260bbefd7d905076bb2b02ba6f68842e09a99ab2': try another readme edit try another readme edit edit readme.md file another edit for README.md fie edited changelog.md and README.md file
2 parents 6fdfc93 + 260bbef commit cf8f065

File tree

2 files changed

+10
-11
lines changed

2 files changed

+10
-11
lines changed

README.md

+9-10
Original file line numberDiff line numberDiff line change
@@ -74,24 +74,23 @@ Although MCC also supports configuration tools for the High Resolution PWM modul
7474
In each PWM example code project the PWM configuration procedure is located in the user file pwm.c, where each register bit required to achieve/enable the specific function or mode of interest is set and its function described with comments.
7575
Once users are familiar with the architecture, features and capabilities, both configuration options (generic peripheral library or MCC) may be used.
7676

77-
*a) Project Directory Structure*
78-
The project contains two sub-directories
79-
- config: location of all hardware abstraction header files
80-
- common: location of generic peripheral drivers
81-
- MCC Generated Files: all device configuration files auto-generated by MCC
82-
- root: application user code
77+
#### a) Project Directory Structure <br/>
78+
The project contains four sub-directories
79+
1. config: location of all hardware abstraction header files
80+
2. common: location of generic peripheral drivers
81+
3. MCC Generated Files: all device configuration files auto-generated by MCC
82+
4. root: application user code
8383

8484
On the hard drive, main.c/h are located in the MPLAB X project directory.
8585
All other user files, incl. peripheral drivers, are located in the sub-directory *sources*.
8686
Files generated by MCC are always located in their own sub-directory *mcc_generated-files*
8787

88-
*b) Using the generic PWM peripheral driver*
89-
The PWM peripheral driver files p33c_pwm.c/h provide data structures representing the Special Function Register (SFR) sets of PWM generators and the PAM base module. These 'virtual' PWM objects are used to load, read and modify PWM generator configurations without the need to hard-coded instructions, which would make the code hard to migrate from one peripheral to another or even across devices.
90-
To simplify PWM configurations, in these examples, each register is reset to a known default state before the user configuration of interest is set. Thus, only the register setting which really matter for a certain features/function are shown.
88+
#### b) Using the generic PWM peripheral driver <br/>
89+
The PWM peripheral driver files p33c_pwm.c/h provide data structures representing the Special Function Register (SFR) sets of PWM generators and the PWM base module. These 'virtual' PWM objects are used to load, read and modify PWM generator configurations without the need for hard-coded instructions, which would make the code hard to migrate from one peripheral to another or even across devices.To simplify PWM configurations, in these examples, each register is reset to a known default state before the user configuration of interest is set. Thus, only the register setting which really matters for a certain features/function are shown.
9190

9291
To learn more about the generic PWM driver, its supported features and intended use cases, please read the comments inside p33c_pwm.c.
9392

94-
*c) Executing the Code Example*
93+
#### c) Executing the Code Example <br/>
9594
This code has been written to automatically start up and perform the function of interest. Please read the demo instructions on top of file main.c to learn more about the code example, test points, expected signals and demo mode operation.
9695

9796

changelog.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# dspic33c-power-pwm-phase-shift, release v1.0.0
1+
# dspic33ck-power-pwm-phase-shift, release v1.0.0
22

33
### Release Highlights
44
This is the initial release demonstrating the basic configuration of a high-resolution PWM generator of the dsPIC33C family of devices.

0 commit comments

Comments
 (0)