Skip to content
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.

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

Add support for capability attributes in demo #21263

Merged
merged 1 commit into from
Jul 3, 2024

Conversation

balloob
Copy link
Member

@balloob balloob commented Jul 3, 2024

Breaking change

Proposed change

This adds capability attribute support to demo entities and allows for state restore when turning a device off and on. When a device is off, we only write the capability attributes, as we do in Home Assistant, as there is no state.

Also adds support for the set_cover_position service.

This fixes:

  • Turning off floor lamp now correctly dims the icon
  • Turning a light off now disables the brightness slider correctly
  • Turning a light off and on now restores brightness
  • Setting a cover to closed position state to closed

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New feature (thank you!)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Example configuration

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue or discussion:
  • Link to documentation pull request:

Checklist

  • The code change is tested and works locally.
  • There is no commented out code in this PR.
  • Tests have been added to verify that the new code works.

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

Copy link
Contributor

coderabbitai bot commented Jul 3, 2024

Walkthrough

Walkthrough

The changes improve the entity handling in a system by adding a CAPABILITY_ATTRIBUTES array to define specific attributes for various entity types like LightEntity, MediaPlayerEntity, ClimateEntity, and WaterHeaterEntity. A logging statement is also introduced to record service activities.

Changes

File Change Summary
src/fake_data/entity.ts Added CAPABILITY_ATTRIBUTES array, updated Entity class to filter attributes, modified several entity classes to include specific attributes for lights, media players, climate, and water heaters.
src/fake_data/provide_hass.ts Introduced a console.log statement before the asynchronous service call in the callService function.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant System
    participant LightEntity
    participant MediaPlayerEntity
    participant ClimateEntity
    participant WaterHeaterEntity

    User->>System: Send attributes
    System->>LightEntity: Filter attributes for LightEntity
    System->>MediaPlayerEntity: Filter attributes for MediaPlayerEntity
    System->>ClimateEntity: Filter attributes for ClimateEntity
    System->>WaterHeaterEntity: Filter attributes for WaterHeaterEntity
    LightEntity->>System: Return filtered attributes
    MediaPlayerEntity->>System: Return filtered attributes
    ClimateEntity->>System: Return filtered attributes
    WaterHeaterEntity->>System: Return filtered attributes
    System->>User: Send filtered attributes
Loading
sequenceDiagram
    participant Developer
    participant provideHassFunction
    participant Console

    Developer->>provideHassFunction: Invoke callService
    provideHassFunction->>Console: Log service call
    provideHassFunction->>Service: Make asynchronous service call
    Service-->>provideHassFunction: Return response
    provideHassFunction-->>Developer: Return service response
Loading

Tip

AI model upgrade

gpt-4o model for reviews and chat is now live

OpenAI claims that this model is better at understanding and generating code than the previous models. Please join our Discord Community to provide any feedback or to report any issues.


Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between d833910 and e273462.

Files selected for processing (2)
  • src/fake_data/entity.ts (8 hunks)
  • src/fake_data/provide_hass.ts (1 hunks)
Additional context used
Biome
src/fake_data/entity.ts

[error] 42-42: Unexpected any. Specify a different type.

any disables many type checking rules. Its use should be avoided.

(lint/suspicious/noExplicitAny)


[error] 68-68: Unexpected any. Specify a different type.

any disables many type checking rules. Its use should be avoided.

(lint/suspicious/noExplicitAny)

Additional comments not posted (12)
src/fake_data/entity.ts (12)

13-24: LGTM!

The CAPABILITY_ATTRIBUTES array is well-defined and used to filter attributes for various entity classes.


44-45: LGTM!

The static CAPABILITY_ATTRIBUTES property is correctly initialized with the CAPABILITY_ATTRIBUTES array.


53-53: LGTM!

The added blank line improves readability.


55-62: LGTM!

The logic to filter attributes based on capability attributes is correctly implemented.


65-65: LGTM!

The attributes property is correctly initialized.


81-81: LGTM!

The attributes property is correctly updated during state updates.


95-95: LGTM!

The conditional logic to set the attributes property based on the state is correctly implemented.


103-105: LGTM!

The specific capability attributes for LightEntity are correctly added.


225-229: LGTM!

The specific capability attributes for MediaPlayerEntity are correctly added.


266-270: LGTM!

The logic to handle cover position settings in the handleService method is correctly implemented.


335-346: LGTM!

The specific capability attributes for ClimateEntity are correctly added.


417-423: LGTM!

The specific capability attributes for WaterHeaterEntity are correctly added.


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?

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>.
    • 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 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 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to 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.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.

@github-actions github-actions bot added Demo Related to frontend demo content Design Related to Home Assistant design gallery labels Jul 3, 2024
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: 1

Comment on lines +281 to +282
// eslint-disable-next-line
console.log("Entity service call", domain, service, data);
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider adding a debug flag for logging.

Logging service calls is useful for debugging, but it might not be necessary for production environments. Consider adding a debug flag to control this logging.

- console.log("Entity service call", domain, service, data);
+ if (hass().debugConnection) {
+   console.log("Entity service call", domain, service, data);
+ }
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
// eslint-disable-next-line
console.log("Entity service call", domain, service, data);
// eslint-disable-next-line
if (hass().debugConnection) {
console.log("Entity service call", domain, service, data);
}

@balloob balloob merged commit 2b5fba4 into dev Jul 3, 2024
10 checks passed
@balloob balloob deleted the demo-capability-attributes branch July 3, 2024 12:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla-signed Demo Related to frontend demo content Design Related to Home Assistant design gallery
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants