PwmDriver
public
interface
PwmDriver
implements
Pwm
| com.google.android.things.userdriver.pio.PwmDriver |
PWM user driver. A PwmDriver must implement all Pwm functions, but additionally this class provides an open() function that will be called whenever a process obtains ownership of the PWM, to match the existing close() function.
Summary
Public methods | |
|---|---|
abstract
void
|
close()
Closes the PWM. |
default
String
|
getName()
Returns null. |
abstract
void
|
open()
Opens the PWM. |
Inherited methods | |
|---|---|
From
interface
com.google.android.things.pio.Pwm
| |
From
interface
java.io.Closeable
| |
From
interface
java.lang.AutoCloseable
| |
Public methods
close
void close ()
Closes the PWM. This will be called when the PWM is closed by its owner. Any resources that need to be cleaned up should be done so here. This method may throw IOException to indicate I/O failure, but will still be considered closed and may attempt to be re-opened in the future.
| Throws | |
|---|---|
IOException |
on I/O failure; the driver will still be considered closed. |
getName
String getName ()
Returns null. I/O user drivers can be registered under any name so this returns null by default. Child classes may override this if other behavior is desired.
| Returns | |
|---|---|
String |
|
open
void open ()
Opens the PWM. This will be called when ownership of a PWM is obtained. The driver should do any initialization needed to configure the PWM for use here.
| Throws | |
|---|---|
IOException |
on I/O failure; the driver will remain closed. |
Interfaces
Classes