Files
allwpilib/wpilibc/wpilibC++Devices/include/Relay.h
James Kuszmaul 4b575e3e7e Replaced ::std with std for readability/consistency.
Change-Id: I65f9673c237d3513f99827e28963eb22ae9df0c2
2015-07-29 16:48:04 -04:00

58 lines
2.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 "SensorBase.h"
#include "tables/ITableListener.h"
#include "LiveWindow/LiveWindowSendable.h"
#include "tables/ITable.h"
#include <memory>
/**
* Class for Spike style relay outputs.
* Relays are intended to be connected to spikes or similar relays. The relay
* channels controls
* a pair of pins that are either both off, one on, the other on, or both on.
* This translates into
* two spike outputs at 0v, one at 12v and one at 0v, one at 0v and the other at
* 12v, or two
* spike outputs at 12V. This allows off, full forward, or full reverse control
* of motors without
* variable speed. It also allows the two channels (forward and reverse) to be
* used independently
* for something that does not care about voltage polatiry (like a solenoid).
*/
class Relay : public SensorBase,
public ITableListener,
public LiveWindowSendable {
public:
enum Value { kOff, kOn, kForward, kReverse };
enum Direction { kBothDirections, kForwardOnly, kReverseOnly };
Relay(uint32_t channel, Direction direction = kBothDirections);
virtual ~Relay();
void Set(Value value);
Value Get() const;
void ValueChanged(std::shared_ptr<ITable> source, const std::string& key, EntryValue value,
bool isNew) override;
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;
std::shared_ptr<ITable> m_table = nullptr;
private:
uint32_t m_channel;
Direction m_direction;
};