home-assistant.io
home-assistant.io copied to clipboard
Add energy sensor entities to Tessie
Proposed change
Add energy sensor entities to Tessie
Type of change
- [ ] Spelling, grammar or other readability improvements (
currentbranch). - [ ] Adjusted missing or incorrect information in the current documentation (
currentbranch). - [ ] Added documentation for a new integration I'm adding to Home Assistant (
nextbranch).- [ ] I've opened up a PR to add logos and icons in Brands repository.
- [x] Added documentation for a new feature I'm adding to Home Assistant (
nextbranch). - [ ] Removed stale or deprecated documentation.
Additional information
- Link to parent pull request in the codebase: https://github.com/home-assistant/core/pull/118452
- Link to parent pull request in the Brands repository:
- This PR fixes or closes issue: fixes #
Checklist
- [x] This PR uses the correct branch, based on one of the following:
- I made a change to the existing documentation and used the
currentbranch. - I made a change that is related to an upcoming version of Home Assistant and used the
nextbranch.
- I made a change to the existing documentation and used the
- [x] The documentation follows the Home Assistant documentation standards.
Summary by CodeRabbit
- New Features
- Renamed "Entities" section to "Vehicle entities."
- Added a new "Energy entities" section with subcategories for various power-related metrics, including sensors for battery power, energy left, generator power, grid power, and more.
It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the current branch. Please change the target branch of this PR to current and rebase if needed. If this is documentation for a new feature, please add a link to that PR in your description.
Deploy Preview for home-assistant-docs ready!
| Name | Link |
|---|---|
| Latest commit | 10060a63f19ce6c4017fd411229be5c96e3089af |
| Latest deploy log | https://app.netlify.com/sites/home-assistant-docs/deploys/6667699ac734cd000824f7d9 |
| Deploy Preview | https://deploy-preview-33003--home-assistant-docs.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.
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks :+1:
Walkthrough
Walkthrough
The recent update reorganizes the "Entities" section into "Vehicle entities" and introduces a new "Energy entities" section. This new section includes several sensor entities related to power metrics, such as battery power, solar power, and grid power. The change enhances clarity and expands the entity categorization to better reflect the different types of data being handled.
Changes
| File | Change Summary |
|---|---|
source/_integrations/tessie.markdown |
Renamed "Entities" section to "Vehicle entities" and added a new "Energy entities" section with various power-related sensor entities. |
Sequence Diagram(s)
sequenceDiagram
participant User
participant System
participant VehicleEntity
participant EnergyEntity
User->>System: Request vehicle data
System->>VehicleEntity: Fetch vehicle data
VehicleEntity->>System: Return vehicle data
System->>User: Display vehicle data
User->>System: Request energy data
System->>EnergyEntity: Fetch energy data
EnergyEntity->>System: Return energy data
System->>User: Display energy data
Recent review details
Configuration used: CodeRabbit UI Review profile: ASSERTIVE
Commits
Files that changed from the base of the PR and between 9efe3dabeaeed13c44c1c380843d0cfdd294450e and 10060a63f19ce6c4017fd411229be5c96e3089af.
Files selected for processing (1)
- source/_integrations/tessie.markdown (2 hunks)
Additional context used
LanguageTool
source/_integrations/tessie.markdown
[style] ~50-~50: The phrase “a variety of” may be wordy. To make your writing clearer, consider replacing it. (A_VARIETY_OF) Context: ... will create binary sensor entities for a variety of metrics related to your vehicles: ####...
[uncategorized] ~62-~62: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’). (AUTO_HYPHEN) Context: ...charging enabled #### Climate state - Auto seat climate left - Auto seat climate right ...
[grammar] ~88-~88: This word is usually spelled as one word: “Flashlights”. (LIGHT_COMPOUNDS) Context: ...trol various aspects of the vehicle: - Flash lights - Homelink - Honk horn - Keyless drivin...
[misspelling] ~89-~89: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US) Context: ...pects of the vehicle: - Flash lights - Homelink - Honk horn - Keyless driving - Play fa...
[style] ~151-~151: The phrase “a variety of” may be wordy. To make your writing clearer, consider replacing it. (A_VARIETY_OF) Context: ...gration will create sensor entities for a variety of metrics related to your vehicles: ####...
[grammar] ~157-~157: This phrase is duplicated. You should probably use “Battery range” only once. (PHRASE_REPETITION) Context: ...e - Battery charging - Battery level - Battery range - Battery range estimate (disabled) - Battery range ide...
[grammar] ~213-~213: This phrase is duplicated. You should probably use “power Grid” only once. (PHRASE_REPETITION) Context: ...Battery power - Energy left - Generator power - Grid power - Grid services power - Load power - Percentag...
Markdownlint
source/_integrations/tessie.markdown
222-222: Element: abbr (MD033, no-inline-html) Inline HTML
Additional comments not posted (2)
source/_integrations/tessie.markdown (2)
46-46: Renaming the section to "Vehicle entities" clarifies the specific focus on vehicle-related entities, enhancing the document's structure.
207-225: The addition of the "Energy entities" section with detailed sensor descriptions significantly enhances the integration's documentation by covering new functionalities.Tools
LanguageTool
[grammar] ~213-~213: This phrase is duplicated. You should probably use “power Grid” only once. (PHRASE_REPETITION) Context: ...Battery power - Energy left - Generator power - Grid power - Grid services power - Load power - Percentag...
Markdownlint
222-222: Element: abbr (MD033, no-inline-html) Inline HTML
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 as 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.
Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
CodeRabbit Configration 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.