mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-06-19 00:41:43 +00:00
[wpilib] Add reference to I2C Lockup to API Docs (NFC) (#4340)
This commit is contained in:
@@ -19,6 +19,10 @@ namespace frc {
|
||||
* This class allows access to a Analog Devices ADXL345 3-axis accelerometer on
|
||||
* an I2C bus. This class assumes the default (not alternate) sensor address of
|
||||
* 0x1D (7-bit address).
|
||||
*
|
||||
* 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.
|
||||
*/
|
||||
class ADXL345_I2C : public Accelerometer,
|
||||
public nt::NTSendable,
|
||||
|
||||
@@ -15,6 +15,10 @@ namespace frc {
|
||||
*
|
||||
* This class is intended to be used by sensor (and other I2C device) drivers.
|
||||
* It probably should not be used directly.
|
||||
*
|
||||
* 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.
|
||||
*/
|
||||
class I2C {
|
||||
public:
|
||||
|
||||
@@ -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;
|
||||
|
||||
@@ -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 {
|
||||
|
||||
Reference in New Issue
Block a user