Skip to content

Most visited

Recently visited

navigation

Pwm

Pwm

public abstract class Pwm
extends Object implements Closeable

java.lang.Object
   ↳ com.google.android.things.pio.Pwm
Known Direct Subclasses


Controls a PWM pin. Opening a PWM pin takes ownership of it for the whole system, preventing anyone else from opening/accessing the PWM until you call close(). Forgetting to call close() will prevent anyone (including the same process/app) from using the PWM.

Summary

Public constructors

Pwm()

Public methods

abstract void close()

Close and release the PWM pin.

String getName()

Returns the I/O name.

abstract void setEnabled(boolean enabled)

Enable the PWM pin.

abstract void setPwmDutyCycle(double duty_cycle)

Set the duty cycle.

abstract void setPwmFrequencyHz(double freq_hz)

Set the frequency of the signal.

String toString()

Returns a string representation of the object.

Inherited methods

From class java.lang.Object
From interface java.io.Closeable
From interface java.lang.AutoCloseable

Public constructors

Pwm

Pwm ()

Public methods

close

void close ()

Close and release the PWM pin. This must be called in order for the PWM pin to be released and be available to other users.

Throws
IOException if the PWM is already closed.

getName

String getName ()

Returns the I/O name.

Returns
String

setEnabled

void setEnabled (boolean enabled)

Enable the PWM pin. Frequency must be set via setPwmFrequencyHz(double) before enabling the pin, but frequency and duty cycle settings can be set in both enabled and disabled state and will be remembered if the PWM is disabled and then re-enabled.

Parameters
enabled boolean: True to enable the PWM, false to disable.
Throws
IOException

setPwmDutyCycle

void setPwmDutyCycle (double duty_cycle)

Set the duty cycle.

Parameters
duty_cycle double: A double between 0 and 100 (inclusive).
Throws
IOException
IllegalArgumentException
IOException

setPwmFrequencyHz

void setPwmFrequencyHz (double freq_hz)

Set the frequency of the signal.

Parameters
freq_hz double: Frequency in Hertz to use for the signal. Must be positive.
Throws
IOException
IllegalArgumentException
IOException

toString

String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Returns
String a string representation of the object.
This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Follow Google Developers on WeChat

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a short survey?
Help us improve the Android developer experience. (Dec 2017 Android Platform & Tools Survey)