jdk.dio.pwm

Class PWMChannelConfig

java.lang.Object

jdk.dio.pwm.PWMChannelConfig

All Implemented Interfaces:

DeviceConfig<PWMChannel>, DeviceConfig.HardwareAddressing

public final class PWMChannelConfig
extends java.lang.Object
implements DeviceConfig<PWMChannel>, DeviceConfig.HardwareAddressing

The PWMChannelConfig class encapsulates the hardware addressing information, and static and dynamic configuration parameters of a PWM channel.

Some hardware addressing, static or dynamic configuration parameters may be set to UNASSIGNED or null (see Unassigned, Default or Unused Parameter Values).

An instance of PWMChannelConfig can be passed to the open(DeviceConfig, ...) and open(Class, DeviceConfig, ...) methods of the DeviceManager to open the designated PWM channel with the specified configuration. A InvalidDeviceConfigException is thrown when attempting to open a device with an invalid or unsupported configuration.

Since:

1.0

See Also:

DeviceManager.open(DeviceConfig), DeviceManager.open(Class, DeviceConfig)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PWMChannelConfig.Builder The Builder class allows for creating and initializing PWMChannelConfig objects.

Nested classes/interfaces inherited from interface jdk.dio.DeviceConfig

DeviceConfig.HardwareAddressing

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALIGN_CENTER Center alignement.
static int	ALIGN_LEFT Left alignement.
static int	ALIGN_RIGHT Right alignement.
static int	IDLE_STATE_HIGH High idle state.
static int	IDLE_STATE_LOW Low idle state.

Fields inherited from interface jdk.dio.DeviceConfig

DEFAULT, UNASSIGNED

Constructor Summary

Constructors

Constructor and Description
PWMChannelConfig(int controllerNumber, int channelNumber, int idleState, int pulsePeriod, int pulseAlignment) Deprecated. As of 1.1, use PWMChannelConfig.Builder instead.
PWMChannelConfig(int controllerNumber, int channelNumber, int idleState, int pulsePeriod, int pulseAlignment, GPIOPinConfig output) Deprecated. As of 1.1, use PWMChannelConfig.Builder instead.
PWMChannelConfig(java.lang.String controllerName, int channelNumber, int idleState, int pulsePeriod, int pulseAlignment) Deprecated. As of 1.1, use PWMChannelConfig.Builder instead.
PWMChannelConfig(java.lang.String controllerName, int channelNumber, int idleState, int pulsePeriod, int pulseAlignment, GPIOPinConfig output) Deprecated. As of 1.1, use PWMChannelConfig.Builder instead.

Method Summary

Methods

Modifier and Type	Method and Description
static PWMChannelConfig	deserialize(java.io.InputStream in) Creates a new PWMChannelConfig whose state is deserialized from the specified InputStream.
boolean	equals(java.lang.Object obj) Checks two PWMChannelConfig objects for equality.
int	getChannelNumber() Gets the configured PWM channel number.
java.lang.String	getControllerName() Gets the configured controller name (such as its device file name on UNIX systems).
int	getControllerNumber() Gets the configured controller number (the PWM controller or generator number).
int	getIdleState() Gets the configured idle output state.
GPIOPin	getOutput() Deprecated. As of 1.1, replaced by PWMChannel.getOutput.
int	getOutputBufferSize() Gets the requested or allocated output buffer size.
GPIOPinConfig	getOutputConfig() Gets the configured output configuration on which the pulses are to be generated.
int	getPulseAlignment() Gets the configured pulse alignment.
int	getPulsePeriod() Gets the configured initial scaled pulse period (in microseconds).
double	getScaleFactor() Gets the configured initial pulse period scale factor.
int	hashCode() Returns the hash code value for this object.
int	serialize(java.io.OutputStream out) Serializes the state of this PWMChannelConfig object to the specified OutputStream.

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

IDLE_STATE_HIGH

public static final int IDLE_STATE_HIGH

High idle state. The idle state is the state of the PWM output when no pulse is generated.

See Also:

Constant Field Values

IDLE_STATE_LOW

public static final int IDLE_STATE_LOW

Low idle state. The idle state is the state of the PWM output when no pulse is generated.

See Also:

Constant Field Values

ALIGN_CENTER

public static final int ALIGN_CENTER

Center alignement. The pulse is centered within the pulse period.

See Also:

Constant Field Values

ALIGN_LEFT

public static final int ALIGN_LEFT

Left alignement. The start of the pulse coincides with the start of the pulse period.

See Also:

Constant Field Values

ALIGN_RIGHT

public static final int ALIGN_RIGHT

Right alignement. The end of the pulse coincides with the end of the pulse period.

See Also:

Constant Field Values

Constructor Detail

PWMChannelConfig

@Deprecated
public PWMChannelConfig(int controllerNumber,
                           int channelNumber,
                           int idleState,
                           int pulsePeriod,
                           int pulseAlignment)

Deprecated. As of 1.1, use PWMChannelConfig.Builder instead.

Creates a new PWMChannelConfig with the specified hardware addressing information and configuration parameters. The output of the PWM channel is implicit (such as a dedicated output pin).

The controller name is set to null. The requested output buffer size is set to UNASSIGNED. The pulse period time scale factor is set to 1.0.

Parameters:

controllerNumber - the hardware PWM controller (or generator)'s number (a positive or zero integer) or UNASSIGNED.

channelNumber - the hardware PWM channel's number (a positive or zero integer) or UNASSIGNED.

idleState - the output idle state: IDLE_STATE_HIGH, IDLE_STATE_LOW or UNASSIGNED.

pulsePeriod - the initial pulse period in microseconds (a positive integer) or UNASSIGNED.

pulseAlignment - the pulse alignment: ALIGN_CENTER, ALIGN_LEFT, ALIGN_RIGHT or UNASSIGNED.

Throws:

java.lang.IllegalArgumentException - if any of the following is true:

• controllerNumber is not in the defined range;
• channelNumber is not in the defined range;
• idleState is not in the defined range;
• pulsePeriod is not in the defined range.
• pulseAlignment is not in the defined range.

PWMChannelConfig

@Deprecated
public PWMChannelConfig(int controllerNumber,
                           int channelNumber,
                           int idleState,
                           int pulsePeriod,
                           int pulseAlignment,
                           GPIOPinConfig output)

Deprecated. As of 1.1, use PWMChannelConfig.Builder instead.

Creates a new PWMChannelConfig the specified hardware addressing information, configuration parameters and GPIO pin output.

The controller name is set to null. The requested output buffer size is set to UNASSIGNED. The pulse period time scale factor is set to 1.0.

If the access modes (exclusive or shared) supported by the designated GPIO pin output are incompatible with those required by the underlying PWMChannel device or device driver, attempting to open the PWMChannel device using this configuration may result in a InvalidDeviceConfigException to be thrown.

Parameters:

controllerNumber - the hardware PWM controller (or generator)'s number (a positive or zero integer) or UNASSIGNED.

channelNumber - the hardware PWM channel's number (a positive or zero integer) or UNASSIGNED.

idleState - the output idle state: IDLE_STATE_HIGH, IDLE_STATE_LOW or UNASSIGNED.

pulsePeriod - the initial pulse period in microseconds (a positive integer) or UNASSIGNED.

pulseAlignment - the pulse alignment: ALIGN_CENTER, ALIGN_LEFT, ALIGN_RIGHT or UNASSIGNED.

output - the configuration of the output (a GPIO output pin) on which the pulses are to be generated.

Throws:

java.lang.IllegalArgumentException - if any of the following is true:

• controllerNumber is not in the defined range;
• channelNumber is not in the defined range;
• idleState is not in the defined range;
• pulsePeriod is not in the defined range;
• pulseAlignment is not in the defined range;
• if the provided GPIO pin configuration's direction is not set to GPIOPinConfig.DIR_OUTPUT_ONLY or GPIOPinConfig.DIR_BOTH_INIT_OUTPUT.

java.lang.NullPointerException - if output is null.

PWMChannelConfig

@Deprecated
public PWMChannelConfig(java.lang.String controllerName,
                           int channelNumber,
                           int idleState,
                           int pulsePeriod,
                           int pulseAlignment)

Deprecated. As of 1.1, use PWMChannelConfig.Builder instead.

Creates a new PWMChannelConfig with the specified hardware addressing information and configuration parameters. The output of the PWM channel is implicit (such as a dedicated output pin).

The controller number is set to UNASSIGNED. The requested output buffer size is set to UNASSIGNED. The pulse period time scale factor is set to 1.0.

Parameters:

controllerName - the controller name (such as its device file name on UNIX systems).

channelNumber - the hardware PWM channel's number (a positive or zero integer) or UNASSIGNED.

idleState - the output idle state: IDLE_STATE_HIGH, IDLE_STATE_LOW or UNASSIGNED.

pulsePeriod - the initial pulse period in microseconds (a positive integer) or UNASSIGNED.

pulseAlignment - the pulse alignment: ALIGN_CENTER, ALIGN_LEFT, ALIGN_RIGHT or UNASSIGNED.

Throws:

java.lang.IllegalArgumentException - if any of the following is true:

• channelNumber is not in the defined range;
• idleState is not in the defined range;
• pulsePeriod is not in the defined range;
• pulseAlignment is not in the defined range.

java.lang.NullPointerException - if controllerName is null.

PWMChannelConfig

@Deprecated
public PWMChannelConfig(java.lang.String controllerName,
                           int channelNumber,
                           int idleState,
                           int pulsePeriod,
                           int pulseAlignment,
                           GPIOPinConfig output)

Deprecated. As of 1.1, use PWMChannelConfig.Builder instead.

Creates a new PWMChannelConfig the specified hardware addressing information, configuration parameters and GPIO pin output.

The controller number is set to UNASSIGNED. The requested output buffer size is set to UNASSIGNED. The pulse period time scale factor is set to 1.0.

If the access modes (exclusive or shared) supported by the designated GPIO pin output are incompatible with those required by the underlying PWMChannel device or device driver, attempting to open the PWMChannel device using this configuration may result in a InvalidDeviceConfigException to be thrown.

Parameters:

controllerName - the controller name (such as its device file name on UNIX systems).

channelNumber - the hardware PWM channel's number (a positive or zero integer) or UNASSIGNED.

idleState - the output idle state: IDLE_STATE_HIGH, IDLE_STATE_LOW or UNASSIGNED.

pulsePeriod - the initial pulse period in microseconds (a positive integer) or UNASSIGNED.

pulseAlignment - the pulse alignment: ALIGN_CENTER, ALIGN_LEFT, ALIGN_RIGHT or UNASSIGNED.

output - the configuration of the output (a GPIO output pin) on which the pulses are to be generated.

Throws:

java.lang.IllegalArgumentException - if any of the following is true:

• channelNumber is not in the defined range;
• idleState is not in the defined range;
• pulsePeriod is not in the defined range;
• pulseAlignment is not in the defined range;
• if the provided GPIO pin configuration's direction is not set to GPIOPinConfig.DIR_OUTPUT_ONLY or GPIOPinConfig.DIR_BOTH_INIT_OUTPUT.

java.lang.NullPointerException - if controllerName or output is null.

Method Detail

deserialize

public static PWMChannelConfig deserialize(java.io.InputStream in)
                                    throws java.io.IOException

Creates a new PWMChannelConfig whose state is deserialized from the specified InputStream. This method may be invoked to restore the state of a PWMChannelConfig object from a persistent store.

Parameters:

in - the stream to read from.

Returns:

a new PWMChannelConfig instance.

Throws:

java.io.IOException - if an I/O error occurs or if the provided stream does not contain a representation of a PWMChannelConfig object.

Since:

1.1

serialize

public int serialize(java.io.OutputStream out)
              throws java.io.IOException

Serializes the state of this PWMChannelConfig object to the specified OutputStream. This method may be invoked by the DeviceManager to save the state of this PWMChannelConfig object to a persistent store.

Specified by:

serialize in interface DeviceConfig<PWMChannel>

Parameters:

out - the stream to write to.

Returns:

the number of bytes written to the stream.

Throws:

java.io.IOException - if an I/O error occurs.

Since:

1.1

See Also:

DeviceProvider.deserialize(java.io.InputStream)

getChannelNumber

public int getChannelNumber()

Gets the configured PWM channel number.

Returns:

the hardware channel's number (a positive or zero integer) or UNASSIGNED.

getControllerNumber

public int getControllerNumber()

Gets the configured controller number (the PWM controller or generator number).

Specified by:

getControllerNumber in interface DeviceConfig.HardwareAddressing

Returns:

the controller number (a positive or zero integer) or UNASSIGNED.

getControllerName

public java.lang.String getControllerName()

Gets the configured controller name (such as its device file name on UNIX systems).

Specified by:

getControllerName in interface DeviceConfig.HardwareAddressing

Returns:

the controller name or null.

getOutputBufferSize

public int getOutputBufferSize()

Gets the requested or allocated output buffer size. The platform/underlying driver may or may not allocate the requested size for the output buffer. When querying the configuration of an opened or registered device the allocated buffer size is returned.

Returns:

the requested or allocated output buffer size (a positive or zero integer) or UNASSIGNED.

Since:

1.1

getOutputConfig

public GPIOPinConfig getOutputConfig()

Gets the configured output configuration on which the pulses are to be generated.

Returns:

the output on which the pulses are to be generated; or null if the output is implicit.

getOutput

@Deprecated
public GPIOPin getOutput()

Deprecated. As of 1.1, replaced by PWMChannel.getOutput.

Gets the output on which the pulses are to be generated.

A concurrent runtime change of the dynamic configuration parameters of the output (such as of its direction) may result in IOException being thrown by PWM operations.

Returns:

the output on which the pulses are to be generated; or null if the output is implicit or if this PWMChannelConfig instance is not associated to an actual PWMChannel instance.

getPulsePeriod

public int getPulsePeriod()

Gets the configured initial scaled pulse period (in microseconds).

Returns:

the initial pulse period in microseconds (a positive integer) or UNASSIGNED.

getIdleState

public int getIdleState()

Gets the configured idle output state.

Returns:

the idle output state: : IDLE_STATE_HIGH, IDLE_STATE_LOW or UNASSIGNED.

getPulseAlignment

public int getPulseAlignment()

Gets the configured pulse alignment. The alignment of the pulse within the pulse period.

Returns:

the pulse alignment: ALIGN_CENTER, ALIGN_LEFT, ALIGN_RIGHT or UNASSIGNED

getScaleFactor

public double getScaleFactor()

Gets the configured initial pulse period scale factor.

Returns:

the initial pulse period scale factor (a number greater or equal to 1.0).

Since:

1.1

hashCode

public int hashCode()

Returns the hash code value for this object.

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code value for this object.

equals

public boolean equals(java.lang.Object obj)

Checks two PWMChannelConfig objects for equality.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object to test for equality with this object.

Returns:

true if obj is a PWMChannelConfig and has the same hardware addressing information and configuration parameter values as this PWMChannelConfig object; false otherwise.