Module michaellee1019:i2cdetect

A Viam module for i2c troubleshooting.

Model i2cdetect

This is a Viam Sensor component that returns all active i2c addresses as sensor values. Useful for troubleshooting wiring and connection issues without having to install the i2cdetect linux command or SSH into the device.

Configuration

{
  "i2c_bus": <int>
}

Attributes

The following attributes are available for this model:

Name	Type	Inclusion	Description
i2c_bus	int	Optional	The I2C bus number. Defaults to 1.

GetReadings

The Sensor.GetReadings response will look like the following. It will list the hexidecimal i2c address of each device that is communicating over the i2c bus. Note that the api call will trigger a read from devices at all addresses on the bus. It could have unindended consequences for devices that perform operations during a read, but is generally safe.

	
{
  "active": [
    "0x68"
  ]
}