Add new component mcp3426 7 8 #6675

mdop · 2024-05-03T19:39:35Z

What does this implement/fix?

Adds support for the 4 channel 16 bit ADC chips of the MCP3426/7/8 family. Structure is based on the ADS1115, but the measurement is done asynchronously.

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): fixes -

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

Test Environment

Example entry for `config.yaml`:

mcp3428:
  address: 0b1101000

sensor:
  - platform: mcp3428
    name: "Channel 1"
    multiplexer: 1
    resolution: 12
    gain: 8
    id: mcp3428_sensor1

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.

This reverts commit 7eac405.

codecov-commenter · 2024-05-03T19:41:52Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 53.78%. Comparing base (4d8b5ed) to head (35f6ecb).
Report is 922 commits behind head on dev.

Additional details and impacted files

@@            Coverage Diff             @@
##              dev    #6675      +/-   ##
==========================================
+ Coverage   53.70%   53.78%   +0.07%     
==========================================
  Files          50       50              
  Lines        9408     9660     +252     
  Branches     1654     1704      +50     
==========================================
+ Hits         5053     5196     +143     
- Misses       4056     4140      +84     
- Partials      299      324      +25

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

jesserockz · 2024-05-05T23:04:51Z

esphome/components/mcp3428/__init__.py

+ }
+ )
+ .extend(cv.COMPONENT_SCHEMA)
+ .extend(i2c.i2c_device_schema(None))


Devices with address pins still have a default address if the pins are left floating.

Suggested change

.extend(i2c.i2c_device_schema(None))

.extend(i2c.i2c_device_schema(0x58))

Ok, but left floating the address is 0x68, like with grounded pins. Addressed it in a separate commit.

esphome/components/mcp3428/sensor/__init__.py

jesserockz · 2024-07-04T21:14:40Z

esphome/components/mcp3428/mcp3428.cpp

+ ESP_LOGCONFIG(TAG, "Setting up MCP3426/7/8...");
+ uint8_t anwser[3];
+ if (this->read(anwser, 3) != i2c::ErrorCode::NO_ERROR) {
+ this->mark_failed();


Please put useful error messages here so users can look back at logs and see why it failed.

Added context that communication failed

jesserockz · 2024-07-04T21:14:45Z

esphome/components/mcp3428/mcp3428.cpp

+ // leave channel at 1, gain at 1x, and resolution at 12 bit
+
+ if (this->write(&config, 1) != i2c::ErrorCode::NO_ERROR) {
+ this->mark_failed();


esphome/components/mcp3428/mcp3428.cpp

jesserockz · 2024-07-04T21:32:06Z

esphome/components/mcp3428/sensor/mcp3428_sensor.cpp

+ ESP_LOGCONFIG(TAG, " Multiplexer: %u", this->multiplexer_);
+ ESP_LOGCONFIG(TAG, " Gain: %u", this->gain_);
+ ESP_LOGCONFIG(TAG, " Resolution: %u", this->resolution_);


These should be converted back to the human friendly values that were entered in yaml

Seems like I forgot to change this when I changed the numerical values of the enums. Fixed in a commit.

jesserockz · 2024-07-04T23:02:52Z

tests/components/MCP3428/test.esp32-c3-idf.yaml

+ sda: 4
+
+mcp3428:
+ address: 0b1101000


Please use hex here to keep consistent with all other i2c examples.

Suggested change

address: 0b1101000

address: 0x68

esphome · 2024-07-04T23:03:08Z

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.

Co-authored-by: Jesse Hills <[email protected]>

mdop · 2024-07-07T13:46:28Z

Not sure why CI / Component test MCP3428 (pull_request) failed, the file ./tests/test_build_components/build_components_base.esp8266.yaml does exist

mdop added 9 commits April 28, 2024 08:05

initial commit

0bcdc4b

fix directory naming

be8a3fb

Correct I2C::ErrorCode interpretation at read and write

d25d0a5

fix negative anwser interpretation

7eac405

Revert "fix negative anwser interpretation"

59cba62

This reverts commit 7eac405.

fix negative result calculation

82c404c

Restructure to allow asynchronous measurement, more detailed logging

591e040

Include delay function in sensor

5b98988

Merge branch 'esphome:dev' into add-MCP3426-7-8

d4bf3b9

probot-esphome bot added has-tests new-integration integration: mcp3428 needs-docs labels May 3, 2024

mdop mentioned this pull request May 3, 2024

Add new component MCP3426/7/8 esphome/esphome-docs#3810

Closed

3 tasks

probot-esphome bot removed the needs-docs label May 3, 2024

mdop added 3 commits May 4, 2024 07:16

Corrected I2C pins in ESP32-C3-IDF test and Codeowners

28e663e

Fix formatting

5a46916

Const a pointer argument

160ba51

mdop marked this pull request as ready for review May 4, 2024 08:48

jesserockz requested changes Jul 4, 2024

View reviewed changes

esphome bot marked this pull request as draft July 4, 2024 23:03

mdop and others added 7 commits July 7, 2024 13:21

Improve logging for humans

8d8bd42

prefix member variable with this->

10c133b

Co-authored-by: Jesse Hills <[email protected]>

Remove arbitrary wait time

9942f3b

Co-authored-by: Jesse Hills <[email protected]>

Improve spelling

813711e

Co-authored-by: Jesse Hills <[email protected]>

streamline sensor/__init__.py

cd96081

Co-authored-by: Jesse Hills <[email protected]>

standardize I2C address to hex

3d565e8

Add default address in __init__.py

619cdc7

mdop added 3 commits July 7, 2024 13:50

fix another answer typo

99b25a1

Fix answer typo also in declaration

177a48d

also fix answer typos in variable names

12a94bc

mdop requested a review from jesserockz July 7, 2024 12:12

mdop added 3 commits July 7, 2024 14:23

Remove unused imports

cd1991a

Remove ESP32-C3 test due to no base test file

54b1bf1

Remove test with missing base test, remove excess filename part

35f6ecb

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add new component mcp3426 7 8 #6675

Add new component mcp3426 7 8 #6675

mdop commented May 3, 2024 •

edited

Loading

codecov-commenter commented May 3, 2024 •

edited

Loading

jesserockz May 5, 2024

mdop Jul 7, 2024

jesserockz Jul 4, 2024

mdop Jul 7, 2024

jesserockz Jul 4, 2024

jesserockz Jul 4, 2024

mdop Jul 7, 2024

jesserockz Jul 4, 2024

esphome bot commented Jul 4, 2024

mdop commented Jul 7, 2024

	.extend(i2c.i2c_device_schema(None))
	.extend(i2c.i2c_device_schema(0x58))

Add new component mcp3426 7 8 #6675

Are you sure you want to change the base?

Add new component mcp3426 7 8 #6675

Conversation

mdop commented May 3, 2024 • edited Loading

What does this implement/fix?

Types of changes

Test Environment

Example entry for config.yaml:

Checklist:

codecov-commenter commented May 3, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

esphome bot commented Jul 4, 2024

mdop commented Jul 7, 2024

mdop commented May 3, 2024 •

edited

Loading

Example entry for `config.yaml`:

codecov-commenter commented May 3, 2024 •

edited

Loading