mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-06-20 00:51:42 +00:00
7eb8550bdb
The changes made in this commit do not affect any actual code,
they are purely aesthetic. I ran clang-format with google style
over all .h/.cpp files in wpilibc that weren't in wpilibC++Sim
or gtest, and the eclipse formatter over all of the Java files
using the Google eclipse formatting configuration.
Change-Id: I9627bca0bc103c398ecc1c5ba17467193291ae63
110 lines
4.0 KiB
C++
110 lines
4.0 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"
|
|
|
|
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(DigitalSource *aSource, DigitalSource *bSource,
|
|
bool reverseDirection = false, EncodingType encodingType = k4X);
|
|
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;
|
|
void SetPIDSourceParameter(PIDSourceParameter pidSource);
|
|
double PIDGet() const override;
|
|
|
|
void SetIndexSource(uint32_t channel, IndexingType type = kResetOnRisingEdge);
|
|
void SetIndexSource(DigitalSource *source,
|
|
IndexingType type = kResetOnRisingEdge);
|
|
void SetIndexSource(DigitalSource &source,
|
|
IndexingType type = kResetOnRisingEdge);
|
|
|
|
void UpdateTable() override;
|
|
void StartLiveWindowMode() override;
|
|
void StopLiveWindowMode() override;
|
|
std::string GetSmartDashboardType() const override;
|
|
void InitTable(ITable *subTable) override;
|
|
ITable *GetTable() const override;
|
|
|
|
int32_t GetFPGAIndex() const { return m_index; }
|
|
|
|
private:
|
|
void InitEncoder(bool _reverseDirection, EncodingType encodingType);
|
|
double DecodingScaleFactor() const;
|
|
|
|
DigitalSource *m_aSource; // the A phase of the quad encoder
|
|
DigitalSource *m_bSource; // the B phase of the quad encoder
|
|
bool m_allocatedASource; // was the A source allocated locally?
|
|
bool m_allocatedBSource; // was the B source allocated locally?
|
|
void *m_encoder;
|
|
int32_t m_index; // The encoder's FPGA index.
|
|
double m_distancePerPulse; // distance of travel for each encoder tick
|
|
Counter *m_counter; // Counter object for 1x and 2x encoding
|
|
EncodingType m_encodingType; // Encoding type
|
|
int32_t m_encodingScale; // 1x, 2x, or 4x, per the encodingType
|
|
PIDSourceParameter
|
|
m_pidSource; // Encoder parameter that sources a PID controller
|
|
|
|
ITable *m_table;
|
|
};
|