Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-06-24 01:31:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

[wpilib] Add reference to I2C Lockup to API Docs (NFC) (#4340)

Browse Source
This commit is contained in:
sciencewhiz
2022-07-29 21:01:21 -07:00
committed by GitHub
parent ce1a90d639
commit 19ffebaf3e
4 changed files with 19 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
wpilibj/src/main/java/edu/wpi/first/wpilibj/ADXL345_I2C.java
View File

@@ -18,7 +18,13 @@ import edu.wpi.first.wpilibj.interfaces.Accelerometer;
import java.nio.ByteBuffer;
import java.nio.ByteOrder;
/** ADXL345 I2C Accelerometer. */
/**
* ADXL345 I2C Accelerometer.
*
* <p>The Onboard I2C port is subject to system lockups. See <a
* href="https://docs.wpilib.org/en/stable/docs/yearly-overview/known-issues.html#onboard-i2c-causing-system-lockups">
* WPILib Known Issues</a> page for details.
*/
@SuppressWarnings({"TypeName", "PMD.UnusedPrivateField"})
public class ADXL345_I2C implements Accelerometer, NTSendable, AutoCloseable {
private static final byte kAddress = 0x1D;

4
wpilibj/src/main/java/edu/wpi/first/wpilibj/I2C.java
View File

@@ -17,6 +17,10 @@ import java.nio.ByteBuffer;
*
* <p>This class is intended to be used by sensor (and other I2C device) drivers. It probably should
* not be used directly.
*
* <p>The Onboard I2C port is subject to system lockups. See <a
* href="https://docs.wpilib.org/en/stable/docs/yearly-overview/known-issues.html#onboard-i2c-causing-system-lockups">
* WPILib Known Issues</a> page for details.
*/
public class I2C implements AutoCloseable {
public enum Port {