Interface: tos.interfaces.I2CPacket

interface I2CPacket<typedef addr_size>

Commands

command error_t read(i2c_flags_t flags, uint16_t addr, uint8_t length, uint8_t *data) Perform an I2C read operation

command error_t write(i2c_flags_t flags, uint16_t addr, uint8_t length, uint8_t *data) Perform an I2C write operation

Events

event void readDone(error_t error, uint16_t addr, uint8_t length, uint8_t *data) Notification that the read operation has completed

event void writeDone(error_t error, uint16_t addr, uint8_t length, uint8_t *data) Notification that the write operation has completed

Commands - Details

command error_t read(i2c_flags_t flags, uint16_t addr, uint8_t length, uint8_t *data)

Perform an I2C read operation

Parameters:: flags - Flags that may be logical ORed and defined by: I2C_START - The START condition is transmitted at the beginning of the packet if set. I2C_STOP - The STOP condition is transmitted at the end of the packet if set. I2C_ACK_END - ACK the last byte if set. Otherwise NACK last byte. This flag cannot be used with the I2C_STOP flag.; addr - The slave device address. Only used if I2C_START is set.; length - Length, in bytes, to be read; 'uint8_t* COUNT(length) data' A point to a data buffer to read into
Returns:: SUCCESS if bus available and request accepted.

command error_t write(i2c_flags_t flags, uint16_t addr, uint8_t length, uint8_t *data)

Perform an I2C write operation

Parameters:: flags - Flags that may be logical ORed and defined by: I2C_START - The START condition is transmitted at the beginning of the packet if set. I2C_STOP - The STOP condition is transmitted at the end of the packet if set.; addr - The slave device address. Only used if I2C_START is set.; length - Length, in bytes, to be read; 'uint8_t* COUNT(length) data' A point to a data buffer to read into
Returns:: SUCCESS if bus available and request accepted.

Events - Details

event void readDone(error_t error, uint16_t addr, uint8_t length, uint8_t *data)

Notification that the read operation has completed

Parameters:: addr - The slave device address; length - Length, in bytes, read; 'uint8_t* COUNT(length) data' Pointer to the received data buffer; success - SUCCESS if transfer completed without error.

event void writeDone(error_t error, uint16_t addr, uint8_t length, uint8_t *data)

Notification that the write operation has completed

Parameters:: addr - The slave device address; length - Length, in bytes, written; 'uint8_t* COUNT(length) data' Pointer to the data buffer written; success - SUCCESS if transfer completed without error.