LimitSwitchConfig.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/ClosedLoopTypes.h"
#include "rev/config/BaseConfig.h"
 
namespace rev::spark {
 
class LimitSwitchConfig : public BaseConfig {
public:
    enum Behavior : uint32_t {
        kKeepMovingMotor = 0,
        kStopMovingMotor = 1,
        kKeepMovingMotorAndSetPosition = 2,
        kStopMovingMotorAndSetPosition = 3,
    };
    enum Type { kNormallyOpen = 0, kNormallyClosed = 1 };
 
    LimitSwitchConfig() = default;
    ~LimitSwitchConfig() override = default;
 
    LimitSwitchConfig(const LimitSwitchConfig&) = delete;
    LimitSwitchConfig& operator=(const LimitSwitchConfig&) = delete;
    LimitSwitchConfig(LimitSwitchConfig&&) noexcept = delete;
    LimitSwitchConfig& operator=(LimitSwitchConfig&&) noexcept = delete;
 
    LimitSwitchConfig& Apply(LimitSwitchConfig& config);
 
    LimitSwitchConfig& SetSparkMaxDataPortConfig();
 
    [[deprecated]] LimitSwitchConfig& ForwardLimitSwitchEnabled(bool enabled);
 
    LimitSwitchConfig& ForwardLimitSwitchTriggerBehavior(Behavior behavior);
 
    LimitSwitchConfig& ForwardLimitSwitchType(Type type);
 
    LimitSwitchConfig& ForwardLimitSwitchPosition(double position);
 
    [[deprecated]] LimitSwitchConfig& ReverseLimitSwitchEnabled(bool enabled);
 
    LimitSwitchConfig& ReverseLimitSwitchTriggerBehavior(Behavior behavior);
 
    LimitSwitchConfig& ReverseLimitSwitchType(Type type);
 
    LimitSwitchConfig& ReverseLimitSwitchPosition(double position);
 
    LimitSwitchConfig& LimitSwitchPositionSensor(FeedbackSensor sensor);
};
 
}  // namespace rev::spark