Package edu.wpi.first.wpilibj.simulation

Class PWMSim

java.lang.Object
edu.wpi.first.wpilibj.simulation.PWMSim
public class PWMSim extends Object
Class to control a simulated PWM output.

  • Constructor Details

    • PWMSim

      public PWMSim(PWM pwm)
      Constructs from a PWM object.
      Parameters:
      pwm - PWM to simulate

    • PWMSim

      public PWMSim(int channel)
      Constructs from a PWM channel number.
      Parameters:
      channel - Channel number

  • Method Details

    • registerInitializedCallback

      public CallbackStore registerInitializedCallback(NotifyCallback callback, boolean initialNotify)
      Register a callback to be run when the PWM is initialized.
      Parameters:
      callback - the callback
      initialNotify - whether to run the callback with the initial state
      Returns:
      the CallbackStore object associated with this callback.

    • getInitialized

      public boolean getInitialized()
      Check whether the PWM has been initialized.
      Returns:
      true if initialized

    • setInitialized

      public void setInitialized(boolean initialized)
      Define whether the PWM has been initialized.
      Parameters:
      initialized - whether this object is initialized

    • registerPulseMicrosecondCallback

      public CallbackStore registerPulseMicrosecondCallback(NotifyCallback callback, boolean initialNotify)
      Register a callback to be run when the PWM raw value changes.
      Parameters:
      callback - the callback
      initialNotify - whether to run the callback with the initial value
      Returns:
      the CallbackStore object associated with this callback.

    • getPulseMicrosecond

      public int getPulseMicrosecond()
      Get the PWM pulse microsecond value.
      Returns:
      the PWM pulse microsecond value

    • setPulseMicrosecond

      public void setPulseMicrosecond(int microsecondPulseTime)
      Set the PWM pulse microsecond value.
      Parameters:
      microsecondPulseTime - the PWM pulse microsecond value

    • registerOutputPeriodCallback

      public CallbackStore registerOutputPeriodCallback(NotifyCallback callback, boolean initialNotify)
      Register a callback to be run when the PWM period scale changes.
      Parameters:
      callback - the callback
      initialNotify - whether to run the callback with the initial value
      Returns:
      the CallbackStore object associated with this callback.

    • getOutputPeriod

      public int getOutputPeriod()
      Get the PWM period scale.
      Returns:
      the PWM period scale

    • setOutputPeriod

      public void setOutputPeriod(int period)
      Set the PWM period scale.
      Parameters:
      period - the PWM period scale

    • resetData

      public void resetData()
      Reset all simulation data.