-
- All Superinterfaces:
AddressConfigBuilder<PwmConfigBuilder,PwmConfig>
,Builder<PwmConfig>
,ConfigBuilder<PwmConfigBuilder,PwmConfig>
,com.pi4j.io.gpio.GpioConfigBuilder<PwmConfigBuilder,PwmConfig>
,IOAddressConfigBuilder<PwmConfigBuilder,PwmConfig>
,IOConfigBuilder<PwmConfigBuilder,PwmConfig>
public interface PwmConfigBuilder extends com.pi4j.io.gpio.GpioConfigBuilder<PwmConfigBuilder,PwmConfig>
PwmConfigBuilder interface.
- Version:
- $Id: $Id
- Author:
- Robert Savage (http://www.savagehomeautomation.com)
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description PwmConfigBuilder
dutyCycle(Number dutyCycle)
Set the duty-cycle value as a decimal value that represents the percentage of the ON vs OFF time of the PWM signal for each period.PwmConfigBuilder
frequency(Integer frequency)
Set the configured frequency value in Hertz (number of cycles per second) that the PWM signal generator should attempt to output when the PWM state is enabled.PwmConfigBuilder
initial(Number dutyCycle)
Optionally configure a PWM duty-cycle value that should automatically be applied to the PWM instance when this PWM instance is created and initialized.static PwmConfigBuilder
newInstance(Context context)
newInstance.PwmConfigBuilder
preset(PwmPreset... preset)
Add one or more PwmPresets to this PWM instance.PwmConfigBuilder
pwmType(PwmType pwmType)
Set the PwmType of this PWM instance.PwmConfigBuilder
shutdown(Number dutyCycle)
Optionally configure a PWM duty-cycle value that should automatically be applied to the PWM instance when the Pi4J context is shutdown.-
Methods inherited from interface com.pi4j.config.AddressConfigBuilder
address
-
Methods inherited from interface com.pi4j.config.ConfigBuilder
allowInheritProperties, description, disallowInheritProperties, id, id, inheritProperties, load, load, load, load, load, load, load, load, load, load, name
-
Methods inherited from interface com.pi4j.io.IOAddressConfigBuilder
platform, platform, provider, provider
-
-
-
-
Method Detail
-
newInstance
static PwmConfigBuilder newInstance(Context context)
newInstance.
- Parameters:
context
-Context
- Returns:
- a
PwmConfigBuilder
object.
-
frequency
PwmConfigBuilder frequency(Integer frequency)
Set the configured frequency value in Hertz (number of cycles per second) that the PWM signal generator should attempt to output when the PWM state is enabled. Please note that certain PWM signal generators may be limited to specific frequency bands and may not generate all possible explicit frequency values. After enabling the PWM signal using the 'on(...)' method, you can check the 'Pwm::frequency()' or 'Pwm::getFrequency()' properties to determine what frequency the PWM generator actually applied.- Parameters:
frequency
- the number of cycles per second (Hertz)- Returns:
- this builder instance
-
dutyCycle
PwmConfigBuilder dutyCycle(Number dutyCycle)
Set the duty-cycle value as a decimal value that represents the percentage of the ON vs OFF time of the PWM signal for each period. The duty-cycle range is valid from 0 to 100 including factional values. (Values above 50% mean the signal will remain HIGH more time than LOW.) Example: A value of 50 represents a duty-cycle where half of the time period the signal is LOW and the other half is HIGH.- Parameters:
dutyCycle
- duty-cycle value expressed as a percentage (rage: 0-100)- Returns:
- this builder instance
-
pwmType
PwmConfigBuilder pwmType(PwmType pwmType)
Set the PwmType of this PWM instance. (Hardware/Software) Please note that not all PWM providers support both hardware and software PWM generators. Please consult the documentation for your PWM provider to determine what support is available and what limitations may apply.- Parameters:
pwmType
- aPwmType
object.- Returns:
- this builder instance
-
shutdown
PwmConfigBuilder shutdown(Number dutyCycle)
Optionally configure a PWM duty-cycle value that should automatically be applied to the PWM instance when the Pi4J context is shutdown. This option can be helpful if you wish to do something like stop a PWM signal (by configuring this 'shutdown' value to zero) when your application is terminated an Pi4J is shutdown.- Parameters:
dutyCycle
- duty-cycle value expressed as a percentage (rage: 0-100)- Returns:
- this builder instance
-
initial
PwmConfigBuilder initial(Number dutyCycle)
Optionally configure a PWM duty-cycle value that should automatically be applied to the PWM instance when this PWM instance is created and initialized. This option can be helpful if you wish to do something like set a default PWM signal (by configuring this 'initial' value to 50%) when your application creates the PWM instance. This just helps eliminate a second line of code to manually start the PWM signal for cases where you prefer it is auto-started.- Parameters:
dutyCycle
- duty-cycle value expressed as a percentage (rage: 0-100)- Returns:
- this builder instance
-
preset
PwmConfigBuilder preset(PwmPreset... preset)
Add one or more PwmPresets to this PWM instance. You can create new PWM preset instance using the 'PwmPreset::newBuilder(name)' static factory method.- Parameters:
preset
- one or more pre-configured PwmPreset instances- Returns:
- this builder instance
-
-