CTRE Phoenix 6 C++ 25.2.1
Loading...
Searching...
No Matches
ctre::phoenix6::hardware::traits::SupportsMusic Class Referenceabstract

Contains all control functions available for motors that support playing music. More...

#include <ctre/phoenix6/hardware/traits/SupportsMusic.hpp>

Inheritance diagram for ctre::phoenix6::hardware::traits::SupportsMusic:
ctre::phoenix6::hardware::traits::CommonTalonWithFOC ctre::phoenix6::hardware::core::CoreTalonFX ctre::phoenix6::hardware::TalonFX

Public Member Functions

virtual ~SupportsMusic ()=default
 
virtual ctre::phoenix::StatusCode SetControl (const controls::MusicTone &request)=0
 Plays a single tone at the user specified frequency.
 
virtual ctre::phoenix::StatusCode SetControl (const controls::ControlRequest &request)=0
 Control device with generic control request object.
 

Detailed Description

Contains all control functions available for motors that support playing music.

Constructor & Destructor Documentation

◆ ~SupportsMusic()

virtual ctre::phoenix6::hardware::traits::SupportsMusic::~SupportsMusic ( )
virtualdefault

Member Function Documentation

◆ SetControl() [1/2]

virtual ctre::phoenix::StatusCode ctre::phoenix6::hardware::traits::SupportsMusic::SetControl ( const controls::ControlRequest & request)
pure virtual

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
requestControl object to request of the device
Returns
Status Code of the request, 0 is OK

Implemented in ctre::phoenix6::hardware::core::CoreTalonFX, and ctre::phoenix6::hardware::traits::CommonTalonWithFOC.

◆ SetControl() [2/2]

virtual ctre::phoenix::StatusCode ctre::phoenix6::hardware::traits::SupportsMusic::SetControl ( const controls::MusicTone & request)
pure virtual

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
requestControl object to request of the device
Returns
Status Code of the request, 0 is OK

Implemented in ctre::phoenix6::hardware::core::CoreTalonFX, and ctre::phoenix6::hardware::traits::CommonTalonWithFOC.


The documentation for this class was generated from the following file: