BME280 SPI #5538

apbodrov · 2023-10-16T06:00:56Z

What does this implement/fix?

Implements BME280 over SPI.

Breaking change notes: The original bme280 component has been renamed to bme280_i2c for consistency with other platforms. To update your configuration, simply replace bme280 with bme280_i2c. No other changes are required.

Types of changes

Bugfix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
Other

Related issue or feature (if applicable): implements esphome/feature-requests#1321

Pull request in esphome-docs with documentation (if applicable): esphome/esphome-docs#3273

Test Environment

Example entry for `config.yaml`:

spi:
  clk_pin: GPIO18
  mosi_pin: GPIO23
  miso_pin: GPIO19

sensor:
  - platform: bme280_spi
    temperature:
      name: "BME280 Temperature"
      oversampling: 16x
    pressure:
      name: "BME280 Pressure"
    humidity:
      name: "BME280 Humidity"
    update_interval: 60s
    cs_pin: GPIO5

Checklist:

The code change is tested and works locally.
Tests have been added to verify that the new code works (under tests/ folder).

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated in esphome-docs.

probot-esphome · 2023-10-16T06:01:09Z

Hey there @apbodrov,
Thanks for submitting this pull request! Can you add yourself as a codeowner for this integration? This way we can notify you if a bug report for this integration is reported.
In __init__.py of the integration, please add:

CODEOWNERS = ["@apbodrov"]

And run script/build_codeowners.py

_{^{(message by NeedsCodeownersLabel)}}

apbodrov · 2023-10-17T00:39:23Z

tested two BMEs with config

spi:
  clk_pin: GPIO18
  mosi_pin: GPIO23
  miso_pin: GPIO19

i2c:
  sda: 21
  scl: 22
  scan: true

sensor:
  - platform: bme280_spi
    temperature:
      name: "BME280 SPI Temperature"
      oversampling: 16x
    pressure:
      name: "BME280 SPI Pressure"
    humidity:
      name: "BME280 SPI Humidity"
    update_interval: 60s
    cs_pin: GPIO5


  - platform: bme280
    temperature:
      name: "BME280 I2C Temperature"
      oversampling: 16x
    pressure:
      name: "BME280 I2C Pressure"
    humidity:
      name: "BME280 I2C Humidity"
    update_interval: 60s
    address: 0x76

apbodrov · 2023-10-17T15:53:04Z

@OttoWinter @jesserockz hello! can you check my PR? Thanks!

jesserockz · 2023-10-19T00:32:16Z

Please don't ping maintainers. Its a good way to get ignored 😉

apbodrov · 2023-10-19T00:44:03Z

@jesserockz
I'm following your own guide ;)

jesserockz · 2023-10-19T00:59:14Z

3 days is not lingering yet. It's still fresh out of the oven.

rossens · 2023-12-16T01:22:55Z

I am looking forward to trying/using this - I have several SPI BME280 and Pi Pico ready and waiting. I'm fairly new to ESPHome - can anyone advise how long it usually takes for something like this to make it over to Home Assistant?
PS - seems one of the Validate YAML tests failed - "Pin 5 is used in multiple places."?

kbx81 · 2023-12-18T06:03:38Z

@rossens you (or anyone else who might be interested) can test this PR as an external component by adding this to your yaml config:

external_components:
  - source: github://pr#5538
    components: [ bme280_base, bme280_spi ]

kbx81 · 2023-12-18T06:05:35Z

While it means a breaking change, for consistency with other components within the platform where the hardware (sensor, display, etc.) is able to support both I2C and SPI, the I2C component should probably be renamed to bme280_i2c.

apbodrov · 2023-12-19T00:59:29Z

While it means a breaking change, for consistency with other components within the platform where the hardware (sensor, display, etc.) is able to support both I2C and SPI, the I2C component should probably be renamed to bme280_i2c.

In fact, the only difference will be another name, but it will take a lot of work to

Refactor the code, tests, and documentation in the repository.
Refactor the alll configs of all users.

I also think that bme280_i2c sounds more logical, but there is not much point in renaming it.

rossens · 2023-12-21T04:44:13Z

@rossens you (or anyone else who might be interested) can test this PR as an external component by adding this to your yaml config:
external_components:
  - source: github://pr#5538
    components: [ bme280_base, bme280_spi ]

Thanks that looks much simpler than what I did (I applied this PR as a patch over my installed ESPHome files). I got it working fine though. Will try this better way next time.

Results: Temperature and pressure seem pretty close - but humidity is reading too low. e.g. currently 25% reported vs 50% actual.
Wondering if it could be anything to do with the PR - but assume it is more likely an issue with the cheap sensors I purchased from AliExpress.

I also wonder if it could be relative vs absolute humidity? I am assuming the sensor/code and ESPHome all talk "relative" but I'm not 100% sure. Anyone know?

I will continue to investigate on my end and advise if/when I get correct Humidity - what was the issue.

apbodrov · 2023-12-21T04:50:51Z

@rossens

Results: Temperature and pressure seem pretty close - but humidity is reading too low. e.g. currently 25% reported vs 50% actual. Wondering if it could be anything to do with the PR - but assume it is more likely an issue with the cheap sensors I purchased from AliExpress.

Hello! I had a similar problem, and I also decided that it was the sensor. But since I'm not the only one with the problem, now I'm starting to think that the problem is in the code.

I'll try to fix the bug and synchronize the readings later.

Thanks!

rossens · 2023-12-21T22:18:04Z

I'm suspicious the problem may be here:

float BME280Component::read_humidity_(const uint8_t *data, int32_t t_fine) {
  uint16_t const raw_adc = ((data[6] & 0xFF) << 8) | (data[7] & 0xFF); // <<<<<<<<<<<<<<<

Depending on compiler - (data[6] << 8) may always give 0 because uint8_t(x) << 8 = uint8_t(0)

Try this instead... (I also removed the & 0xFF which aren't neccesary)

  uint16_t const raw_adc = (uint16_t(data[6]) << 8) | data[7];

I'll also give this a try later on today myself.

apbodrov · 2023-12-21T23:47:52Z

I'm suspicious the problem may be here:
float BME280Component::read_humidity_(const uint8_t *data, int32_t t_fine)

This is a shared code between I2C and SPI component, it was moved from BME280 I2C. So that fix will affect I2C code (which I do not touched, just move)

remove failed test

add test to another file with free GPIO5 pin

jesserockz

As per the message above from @kbx81

While it means a breaking change, for consistency with other components within the platform where the hardware (sensor, display, etc.) is able to support both I2C and SPI, the I2C component should probably be renamed to bme280_i2c.

Please move the main component. This is to avoid confusion in the future and we have done it many times in the past.

esphome · 2023-12-23T01:55:20Z

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

CODEOWNERS

esphome/components/bme280_spi/bme280_spi.cpp

rossens

Looks good to me.
I'm successfully using this PR/patch to operate 4x BME280 SPI sensors on a Pi Pico.

TCB13 · 2024-01-09T12:36:10Z

Any updates on merging this? Thank you.

kbx81

LGTM, thanks!

Request implemented

probot-esphome bot added has-tests integration: bme280 integration: bme280_base integration: bme280_spi new-integration needs-docs needs-codeowners labels Oct 16, 2023

probot-esphome bot removed the needs-codeowners label Oct 16, 2023

apbodrov force-pushed the bmespifinal branch from ada2bb0 to ac23532 Compare October 16, 2023 07:34

apbodrov mentioned this pull request Oct 17, 2023

Add BME280 SPI Component esphome/esphome-docs#3273

Merged

1 task

probot-esphome bot removed the needs-docs label Oct 17, 2023

apbodrov force-pushed the bmespifinal branch from bf46fd8 to 6038ec2 Compare October 17, 2023 01:38

probot-esphome bot added needs-tests has-tests and removed has-tests needs-tests labels Dec 19, 2023

apbodrov added 10 commits December 23, 2023 04:48

CO

444be1f

tidy

b37b50e

lint

cc62ae5

tidy [2]

b669dce

tidy[-1]

0d5a2ad

final solution

b398dd6

Update test1.yaml

94d37bb

remove failed test

Update test1.1.yaml

58b4abb

add test to another file with free GPIO5 pin

fix spi read bytes

90cc284

fix tests

593c72d

apbodrov force-pushed the bmespifinal branch from 4d7aff1 to 593c72d Compare December 23, 2023 01:48

jesserockz previously requested changes Dec 23, 2023

View reviewed changes

esphome bot marked this pull request as draft December 23, 2023 01:55

rename bme280 to bme280_i2c

c1e5f57

probot-esphome bot added the integration: bme280_i2c label Dec 23, 2023

apbodrov marked this pull request as ready for review December 23, 2023 03:06

esphome bot requested a review from jesserockz December 23, 2023 03:06

apbodrov requested a review from rossens December 23, 2023 03:20

Merge branch 'dev' into bmespifinal

b615cfb

rossens reviewed Dec 24, 2023

View reviewed changes

CODEOWNERS Show resolved Hide resolved

rossens reviewed Dec 24, 2023

View reviewed changes

esphome/components/bme280_spi/bme280_spi.cpp Show resolved Hide resolved

rossens approved these changes Dec 24, 2023

View reviewed changes

Merge branch 'dev' into bmespifinal

59a60e4

kbx81 approved these changes Jan 10, 2024

View reviewed changes

kbx81 added the breaking-change label Jan 10, 2024

kbx81 merged commit 4b783c0 into esphome:dev Jan 10, 2024
50 checks passed

github-actions bot locked and limited conversation to collaborators Jan 12, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

BME280 SPI #5538

BME280 SPI #5538

apbodrov commented Oct 16, 2023 •

edited by kbx81

Loading

probot-esphome bot commented Oct 16, 2023

apbodrov commented Oct 17, 2023

apbodrov commented Oct 17, 2023 •

edited

Loading

jesserockz commented Oct 19, 2023

apbodrov commented Oct 19, 2023 •

edited

Loading

jesserockz commented Oct 19, 2023

rossens commented Dec 16, 2023 •

edited

Loading

kbx81 commented Dec 18, 2023

kbx81 commented Dec 18, 2023

apbodrov commented Dec 19, 2023 •

edited

Loading

rossens commented Dec 21, 2023 •

edited

Loading

apbodrov commented Dec 21, 2023

rossens commented Dec 21, 2023

apbodrov commented Dec 21, 2023

jesserockz left a comment

esphome bot commented Dec 23, 2023

rossens left a comment

TCB13 commented Jan 9, 2024

kbx81 left a comment

BME280 SPI #5538

BME280 SPI #5538

Conversation

apbodrov commented Oct 16, 2023 • edited by kbx81 Loading

What does this implement/fix?

Types of changes

Test Environment

Example entry for config.yaml:

Checklist:

probot-esphome bot commented Oct 16, 2023

apbodrov commented Oct 17, 2023

apbodrov commented Oct 17, 2023 • edited Loading

jesserockz commented Oct 19, 2023

apbodrov commented Oct 19, 2023 • edited Loading

jesserockz commented Oct 19, 2023

rossens commented Dec 16, 2023 • edited Loading

kbx81 commented Dec 18, 2023

kbx81 commented Dec 18, 2023

apbodrov commented Dec 19, 2023 • edited Loading

rossens commented Dec 21, 2023 • edited Loading

apbodrov commented Dec 21, 2023

rossens commented Dec 21, 2023

apbodrov commented Dec 21, 2023

jesserockz left a comment

Choose a reason for hiding this comment

esphome bot commented Dec 23, 2023

rossens left a comment

Choose a reason for hiding this comment

TCB13 commented Jan 9, 2024

kbx81 left a comment

Choose a reason for hiding this comment

apbodrov commented Oct 16, 2023 •

edited by kbx81

Loading

Example entry for `config.yaml`:

apbodrov commented Oct 17, 2023 •

edited

Loading

apbodrov commented Oct 19, 2023 •

edited

Loading

rossens commented Dec 16, 2023 •

edited

Loading

apbodrov commented Dec 19, 2023 •

edited

Loading

rossens commented Dec 21, 2023 •

edited

Loading