Skip to content

Update USERMOD BME68X to version 1.0.2 #4620

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
willmmiles merged 1 commit into from
Mar 29, 2025
Merged

Update USERMOD BME68X to version 1.0.2 #4620

willmmiles merged 1 commit into from
Mar 29, 2025

Conversation

@gsieben
Copy link
Contributor

@gsieben gsieben commented Mar 28, 2025 •
edited by coderabbitai bot
Loading

I have updated the USERMOD_BME68X from version 1.0.1 version 1.0.2.

The following was modified:

  1. Rebased to WELD Version 0.16
  2. Fixed: Solved compilation problems related to some macro naming interferences.

Greetings and have a nice weekend

Gabriel

Summary by CodeRabbit

  • Documentation

    • Enhanced overall documentation with clearer formatting, better section separation, and improved instructions.
    • Introduced a dedicated compilation section and updated the revision history with the latest version details.

  • Chores

    • Refined project configuration by updating the project naming and removing obsolete build settings to streamline the build process.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 28, 2025 •
edited
Loading

Walkthrough

The changes update the BME68X usermod documentation and configuration. The README now features improved formatting with clearer sections, including a new "Compilation" section and an expanded revision history reflecting version 1.0.2. A new function, getDewPoint();, has been added and method descriptions have been refined. The JSON configuration has been simplified by updating the library name from "BME68X_v2" to "BME68X" and removing the previously specified build property.

Changes

File(s) Change Summary
usermods/.../README.md Updated formatting for clarity including added "Compilation" section, expanded revision history (v1.0.2), added getDewPoint(); declaration, and enhanced tables and method descriptions.
usermods/.../library.json Modified the "name" field from "BME68X_v2" to "BME68X" and removed the "build" property that previously set "libArchive": false.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot]
coderabbitai bot reviewed Mar 28, 2025
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (8)
usermods/BME68X_v2/library.json (1)

2-2: Typo in JSON Key:
The key is defined as "name:" (with an extra colon) instead of the expected "name". This could lead to misconfiguration or lookup issues within the build system. Please remove the colon to ensure the key conforms to the standard JSON configuration.

usermods/BME68X_v2/README.md (7)

5-5: Add Alternative Text for Images:
Several <img> tags (at lines 5, 9, 13, and 17) lack alt attributes, which hurts accessibility and does not comply with markdownlint (MD045) guidelines. Please add descriptive alt text (e.g. alt="Diagram of sensor placement") to all image tags.

Also applies to: 9-9, 13-13, 17-17

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

5-5: Images should have alternate text (alt text)
null

(MD045, no-alt-text)

57-58: Remove Duplicate Sentence:
The sentence about sensor calibration is repeated (lines 57 and 58). Removing the duplicate will enhance clarity and reduce redundancy.

64-64: Consistent Terminology:
In line 64, consider hyphenating “GAS based” to “gas-based” for improved consistency and readability.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~64-~64: This expression is usually spelled with a hyphen.
Context: ...ation is finished (1) Furthermore, all GAS based values have their own accuracy value. T...

(BASED_HYPHEN)

66-67: Correct Typo in Calibration Details:
In line 67, the word “chaning” appears; it should be corrected to “changing.”

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

66-66: Hard tabs
Column: 20

(MD010, no-hard-tabs)

67-67: Hard tabs
Column: 19

(MD010, no-hard-tabs)

144-145: Revision History Formatting:
In the Version 1.0.2 section (lines 144–145), unordered list items are marked with asterisks. For consistency with repository guidelines, please replace the asterisks with dashes (-).

23-29: Replace Hard Tabs with Spaces:
Several sections (e.g., within the sensor tables and settings lists) contain hard tabs. Replacing these with spaces will ensure consistent formatting across editors and viewers, and it addresses several markdownlint (MD010) warnings.

Also applies to: 85-93

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

23-23: Heading style
Expected: atx; Actual: setext

(MD003, heading-style)

23-23: Hard tabs
Column: 7

(MD010, no-hard-tabs)

23-23: Hard tabs
Column: 17

(MD010, no-hard-tabs)

23-23: Hard tabs
Column: 23

(MD010, no-hard-tabs)

26-26: Hard tabs
Column: 12

(MD010, no-hard-tabs)

26-26: Hard tabs
Column: 20

(MD010, no-hard-tabs)

26-26: Hard tabs
Column: 27

(MD010, no-hard-tabs)

27-27: Hard tabs
Column: 9

(MD010, no-hard-tabs)

27-27: Hard tabs
Column: 16

(MD010, no-hard-tabs)

27-27: Hard tabs
Column: 19

(MD010, no-hard-tabs)

28-28: Hard tabs
Column: 9

(MD010, no-hard-tabs)

28-28: Hard tabs
Column: 16

(MD010, no-hard-tabs)

28-28: Hard tabs
Column: 21

(MD010, no-hard-tabs)

29-29: Hard tabs
Column: 15

(MD010, no-hard-tabs)

23-23: Standardize Heading Style:
Static analysis indicates that some headings are rendered in setext style instead of the repository’s preferred atx style (with #). Converting these headings to atx style can improve consistency and readability.

Also applies to: 32-32, 42-42

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

23-23: Heading style
Expected: atx; Actual: setext

(MD003, heading-style)

23-23: Hard tabs
Column: 7

(MD010, no-hard-tabs)

23-23: Hard tabs
Column: 17

(MD010, no-hard-tabs)

23-23: Hard tabs
Column: 23

(MD010, no-hard-tabs)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e76e9a3 and 7e87891.

📒 Files selected for processing (2)
  • usermods/BME68X_v2/README.md (3 hunks)
  • usermods/BME68X_v2/library.json (1 hunks)
🧰 Additional context used
🪛 LanguageTool
usermods/BME68X_v2/README.md

[style] ~3-~3: Consider using “incompatible” to avoid wordiness.
Context: ...r a BME680/BME68X sensor. The BME68X is not compatible with the BME280/BMP280 chip. It has its...

(NOT_ABLE_PREMIUM)

[uncategorized] ~64-~64: This expression is usually spelled with a hyphen.
Context: ...ation is finished (1) Furthermore, all GAS based values have their own accuracy value. T...

(BASED_HYPHEN)

[style] ~88-~88: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... the gas values are also published. - Pub Calib State: If this item is active,...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

[grammar] ~109-~109: The verb ‘to depend’ requires the preposition ‘(up)on’.
Context: ... - getTemperature(); The scale °C/°F is depended to the settings - getHumidity(); - getPres...

(DEPEND_ON)

🪛 markdownlint-cli2 (0.17.2)
usermods/BME68X_v2/README.md

5-5: Images should have alternate text (alt text)
null

(MD045, no-alt-text)

9-9: Images should have alternate text (alt text)
null

(MD045, no-alt-text)

13-13: Images should have alternate text (alt text)
null

(MD045, no-alt-text)

17-17: Images should have alternate text (alt text)
null

(MD045, no-alt-text)

23-23: Heading style
Expected: atx; Actual: setext

(MD003, heading-style)

23-23: Hard tabs
Column: 7

(MD010, no-hard-tabs)

23-23: Hard tabs
Column: 17

(MD010, no-hard-tabs)

23-23: Hard tabs
Column: 23

(MD010, no-hard-tabs)

26-26: Hard tabs
Column: 12

(MD010, no-hard-tabs)

26-26: Hard tabs
Column: 20

(MD010, no-hard-tabs)

26-26: Hard tabs
Column: 27

(MD010, no-hard-tabs)

27-27: Hard tabs
Column: 9

(MD010, no-hard-tabs)

27-27: Hard tabs
Column: 16

(MD010, no-hard-tabs)

27-27: Hard tabs
Column: 19

(MD010, no-hard-tabs)

28-28: Hard tabs
Column: 9

(MD010, no-hard-tabs)

28-28: Hard tabs
Column: 16

(MD010, no-hard-tabs)

28-28: Hard tabs
Column: 21

(MD010, no-hard-tabs)

29-29: Hard tabs
Column: 15

(MD010, no-hard-tabs)

32-32: Heading style
Expected: atx; Actual: setext

(MD003, heading-style)

32-32: Hard tabs
Column: 7

(MD010, no-hard-tabs)

32-32: Hard tabs
Column: 17

(MD010, no-hard-tabs)

32-32: Hard tabs
Column: 23

(MD010, no-hard-tabs)

32-32: Multiple headings with the same content
null

(MD024, no-duplicate-heading)

35-35: Hard tabs
Column: 5

(MD010, no-hard-tabs)

36-36: Hard tabs
Column: 12

(MD010, no-hard-tabs)

37-37: Hard tabs
Column: 5

(MD010, no-hard-tabs)

38-38: Hard tabs
Column: 5

(MD010, no-hard-tabs)

39-39: Hard tabs
Column: 16

(MD010, no-hard-tabs)

42-42: Heading style
Expected: atx; Actual: setext

(MD003, heading-style)

42-42: Hard tabs
Column: 7

(MD010, no-hard-tabs)

42-42: Hard tabs
Column: 17

(MD010, no-hard-tabs)

42-42: Hard tabs
Column: 23

(MD010, no-hard-tabs)

42-42: Multiple headings with the same content
null

(MD024, no-duplicate-heading)

45-45: Hard tabs
Column: 18

(MD010, no-hard-tabs)

45-45: Hard tabs
Column: 20

(MD010, no-hard-tabs)

46-46: Hard tabs
Column: 11

(MD010, no-hard-tabs)

52-52: Images should have alternate text (alt text)
null

(MD045, no-alt-text)

62-62: Hard tabs
Column: 22

(MD010, no-hard-tabs)

66-66: Hard tabs
Column: 20

(MD010, no-hard-tabs)

67-67: Hard tabs
Column: 19

(MD010, no-hard-tabs)

68-68: Hard tabs
Column: 19

(MD010, no-hard-tabs)

69-69: Hard tabs
Column: 19

(MD010, no-hard-tabs)

79-79: Images should have alternate text (alt text)
null

(MD045, no-alt-text)

83-83: Hard tabs
Column: 14

(MD010, no-hard-tabs)

84-84: Hard tabs
Column: 19

(MD010, no-hard-tabs)

85-85: Hard tabs
Column: 16

(MD010, no-hard-tabs)

86-86: Hard tabs
Column: 23

(MD010, no-hard-tabs)

87-87: Hard tabs
Column: 20

(MD010, no-hard-tabs)

88-88: Hard tabs
Column: 23

(MD010, no-hard-tabs)

89-89: Hard tabs
Column: 18

(MD010, no-hard-tabs)

90-90: Hard tabs
Column: 19

(MD010, no-hard-tabs)

91-91: Hard tabs
Column: 20

(MD010, no-hard-tabs)

92-92: Hard tabs
Column: 31

(MD010, no-hard-tabs)

93-93: Hard tabs
Column: 28

(MD010, no-hard-tabs)

109-109: Hard tabs
Column: 20

(MD010, no-hard-tabs)

153-153: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)

154-154: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)

🔇 Additional comments (2)
usermods/BME68X_v2/README.md (2)

107-112: Improve Method Description Grammar:
The phrase “The scale °C/°F is depended to the settings” (for both getTemperature(); and getDewPoint();) is grammatically incorrect. A clearer phrasing would be “The scale °C/°F depends on the settings” or “is set according to the settings.”
[grammar, suggest_nitpick]

🧰 Tools
🪛 LanguageTool

[grammar] ~109-~109: The verb ‘to depend’ requires the preposition ‘(up)on’.
Context: ... - getTemperature(); The scale °C/°F is depended to the settings - getHumidity(); - getPres...

(DEPEND_ON)

🪛 markdownlint-cli2 (0.17.2)

109-109: Hard tabs
Column: 20

(MD010, no-hard-tabs)

126-133: Clear Compilation Instructions:
The new Compilation section clearly explains how to enable the usermod via platformio_override.ini. This addition improves usability by guiding users through the build process.

willmmiles
willmmiles approved these changes Mar 29, 2025
View reviewed changes
Copy link
Member

@willmmiles willmmiles left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice job, you beat me to it!

@willmmiles willmmiles merged commit b0b3196 into wled:main Mar 29, 2025
21 checks passed
@coderabbitai coderabbitai bot mentioned this pull request May 19, 2025
Merged
@coderabbitai coderabbitai bot mentioned this pull request Jun 28, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@willmmiles willmmiles willmmiles approved these changes

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@gsieben @willmmiles