Package frc.lib5k.components.sensors

Class HallEffect

  • All Implemented Interfaces:
    edu.wpi.first.wpilibj.Sendable, IBinarySensor, java.lang.AutoCloseable
    public class HallEffect
extends edu.wpi.first.wpilibj.DigitalInput
implements IBinarySensor
    Hall effect sensor

    • Nested Class Summary

      • Nested classes/interfaces inherited from class edu.wpi.first.wpilibj.InterruptableSensorBase

        edu.wpi.first.wpilibj.InterruptableSensorBase.WaitResult

    • Field Summary

      • Fields inherited from class edu.wpi.first.wpilibj.InterruptableSensorBase

        m_interrupt, m_isSynchronousInterrupt

    • Constructor Summary

      Constructors 
      Constructor Description
      HallEffect​(int channel)
      Create a digital Hall Effect sensor object

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean get()
      Get binary sensor reading

      • Methods inherited from class edu.wpi.first.wpilibj.DigitalInput

        close, getAnalogTriggerTypeForRouting, getChannel, getPortHandleForRouting, initSendable, isAnalogTrigger, setSimDevice

      • Methods inherited from class edu.wpi.first.wpilibj.InterruptableSensorBase

        allocateInterrupts, cancelInterrupts, disableInterrupts, enableInterrupts, readFallingTimestamp, readRisingTimestamp, requestInterrupts, requestInterrupts, requestInterrupts, setUpSourceEdge, waitForInterrupt, waitForInterrupt

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface edu.wpi.first.wpilibj.Sendable

        addChild, getName, getSubsystem, setName, setName, setName, setName, setSubsystem

    • Constructor Detail

      • HallEffect

        public HallEffect​(int channel)
        Create a digital Hall Effect sensor object
        Parameters:
        channel - DigitalIO channel

    • Method Detail

      • get

        public boolean get()
        Description copied from interface: IBinarySensor
        Get binary sensor reading
        Specified by:
        get in interface IBinarySensor
        Overrides:
        get in class edu.wpi.first.wpilibj.DigitalInput
        Returns:
        Is sensor on?