This function configures and initializes the desired I²C module with default settings.

This function enables the I²C module by setting the I2CEN bit. The rest of the bits in I²C control register remains unchanged. Default initialization (after reset) of I²C module is :

• Continue operation in IDLE mode.
• 7-bit slave address.
• Slew rate control enabled for High Speed mode (400 kHz).
• General call address disabled.
• SCL clock stretching disabled.

As per the I²C standard, SCL clock may be 100 kHz or 400 kHz. However, the user can specify any clock rate up to 1 MHz.

• scl: requested serial clock rate.

Nothing.

MCU with the I²C module.

// Initialize the I2C1 module with clock_rate of 100000
I2C1_Init(100000);

• Refer to the MCU's datasheet for correct values of the scl in respect with Fosc.
• I²C library routines require you to specify the module you want to use. To select the desired I²C module, simply change the letter x in the routine prototype for a number from 1 to 5.
• Number of I²C modules per MCU differs from chip to chip. Please, read the appropriate datasheet before utilizing this library.

This function configures and initializes the desired I²C module using Peripheral Bus Clock and default initialization settings.

As per the I²C standard, SCL clock may be 100 kHz or 400 kHz. However, the user can specify any clock rate up to 1 MHz.

• Fclk_Khz: Peripheral Bus Clock frequency in kHz.
• scl: requested serial clock rate.

Nothing.

MCU with the I²C module.

I2C1_Init_Advanced(50000, 100000);

• I²C library routines require you to specify the module you want to use. To select the desired I²C module, simply change the letter x in the routine prototype for a number from 1 to 5.
• Number of I²C modules per MCU differs from chip to chip. Please, read the appropriate datasheet before utilizing this library.

Determines if the I²C bus is free and issues START signal.

None.

• 0 if I²C bus was successfully started.
• 0xFFFF if I²C bus was not successfully started.

MCU with at least one I²C module.

Used I²C module must be initialized before using this function. See I2Cx_Init routine.

// Issue START signal
I2C1_Start();

• I²C library routines require you to specify the module you want to use. To select the desired I²C module, simply change the letter x in the routine prototype for a number from 1 to 5.
• Number of I²C modules per MCU differs from chip to chip. Please, read the appropriate datasheet before utilizing this library.

Issues repeated START signal.

None.

• 0 if I²C bus was successfully restarted.
• 0xFFFF if I²C bus was not successfully restarted.

MCU with at least one I²C module.

Used I²C module must be initialized before using this function. See I2Cx_Init routine.

// Issue RESTART signal
I2C1_Restart();

• I²C library routines require you to specify the module you want to use. To select the desired I²C module, simply change the letter x in the routine prototype for a number from 1 to 5.
• Number of I²C modules per MCU differs from chip to chip. Please, read the appropriate datasheet before utilizing this library.

Waits for the I²C bus to become free. This is a blocking function.

None.

• 0 if I²C bus is free.
• 1 if I²C bus is not free.

MCU with at least one I²C module.

Used I²C module must be initialized before using this function. See I2Cx_Init routine.

unsigned char data_;
...
if (!I2C1_Is_Idle)
  I2C1_Write(data_);
...

• I²C library routines require you to specify the module you want to use. To select the desired I²C module, simply change the letter x in the routine prototype for a number from 1 to 5.
• Number of I²C modules per MCU differs from chip to chip. Please, read the appropriate datasheet before utilizing this library.

Reads a byte from the I²C bus.

• ack: acknowledge signal parameter. If this parameter is _I2C_ACK, acknowledge signal will be sent after reading, if its value is _I2C_NACK, not acknowledge signal will be sent after reading.

Received data.

MCU with at least one I²C module.

Used I²C module must be initialized before using this function. See I2Cx_Init routine.

Also, START signal needs to be issued in order to use this function. See I2Cx_Start.

unsigned char take;
...
// Read data and send the not_acknowledge signal
take = I2C1_Read(_I2C_NACK);

• I²C library routines require you to specify the module you want to use. To select the desired I²C module, simply change the letter x in the routine prototype for a number from 1 to 5.
• Number of I²C modules per MCU differs from chip to chip. Please, read the appropriate datasheet before utilizing this library.

Sends data byte via the I²C bus.

• data_: data to be sent

• 0 if there were no errors.
• 1 if write collision was detected on the I²C bus.

MCU with at least one I²C module.

Used I²C module must be initialized before using this function. See I2Cx_Init routine.

Also, START signal needs to be issued in order to use this function. See I2Cx_Start.

unsigned char data_;
unsigned error;
...
error = I2C1_Write(data_);
error = I2C1_Write(0xA3);

• I²C library routines require you to specify the module you want to use. To select the desired I²C module, simply change the letter x in the routine prototype for a number from 1 to 5.
• Number of I²C modules per MCU differs from chip to chip. Please, read the appropriate datasheet before utilizing this library.

Issues STOP signal.

None.

Nothing.

MCU with at least one I²C module.

Used I²C module must be initialized before using this function. See I2Cx_Init routine.

// Issue STOP signal
I2C1_Stop();

• I²C library routines require you to specify the module you want to use. To select the desired I²C module, simply change the letter x in the routine prototype for a number from 1 to 5.
• Number of I²C modules per MCU differs from chip to chip. Please, read the appropriate datasheet before utilizing this library.

This function checks for a I²C timeout condition in a user defined time period, after which it jumps to a callback function if this condition is met.
Different I²C operations can cause a timeout (read, write, start and repeated start) so user may test which one caused it, as in the example below.

• timeout: Represents a number of while loops in which the I²C timeout condition is checked.
• I2C_timeout: pointer to the callback function. Callback function must be written according to this function prototype :

  void I2C1_TimeoutCallback(char errorCode) {
  
  }	
  

Nothing.

I²C must be configured before using this function. See I2Cx_Init or I2Cx_Init_Advanced.

// define callback function
void I2C1_TimeoutCallback(char errorCode) {

   if (errorCode == _I2C_TIMEOUT_RD) {
     // do something if timeout is caused during read
   }

   if (errorCode == _I2C_TIMEOUT_WR) {
     // do something if timeout is caused during write
   }

   if (errorCode == _I2C_TIMEOUT_STOP) {
     // do something if timeout is caused during stop
   }

   if (errorCode == _I2C_TIMEOUT_START) {
     // do something if timeout is caused during start
   }

   if (errorCode == _I2C_TIMEOUT_REPEATED_START) {
     // do something if timeout is caused during start
   }

   if (errorCode == _I2C_TIMEOUT_INIT) {
     // do something if timeout is caused during initialization
   }

   if (errorCode == _I2C_TIMEOUT_INIT_ADVANCED) {
     // do something if timeout is caused during advanced initialization
   }
   
}	

// initialize I2C module
I2C1_Init(100000);

// set timeout period and callback function
I2C1_SetTimeoutCallback(1000, I2C1_TimeoutCallback);

• I²C library routines require you to specify the module you want to use. To select the desired I²C module, simply change the letter x in the routine prototype for a number from 1 to 5.
• Number of I²C modules per MCU differs from chip to chip. Please, read the appropriate datasheet before utilizing this library.

Sets the active I²C module which will be used by the I²C routines.

• start_ptr: I2Cx_Start handler
• restart_ptr: I2Cx_Restart handler
• read_ptr: I2Cx_Read handler
• write_ptr: I2Cx_Write handler
• stop_ptr: I2Cx_Stop handler
• is_idle_ptr: I2Cx_Is_Idle handler

Nothing.

Used I²C module must be initialized before using this function. See the I2Cx_Init and I2Cx_Init_Advanced routines.

I2C_Set_Active(&I2C1_Start, &I2C1_Restart, &I2C1_Read, &I2C1_Write, &I2C1_Stop, &I2C1_Is_Idle); // Sets the I2C1 module active

Number of I²C modules per MCU differs from chip to chip. Please, read the appropriate datasheet before utilizing this library.

Determines if the I²C bus is free and issues START signal.

This is a generic routine which uses the active I²C module previously activated by the I2C_Set_Active routine.

None.

• 0 if I²C bus was successfully started.
• 0xFFFF if I²C bus was not successfully started.

MCU with at least one I²C module.

Used I²C module must be initialized before using this function. See I2Cx_Init routine.

I2C_Set_Active(&I2C1_Start, &I2C1_Restart, &I2C1_Read, &I2C1_Write, &I2C1_Stop, &I2C1_Is_Idle); // Sets the I2C1 module active
// Issue START signal
I2C1_Start();

None.

Issues repeated START signal.

This is a generic routine which uses the active I²C module previously activated by the I2C_Set_Active routine.

None.

• 0 if I²C bus was successfully restarted.
• 0xFFFF if I²C bus was not successfully restarted.

MCU with at least one I²C module.

Used I²C module must be initialized before using this function. See I2Cx_Init routine.

I2C_Set_Active(&I2C1_Start, &I2C1_Restart, &I2C1_Read, &I2C1_Write, &I2C1_Stop, &I2C1_Is_Idle); // Sets the I2C1 module active
...
// Issue RESTART signal
I2C_Restart();

None.

Waits for the I²C bus to become free. This is a blocking function.

This is a generic routine which uses the active I²C module previously activated by the I2C_Set_Active routine.

None.

• 0 if I²C bus is free.
• 1 if I²C bus is not free.

MCU with at least one I²C module.

Used I²C module must be initialized before using this function. See I2Cx_Init routine.

unsigned char data_;
...
I2C_Set_Active(&I2C1_Start, &I2C1_Restart, &I2C1_Read, &I2C1_Write, &I2C1_Stop, &I2C1_Is_Idle); // Sets the I2C1 module active
if !(I2C_Is_Idle)
  I2C_Write(data_);
...

None.

Reads a byte from the I²C bus.

This is a generic routine which uses the active I²C module previously activated by the I2C_Set_Active routine.

• ack: acknowledge signal parameter. If this parameter is _I2C_ACK, acknowledge signal will be sent after reading, if its value is _I2C_NACK, not acknowledge signal will be sent after reading.

Received data.

MCU with at least one I²C module.

Used I²C module must be initialized before using this function. See I2Cx_Init routine.

Also, START signal needs to be issued in order to use this function. See I2Cx_Start.

unsigned char take;
...
I2C_Set_Active(&I2C1_Start, &I2C1_Restart, &I2C1_Read, &I2C1_Write, &I2C1_Stop, &I2C1_Is_Idle); // Sets the I2C1 module active

// Read data and send the not_acknowledge signal
take = I2C_Read(_I2C_NACK);

None.

Sends data byte via the I²C bus.

This is a generic routine which uses the active I²C module previously activated by the I2C_Set_Active routine.

• data_: data to be sent

• 0 if there were no errors.
• 1 if write collision was detected on the I²C bus.

MCU with at least one I²C module.

Used I²C module must be initialized before using this function. See I2Cx_Init routine.

Also, START signal needs to be issued in order to use this function. See I2Cx_Start.

unsigned char data_;
unsigned error;
...

I2C_Set_Active(&I2C1_Start, &I2C1_Restart, &I2C1_Read, &I2C1_Write, &I2C1_Stop, &I2C1_Is_Idle); // Sets the I2C1 module active

error = I2C_Write(data_);
error = I2C_Write(0xA3);

None.

Issues STOP signal.

This is a generic routine which uses the active I²C module previously activated by the I2C_Set_Active routine.

None.

Nothing.

MCU with at least one I²C module.

Used I²C module must be initialized before using this function. See I2Cx_Init routine.

I2C_Set_Active(&I2C1_Start, &I2C1_Restart, &I2C1_Read, &I2C1_Write, &I2C1_Stop, &I2C1_Is_Idle); // Sets the I2C1 module active
// Issue STOP signal
I2C_Stop();

None.