Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-07-02 02:51:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fixed inconsistencies in documentation (#168)

Browse Source
This commit is contained in:
Tyler Veness
2016-07-12 10:50:21 -07:00
committed by Peter Johnson
parent c99e89dfca
commit 3fade171f9
2 changed files with 12 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
wpilibc/athena/include/AnalogTriggerOutput.h
View File

@@ -12,13 +12,15 @@
class AnalogTrigger;
/** Class to represent a specific output from an analog trigger.
* This class is used to get the current output value and also as a
/**
* Class to represent a specific output from an analog trigger.
*
* This class is used to get the current output value and also as a
* DigitalSource to provide routing of an output to digital subsystems on the
* FPGA such as Counter, Encoder, and Interrupt.
*
* The TriggerState output indicates the primary output value of the trigger.
* If the analog signal is less than the lower limit, the output is false. If
* If the analog signal is less than the lower limit, the output is false. If
* the analog value is greater than the upper limit, then the output is true.
* If the analog value is in between, then the trigger output state maintains
* its most recent value.
@@ -27,18 +29,18 @@ class AnalogTrigger;
* range defined by the limits.
*
* The RisingPulse and FallingPulse outputs detect an instantaneous transition
* from above the upper limit to below the lower limit, and vise versa. These
* from above the upper limit to below the lower limit, and vise versa. These
* pulses represent a rollover condition of a sensor and can be routed to an up
* / down couter or to interrupts. Because the outputs generate a pulse, they
* cannot be read directly. To help ensure that a rollover condition is not
* / down couter or to interrupts. Because the outputs generate a pulse, they
* cannot be read directly. To help ensure that a rollover condition is not
* missed, there is an average rejection filter available that operates on the
* upper 8 bits of a 12 bit number and selects the nearest outlyer of 3 samples.
* This will reject a sample that is (due to averaging or sampling) errantly
* between the two limits. This filter will fail if more than one sample in a
* row is errantly in between the two limits. You may see this problem if
* between the two limits. This filter will fail if more than one sample in a
* row is errantly in between the two limits. You may see this problem if
* attempting to use this feature with a mechanical rollover sensor, such as a
* 360 degree no-stop potentiometer without signal conditioning, because the
* rollover transition is not sharp / clean enough. Using the averaging engine
* rollover transition is not sharp / clean enough. Using the averaging engine
* may help with this, but rotational speeds of the sensor will then be limited.
*/
class AnalogTriggerOutput : public DigitalSource {

2
wpilibc/athena/src/DriverStation.cpp
View File

@@ -462,7 +462,7 @@ bool DriverStation::IsBrownedOut() const {
* this function was called?
*
* Warning: If you call this function from more than one place at the same time,
* you will not get the get the intended behaviour.
* you will not get the intended behavior.
*
* @return True if the control data has been updated since the last call.
*/