Madvr#33401
Conversation
iloveicedgreentea
requested review from
a team,
Adminiuga,
TheJulianJES,
bdraco,
dmulcahey and
puddly
as code owners
home-assistant
Bot
added
has-parent
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
WalkthroughWalkthroughThis update involves several major and minor changes across multiple integrations, as well as the removal of specific extensions. New features were introduced, including support for madVR Envy devices and detailed monitoring metrics for Prometheus. Additionally, there were name changes for sensors in the Jewish calendar integration, modifications in error messaging for UniFi Protect, and additions to Verisure and ZHA integrations. These changes aim to enhance clarity, improve functionality, and ensure better reliability and monitoring capabilities. Changes
Sequence Diagram(s)Changes are too varied to generate a single comprehensive sequence diagram. 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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Outside diff range comments (17)
source/_integrations/http.markdown (15)
Line range hint
35-35: Consider revising the preposition for clarity.The phrase "By default the
httpintegration auto-detects..." might be clearer with a comma after "By default," to improve readability.- By default the `http` integration auto-detects... + By default, the `http` integration auto-detects...Tools
LanguageTool
[typographical] ~86-~86: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Context: ...rations causing SSL handshake errors. required: false type: string default: modern...
[misspelling] ~89-~89: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...lse type: string default: modern {% endconfiguration %} The sample below shows a configurat...
Line range hint
41-41: Start the sentence with an uppercase letter.The sentence beginning with "Let you set a port to use." should start with an uppercase letter to maintain consistency and proper grammar in documentation.
- Let you set a port to use. + Let you set a port to use.Tools
LanguageTool
[typographical] ~86-~86: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Context: ...rations causing SSL handshake errors. required: false type: string default: modern...
[misspelling] ~89-~89: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...lse type: string default: modern {% endconfiguration %} The sample below shows a configurat...
Line range hint
45-45: Grammar improvement: Use gerund form with 'recommend'.The phrase "We recommend to use the [NGINX add-on]" should use the gerund form 'using' to be grammatically correct.
- We recommend to use the [NGINX add-on] + We recommend using the [NGINX add-on]Tools
LanguageTool
[typographical] ~86-~86: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Context: ...rations causing SSL handshake errors. required: false type: string default: modern...
[misspelling] ~89-~89: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...lse type: string default: modern {% endconfiguration %} The sample below shows a configurat...
Line range hint
50-50: Start the sentence with an uppercase letter.The description under
ssl_keyshould start with an uppercase letter for consistency and readability.- description: Path to your TLS/SSL key to serve Home Assistant over a secure connection. + Description: Path to your TLS/SSL key to serve Home Assistant over a secure connection.Tools
LanguageTool
[typographical] ~86-~86: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Context: ...rations causing SSL handshake errors. required: false type: string default: modern...
[misspelling] ~89-~89: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...lse type: string default: modern {% endconfiguration %} The sample below shows a configurat...
Line range hint
54-54: Start the sentence with an uppercase letter.The description under
cors_allowed_originsshould start with an uppercase letter for consistency and readability.- description: "A list of origin domain names to allow [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) requests from... + Description: "A list of origin domain names to allow [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) requests from...Tools
LanguageTool
[typographical] ~86-~86: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Context: ...rations causing SSL handshake errors. required: false type: string default: modern...
[misspelling] ~89-~89: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...lse type: string default: modern {% endconfiguration %} The sample below shows a configurat...
Line range hint
60-60: Remove unnecessary colon for grammatical correctness.The description of
use_x_forwarded_forends with a colon before a series introduced by a preposition, which is grammatically incorrect.- Enable parsing of the `X-Forwarded-For` header, passing on the client's correct IP address in proxied setups: + Enable parsing of the `X-Forwarded-For` header, passing on the client's correct IP address in proxied setups.Tools
LanguageTool
[typographical] ~86-~86: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Context: ...rations causing SSL handshake errors. required: false type: string default: modern...
[misspelling] ~89-~89: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...lse type: string default: modern {% endconfiguration %} The sample below shows a configurat...
Line range hint
71-71: Consider adding a comma for clarity.The sentence "Therefore in a reverse proxy scenario, this option should be set with extreme care." might be clearer with a comma after "Therefore," to improve readability.
- Therefore in a reverse proxy scenario, this option should be set with extreme care. + Therefore, in a reverse proxy scenario, this option should be set with extreme care.Tools
LanguageTool
[typographical] ~86-~86: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Context: ...rations causing SSL handshake errors. required: false type: string default: modern...
[misspelling] ~89-~89: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...lse type: string default: modern {% endconfiguration %} The sample below shows a configurat...
Line range hint
76-76: Start the sentence with an uppercase letter.The description under
ip_ban_enabledshould start with an uppercase letter for consistency and readability.- description: Flag indicating whether additional IP filtering is enabled. + Description: Flag indicating whether additional IP filtering is enabled.Tools
LanguageTool
[typographical] ~86-~86: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Context: ...rations causing SSL handshake errors. required: false type: string default: modern...
[misspelling] ~89-~89: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...lse type: string default: modern {% endconfiguration %} The sample below shows a configurat...
Line range hint
80-80: Consider adding a comma for clarity.The sentence "Number of failed login attempt from single IP after which it will be automatically banned if
ip_ban_enabledistrue." might be clearer with a comma after "IP," to improve readability.- Number of failed login attempt from single IP after which it will be automatically banned if `ip_ban_enabled` is `true`. + Number of failed login attempt from single IP, after which it will be automatically banned if `ip_ban_enabled` is `true`.Tools
LanguageTool
[typographical] ~86-~86: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Context: ...rations causing SSL handshake errors. required: false type: string default: modern...
[misspelling] ~89-~89: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...lse type: string default: modern {% endconfiguration %} The sample below shows a configurat...
Line range hint
134-134: Use consistent strong style in Markdown.The Markdown syntax for strong emphasis should be consistent. Replace asterisks with underscores for strong emphasis to align with the expected style.
- **User profile** + __User profile__Tools
LanguageTool
[typographical] ~86-~86: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Context: ...rations causing SSL handshake errors. required: false type: string default: modern...
[misspelling] ~89-~89: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...lse type: string default: modern {% endconfiguration %} The sample below shows a configurat...
Line range hint
147-147: Consider adding a comma for clarity.The sentence "After a ban is added a Persistent Notification is populated to the Home Assistant frontend." might be clearer with a comma after "added," to improve readability.
- After a ban is added a Persistent Notification is populated to the Home Assistant frontend. + After a ban is added, a Persistent Notification is populated to the Home Assistant frontend.Tools
LanguageTool
[typographical] ~86-~86: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Context: ...rations causing SSL handshake errors. required: false type: string default: modern...
[misspelling] ~89-~89: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...lse type: string default: modern {% endconfiguration %} The sample below shows a configurat...
Line range hint
169-169: Consider adding a comma for clarity.The sentence "After a restart of Home Assistant the sensor will be gone until it is triggered again." might be clearer with a comma after "Assistant," to improve readability.
- After a restart of Home Assistant the sensor will be gone until it is triggered again. + After a restart of Home Assistant, the sensor will be gone until it is triggered again.Tools
LanguageTool
[typographical] ~86-~86: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Context: ...rations causing SSL handshake errors. required: false type: string default: modern...
[misspelling] ~89-~89: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...lse type: string default: modern {% endconfiguration %} The sample below shows a configurat...
Line range hint
187-187: Consider adding a comma for clarity.The sentence "For a quick test
curlcan be useful to 'simulate' a device." might be clearer with a comma after "test," to improve readability.- For a quick test `curl` can be useful to "simulate" a device. + For a quick test, `curl` can be useful to "simulate" a device.Tools
LanguageTool
[typographical] ~86-~86: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Context: ...rations causing SSL handshake errors. required: false type: string default: modern...
[misspelling] ~89-~89: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...lse type: string default: modern {% endconfiguration %} The sample below shows a configurat...
Line range hint
222-222: Consider adding a comma for clarity.The sentence "In this section you'll find some real-life examples of how to use this sensor, besides
curl, which was shown earlier." might be clearer with a comma after "sensor," to improve readability.- In this section you'll find some real-life examples of how to use this sensor, besides `curl`, which was shown earlier. + In this section, you'll find some real-life examples of how to use this sensor, besides `curl`, which was shown earlier.Tools
LanguageTool
[typographical] ~86-~86: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Context: ...rations causing SSL handshake errors. required: false type: string default: modern...
[misspelling] ~89-~89: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...lse type: string default: modern {% endconfiguration %} The sample below shows a configurat...
Line range hint
242-242: Start the sentence with an uppercase letter.The description under the
httpieexample should start with an uppercase letter for consistency and readability.- `httpie` is a user-friendly CLI HTTP client. + `httpie` is a user-friendly CLI HTTP client.Tools
LanguageTool
[typographical] ~86-~86: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Context: ...rations causing SSL handshake errors. required: false type: string default: modern...
[misspelling] ~89-~89: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...lse type: string default: modern {% endconfiguration %} The sample below shows a configurat...source/_integrations/zha.markdown (2)
Line range hint
343-346: Markdown Linting IssuesThere are several markdown linting issues related to unordered list indentation and trailing spaces that should be addressed to comply with best practices.
- - Silicon Labs EmberZNet based radios using the EZSP protocol (via the [bellows](https://github.com/zigpy/bellows) library for zigpy) + - Silicon Labs EmberZNet based radios using the EZSP protocol (via the [bellows](https://github.com/zigpy/bellows) library for zigpy) - - Texas Instruments based radios (via the [zigpy-znp](https://github.com/zigpy/zigpy-znp) library for zigpy) + - Texas Instruments based radios (via the [zigpy-znp](https://github.com/zigpy/zigpy-znp) library for zigpy) - - [CC2652P/CC2652R/CC2652RB USB stick, module, or dev board hardware flashed with Z-Stack coordinator firmware](https://www.zigbee2mqtt.io/guide/adapters/) + - [CC2652P/CC2652R/CC2652RB USB stick, module, or dev board hardware flashed with Z-Stack coordinator firmware](https://www.zigbee2mqtt.io/guide/adapters/) - - [CC1352P/CC1352R USB stick, module, or dev board hardware flashed with Z-Stack coordinator firmware](https://www.zigbee2mqtt.io/guide/adapters/) + - [CC1352P/CC1352R USB stick, module, or dev board hardware flashed with Z-Stack coordinator firmware](https://www.zigbee2mqtt.io/guide/adapters/) - - dresden elektronik deCONZ based Zigbee radios (via the [zigpy-deconz](https://github.com/zigpy/zigpy-deconz) library for zigpy) + - dresden elektronik deCONZ based Zigbee radios (via the [zigpy-deconz](https://github.com/zigpy/zigpy-deconz) library for zigpy)Also applies to: 534-535, 546-554, 638-638
Tools
Markdownlint
138-138: Element: div (MD033, no-inline-html)
Inline HTML
Line range hint
282-282: Inconsistent Emphasis StyleThe document uses asterisks for emphasis instead of underscores, which is inconsistent with the expected markdown style. It's recommended to use underscores for emphasis to maintain consistency across the documentation.
- *text* + _text_Also applies to: 393-393
Tools
Markdownlint
138-138: Element: div (MD033, no-inline-html)
Inline HTML
| #### Warning about Wi-Fi-based Zigbee-to-Serial bridges/gateways | ||
| #### Warning about using Zigbee Coordinator over Wi-Fi/WAN/VPN | ||
|
|
||
| <div class="note warning"> |
There was a problem hiding this comment.
Usage of Inline HTML
The use of inline HTML <div> tags is generally discouraged in markdown files as it can lead to issues with portability and rendering on different platforms. Consider using markdown syntax for notes and warnings instead.
- <div class="note warning">
+ **Warning:**
- </div>
+ _End of Warning_Also applies to: 234-234, 340-340, 431-431
Tools
Markdownlint
138-138: Element: div (MD033, no-inline-html)
Inline HTML
| @@ -86,11 +86,6 @@ ssl_profile: | |||
| required: false | |||
There was a problem hiding this comment.
Start the sentence with an uppercase letter.
The description under ssl_profile should start with an uppercase letter for consistency and readability.
- description: The [Mozilla SSL profile](https://wiki.mozilla.org/Security/Server_Side_TLS) to use.
+ Description: The [Mozilla SSL profile](https://wiki.mozilla.org/Security/Server_Side_TLS) to use.Committable suggestion was skipped due to low confidence.
Tools
LanguageTool
[typographical] ~86-~86: This sentence does not start with an uppercase letter. (UPPERCASE_SENTENCE_START)
Context: ...rations causing SSL handshake errors. required: false type: string default: modern...
Co-authored-by: Franck Nijhof <git@frenck.dev> Co-authored-by: Franck Nijhof <frenck@frenck.nl>
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
|
Please revert the changes of other parent PRs, these will need their own separate PRs once this one is merged. There are also unrelated changes in this PR that must be removed. This Pr should only cover the adding of the initial Core PR. ../Frenck |
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
|
I have no idea what happened here but this is a mess. Will close and open a new PR. |
home-assistant
Bot
removed
the
parent-merged
|
corrected PR #33626 |
12 participants
Proposed change
This adds documentation for the upcoming madvr integration
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
New Features
Changes
weekly_portionis nowparshat_hashavuaandomer_countis nowday_of_the_omer.strict_connectionparameter from thessl_profileconfiguration.