PIC18F4539 Datasheet, PDF (119/322 Pages) Microchip Technology – Enhanced FLASH Microcontrollers with Single Phase Induction Motor Control Kernel

PIC18FXX39
14.3.3 ProMPT API METHODS
There are 27 separate API methods for the ProMPT kernel:
Note:
The operation of the Motor Control kernel and its APIs is based on an assumed clock frequency of 20 MHz.
Changing the oscillator frequency will change the timing used in the Motor Control kernel accordingly. To
achieve the best results in motor control applications, a clock frequency of 20 MHz is highly recommended.
void ProMPT_ClearTick(void)
Resources used: 0 stack levels
Description: This function clears the Tick (62.5 ms) timer flag returned by ProMPT_tick(). This function must be
called by any routine that is used for timing purposes.
void ProMPT_DisableBoostMode(void)
Resources used: 0 stack levels
Description: This function disables the Boost mode logic. This method should be called before changing any of the
Boost mode parameters.
void ProMPT_EnableBoostMode(void)
Resources used: 0 stack levels
Description: This function enables the Boost mode logic. Boost mode is entered when a stopped drive is commanded
to start. The drive will immediately go to Boost Frequency and ramp from Start Modulation to End Modulation over the
time period, Boost Time.
unsigned char ProMPT_GetAccelRate(void)
Resources used: 1 stack level
Range of values: 0 to 255
Description: Returns the current Acceleration Rate in Hz/second.
unsigned char ProMPT_GetBoostEndModulation(void)
Resources used: 1 stack level
Range of values: 0 to 200
Description: Returns the current End Modulation (in %) used in the boost logic.
unsigned char ProMPT_GetBoostFrequency(void)
Resources used: 1 stack level
Range of values: 0 to 127
Description: Returns the current Boost Frequency in Hz.
unsigned char ProMPT_GetBoostStartModulation(void)
Resources used: 1 stack level
Range of values: 0 to BoostEndModulation
Description: Returns the Start Modulation (in %) used in the Boost logic.
 2002 Microchip Technology Inc.
Preliminary
DS30485A-page 117