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

Interface PwmConfig

    • Method Detail

      • dutyCycle

        Float dutyCycle()
        Get the configured 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 configured 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 the PWM state is enabled.
        Returns:
        frequency value in Hz (number of cycles per second)

      • 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 the PWM state is enabled.
        Returns:
        frequency value in Hz (number of cycles per second)

      • pwmType

        PwmType pwmType()
        Get the configured 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.
        Returns:
        the PwmType for this PWM instance

      • getPwmType

        default PwmType getPwmType()
        Get the configured 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.
        Returns:
        the PwmType for this PWM instance

      • shutdownValue

        Float shutdownValue()
        Get configured PWM duty-cycle value that is automatically 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.
        Returns:
        optional duty-cycle value expressed as a percentage (rage: 0-100) that is applied when shutting down the Pi4J context.

      • getShutdownValue

        default Float getShutdownValue()
        Get configured PWM duty-cycle value that is automatically 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.
        Returns:
        duty-cycle value expressed as a percentage (rage: 0-100) that is applied when shutting down the Pi4J context.

      • shutdownValue

        PwmConfig shutdownValue​(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 PwmConfig instance

      • setShutdownValue

        default void setShutdownValue​(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)

      • initialValue

        Float initialValue()
        Get configured PWM duty-cycle value that is automatically 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.
        Returns:
        duty-cycle value expressed as a percentage (rage: 0-100) that is applied when creating and initializing the PWM instance.

      • getInitialValue

        default Float getInitialValue()
        Get configured PWM duty-cycle value that is automatically 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.
        Returns:
        duty-cycle value expressed as a percentage (rage: 0-100) that is applied when creating and initializing the PWM instance.

      • presets

        Collection<PwmPreset> presets()
        Get the configured PwmPresets assigned to this PWM instance.
        Returns:
        collection of PwmPresets

      • getPresets

        default Collection<PwmPreset> getPresets()
        Get the configured PwmPresets assigned to this PWM instance.
        Returns:
        collection of PwmPresets