Package 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	Description
static int	FREQUENCY	Deprecated. This constant is no longer acceptable for default frequency. Use getFrequency()
static long	PERIOD	Deprecated. This constant is no longer acceptable for default period. Use getPeriod()

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object other)
int	getChannelIndex()	Retrieves the PWM channel index.
PWMChip	getChip()	Retrieves the PWM chip.
double	getDutyCycle()	Deprecated. This method is no longer acceptable to read the PWM channel duty cycle percentage. Use getDutyCyclePercentage() or getDutyCycleRaw() instead.
int	getDutyCyclePercentage()	Retrieves the configured duty cycle percentage of this PWM channel.
long	getDutyCycleRaw()	Retrieves the configured duty cycle of this PWM channel in nanoseconds.
long	getFrequency()	Retrieves the configured frequency of this PWM channel in Hz.
long	getPeriod()	Retrieves the configured period of this PWM channel in nanoseconds.
PWMPolarity	getPolarity()	Retrieves the configured polarity of this PWM channel.
int	hashCode()
boolean	isEnabled()	Retrieves the enable status of this PWM channel.
void	setDutyCycle(double dutyCycle)	Deprecated. This method is no longer acceptable to set the PWM channel duty cycle percentage. Use setDutyCyclePercentage(double) or setDutyCycleRaw(long) instead.
void	setDutyCyclePercentage(int percentage)	Sets the duty cycle percentage of the PWM signal.
void	setDutyCycleRaw(long dutyCycle)	Sets the duty cycle of the PWM signal in nanoseconds.
void	setEnabled(boolean enable)	Changes the enable status of this PWM channel.
void	setFrequency(long frequency)	Sets the frequency of the PWM signal in Hz.
void	setPeriod(long period)	Sets the period of the PWM signal in nanoseconds.
void	setPolarity(PWMPolarity polarity)	Sets the polarity of the PWM signal.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

FREQUENCY

@Deprecated
public static final int FREQUENCY

Deprecated. This constant is no longer acceptable for default frequency. Use getFrequency()

Default frequency configured in the PWM: Hz.

See Also:

Constant Field Values

PERIOD

@Deprecated
public static final long PERIOD

Deprecated. This constant is no longer acceptable for default period. Use getPeriod()

Default period configured in the PWM: nanoseconds.

See Also:

Constant Field Values

Method Detail

getChip

public PWMChip getChip()

Retrieves the PWM chip.

Returns:

The PWM chip.

See Also:

getChannelIndex(), PWMChip

getChannelIndex

public int getChannelIndex()

Retrieves the PWM channel index.

Returns:

The PWM channel index.

See Also:

getChip()

setDutyCycle

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

Deprecated. This method is no longer acceptable to set the PWM channel duty cycle percentage.

Use setDutyCyclePercentage(double) or setDutyCycleRaw(long) instead.

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

@Deprecated
public double getDutyCycle()
                    throws PWMException

Deprecated. This method is no longer acceptable to read the PWM channel duty cycle percentage.

Use getDutyCyclePercentage() or getDutyCycleRaw() instead.

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.

setPeriod

public void setPeriod(long period)
               throws java.lang.IllegalArgumentException,
                      PWMException

Sets the period of the PWM signal in nanoseconds.

Parameters:

period - The new period to set in nanoseconds.

Throws:

java.lang.IllegalArgumentException - If period < 1

PWMException - If there is any error setting the period.

See Also:

getPeriod(), #setFrequency(int), getFrequency()

getPeriod

public long getPeriod()
               throws PWMException

Retrieves the configured period of this PWM channel in nanoseconds.

Returns:

The configured period of this PWM channel in nanoseconds.

Throws:

PWMException - If there is any error reading the period.

See Also:

setPeriod(long), #setFrequency(int), getFrequency()

setDutyCycleRaw

public void setDutyCycleRaw(long dutyCycle)
                     throws java.lang.IllegalArgumentException,
                            PWMException

Sets the duty cycle of the PWM signal in nanoseconds.

Parameters:

dutyCycle - The new duty cycle to set in nanoseconds.

Throws:

java.lang.IllegalArgumentException - If dutyCycle < 0 or the duty cycle to set is greater than the configured period.

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

See Also:

getDutyCycleRaw(), setDutyCyclePercentage(int), getDutyCyclePercentage()

getDutyCycleRaw

public long getDutyCycleRaw()
                     throws PWMException

Retrieves the configured duty cycle of this PWM channel in nanoseconds.

Returns:

The configured duty cycle of this PWM channel in nanoseconds.

Throws:

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

See Also:

setDutyCycleRaw(long), setDutyCyclePercentage(int), getDutyCyclePercentage()

setDutyCyclePercentage

public void setDutyCyclePercentage(int percentage)
                            throws java.lang.IllegalArgumentException,
                                   PWMException

Sets the duty cycle percentage of the PWM signal.

Parameters:

percentage - The new duty cycle percentage to set.

Throws:

java.lang.IllegalArgumentException - If percentage < 0 or if percentage > 100

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

See Also:

setDutyCycleRaw(long), getDutyCycleRaw(), getDutyCyclePercentage()

getDutyCyclePercentage

public int getDutyCyclePercentage()
                           throws PWMException

Retrieves the configured duty cycle percentage of this PWM channel.

Returns:

The configured duty cycle percentage of this PWM channel.

Throws:

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

See Also:

setDutyCycleRaw(long), getDutyCycleRaw(), setDutyCyclePercentage(int)

setFrequency

public void setFrequency(long frequency)
                  throws java.lang.IllegalArgumentException,
                         PWMException

Sets the frequency of the PWM signal in Hz.

Parameters:

frequency - The new frequency to set in Hz.

Throws:

java.lang.IllegalArgumentException - If frequency <= 0 or if frequency > 1000000000

PWMException - If there is any error setting the frequency.

See Also:

setPeriod(long), getPeriod(), getFrequency()

getFrequency

public long getFrequency()
                  throws PWMException

Retrieves the configured frequency of this PWM channel in Hz.

Returns:

The configured frequency of this PWM channel in Hz.

Throws:

PWMException - If there is any error reading the frequency.

See Also:

setPeriod(long), getPeriod(), setFrequency(long)

setPolarity

public void setPolarity(PWMPolarity polarity)
                 throws java.lang.NullPointerException,
                        PWMException

Sets the polarity of the PWM signal.

Parameters:

polarity - The new polarity to set.

Throws:

java.lang.NullPointerException - If polarity == null

PWMException - If there is any error setting the polarity.

See Also:

PWMPolarity, getPolarity()

getPolarity

public PWMPolarity getPolarity()
                        throws PWMException

Retrieves the configured polarity of this PWM channel.

Returns:

The configured polarity of this PWM channel.

Throws:

PWMException - If there is any error reading the polarity.

See Also:

PWMPolarity, setPolarity(PWMPolarity)

setEnabled

public void setEnabled(boolean enable)
                throws PWMException

Changes the enable status of this PWM channel.

Parameters:

enable - true to enable the PWM channel, false to disable it.

Throws:

PWMException - If there is any error changing the enable status.

See Also:

isEnabled()

isEnabled

public boolean isEnabled()
                  throws PWMException

Retrieves the enable status of this PWM channel.

Returns:

true if PWM channel is enabled, false otherwise.

Throws:

PWMException - If there is any error reading the enable status.

See Also:

setEnabled(boolean)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object