mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-06-26 01:51:41 +00:00
5c2addda0f
Add missing HAL docs for PCM and PH Fix references to PCM Document different one shot durations for PCM and PH
129 lines
3.6 KiB
C++
129 lines
3.6 KiB
C++
// Copyright (c) FIRST and other WPILib contributors.
|
|
// Open Source Software; you can modify and/or share it under the terms of
|
|
// the WPILib BSD license file in the root directory of this project.
|
|
|
|
#pragma once
|
|
|
|
#include <memory>
|
|
|
|
#include <hal/Types.h>
|
|
#include <wpi/sendable/Sendable.h>
|
|
#include <wpi/sendable/SendableHelper.h>
|
|
|
|
#include "frc/PneumaticsBase.h"
|
|
#include "frc/PneumaticsModuleType.h"
|
|
|
|
namespace frc {
|
|
|
|
/**
|
|
* DoubleSolenoid class for running 2 channels of high voltage Digital Output
|
|
* on a pneumatics module.
|
|
*
|
|
* The DoubleSolenoid class is typically used for pneumatics solenoids that
|
|
* have two positions controlled by two separate channels.
|
|
*/
|
|
class DoubleSolenoid : public wpi::Sendable,
|
|
public wpi::SendableHelper<DoubleSolenoid> {
|
|
public:
|
|
enum Value { kOff, kForward, kReverse };
|
|
|
|
/**
|
|
* Constructs a double solenoid for a specified module of a specific module
|
|
* type.
|
|
*
|
|
* @param module The module of the solenoid module to use.
|
|
* @param moduleType The module type to use.
|
|
* @param forwardChannel The forward channel on the module to control.
|
|
* @param reverseChannel The reverse channel on the module to control.
|
|
*/
|
|
DoubleSolenoid(int module, PneumaticsModuleType moduleType,
|
|
int forwardChannel, int reverseChannel);
|
|
|
|
/**
|
|
* Constructs a double solenoid for a default module of a specific module
|
|
* type.
|
|
*
|
|
* @param moduleType The module type to use.
|
|
* @param forwardChannel The forward channel on the module to control.
|
|
* @param reverseChannel The reverse channel on the module to control.
|
|
*/
|
|
DoubleSolenoid(PneumaticsModuleType moduleType, int forwardChannel,
|
|
int reverseChannel);
|
|
|
|
~DoubleSolenoid() override;
|
|
|
|
DoubleSolenoid(DoubleSolenoid&&) = default;
|
|
DoubleSolenoid& operator=(DoubleSolenoid&&) = default;
|
|
|
|
/**
|
|
* Set the value of a solenoid.
|
|
*
|
|
* @param value The value to set (Off, Forward or Reverse)
|
|
*/
|
|
virtual void Set(Value value);
|
|
|
|
/**
|
|
* Read the current value of the solenoid.
|
|
*
|
|
* @return The current value of the solenoid.
|
|
*/
|
|
virtual Value Get() const;
|
|
|
|
/**
|
|
* Toggle the value of the solenoid.
|
|
*
|
|
* If the solenoid is set to forward, it'll be set to reverse. If the solenoid
|
|
* is set to reverse, it'll be set to forward. If the solenoid is set to off,
|
|
* nothing happens.
|
|
*/
|
|
void Toggle();
|
|
|
|
/**
|
|
* Get the forward channel.
|
|
*
|
|
* @return the forward channel.
|
|
*/
|
|
int GetFwdChannel() const;
|
|
|
|
/**
|
|
* Get the reverse channel.
|
|
*
|
|
* @return the reverse channel.
|
|
*/
|
|
int GetRevChannel() const;
|
|
|
|
/**
|
|
* Check if the forward solenoid is Disabled.
|
|
*
|
|
* If a solenoid is shorted, it is added to the DisabledList and disabled
|
|
* until power cycle, or until faults are cleared.
|
|
*
|
|
* @see ClearAllStickyFaults()
|
|
* @return If solenoid is disabled due to short.
|
|
*/
|
|
bool IsFwdSolenoidDisabled() const;
|
|
|
|
/**
|
|
* Check if the reverse solenoid is Disabled.
|
|
*
|
|
* If a solenoid is shorted, it is added to the DisabledList and disabled
|
|
* until power cycle, or until faults are cleared.
|
|
*
|
|
* @see ClearAllStickyFaults()
|
|
* @return If solenoid is disabled due to short.
|
|
*/
|
|
bool IsRevSolenoidDisabled() const;
|
|
|
|
void InitSendable(wpi::SendableBuilder& builder) override;
|
|
|
|
private:
|
|
std::shared_ptr<PneumaticsBase> m_module;
|
|
int m_forwardChannel; // The forward channel on the module to control.
|
|
int m_reverseChannel; // The reverse channel on the module to control.
|
|
int m_forwardMask; // The mask for the forward channel.
|
|
int m_reverseMask; // The mask for the reverse channel.
|
|
int m_mask;
|
|
};
|
|
|
|
} // namespace frc
|