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. |
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. |
Inherited methods | |
---|---|
From
class
java.lang.Object
| |
From
interface
java.io.Closeable
| |
From
interface
java.lang.AutoCloseable
|
Public constructors
Pwm
</div>
Pwm ()
</div>
Public methods
close
</div>
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.</p>
Throws | |
---|---|
IOException |
if the PWM is already closed. |
</div>
setEnabled
</div>
void setEnabled (boolean enabled)
Enable the PWM pin.
setPwmDutyCycle(double)
and setPwmFrequencyHz(double)
must be called before enabling
the pin.</p>
Parameters | |
---|---|
enabled |
boolean :
True to enable the PWM, false to disable. |
Throws | |
---|---|
IOException |
</div>
setPwmDutyCycle
</div>
void setPwmDutyCycle (double duty_cycle)
Set the duty cycle.
Parameters | |
---|---|
duty_cycle |
double :
A double between 0 and 100 (inclusive). |
Throws | |
---|---|
|
IOException |
IllegalArgumentException |
|
IOException |
</div>
setPwmFrequencyHz
</div>
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 non-negative. |
Throws | |
---|---|
|
IOException |
IllegalArgumentException |
|
IOException |
</div>