feat:face_template

[JarbasAl]

extract face from naptime skill

Summary by CodeRabbit

• New Features

  • Introduced a customizable face component with adjustable eye and mouth states.
  • Added a card delegate that dynamically updates the face based on user sleep state.

• Bug Fixes

  • Improved responsiveness of face features to user state changes.

[coderabbitai]

Walkthrough

A new graphical user interface component for representing a face has been introduced in the OVOS GUI system. The implementation includes two QML files: Face.qml and SYSTEM_Face.qml. The Face.qml defines the core graphical structure with customizable properties for eye and mouth states, while SYSTEM_Face.qml creates a card delegate that dynamically updates the face's appearance based on session data, such as sleeping status.

Changes

File	Change Summary
ovos_gui/res/gui/qt5/Face.qml	Added new QML component with properties for eyesOpen, mouth, and mouthItem. Implemented face rendering with configurable eye and mouth states.
ovos_gui/res/gui/qt5/SYSTEM_Face.qml	Created a new Mycroft.CardDelegate that dynamically updates face properties based on sessionData, controlling eye and mouth appearance.

Sequence Diagram

sequenceDiagram
    participant SessionData
    participant SYSTEM_Face
    participant Face
    
    SessionData->>SYSTEM_Face: Update sleeping status
    SYSTEM_Face->>Face: Set eyesOpen property
    SYSTEM_Face->>Face: Set mouth property
    Face->>Face: Update visual representation

Loading

Poem

🐰 A face of code, so sleek and bright
With eyes that open, close just right
A smile that shifts with playful grace
In QtQuick's embrace, a digital face
Coding magic, rabbit's delight! 🤖

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @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]

Actionable comments posted: 1

🧹 Nitpick comments (3)

ovos_gui/res/gui/qt5/Face.qml (3)

8-14: Regard default values and behavior for new properties
The eyesOpen and mouth properties do not have default values. Consider providing default states (e.g., eyesOpen: true, mouth: "Smile.svg") to establish baseline behavior.

Apply this diff snippet to set default values:

 property bool eyesOpen
+    default: true
 property string mouth
+    default: "Smile.svg"

---

15-23: Responsive design approach
The logic for maintaining a 1.6 aspect ratio is good. However, consider using QML’s ColumnLayout/RowLayout or anchors if you anticipate advanced layout changes. The current manual approach is perfectly fine if we only need a fixed aspect ratio.

---

112-133: Adjust mouth positioning or size overshadow
When mouth images have large dimensions, the smile.implicitHeight might overshadow the layout. To avoid unexpected overflows, consider capping the width/height or adding a clip: true.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 55bf23b and 6af786d.

⛔ Files ignored due to path filters (5)

• ovos_gui/res/gui/qt5/face/Eyeball.svg is excluded by !**/*.svg
• ovos_gui/res/gui/qt5/face/GreySmile.svg is excluded by !**/*.svg
• ovos_gui/res/gui/qt5/face/Smile.svg is excluded by !**/*.svg
• ovos_gui/res/gui/qt5/face/lid.svg is excluded by !**/*.svg
• ovos_gui/res/gui/qt5/face/upper-lid.svg is excluded by !**/*.svg

📒 Files selected for processing (2)

• ovos_gui/res/gui/qt5/Face.qml (1 hunks)
• ovos_gui/res/gui/qt5/SYSTEM_Face.qml (1 hunks)

🔇 Additional comments (3)

ovos_gui/res/gui/qt5/SYSTEM_Face.qml (2)

6-7: Ensure that Mycroft 1.0 is the correct version
Before finalizing, confirm that Mycroft 1.0 is the stable release suitable for this GUI integration.

---

8-19: CardDelegate usage looks good
The usage of Mycroft.CardDelegate with properties bound to sessionData is intuitive. Exposing eyesOpen and mouth on the embedded Face component is a practical approach to keep the GUI responsive.

ovos_gui/res/gui/qt5/Face.qml (1)

32-65: Eye images are structured well
The layering of Eyeball.svg and lid.svg/upper-lid.svg is a neat approach to toggling eyes open/closed. This layering is clear and self-explanatory.