com.digi.android.pwm

Class PWM

java.lang.Object

com.digi.android.pwm.PWM

public class PWM
extends java.lang.Object

Represents a PWM (Pulse Width Modulation) channel. A PWM channel lets you control the physical module PWM interface.

To obtain an instance of the PWM you have to use the PWMManager.createPWM(int) method.

Field Summary

Fields

Modifier and Type	Field and Description
static int	FREQUENCY Default frequency configured in the PWM: 21000 Hz.
static long	PERIOD Default period configured in the PWM: 47619L nanoseconds.

Method Summary

Methods

Modifier and Type	Method and Description
int	getChannelIndex() Retrieves the PWM channel index.
double	getDutyCycle() Retrieves the duty cycle percentage configured in this PWM channel.
void	setDutyCycle(double dutyCycle) Sets the duty cycle percentage of the PWM signal.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FREQUENCY

public static final int FREQUENCY

Default frequency configured in the PWM: 21000 Hz.

See Also:

Constant Field Values

PERIOD

public static final long PERIOD

Default period configured in the PWM: 47619L nanoseconds.

See Also:

Constant Field Values

Method Detail

getChannelIndex

public int getChannelIndex()

Retrieves the PWM channel index.

Returns:

The PWM channel index.

setDutyCycle

public void setDutyCycle(double dutyCycle)
                  throws java.lang.IllegalArgumentException,
                         PWMException

Sets the duty cycle percentage of the PWM signal.

Parameters:

dutyCycle - The duty cycle percentage of the PWM signal (0 to 100%).

Throws:

java.lang.IllegalArgumentException - If dutyCycle < 0 or dutyCycle > 100.

PWMException - If there is any error setting the duty cycle.

getDutyCycle

public double getDutyCycle()
                    throws PWMException

Retrieves the duty cycle percentage configured in this PWM channel.

Returns:

dutyCycle The duty cycle percentage configured in this PWM channel (0 to 100%).

Throws:

PWMException - If there is any error reading the duty cycle.