Package com.ctre.phoenix6.hardware.traits

Interface SupportsMusic

All Known Subinterfaces:
CommonTalonWithFOC
All Known Implementing Classes:
CoreTalonFX, TalonFX
public interface SupportsMusic
Contains all control functions available for motors that support playing music.

  • Method Details

    • setControl

      StatusCode setControl(MusicTone request)
      Plays a single tone at the user specified frequency.
      • MusicTone 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.
      Parameters:
      request - Control object to request of the device
      Returns:
      Code response of the request

    • setControl

      StatusCode setControl(ControlRequest request)
      Control device with generic control request object.

      User must make sure the specified object is castable to a valid control request, otherwise this function will fail at run-time and return the NotSupported StatusCode

      Parameters:
      request - Control object to request of the device
      Returns:
      Status Code of the request, 0 is OK