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

I2C: Add tip about writeBulk() to transaction() (#1806)

Browse Source
This commit is contained in:
Austin Shalit
2019-08-04 04:16:38 -04:00
committed by Peter Johnson
parent 607d6c148a
commit 810e58ea85
2 changed files with 7 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
wpilibc/src/main/native/include/frc/I2C.h
View File

@@ -1,5 +1,5 @@
/*----------------------------------------------------------------------------*/
/* Copyright (c) 2008-2018 FIRST. All Rights Reserved. */
/* Copyright (c) 2008-2019 FIRST. All Rights Reserved. */
/* Open Source Software - may be modified and shared by FRC teams. The code */
/* must be accompanied by the FIRST BSD license file in the root directory of */
/* the project. */
@@ -42,7 +42,9 @@ class I2C : public ErrorBase {
* Generic transaction.
*
* This is a lower-level interface to the I2C hardware giving you more control
* over each transaction.
* over each transaction. If you intend to write multiple bytes in the same
* transaction and do not plan to receive anything back, use writeBulk()
* instead. Calling this with a receiveSize of 0 will result in an error.
*
* @param dataToSend Buffer of data to send as part of the transaction.
* @param sendSize Number of bytes to send as part of the transaction.