-
public interface PwmPreset
PwmPreset interface.
- Version:
- $Id: $Id
- Author:
- Robert Savage (http://www.savagehomeautomation.com)
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description Float
dutyCycle()
Get 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.Integer
frequency()
Get the configured frequency value in Hertz (number of cycles per second) that the PWM signal generator should attempt to output when this preset is applied to a PWM instance.default Float
getDutyCycle()
Get 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.default Integer
getFrequency()
Get the configured frequency value in Hertz (number of cycles per second) that the PWM signal generator should attempt to output when this preset is applied to a PWM instance.default String
getName()
Get the preset name assigned to this PWM preset instance.String
name()
Get the preset name assigned to this PWM preset instance.static PwmPresetBuilder
newBuilder(String name)
Return a new PWM Preset builder; (static factory method)
-
-
-
Method Detail
-
newBuilder
static PwmPresetBuilder newBuilder(String name)
Return a new PWM Preset builder; (static factory method)- Parameters:
name
- the unique preset name assigned to the PWM preset instance being created.- Returns:
- a new PWM preset builder instance.
-
name
String name()
Get the preset name assigned to this PWM preset instance.- Returns:
- preset name
-
getName
default String getName()
Get the preset name assigned to this PWM preset instance.- Returns:
- preset name
-
dutyCycle
Float dutyCycle()
Get 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.- Returns:
- duty-cycle value expressed as a percentage (rage: 0-100)
-
getDutyCycle
default Float getDutyCycle()
Get 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.- Returns:
- duty-cycle value expressed as a percentage (rage: 0-100)
-
frequency
Integer frequency()
Get the configured frequency value in Hertz (number of cycles per second) that the PWM signal generator should attempt to output when this preset is applied to a PWM instance. 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.- Returns:
- the configured frequency (Hz) that is used when turning the PWM signal to the 'ON' state when applying this PWM preset.
-
getFrequency
default Integer getFrequency()
Get the configured frequency value in Hertz (number of cycles per second) that the PWM signal generator should attempt to output when this preset is applied to a PWM instance. 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.- Returns:
- the configured frequency (Hz) that is used when turning the PWM signal to the 'ON' state when applying this PWM preset.
-
-