esphome-docs
esphome-docs copied to clipboard
Add calibration values for BL0942
Description:
Related issue (if applicable): fixes
Pull request in esphome with YAML changes (if applicable): https://github.com/esphome/esphome/pull/7299
Checklist:
-
[x] I am merging into
nextbecause this is new documentation that has a matching pull-request in esphome as linked above.
or -
[ ] I am merging into
currentbecause this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature. -
[ ] Link added in
/index.rstwhen creating new documents for new components or cookbook.
Walkthrough
The recent updates significantly enhance the usability and configurability of various components within the ESPHome documentation. Key changes include the introduction of optional configuration variables, enhanced calibration instructions for sensors, and the reclassification of service terminology to actions. These modifications streamline interactions, clarify documentation, and provide users with the necessary tools to integrate and configure their devices effectively.
Changes
| Files | Change Summary |
|---|---|
| components/sensor/bl0942.rst | Introduced new optional configuration variables: line_frequency, address, current_reference, voltage_reference, power_reference, and energy_reference. Added a detailed calibration section. |
| components/api.rst | Replaced "services" with "actions" throughout, clarifying terminology for user-defined functionalities. |
| components/ble_client.rst | Changed terminology from "services" to "actions" for BLE client functionalities. |
| components/mqtt.rst | Introduced new configuration variable discover_ip for device discovery; renamed discovery to discover_ip. |
| components/light/index.rst | Added new optional configuration option brightness_limits with parameters for controlling brightness. |
| components/update/index.rst | Introduced new automation and action related to updates: on_update_available, update.perform, and update.is_available. |
| components/switch/homeassistant.rst | New documentation for Home Assistant Switch platform, detailing setup via ESPHome. |
| components/select/lvgl.rst | New documentation for LVGL Select component, including configuration examples. |
| components/lvgl/index.rst | Comprehensive documentation for LVGL integration, covering widgets and user interface components. |
| components/sensor/apds9306.rst | Added documentation for the APDS9306 ambient light sensor, detailing configuration and usage. |
Sequence Diagram(s)
sequenceDiagram
participant User
participant BL0942
participant CalibrationTool
User->>BL0942: Set configuration parameters
BL0942->>User: Acknowledge configuration
User->>CalibrationTool: Measure current and voltage
CalibrationTool-->>User: Returns measured values
User->>BL0942: Input calibration values
BL0942->>User: Acknowledge calibration
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
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>.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
@coderabbitaiin 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
@coderabbitaiin 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 generate interesting stats about this repository and render them as a table.@coderabbitai show all the console.log statements in this repository.@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 pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile 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.
Deploy Preview for esphome ready!
| Name | Link |
|---|---|
| Latest commit | f72aa8f77d8e7a1fd136d4aa4345b5d1e7efe183 |
| Latest deploy log | https://app.netlify.com/sites/esphome/deploys/66d8f63fd946f9000853b315 |
| Deploy Preview | https://deploy-preview-4163--esphome.netlify.app |
| Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify site configuration.