Package com.digi.android.pwm

Class PWMManager

java.lang.Object

com.digi.android.pwm.PWMManager

public class PWMManager
extends java.lang.Object

This class provides access to PWM.

This manager allows applications to create PWM objects.

Unless noted, all PWM API methods require the com.digi.android.permission.PWM permission. If your application does not have this permission it will not have access to any PWM manager feature.

See Also:

PWM

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ERROR_CHANNEL_NUMBER
static java.lang.String	ERROR_CHIP_NULL
static java.lang.String	ERROR_REMOTE_EXCEPTION

Constructor Summary

Constructors

Constructor	Description
PWMManager(android.content.Context context)	Class constructor.

Method Summary

Modifier and Type	Method	Description
PWM	createPWM(int channel)	Deprecated. This method is no longer acceptable to create a PWM object. Use createPWM(int, int) instead.
PWM	createPWM(PWMChip chip, int channel)	Creates and returns a PWM object with the given pair of chip and channel.
int[]	listChannels()	Deprecated. This method is no longer acceptable to list PWM channels. Use listPWMChips() and {@link PWMChip.listChannels()} instead.
java.util.List<PWMChip>	listPWMChips()	Lists all available PWM chips in the device.

Methods inherited from class java.lang.Object

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

Field Detail

ERROR_CHIP_NULL

public static final java.lang.String ERROR_CHIP_NULL

See Also:

Constant Field Values

ERROR_CHANNEL_NUMBER

public static final java.lang.String ERROR_CHANNEL_NUMBER

See Also:

Constant Field Values

ERROR_REMOTE_EXCEPTION

public static final java.lang.String ERROR_REMOTE_EXCEPTION

See Also:

Constant Field Values

Constructor Detail

PWMManager

public PWMManager(android.content.Context context)

Class constructor.

Instantiates a new PWMManager for the given application.

Parameters:

context - Context of the application.

Method Detail

createPWM

@Deprecated
public PWM createPWM(int channel)
              throws PWMException

Deprecated. This method is no longer acceptable to create a PWM object.

Use createPWM(int, int) instead.

Creates and returns a PWM object with the given channel.

Parameters:

channel - PWM channel index.

Returns:

The PWM created.

Throws:

java.lang.IllegalArgumentException - If channel < 0.

PWMException - If the provided PWM channel is not available.

See Also:

listChannels(), PWM

createPWM

public PWM createPWM(PWMChip chip,
                     int channel)
              throws PWMException

Creates and returns a PWM object with the given pair of chip and channel.

Parameters:

chip - PWM chip that holds the PWM channel.

channel - PWM channel index.

Returns:

The PWM created.

Throws:

java.lang.NullPointerException - if chip == null

java.lang.IllegalArgumentException - if channel < 0.

PWMException - If the provided pair of chip and channel is not available or if there is any error creating the PWM channel.

See Also:

listPWMChips(), PWMChip.listChannels(), PWMChip, PWM

listChannels

@Deprecated
public int[] listChannels()

Deprecated. This method is no longer acceptable to list PWM channels.

Use listPWMChips() and {@link PWMChip.listChannels()} instead.

Lists all available PWM channels in the device.

Returns:

List with all available PWM channels in the device.

listPWMChips

public java.util.List<PWMChip> listPWMChips()

Lists all available PWM chips in the device.

Returns:

List with all available PWM chips in the device.

See Also:

PWMChip, PWMChip.listChannels()