Class MusicTone

java.lang.Object
com.ctre.phoenix6.controls.MusicTone
All Implemented Interfaces:
ControlRequest, Cloneable
public final class MusicTone extends Object implements ControlRequest, Cloneable
Plays a single tone at the user specified frequency.

  • Field Details

    • AudioFrequency

      public double AudioFrequency
      Sound frequency to play. A value of zero will silence the device. The effective frequency range is 10-20000 Hz. Any nonzero frequency less than 10 Hz will be capped to 10 Hz. Any frequency above 20 kHz will be capped to 20 kHz.
      • Units: Hz

    • UpdateFreqHz

      public double UpdateFreqHz
      The frequency at which this control will update. This is designated in Hertz, with a minimum of 20 Hz (every 50 ms) and a maximum of 1000 Hz (every 1 ms). Some update frequencies are not supported and will be promoted up to the next highest supported frequency.

      If this field is set to 0 Hz, the control request will be sent immediately as a one-shot frame. This may be useful for advanced applications that require outputs to be synchronized with data acquisition. In this case, we recommend not exceeding 50 ms between control calls.

  • Constructor Details

    • MusicTone

      public MusicTone(double AudioFrequency)
      Plays a single tone at the user specified frequency.
      Parameters:
      AudioFrequency - Sound frequency to play. A value of zero will silence the device. The effective frequency range is 10-20000 Hz. Any nonzero frequency less than 10 Hz will be capped to 10 Hz. Any frequency above 20 kHz will be capped to 20 kHz.

    • MusicTone

      public MusicTone(Frequency AudioFrequency)
      Plays a single tone at the user specified frequency.
      Parameters:
      AudioFrequency - Sound frequency to play. A value of zero will silence the device. The effective frequency range is 10-20000 Hz. Any nonzero frequency less than 10 Hz will be capped to 10 Hz. Any frequency above 20 kHz will be capped to 20 kHz.

  • Method Details

    • getName

      public String getName()
      Description copied from interface: ControlRequest
      Gets the name of this control request.
      Specified by:
      getName in interface ControlRequest
      Returns:
      Name of the control request

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • sendRequest

      public StatusCode sendRequest(CANBus network, int deviceHash)
      Description copied from interface: ControlRequest
      Sends the control request to the device. Users should call setControl() on the device instead.
      Specified by:
      sendRequest in interface ControlRequest
      Parameters:
      network - Device network
      deviceHash - Device hash
      Returns:
      Status code of sending the request

    • getControlInfo

      public Map<String,String> getControlInfo()
      Gets information about this control request.
      Specified by:
      getControlInfo in interface ControlRequest
      Returns:
      Map of control parameter names and corresponding applied values

    • withAudioFrequency

      public MusicTone withAudioFrequency(double newAudioFrequency)
      Modifies this Control Request's AudioFrequency parameter and returns itself for method-chaining and easier to use request API.

      Sound frequency to play. A value of zero will silence the device. The effective frequency range is 10-20000 Hz. Any nonzero frequency less than 10 Hz will be capped to 10 Hz. Any frequency above 20 kHz will be capped to 20 kHz.

      • Units: Hz
      Parameters:
      newAudioFrequency - Parameter to modify
      Returns:
      Itself

    • withAudioFrequency

      public MusicTone withAudioFrequency(Frequency newAudioFrequency)
      Modifies this Control Request's AudioFrequency parameter and returns itself for method-chaining and easier to use request API.

      Sound frequency to play. A value of zero will silence the device. The effective frequency range is 10-20000 Hz. Any nonzero frequency less than 10 Hz will be capped to 10 Hz. Any frequency above 20 kHz will be capped to 20 kHz.

      • Units: Hz
      Parameters:
      newAudioFrequency - Parameter to modify
      Returns:
      Itself

    • getAudioFrequencyMeasure

      public Frequency getAudioFrequencyMeasure()
      Helper method to get this Control Request's AudioFrequency parameter converted to a unit type. If not using the Java units library, AudioFrequency can be accessed directly instead.

      Sound frequency to play. A value of zero will silence the device. The effective frequency range is 10-20000 Hz. Any nonzero frequency less than 10 Hz will be capped to 10 Hz. Any frequency above 20 kHz will be capped to 20 kHz.

      • Units: Hz
      Returns:
      AudioFrequency

    • withUpdateFreqHz

      public MusicTone withUpdateFreqHz(double newUpdateFreqHz)
      Sets the frequency at which this control will update. This is designated in Hertz, with a minimum of 20 Hz (every 50 ms) and a maximum of 1000 Hz (every 1 ms). Some update frequencies are not supported and will be promoted up to the next highest supported frequency.

      If this field is set to 0 Hz, the control request will be sent immediately as a one-shot frame. This may be useful for advanced applications that require outputs to be synchronized with data acquisition. In this case, we recommend not exceeding 50 ms between control calls.

      Specified by:
      withUpdateFreqHz in interface ControlRequest
      Parameters:
      newUpdateFreqHz - Parameter to modify
      Returns:
      Itself

    • withUpdateFreqHz

      public MusicTone withUpdateFreqHz(Frequency newUpdateFreqHz)
      Sets the frequency at which this control will update. This is designated in Hertz, with a minimum of 20 Hz (every 50 ms) and a maximum of 1000 Hz (every 1 ms). Some update frequencies are not supported and will be promoted up to the next highest supported frequency.

      If this field is set to 0 Hz, the control request will be sent immediately as a one-shot frame. This may be useful for advanced applications that require outputs to be synchronized with data acquisition. In this case, we recommend not exceeding 50 ms between control calls.

      Specified by:
      withUpdateFreqHz in interface ControlRequest
      Parameters:
      newUpdateFreqHz - Parameter to modify
      Returns:
      Itself

    • clone

      public MusicTone clone()
      Overrides:
      clone in class Object