io.github.robolib.module.sensor

Class Potentiometer

java.lang.Object

io.github.robolib.module.iface.Interface

io.github.robolib.module.iface.AnalogIO

io.github.robolib.module.iface.AnalogInput

io.github.robolib.module.sensor.Potentiometer

All Implemented Interfaces:

AngleSource, LiveWindowSendable, NumberSource, Sendable, UpdatingSendable, Module, SensorModule

public class Potentiometer
extends AnalogInput
implements SensorModule, AngleSource

Potentiometer Class. Wraps the AnalogInput class.

Author:

noriah

Nested Class Summary

Nested classes/interfaces inherited from class io.github.robolib.module.iface.AnalogInput

AnalogInput.AccumulatorResult, AnalogInput.AnalogTriggerType

Nested classes/interfaces inherited from class io.github.robolib.module.iface.AnalogIO

AnalogIO.AnalogChannel, AnalogIO.Direction

Nested classes/interfaces inherited from class io.github.robolib.module.iface.Interface

Interface.InterfaceType

Field Summary

Fields inherited from class io.github.robolib.module.iface.AnalogInput

m_table

Fields inherited from class io.github.robolib.module.iface.AnalogIO

m_channel, m_port, m_portPointer

Fields inherited from class io.github.robolib.module.iface.Interface

m_ifaceType, MAX_ANALOG_IN_CHANNELS, MAX_ANALOG_OUT_CHANNELS, MAX_DIGITAL_CHANNELS, MAX_PWM_CHANNELS, MAX_RELAY_CHANNELS

Constructor Summary

Constructors

Constructor and Description
Potentiometer(AnalogIO.AnalogChannel channel, int avgBits, int ovrBits) Instantiates a new potentiometer.

Method Summary

Modifier and Type	Method and Description
void	disableModule() Disable the module
void	enableModule() Enable the module
double	getAngle()
boolean	getModuleEnabled()
java.lang.String	getSmartDashboardType() Live Window code, only does anything if live window is activated.

Methods inherited from class io.github.robolib.module.iface.AnalogInput

createTriggerOutput, free, get, getAccumulatorCount, getAccumulatorOutput, getAccumulatorValue, getAverageBits, getAverageValue, getAverageVoltage, getGlobalSampleRate, getInWindow, getLSBWeight, getOffset, getOversampleBits, getTable, getTriggerIndex, getTriggerState, getValue, getVoltage, initAccumulator, initTable, initTrigger, isAccumulatorChannel, resetAccumulator, setAccumulatorCenter, setAccumulatorDeadband, setAccumulatorInitialValue, setAverageBits, setAveraged, setFiltered, setGlobalSampleRate, setLimitsRaw, setLimitsVoltage, setOversampleBits, startLiveWindowMode, stopLiveWindowMode, updateTable

Methods inherited from class io.github.robolib.module.iface.AnalogIO

getChannel, getChannelNumber

Methods inherited from class io.github.robolib.module.iface.Interface

allocateMXPPin, checkAnalogInputChannel, checkAnalogOutputChannel, checkDigitalChannel, checkPWMChannel, checkRelayChannel, freeMXPPin, getInterfaceType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Potentiometer

public Potentiometer(AnalogIO.AnalogChannel channel,
                     int avgBits,
                     int ovrBits)

Instantiates a new potentiometer.

Parameters:

channel - AnalogIO Channel of the Potentiometer

avgBits - Number of Averaging Bits

ovrBits - Number of Oversample Bits

Method Detail

getAngle

public double getAngle()

Specified by:

getAngle in interface AngleSource

getSmartDashboardType

public java.lang.String getSmartDashboardType()

Live Window code, only does anything if live window is activated.

Specified by:

getSmartDashboardType in interface Sendable

Overrides:

getSmartDashboardType in class AnalogInput

enableModule

public void enableModule()

Enable the module

Specified by:

enableModule in interface Module

disableModule

public void disableModule()

Disable the module

Specified by:

disableModule in interface Module

getModuleEnabled

public boolean getModuleEnabled()

Specified by:

getModuleEnabled in interface Module