DetachedEncoder.h

Go to the documentation of this file.

/*
 * Copyright (c) 2025-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 <stdint.h>
 
#include "rev/ConfigureTypes.h"
#include "rev/DetachedEncoderLowLevel.h"
#include "rev/REVLibError.h"
#include "rev/RelativeEncoder.h"
#include "rev/config/DetachedEncoderConfigAccessor.h"
 
namespace rev::detached {
 
class DetachedEncoderConfig;
 
class DetachedEncoder : public RelativeEncoder, public DetachedEncoderLowLevel {
public:
    DetachedEncoderConfigAccessor configAccessor;
 
    DetachedEncoder(DetachedEncoder&& rhs) = default;
    DetachedEncoder& operator=(DetachedEncoder&& rhs) = default;
 
    DetachedEncoder(const DetachedEncoder& rhs) = default;
 
    ~DetachedEncoder() override = default;
 
    double GetPosition() const override;
 
    double GetVelocity() const override;
 
    double GetAngle() const;
 
    double GetRawAngle() const;
 
    REVLibError SetPosition(double position) override;
 
    /* ***** Extended Functions ****** */
 
    REVLibError Configure(DetachedEncoderConfig& config,
                          rev::ResetMode resetMode);
 
    struct Faults {
        bool unexpected;
        bool hasReset;
        bool canTx;
        bool canRx;
        bool eeprom;
 
        int rawBits;
    };
 
    Faults GetFaults() const;
 
    Faults GetStickyFaults() const;
 
    REVLibError ClearFaults();
 
protected:
    DetachedEncoder(int deviceID, EncoderModel model);
};
 
}  // namespace rev::detached