SignalsConfig.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024-2025 REV Robotics
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of REV Robotics nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
 
#pragma once
 
#include "rev/config/BaseConfig.h"
 
namespace rev::spark {
 
class SignalsConfig : public BaseConfig {
public:
    SignalsConfig() = default;
    ~SignalsConfig() override = default;
 
    SignalsConfig(const SignalsConfig&) = delete;
    SignalsConfig& operator=(const SignalsConfig&) = delete;
    SignalsConfig(SignalsConfig&&) noexcept = delete;
    SignalsConfig& operator=(SignalsConfig&&) noexcept = delete;
 
    SignalsConfig& Apply(SignalsConfig& config);
 
    SignalsConfig& AppliedOutputPeriodMs(int periodMs);
 
    [[deprecated]] SignalsConfig& AppliedOutputAlwaysOn(bool enabled);
 
    SignalsConfig& BusVoltagePeriodMs(int periodMs);
 
    [[deprecated]] SignalsConfig& BusVoltageAlwaysOn(bool enabled);
 
    SignalsConfig& OutputCurrentPeriodMs(int periodMs);
 
    [[deprecated]] SignalsConfig& OutputCurrentAlwaysOn(bool enabled);
 
    SignalsConfig& MotorTemperaturePeriodMs(int periodMs);
 
    [[deprecated]] SignalsConfig& MotorTemperatureAlwaysOn(bool enabled);
 
    SignalsConfig& LimitsPeriodMs(int periodMs);
 
    [[deprecated]] SignalsConfig& LimitsAlwaysOn(bool enabled);
 
    SignalsConfig& FaultsPeriodMs(int periodMs);
 
    SignalsConfig& FaultsAlwaysOn(bool enabled);
 
    SignalsConfig& WarningsPeriodMs(int periodMs);
 
    SignalsConfig& WarningsAlwaysOn(bool enabled);
 
    SignalsConfig& PrimaryEncoderVelocityPeriodMs(int periodMs);
 
    SignalsConfig& PrimaryEncoderVelocityAlwaysOn(bool enabled);
 
    SignalsConfig& PrimaryEncoderPositionPeriodMs(int periodMs);
 
    SignalsConfig& PrimaryEncoderPositionAlwaysOn(bool enabled);
 
    SignalsConfig& AnalogVoltagePeriodMs(int periodMs);
 
    SignalsConfig& AnalogVoltageAlwaysOn(bool enabled);
 
    SignalsConfig& AnalogVelocityPeriodMs(int periodMs);
 
    SignalsConfig& AnalogVelocityAlwaysOn(bool enabled);
 
    SignalsConfig& AnalogPositionPeriodMs(int periodMs);
 
    SignalsConfig& AnalogPositionAlwaysOn(bool enabled);
 
    SignalsConfig& ExternalOrAltEncoderVelocity(int periodMs);
 
    SignalsConfig& ExternalOrAltEncoderVelocityAlwaysOn(bool enabled);
 
    SignalsConfig& ExternalOrAltEncoderPosition(int periodMs);
 
    SignalsConfig& ExternalOrAltEncoderPositionAlwaysOn(bool enabled);
 
    SignalsConfig& AbsoluteEncoderVelocityPeriodMs(int periodMs);
 
    SignalsConfig& AbsoluteEncoderVelocityAlwaysOn(bool enabled);
 
    SignalsConfig& AbsoluteEncoderPositionPeriodMs(int periodMs);
 
    SignalsConfig& AbsoluteEncoderPositionAlwaysOn(bool enabled);
 
    SignalsConfig& IAccumulationPeriodMs(int periodMs);
 
    SignalsConfig& IAccumulationAlwaysOn(bool enabled);
 
    SignalsConfig& SetpointPeriodMs(int periodMs);
 
    SignalsConfig& SetpointAlwaysOn(bool enabled);
 
    SignalsConfig& IsAtSetpointPeriodMs(int periodMs);
 
    SignalsConfig& IsAtSetpointAlwaysOn(bool enabled);
 
    SignalsConfig& SelectedSlotPeriodMs(int periodMs);
 
    SignalsConfig& SelectedSlotAlwaysOn(bool enabled);
 
    SignalsConfig& MaxMotionSetpointPositionPeriodMs(int periodMs);
 
    SignalsConfig& MaxMotionSetpointPositionAlwaysOn(bool enabled);
 
    SignalsConfig& MaxMotionSetpointVelocityPeriodMs(int periodMs);
 
    SignalsConfig& MaxMotionSetpointVelocityAlwaysOn(bool enabled);
 
private:
    void SetPeriodMsCore(int parameterId, int periodMs);
    void SetAlwaysOnCore(int parameterId, bool enabled);
};  // class SignalsConfig
 
}  // namespace rev::spark