Definition:

#include <aMotion.h>
object code: aMotion.c



aErr aMotion_DecodeFrequency(

const short paramVal, long* pFrequency);

Parameters:

paramVal	-	The 2-byte value with the encoded PWM frequency.
pFrequency	-	Address of long where the result will be stored.

Return Value:

This routine returns aErrNone when there are no errors.

Description:

This routine converts two bytes encoded with the current PWM frequency to a value in kilohertz.  The coded value for the current PWM frequency may be obtained by calling the aMotion_GetMode routine.

See the cmdMO_CFG documentation for a discussion of the encoding for the PWM frequency.

Related:

aMotion_GetMode, aMotion_SetMode