Configure a BME280 Environmental Sensor

Configure a bme280 sensor to integrate a BME280 environmental sensor, used for sensing temperature, humidity, and barometric pressure, into your machine:

Navigate to the Config tab of your machine’s page in the Viam app. Click on the Components subtab and click Create component. Select the sensor type, then select the bme280 model. Enter a name for your sensor and click Create.

Creation of a bme280 sensor in the Viam app config builder.

Copy and paste the following attribute template into your sensor’s Attributes box. Then remove and fill in the attributes as applicable to your sensor, according to the table below.

{
  "i2c_bus": "<your-i2c-bus-index-on-board>",
  "i2c_address": "<your-i2c-address>"
}
{
  "i2c_bus": "1"
}
{
  "components": [
    {
      "name": "<your-bme280-sensor-name>",
      "model": "bme280",
      "type": "sensor",
      "namespace": "rdk",
      "attributes": {
        "i2c_bus": "<your-i2c-bus-index-on-board>",
        "i2c_address": "<your-i2c-address>"
      },
      "depends_on": []
    }
  ]
}

The following attributes are available for bme280 sensors:

AttributeTypeInclusionDescription
i2c_busstringRequiredThe index of the I2C bus on the board that the sensor is wired to.
i2c_addressstringOptionalDefault: 0x77. The I2C device address of the sensor.

Test the sensor

After you configure your sensor, navigate to the Control tab and select the Sensors dropdown panel. If you have multiple sensors configured, your sensor will be listed here among others. To access detailed readings from your sensor, select the Get Readings button.

The sensor component in the control tab


Have questions, or want to meet other people working on robots? Join our Community Discord.

If you notice any issues with the documentation, feel free to file an issue or edit this file.