Bug in `readRegister()` – Incorrect register byte count in `readRegisters` call

[justkozi]

Bug in readRegister() – Incorrect register byte count in readRegisters call

Description

While working with the TMAG5273 sensor on the Raspberry Pi Pico using your library, I encountered a communication issue which I traced back to the readRegister() function.

Problem

The current implementation reads 2 bytes from a register instead of the expected 1 byte, which leads to incorrect behavior on devices with strict I2C read handling like the Pi Pico.

uint8_t TMAG5273::readRegister(uint8_t regAddress)
{
    uint8_t regVal = 0;
    readRegisters(regAddress, &regVal, 2);  // <-- Incorrect byte count
    return regVal;
}

Fix

uint8_t TMAG5273::readRegister(uint8_t regAddress)
{
    uint8_t regVal = 0;
    readRegisters(regAddress, &regVal, 1);  // <-- Should read only 1 byte
    return regVal;
}

Impact

• Causes data corruption or bus errors on microcontrollers with strict I2C behavior
• Verified specifically on Raspberry Pi Pico (RP2040)

Please consider updating the library accordingly. Let me know if a pull request is preferred—I’d be happy to submit one.

[kdyke]

I just hit this as well trying to use this library with the SparkFun SAMD21 board. Among other things this also trashes values on the stack, causing functions that call this to wind up with locally corrupted values, and this causes the sensor init to fail for me. The read of 2 bytes is very clearly wrong as it’s trying to read two bytes where there is only storage for one.

[thebluewizards]

I agree. This fixed some of my issues when trying to wire multiple boards simultaneously

[gigapod]

We will get this looked at/fixed next week (12/8).

Kirk

[gigapod]

FYI - I should have a fix for this and a few other issues out later this week.

Most of this work is done and on the 'feature/sparkfun-toolkit' branch. I moved this library to our common I2C implementation in the SparkFun Toolkit library.

[gigapod]

This was fixed in version 2.0 - which now uses the SparkFun Toolkit for communication.