985ad3d8e3
* Add and update I2C topics * Throw in some edits for the serial buffer apis * Add an example to serial read buffer
1.8 KiB
i2c Read Buffer
Read data into a buffer from a device at an I2C address.
pins.i2cReadBuffer(0, 0, false);
A device connected to the I2C pins on the @boardname@ at the address is selected to read data from. If it has data available to transfer, the data is received and copied into a buffer for your program to use. Your program says how big (how many bytes to receive) the buffer should be. You won't get back that many bytes of data if the connected device has less to send than what you asked for.
~hint
Simulator
This function needs real hardware to work with. It's not supported in the simulator.
~
Parameters
- address: the 7-bit I2C address to read the data from.
- size: the number of bytes to read into the buffer from the device.
- repeated: if
true, a repeated start condition is set to help make sure the data is read from the device with out an interruption. If set tofalse(the default), the data is read without setting a start condition more than once.
Returns
- a buffer that contains the data read from the device at the I2C address. The number of bytes returned to you is less than or equal to amount you asked for in the size parameter.
Example
Tell a device connected to the I2C pins with the address of 141 to respond to a read status command. The device sends the status data on the I2C wires if receives a command byte equal to 0. 32 bytes of status data are read into a buffer.
const i2cDevice = 141;
pins.i2cWriteNumber(i2cDevice, NumberFormat.UInt8LE, 0)
let i2cBuffer = pins.i2cReadBuffer(i2cDevice, 32, false);