Resolving I2C Bus Hang and Timeout on ESP32

What causes this

I2C bus hang on the ESP32 is typically caused by improper handling of the I2C bus state, often due to a slave device holding the SDA line low. This can occur when the ESP32, acting as an I2C master, fails to complete a transaction due to noise, power fluctuations, or a misbehaving slave device. The ESP32's I2C hardware peripheral uses registers such as I2C_SDA_HOLD_REG and I2C_SCL_LOW_PERIOD_REG to manage timing and signal integrity. A common culprit is the lack of proper pull-up resistors on the SDA and SCL lines, which can cause indefinite bus lockup. The ESP-IDF libraries utilize error codes like ESP_ERR_TIMEOUT to signal these issues, but these may not always be caught or logged unless explicitly handled in firmware.

Minimal reproduction

The following code snippet demonstrates a minimal example that triggers an I2C bus hang. The issue arises when a slave device is disconnected mid-transaction.

```cpp

#include

#define I2C_ADDRESS 0x68

void setup() {

Serial.begin(115200);

Wire.begin();

Wire.beginTransmission(I2C_ADDRESS);

int error = Wire.endTransmission();

if (error != 0) {

Serial.printf("I2C Error: %d\n", error);

}

}

void loop() {

// Intentionally left empty

}

```

Expected Serial Output:

```

I2C Error: 2

```

This output indicates an ESP_ERR_TIMEOUT, signaling a bus lockup.

The fix

To resolve the I2C bus hang, ensure proper hardware setup and implement a reset mechanism for the I2C bus. Here's an improved code snippet:

Before:

```cpp

Wire.beginTransmission(I2C_ADDRESS);

int error = Wire.endTransmission();

```

After:

```cpp

Wire.beginTransmission(I2C_ADDRESS);

int error = Wire.endTransmission();

if (error != 0) {

Serial.printf("I2C Error: %d\n", error);

Wire.begin(); // Reinitialize I2C to reset the bus

}

```

Additionally, ensure that pull-up resistors (typically 4.7kΩ) are connected to the SDA and SCL lines.

How SerialDoctor catches this

SerialDoctor reads the serial output from your ESP32 device, swiftly identifying common I2C issues like bus hangs. By analyzing error codes such as ESP_ERR_TIMEOUT, SerialDoctor provides a precise diagnosis in under 3 seconds, guiding you to the root cause and suggesting remedies. Discover how at serialdoctor.com.

Quick checklist

• Ensure SDA and SCL lines have appropriate pull-up resistors.
• Use error handling to reset the I2C bus on failure.
• Verify that all slave devices are powered and properly connected.
• Minimize noise and power fluctuations on the I2C lines.
• Regularly update ESP-IDF libraries to leverage the latest fixes.

Seeing this crash on your board right now?

Connect it to SerialDoctor and get a root cause + code fix in under 3 seconds.