Interface: I2C

Byte and Command interface for using the I2C hardware bus

Components providing this interface:

tos.platform.mica.I2CC
tos.platform.mica.I2CM

Components requiring this interface:

tos.sensorboards.micasb.I2CPotM

Commands

• result_t sendStart(void) Checks if the bus is free and sends a start condition

  Returns:

  SUCCESS if the start request is accepted, FAIL otherwise

• result_t sendEnd(void) Sends a stop/end condition over the bus

  Returns:

  SUCCESS if the end request is accepted, FAIL otherwise

• result_t read(bool ack) reads a single byte from the I2C bus from a slave device

  Returns:

  SUCCESS if the read request is accepted, FAIL otherwise

• result_t write(char data) writes a single byte to the I2C bus from master to slave

  Returns:

  SUCCESS if the write request is accepted, FAIL otherwise

• result_t sendStartDone(void) Notifies that the start condition has been established

  Returns:

  SUCCESS to continue using the bus, FAIL to release it

• result_t sendEndDone(void) Notifies that the end condition has been established

  Returns:

  Always return SUCCESS (you have released the bus)

• result_t readDone(char data) Returns the byte read from the I2C bus

  Returns:

  SUCCESS to continue using the bus, FAIL to release it

• result_t writeDone(bool success) Notifies that the byte has been written to the I2C bus

  Parameters:	success - SUCCESS if the slave acknowledged the byte, FAIL otherwise
  Returns:	SUCCESS to continue using the bus, FAIL to release it