AbsoluteEncoderConfig.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024-2026 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 AbsoluteEncoderConfig : public BaseConfig {
public:
    AbsoluteEncoderConfig() = default;
    ~AbsoluteEncoderConfig() override = default;
 
    AbsoluteEncoderConfig(const AbsoluteEncoderConfig&) = default;
    AbsoluteEncoderConfig& operator=(const AbsoluteEncoderConfig&) = delete;
    AbsoluteEncoderConfig(AbsoluteEncoderConfig&&) noexcept = delete;
    AbsoluteEncoderConfig& operator=(AbsoluteEncoderConfig&&) noexcept = delete;
 
    struct Presets final {
        static AbsoluteEncoderConfig& REV_ThroughBoreEncoder() {
            static AbsoluteEncoderConfig config{
                AbsoluteEncoderConfig().StartPulseUs(1.0).EndPulseUs(1.0)};
            return config;
        }
 
        static AbsoluteEncoderConfig& REV_ThroughBoreEncoderV2() {
            static AbsoluteEncoderConfig config{AbsoluteEncoderConfig()
                                                    .StartPulseUs(3.88443797)
                                                    .EndPulseUs(1.94221899)};
            return config;
        }
 
        static AbsoluteEncoderConfig& REV_SplineEncoder() {
            static AbsoluteEncoderConfig config{
                AbsoluteEncoderConfig().StartPulseUs(1.0).EndPulseUs(1.0)};
            return config;
        }
    };
 
    AbsoluteEncoderConfig& Apply(AbsoluteEncoderConfig& config);
 
    AbsoluteEncoderConfig& SetSparkMaxDataPortConfig();
 
    AbsoluteEncoderConfig& Inverted(bool inverted);
 
    AbsoluteEncoderConfig& ZeroOffset(double offset);
 
    AbsoluteEncoderConfig& AverageDepth(int depth);
 
    AbsoluteEncoderConfig& StartPulseUs(double startPulseUs);
 
    AbsoluteEncoderConfig& EndPulseUs(double endPulseUs);
 
    [[deprecated("Use RangeOffset(0.0) instead.")]]
    AbsoluteEncoderConfig& ZeroCentered(bool zeroCentered);
 
    AbsoluteEncoderConfig& RangeOffset(double offset);
};
 
}  // namespace rev::spark