Module com.pi4j
Package com.pi4j.io.pwm

Interface PwmPresetBuilder

All Superinterfaces:
Builder<PwmPreset>
public interface PwmPresetBuilder extends Builder<PwmPreset>

PwmPresetBuilder interface.

Version:
$Id: $Id
Author:
Robert Savage (http://www.savagehomeautomation.com)

  • Method Summary

    Modifier and Type
    Method
    Description
    PwmPresetBuilder
    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.
    PwmPresetBuilder
    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 this preset is applied to a PWM instance.
    static PwmPresetBuilder
    newInstance(String name)
    newInstance.

    Methods inherited from interface com.pi4j.config.Builder

    build

  • Method Details

    • newInstance

      static PwmPresetBuilder newInstance(String name)

      newInstance.

      Parameters:
      name - a String object.
      Returns:
      a PwmPresetBuilder object.

    • dutyCycle

      PwmPresetBuilder 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

    • frequency

      PwmPresetBuilder 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 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.
      Parameters:
      frequency - the number of cycles per second (Hertz)
      Returns:
      this builder instance