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 Jellyfin remote #34871

Open
wants to merge 1 commit into
base: next
Choose a base branch
from

Conversation

ianhattendorf
Copy link

@ianhattendorf ianhattendorf commented Sep 23, 2024

Proposed change

Add Jellyfin remote.

Type of change

  • Spelling, grammar or other readability improvements (current branch).
  • Adjusted missing or incorrect information in the current documentation (current branch).
  • Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

Checklist

  • This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

  • New Features
    • Introduced a new "Remote" category for the Jellyfin integration in Home Assistant.
    • Added a "remote" platform to enable sending commands to the Jellyfin client.
    • Users can now create a Remote entity for remote commands, enhancing interaction with the client interface.
    • Provided an example YAML script for utilizing the new remote command feature.

@home-assistant home-assistant bot added has-parent This PR has a parent PR in a other repo next This PR goes into the next branch labels Sep 23, 2024
Copy link

netlify bot commented Sep 23, 2024

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 2431936
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/66f0b68e1f920600083ad482
😎 Deploy Preview https://deploy-preview-34871--home-assistant-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

coderabbitai bot commented Sep 23, 2024

Walkthrough

Walkthrough

The changes introduce a new category and platform for the Jellyfin integration in Home Assistant. A new ha_category of "Remote" has been added, and the ha_platforms now includes "remote." Additionally, a new Remote entity functionality has been implemented, allowing users to send remote commands to the Jellyfin client. An example YAML script is provided to illustrate the usage of this feature.

Changes

File Path Change Summary
source/_integrations/jellyfin.markdown - Added new category: Remote in ha_category
- Added new platform: remote in ha_platforms
- Introduced new functionality: Remote entity for sending commands

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HomeAssistant
    participant JellyfinClient

    User->>HomeAssistant: Send remote command
    HomeAssistant->>JellyfinClient: Forward command
    JellyfinClient-->>HomeAssistant: Acknowledge command
    HomeAssistant-->>User: Confirm command sent
Loading

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 057d4c1 and 2431936.

Files selected for processing (1)
  • source/_integrations/jellyfin.markdown (3 hunks)
Files skipped from review as they are similar to previous changes (1)
  • source/_integrations/jellyfin.markdown

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>, 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 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 or @coderabbitai title 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.

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

Outside diff range and nitpick comments (1)
source/_integrations/jellyfin.markdown (1)

33-48: Excellent addition of the Remote entity functionality and example YAML script!

The new section clearly describes the purpose and usage of the Remote entity for sending remote commands to the Jellyfin client. The example YAML script provides a helpful illustration of how to use this feature to navigate and select items on the client interface.

Just one minor formatting suggestion:

To adhere to the Markdown formatting guidelines, please add blank lines before and after the fenced code block. Here's the suggested change:

This integration also creates a `Remote` entity for sending [remote commands](https://github.com/jellyfin/jellyfin/blob/master/MediaBrowser.Model/Session/GeneralCommandType.cs) to the client, if supported. For example, this can be used to tell the client to navigate right twice, down once, and select the focused item:

+
```yaml
jellyfin_remote_script:
  alias: "Jellyfin Remote Script"
  sequence:
    - action: remote.send_command
      target:
        entity_id: remote.jellyfin_client
      data:
        delay_secs: 1.5
        command:
          - MoveRight
          - MoveRight
          - MoveDown
          - Select

<details>
<summary>Tools</summary>

<details>
<summary>Markdownlint</summary><blockquote>

34-34: null
Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

</blockquote></details>

</details>

</blockquote></details>

</blockquote></details>

<details>
<summary>Review details</summary>

**Configuration used: CodeRabbit UI**
**Review profile: CHILL**

<details>
<summary>Commits</summary>

Files that changed from the base of the PR and between 1f7762498b3886d8b5facd3631565ca7272cb7d9 and 057d4c16c22897552c7557606af277225c91a476.

</details>


<details>
<summary>Files selected for processing (1)</summary>

* source/_integrations/jellyfin.markdown (3 hunks)

</details>












<details>
<summary>Additional context used</summary>

<details>
<summary>Markdownlint</summary><blockquote>

<details>
<summary>source/_integrations/jellyfin.markdown</summary><blockquote>

34-34: null
Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

</blockquote></details>

</blockquote></details>

</details>
<details>
<summary>Additional comments not posted (3)</summary><blockquote>

<details>
<summary>source/_integrations/jellyfin.markdown (3)</summary><blockquote>

`7-7`: **LGTM!**

The addition of the "Remote" category to `ha_category` aligns with the PR objective and is consistent with the AI-generated summary.

---

`19-19`: **LGTM!**

The addition of the "remote" platform to `ha_platforms` aligns with the PR objective and is consistent with the AI-generated summary.

---

`49-49`: **LGTM!**

The addition of the blank line after the fenced code block adheres to the Markdown formatting guidelines and addresses the static analysis hint.

</blockquote></details>

</blockquote></details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->

@c0ffeeca7 c0ffeeca7 added parent-merged The parent PR has been merged already and removed parent-merged The parent PR has been merged already labels Sep 23, 2024
Copy link
Contributor

@c0ffeeca7 c0ffeeca7 left a comment

Choose a reason for hiding this comment

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

Thank you, @ianhattendorf 👍

@c0ffeeca7 c0ffeeca7 added the awaits-parent Awaits the merge of an parent PR label Sep 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaits-parent Awaits the merge of an parent PR has-parent This PR has a parent PR in a other repo next This PR goes into the next branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants