mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-06-19 00:41:43 +00:00
f65e697107
I'm not 100% sure whether we want these, but they are a quick find and replace to do. Basically, there are two primary things that we have done this summer that break existing user code: -Changing GetInstance() calls to return references instead of pointers. This forces users to change from doing something like LiveWindow::GetInstance()->AddSensor() to LiveWindow::GetInstance().AddSensor(). -Making PIDGet() and related calls const, forcing users to change the function signatures wherever they override them. The GetInstance() calls don't really matter to me either way, especially since there are no real ownership issues going on there, unlike the rest of the smart pointer-related changes. For the const stuff, it is certainly more correct to mandate that user PIDGet() functions be const and the such, but at the same time, I'm not sure that there is any strong need for it, and the errors generated are not the most helpful. While this wouldn't necessarily be an issue for more experienced teams or completely new teams (who don't have any old code to be reusing), it may cause issues for more average teams who aren't familiar with the intricacies of C++ anything. Change-Id: I6e7007982069292ea70e6d0fc8ca40203340df1b
120 lines
4.6 KiB
C++
120 lines
4.6 KiB
C++
/*----------------------------------------------------------------------------*/
|
|
/* Copyright (c) FIRST 2008. All Rights Reserved.
|
|
*/
|
|
/* Open Source Software - may be modified and shared by FRC teams. The code */
|
|
/* must be accompanied by the FIRST BSD license file in $(WIND_BASE)/WPILib. */
|
|
/*----------------------------------------------------------------------------*/
|
|
#pragma once
|
|
|
|
#include "HAL/HAL.hpp"
|
|
#include "CounterBase.h"
|
|
#include "SensorBase.h"
|
|
#include "Counter.h"
|
|
#include "PIDSource.h"
|
|
#include "LiveWindow/LiveWindowSendable.h"
|
|
|
|
#include <memory>
|
|
|
|
class DigitalSource;
|
|
|
|
/**
|
|
* Class to read quad encoders.
|
|
* Quadrature encoders are devices that count shaft rotation and can sense
|
|
* direction. The output of
|
|
* the QuadEncoder class is an integer that can count either up or down, and can
|
|
* go negative for
|
|
* reverse direction counting. When creating QuadEncoders, a direction is
|
|
* supplied that changes the
|
|
* sense of the output to make code more readable if the encoder is mounted such
|
|
* that forward movement
|
|
* generates negative values. Quadrature encoders have two digital outputs, an A
|
|
* Channel and a B Channel
|
|
* that are out of phase with each other to allow the FPGA to do direction
|
|
* sensing.
|
|
*
|
|
* All encoders will immediately start counting - Reset() them if you need them
|
|
* to be zeroed before use.
|
|
*/
|
|
class Encoder : public SensorBase,
|
|
public CounterBase,
|
|
public PIDSource,
|
|
public LiveWindowSendable {
|
|
public:
|
|
enum IndexingType {
|
|
kResetWhileHigh,
|
|
kResetWhileLow,
|
|
kResetOnFallingEdge,
|
|
kResetOnRisingEdge
|
|
};
|
|
|
|
Encoder(uint32_t aChannel, uint32_t bChannel, bool reverseDirection = false,
|
|
EncodingType encodingType = k4X);
|
|
Encoder(std::shared_ptr<DigitalSource> aSource,
|
|
std::shared_ptr<DigitalSource> bSource,
|
|
bool reverseDirection = false, EncodingType encodingType = k4X);
|
|
[[deprecated(
|
|
"Raw pointers are deprecated; if you wish to construct your own copy of "
|
|
"the DigitalSource and pass it to the constructor, use an "
|
|
"std::shared_ptr instead.")]]
|
|
Encoder(DigitalSource *aSource, DigitalSource *bSource,
|
|
bool reverseDirection = false, EncodingType encodingType = k4X);
|
|
[[deprecated(
|
|
"References are deprecated; if you wish to construct your own copy of "
|
|
"the DigitalSource and pass it to the constructor, use an "
|
|
"std::shared_ptr instead.")]]
|
|
Encoder(DigitalSource &aSource, DigitalSource &bSource,
|
|
bool reverseDirection = false, EncodingType encodingType = k4X);
|
|
virtual ~Encoder();
|
|
|
|
// CounterBase interface
|
|
int32_t Get() const override;
|
|
int32_t GetRaw() const;
|
|
int32_t GetEncodingScale() const;
|
|
void Reset() override;
|
|
double GetPeriod() const override;
|
|
void SetMaxPeriod(double maxPeriod) override;
|
|
bool GetStopped() const override;
|
|
bool GetDirection() const override;
|
|
|
|
double GetDistance() const;
|
|
double GetRate() const;
|
|
void SetMinRate(double minRate);
|
|
void SetDistancePerPulse(double distancePerPulse);
|
|
void SetReverseDirection(bool reverseDirection);
|
|
void SetSamplesToAverage(int samplesToAverage);
|
|
int GetSamplesToAverage() const;
|
|
double PIDGet() override;
|
|
|
|
void SetIndexSource(uint32_t channel, IndexingType type = kResetOnRisingEdge);
|
|
[[deprecated("Raw pointers are deprecated; use references instead.")]]
|
|
void SetIndexSource(DigitalSource *source,
|
|
IndexingType type = kResetOnRisingEdge);
|
|
void SetIndexSource(const DigitalSource &source,
|
|
IndexingType type = kResetOnRisingEdge);
|
|
|
|
void UpdateTable() override;
|
|
void StartLiveWindowMode() override;
|
|
void StopLiveWindowMode() override;
|
|
std::string GetSmartDashboardType() const override;
|
|
void InitTable(std::shared_ptr<ITable> subTable) override;
|
|
std::shared_ptr<ITable> GetTable() const override;
|
|
|
|
int32_t GetFPGAIndex() const { return m_index; }
|
|
|
|
private:
|
|
void InitEncoder(bool _reverseDirection, EncodingType encodingType);
|
|
double DecodingScaleFactor() const;
|
|
|
|
std::shared_ptr<DigitalSource> m_aSource; // the A phase of the quad encoder
|
|
std::shared_ptr<DigitalSource> m_bSource; // the B phase of the quad encoder
|
|
void *m_encoder = nullptr;
|
|
int32_t m_index = 0; // The encoder's FPGA index.
|
|
double m_distancePerPulse = 1.0; // distance of travel for each encoder tick
|
|
std::unique_ptr<Counter> m_counter =
|
|
nullptr; // Counter object for 1x and 2x encoding
|
|
EncodingType m_encodingType; // Encoding type
|
|
int32_t m_encodingScale; // 1x, 2x, or 4x, per the encodingType
|
|
|
|
std::shared_ptr<ITable> m_table = nullptr;
|
|
};
|