MusicTone.hpp

Go to the documentation of this file.

/*
 * Copyright (C) Cross The Road Electronics.  All rights reserved.
 * License information can be found in CTRE_LICENSE.txt
 * For support and suggestions contact support@ctr-electronics.com or file
 * an issue tracker at https://github.com/CrossTheRoadElec/Phoenix-Releases
 */
#pragma once
 
#include "ctre/phoenix6/controls/ControlRequest.hpp"
#include <units/frequency.h>
#include <units/time.h>
 
namespace ctre {
namespace phoenix6 {
namespace controls {
 
/**
 * Plays a single tone at the user specified frequency.
 */
class MusicTone final : public ControlRequest {
    ctre::phoenix::StatusCode SendRequest(const char *network, uint32_t deviceHash, std::shared_ptr<ControlRequest> &req) const override;
 
public:
    /**
     * \brief 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
     * 
     */
    units::frequency::hertz_t AudioFrequency;
 
    /**
     * \brief 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.
     */
    units::frequency::hertz_t UpdateFreqHz{100_Hz};
 
    /**
     * \brief Plays a single tone at the user specified frequency.
     * 
     * \param 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.
     */
    constexpr MusicTone(units::frequency::hertz_t AudioFrequency) : ControlRequest{},
        AudioFrequency{std::move(AudioFrequency)}
    {}
 
    constexpr ~MusicTone() override {}
 
    /**
     * \brief Gets the name of this control request.
     *
     * \returns Name of the control request
     */
    constexpr std::string_view GetName() const override
    {
        return "MusicTone";
    }
    
    /**
     * \brief 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
     * 
     *
     * \param newAudioFrequency Parameter to modify
     * \returns Itself
     */
    constexpr MusicTone &WithAudioFrequency(units::frequency::hertz_t newAudioFrequency)
    {
        AudioFrequency = std::move(newAudioFrequency);
        return *this;
    }
 
    /**
     * \brief 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.
     *
     * \param newUpdateFreqHz Parameter to modify
     * \returns Itself
     */
    constexpr MusicTone &WithUpdateFreqHz(units::frequency::hertz_t newUpdateFreqHz)
    {
        UpdateFreqHz = newUpdateFreqHz;
        return *this;
    }
 
    /**
     * \brief Returns a string representation of the object.
     *
     * \returns a string representation of the object.
     */
    std::string ToString() const override;
 
    /**
     * \brief Gets information about this control request.
     *
     * \returns Map of control parameter names and corresponding applied values
     */
    std::map<std::string, std::string> GetControlInfo() const override;
};
 
}
}
}