Update androidtv_remote.markdown #37482
Conversation
Added information about nVidia Shield limitations according to home-assistant/core#136111
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe change updates the Android TV Remote integration documentation for Nvidia Shield devices. It adds a clarification in the markdown file specifying that users should disable specific options in the settings to enable the wake functionality of their Nvidia Shield devices. There are no alterations to the declarations of exported or public entities. Changes
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (3)
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/androidtv_remote.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/androidtv_remote.markdown
[uncategorized] ~572-~572: A comma may be missing after the conjunctive/linking adverb ‘Otherwise’.
Context: ...ton, not only one with the nVidia logo. Otherwise they can't be turn on by this integrati...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[grammar] ~572-~572: The past participle is required after “can’t be”.
Context: ...he nVidia logo. Otherwise they can't be turn on by this integration (https://github....
(BE_VBP_IN)
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/androidtv_remote.markdown
572-572: Bare URL used
null
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
| @@ -569,3 +569,4 @@ cards: | |||
| - Some devices experience disconnects every 15 seconds. This is typically resolved by rebooting the Android TV device after the initial setup of the integration. | |||
| - If you are not able to connect to the Android TV device, or are asked to pair it again and again, try force-stopping the Android TV Remote Service and clearing its storage. On the Android TV device, go to **Settings** > **Apps** > **Show system apps**. Then, select **Android TV Remote Service** > **Storage** > **Clear storage**. You will have to pair again. | |||
| - Some onscreen keyboards enabled by TV manufacturers do not support concurrent virtual and onscreen keyboard use. This presents whenever a text field is selected, such as "search" where a constant **use the keyboard on your mobile device** will show, preventing you from opening the onscreen keyboard to type. This can be overcome by either disabling your 3rd party keyboard and using the default Gboard keyboard or by deselecting **Enable IME** in the **Configure** page of the integration. | |||
| - nVidia Shield devices have to have enabled options to wake up by any controller button, not only one with the nVidia logo. Otherwise they can't be turn on by this integration (https://github.com/home-assistant/core/issues/136111). | |||
There was a problem hiding this comment.
🛠️ Refactor suggestion
Improve Grammar and Link Formatting for nVidia Shield Limitation
The new addition regarding nVidia Shield devices contains a grammatical issue ("can't be turn on" should be "can't be turned on"), and it would benefit from clearer phrasing. Additionally, the bare URL should be replaced with a proper Markdown link for better readability and compliance with markdownlint guidelines.
Consider updating the line as follows:
- - nVidia Shield devices have to have enabled options to wake up by any controller button, not only one with the nVidia logo. Otherwise they can't be turn on by this integration (https://github.com/home-assistant/core/issues/136111).
+ - nVidia Shield devices must have the option enabled to wake up using any controller button, not only the one with the nVidia logo. Otherwise, they can't be turned on by this integration (see [#136111](https://github.com/home-assistant/core/issues/136111)).This revision addresses the grammatical errors, improves clarity, and replaces the bare URL with a proper link.
📝 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.
| - nVidia Shield devices have to have enabled options to wake up by any controller button, not only one with the nVidia logo. Otherwise they can't be turn on by this integration (https://github.com/home-assistant/core/issues/136111). | |
| - nVidia Shield devices must have the option enabled to wake up using any controller button, not only the one with the nVidia logo. Otherwise, they can't be turned on by this integration (see [#136111](https://github.com/home-assistant/core/issues/136111)). |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~572-~572: A comma may be missing after the conjunctive/linking adverb ‘Otherwise’.
Context: ...ton, not only one with the nVidia logo. Otherwise they can't be turn on by this integrati...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[grammar] ~572-~572: The past participle is required after “can’t be”.
Context: ...he nVidia logo. Otherwise they can't be turn on by this integration (https://github....
(BE_VBP_IN)
🪛 markdownlint-cli2 (0.17.2)
572-572: Bare URL used
null
(MD034, no-bare-urls)
| @@ -569,3 +569,4 @@ cards: | |||
| - Some devices experience disconnects every 15 seconds. This is typically resolved by rebooting the Android TV device after the initial setup of the integration. | |||
| - If you are not able to connect to the Android TV device, or are asked to pair it again and again, try force-stopping the Android TV Remote Service and clearing its storage. On the Android TV device, go to **Settings** > **Apps** > **Show system apps**. Then, select **Android TV Remote Service** > **Storage** > **Clear storage**. You will have to pair again. | |||
| - Some onscreen keyboards enabled by TV manufacturers do not support concurrent virtual and onscreen keyboard use. This presents whenever a text field is selected, such as "search" where a constant **use the keyboard on your mobile device** will show, preventing you from opening the onscreen keyboard to type. This can be overcome by either disabling your 3rd party keyboard and using the default Gboard keyboard or by deselecting **Enable IME** in the **Configure** page of the integration. | |||
| - nVidia Shield devices have to have enabled options to wake up by any controller button, not only one with the nVidia logo. Otherwise they can't be turn on by this integration (https://github.com/home-assistant/core/issues/136111). | |||
There was a problem hiding this comment.
| - nVidia Shield devices have to have enabled options to wake up by any controller button, not only one with the nVidia logo. Otherwise they can't be turn on by this integration (https://github.com/home-assistant/core/issues/136111). | |
| - If you can't turn on your Nvidia Shield device, make sure you enable the xx option in .. |
I took a stab at rephrasing this a bit. let me know if it is still correct.
There was a problem hiding this comment.
I don't remember how the options are named. I'd change this to: If you can't turn on your Nvidia Shield device, make sure you enable "mention setting and how to access it".
I'd also remove the link to the GitHub issue. It doesn't add any value.
Keep in mind nVidia isn't the correct way to write it. Use the one in https://en.m.wikipedia.org/wiki/Nvidia_Shield_TV
There was a problem hiding this comment.
@szymonzdziabek, do you know what the option is called exactly?
There was a problem hiding this comment.
I checked this, made pictures of the menu, so generally yes, however my system is in Polish :P I found however the menu screenshots in the web, and the proper options are located under: Settings -> Remotes & accessories. I'll try to change the language and send you the English name of the options.
There was a problem hiding this comment.
English version below :)
Section: Simplified wake buttons
Options to be set to off:
- SHIELD 2019 Remote: Wake on power and Netflix buttons only
- Controllers: Wake on NVIDIA or logo buttons only
There was a problem hiding this comment.
Nice! Thank you! Could you rephrase the description to include these strings?
There was a problem hiding this comment.
I'd love to, but that's my first time of GitHub, so could you please guide me how can I change this pull request? I've edited the file again and created the new commit.
There was a problem hiding this comment.
Looks like that couldn't stop you. Obviously, you got this 💪 🚀
Added information about nVidia Shield limitations according to home-assistant/core#136111
Proposed change
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit