Docs for TIS Control integration #37071
Conversation
* Update network_storage.md * Update network_storage.md * tiny tweak --------- Co-authored-by: c0ffeeca7 <[email protected]>
* aquacell.markdown: Tweak docs * aquacell.markdown: Add TwinTec too * aquacell.markdown: Mention Culligan
…ion regarding needing a special P1 cable (home-assistant#37043)
Co-authored-by: Franck Nijhof <[email protected]>
* Add debugging steps for nest integration. Google can delete your pub/sub subscription. This adds troubleshooting steps to address that issue for the nest integration. * tiny tweak * Update source/_integrations/nest.markdown * Apply suggestions from coderabbitai code review * Update source/_integrations/nest.markdown * tweak to kick the CI --------- Co-authored-by: c0ffeeca7 <[email protected]>
…e-assistant#37067) Bumps [sorbet-runtime](https://github.com/sorbet/sorbet) from 0.5.11766 to 0.5.11778. - [Release notes](https://github.com/sorbet/sorbet/releases) - [Commits](https://github.com/sorbet/sorbet/commits) --- updated-dependencies: - dependency-name: sorbet-runtime dependency-type: indirect update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
…7068) Bumps [rubocop](https://github.com/rubocop/rubocop) from 1.70.0 to 1.71.0. - [Release notes](https://github.com/rubocop/rubocop/releases) - [Changelog](https://github.com/rubocop/rubocop/blob/master/CHANGELOG.md) - [Commits](rubocop/rubocop@v1.70.0...v1.71.0) --- updated-dependencies: - dependency-name: rubocop dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Correct "lighting" to "lightning"
…sistant#37030) * Update squeezebox.markdown Clarify the integration connects to an exiting instance and doesn't provide the LMS control directly itself as this has come up a couple of times in the HA LMS add-no thread. * Update source/_integrations/squeezebox.markdown Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update source/_integrations/squeezebox.markdown Co-authored-by: c0ffeeca7 <[email protected]> --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: c0ffeeca7 <[email protected]>
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe pull request introduces a new markdown documentation file for the TIS Control integration in Home Assistant. This file contains metadata, configuration instructions, and guidance on integrating TIS Control devices, specifically switch devices like RCU and RELAY. It outlines the requirement for devices to be on the same local network and details the configuration process through the Home Assistant integrations page, including the specification of the UDP port. Changes
Sequence DiagramsequenceDiagram
participant User
participant HomeAssistant
participant TISDeviceManager
participant TISControlDevice
User->>HomeAssistant: Configure TIS Control Integration
HomeAssistant->>User: Request UDP Port (default 6000)
User->>HomeAssistant: Provide UDP Port
HomeAssistant->>TISDeviceManager: Initialize Communication
TISDeviceManager->>TISControlDevice: Discover and Add Devices
HomeAssistant->>TISControlDevice: Enable Control and Monitoring
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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (2)
source/_integrations/tis_control.markdown (2)
3-4: Fix grammatical issues in the description.The description should capitalize "Home Assistant" consistently.
-description: Instructions on how to integrate your TIS Control devices with home assistant. +description: Instructions on how to integrate your TIS Control devices with Home Assistant.
22-22: Add missing newline at end of file.Add a newline character at the end of the file to comply with markdown formatting standards.
🧰 Tools
🪛 Markdownlint (0.37.0)
22-22: null
Files should end with a single newline character(MD047, single-trailing-newline)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/tis_control.markdown(1 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
source/_integrations/tis_control.markdown
22-22: null
Files should end with a single newline character
(MD047, single-trailing-newline)
⏰ 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
🔇 Additional comments (1)
source/_integrations/tis_control.markdown (1)
4-4: Verify the version number format.The version number
0.1.4doesn't follow Home Assistant's typical versioning scheme (YYYY.M.X). Please verify if this is the correct version format for this integration.
| The TIS Control integration makes it possible to integrate and control TIS Control devices within Home Assistant. | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Enhance the integration description.
The current description lacks essential information. Consider adding:
- What TIS Control devices are and their typical use cases
- Prerequisites or requirements for using this integration
- Supported device types or models
- Network requirements or limitations
…e-assistant#37135) Bumps [sorbet-runtime](https://github.com/sorbet/sorbet) from 0.5.11778 to 0.5.11781. - [Release notes](https://github.com/sorbet/sorbet/releases) - [Commits](https://github.com/sorbet/sorbet/commits) --- updated-dependencies: - dependency-name: sorbet-runtime dependency-type: indirect update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
…ant#37136) Bumps [actions/setup-node](https://github.com/actions/setup-node) from 4.1.0 to 4.2.0. - [Release notes](https://github.com/actions/setup-node/releases) - [Commits](actions/setup-node@v4.1.0...v4.2.0) --- updated-dependencies: - dependency-name: actions/setup-node dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
* Add basic configuration * Give the supported devices info its own header * Remove `intergas` term * Update source/_integrations/incomfort.markdown * Add troubleshooing section
home-assistant
bot
added
in-progress
|
It seems that this PR is targeted against an incorrect branch since it has a parent PR on one of our codebases. Documentation that needs to be updated for an upcoming release should target the |
KarimTIS
requested review from
a team,
rytilahti,
bdraco,
frenck,
klaasnicolaas,
allenporter,
jbouwh and
zweckj
as code owners
home-assistant
bot
removed
needs-rebase
There was a problem hiding this comment.
Actionable comments posted: 3
♻️ Duplicate comments (2)
source/_integrations/tis_control.markdown (2)
19-22: 🛠️ Refactor suggestionEnhance the integration description.
The current description lacks essential information about TIS Control devices, prerequisites, and supported features.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
20-20: Bare URL used
null(MD034, no-bare-urls)
24-27: 🛠️ Refactor suggestionAdd standard Home Assistant documentation sections.
The documentation is missing several standard sections typically included in Home Assistant integration documentation.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~27-~27: A comma might be missing here.
Context: ...ation. The default port is 6000.
After this the integration will scan the network a...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
🪛 markdownlint-cli2 (0.17.2)
27-27: Files should end with a single newline character
null(MD047, single-trailing-newline)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/tis_control.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/tis_control.markdown
[uncategorized] ~27-~27: A comma might be missing here.
Context: ...ation. The default port is 6000.
After this the integration will scan the network a...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/tis_control.markdown
20-20: Bare URL used
null
(MD034, no-bare-urls)
27-27: Files should end with a single newline character
null
(MD047, single-trailing-newline)
| --- | ||
| title: TIS Control | ||
| description: Instructions on how to integrate your TIS Control devices with home assistant. | ||
| ha_release: 0.1.4 | ||
| ha_category: | ||
| - Network | ||
| - Notifications | ||
| ha_iot_class: Local Polling | ||
| ha_domain: tis_control | ||
| ha_platforms: | ||
| - switch | ||
| ha_codeowners: | ||
| - '@karimtis' | ||
| - '@Mustafa744' | ||
|
|
||
| ha_integration_type: integration | ||
| --- |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Revise metadata section for accuracy.
Several metadata fields need attention:
- The description should capitalize "Home Assistant"
- The version number format should follow Home Assistant's YYYY.M.0 pattern
- The "Notifications" category seems incorrect for a switch control integration
Apply these changes:
---
title: TIS Control
-description: Instructions on how to integrate your TIS Control devices with home assistant.
+description: Instructions on how to integrate your TIS Control devices with Home Assistant.
-ha_release: 0.1.4
+ha_release: 2024.2.0
ha_category:
- Network
- - Notifications
+ - Switch
ha_iot_class: Local Polling📝 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.
| --- | |
| title: TIS Control | |
| description: Instructions on how to integrate your TIS Control devices with home assistant. | |
| ha_release: 0.1.4 | |
| ha_category: | |
| - Network | |
| - Notifications | |
| ha_iot_class: Local Polling | |
| ha_domain: tis_control | |
| ha_platforms: | |
| - switch | |
| ha_codeowners: | |
| - '@karimtis' | |
| - '@Mustafa744' | |
| ha_integration_type: integration | |
| --- | |
| --- | |
| title: TIS Control | |
| description: Instructions on how to integrate your TIS Control devices with Home Assistant. | |
| ha_release: 2024.2.0 | |
| ha_category: | |
| - Network | |
| - Switch | |
| ha_iot_class: Local Polling | |
| ha_domain: tis_control | |
| ha_platforms: | |
| - switch | |
| ha_codeowners: | |
| - '@karimtis' | |
| - '@Mustafa744' | |
| ha_integration_type: integration | |
| --- |
| ## Configuration | ||
|
|
||
| To enable the integration, go to the integrations page inside the configuration panel and add the TIS Control integration. You will be asked to enter the port number for the UDP communication. The default port is 6000. | ||
| After this the integration will scan the network and add the devices automatically to your Home Assistant device list under the TIS Control Integration. |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Fix formatting and grammar in configuration section.
The configuration section needs formatting and grammar improvements.
Apply these changes:
## Configuration
To enable the integration, go to the integrations page inside the configuration panel and add the TIS Control integration. You will be asked to enter the port number for the UDP communication. The default port is 6000.
-After this the integration will scan the network and add the devices automatically to your Home Assistant device list under the TIS Control Integration.
+After this, the integration will scan the network and add the devices automatically to your Home Assistant device list under the TIS Control Integration.
+📝 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.
| ## Configuration | |
| To enable the integration, go to the integrations page inside the configuration panel and add the TIS Control integration. You will be asked to enter the port number for the UDP communication. The default port is 6000. | |
| After this the integration will scan the network and add the devices automatically to your Home Assistant device list under the TIS Control Integration. | |
| ## Configuration | |
| To enable the integration, go to the integrations page inside the configuration panel and add the TIS Control integration. You will be asked to enter the port number for the UDP communication. The default port is 6000. | |
| After this, the integration will scan the network and add the devices automatically to your Home Assistant device list under the TIS Control Integration. | |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~27-~27: A comma might be missing here.
Context: ...ation. The default port is 6000.
After this the integration will scan the network a...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
🪛 markdownlint-cli2 (0.17.2)
27-27: Files should end with a single newline character
null
(MD047, single-trailing-newline)
| The TIS Control integration makes it possible to integrate and control TIS Control devices within Home Assistant. | ||
| For full list of the products visit https://www.tiscontrol.com/. | ||
| currently the integration only supports switch devices aka (RCU, RELAY) devices. | ||
| To use the integration you need to have one or more supported device connected to the same local network and know which communication port they are using (default for TIS Control devices is udp 6000). |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Fix formatting and style issues.
The description section needs formatting improvements:
- Format the URL as a proper markdown link
- Capitalize sentence beginnings
- Format technical terms using backticks
- Fix grammatical issues
Apply these changes:
The TIS Control integration makes it possible to integrate and control TIS Control devices within Home Assistant.
-For full list of the products visit https://www.tiscontrol.com/.
-currently the integration only supports switch devices aka (RCU, RELAY) devices.
-To use the integration you need to have one or more supported device connected to the same local network and know which communication port they are using (default for TIS Control devices is udp 6000).
+For a full list of the products, visit [TIS Control's website](https://www.tiscontrol.com/).
+Currently, the integration only supports switch devices (also known as `RCU` and `RELAY` devices).
+To use the integration, you need to have one or more supported devices connected to the same local network and know which communication port they are using (default for TIS Control devices is UDP port `6000`).📝 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.
| The TIS Control integration makes it possible to integrate and control TIS Control devices within Home Assistant. | |
| For full list of the products visit https://www.tiscontrol.com/. | |
| currently the integration only supports switch devices aka (RCU, RELAY) devices. | |
| To use the integration you need to have one or more supported device connected to the same local network and know which communication port they are using (default for TIS Control devices is udp 6000). | |
| The TIS Control integration makes it possible to integrate and control TIS Control devices within Home Assistant. | |
| For a full list of the products, visit [TIS Control's website](https://www.tiscontrol.com/). | |
| Currently, the integration only supports switch devices (also known as `RCU` and `RELAY` devices). | |
| To use the integration, you need to have one or more supported devices connected to the same local network and know which communication port they are using (default for TIS Control devices is UDP port `6000`). |
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
20-20: Bare URL used
null
(MD034, no-bare-urls)
c0ffeeca7
removed request for
a team,
frenck,
bdraco,
rytilahti,
allenporter,
jbouwh,
klaasnicolaas and
zweckj
Proposed change
Added documentaion for TIS Control integration
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
Summary by CodeRabbit
New Features
Documentation