Enhance STIPS IR Remote integration documentation and details#44802
Enhance STIPS IR Remote integration documentation and details#44802hanyNaji wants to merge 3 commits intohome-assistant:currentfrom
Conversation
Added documentation for STIPS IR Remote integration, including setup, configuration, supported functionality, and troubleshooting.
Updated formatting and added release version information.
home-assistant
Bot
added
current
|
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 |
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
Adds initial documentation for the new STIPS IR Remote integration, describing setup, requirements, supported climate features, limitations, and troubleshooting for controlling air conditioners via the STIPS IRU1 device.
Changes:
- Introduces a new integration documentation page for
stips_iru1. - Documents prerequisites, configuration steps, supported climate functionality, limitations, and troubleshooting guidance.
|
|
||
| 1. Confirm the IRU1 is powered on and connected to your LAN. | ||
| 2. Confirm Home Assistant can resolve and reach the device hostname. | ||
| 3. From **Devices & services**, open STIPS IR Remote integration and reload the integration from (three-dots menu). |
There was a problem hiding this comment.
Troubleshooting step 3 is hard to follow as written (“reload the integration from (three-dots menu)”). To improve clarity and match other docs, refer to the menu and action explicitly (for example, “select the three-dots menu, then select Reload”).
| 3. From **Devices & services**, open STIPS IR Remote integration and reload the integration from (three-dots menu). | |
| 3. From **Settings** > **Devices & services**, open the **STIPS IR Remote** integration, select the three-dots menu, and then select **Reload**. |
| @@ -0,0 +1,70 @@ | |||
| --- | |||
| title: "STIPS IR Remote" | |||
| description: "Control AC units through STIPS IRU1 over your local network." | |||
There was a problem hiding this comment.
Front matter description uses the abbreviation “AC”. To match the documentation style used across integrations and to keep wording clear for non-technical readers, spell this out as “air conditioner(s)” instead of “AC”.
| description: "Control AC units through STIPS IRU1 over your local network." | |
| description: "Control air conditioners through STIPS IRU1 over your local network." |
| ## STIPS IR Remote | ||
|
|
There was a problem hiding this comment.
The page title is already provided by the front matter, so repeating it as a second-level heading adds unnecessary duplication. Other integration docs start with an introductory paragraph directly after the front matter (see source/_integrations/_integration_docs_template.markdown:25). Consider removing this heading and starting with the intro text.
| ## STIPS IR Remote |
| 1. In Home Assistant, go to **Settings** > **Devices & services**. | ||
| 2. Select **Add Integration**. | ||
| 3. Search for **STIPS IR Remote**. | ||
| 4. Enter: | ||
| - API host | ||
| - Username | ||
| - Password | ||
| 5. Finish setup. | ||
|
|
||
| If setup succeeds, Home Assistant imports supported climate remotes from your STIPS catalog. | ||
|
|
There was a problem hiding this comment.
This integration is set up via config flow (ha_config_flow: true), but the docs don’t include the standard config-flow include and field documentation. Most integration pages use {% include integrations/config_flow.md %} and a {% configuration_basic %} block to describe the config fields (see source/_integrations/_integration_docs_template.markdown:51-62). Adding those here would keep the setup section consistent and let you describe what “API host”, “Username”, and “Password” mean.
| 1. In Home Assistant, go to **Settings** > **Devices & services**. | |
| 2. Select **Add Integration**. | |
| 3. Search for **STIPS IR Remote**. | |
| 4. Enter: | |
| - API host | |
| - Username | |
| - Password | |
| 5. Finish setup. | |
| If setup succeeds, Home Assistant imports supported climate remotes from your STIPS catalog. | |
| {% include integrations/config_flow.md %} | |
| {% configuration_basic %} | |
| API host: | |
| description: "The hostname or IP address of your STIPS IRU1 device on your local network. Home Assistant uses this address to send climate commands locally after setup." | |
| Username: | |
| description: "Your STIPS account username. Home Assistant uses this account during setup to sign in and download your IR catalog, including your areas, devices, and remotes." | |
| Password: | |
| description: "Your STIPS account password for signing in during setup." | |
| {% endconfiguration_basic %} | |
| After setup completes, Home Assistant imports supported climate remotes from your STIPS catalog. |
|
|
||
| The **STIPS IR Remote** integration lets Home Assistant control supported air conditioners through a **STIPS IRU1** device. | ||
|
|
||
| During setup, Home Assistant signs in to your STIPS account to download your IR catalog, including areas, devices, and remotes. After setup, climate commands are sent locally on your LAN to the IRU1 device. |
There was a problem hiding this comment.
The term “LAN” is used here without being defined. Prefer consistently using “local network” throughout, or define it once as “local network (LAN)” on first use to keep the text accessible.
c0ffeeca7
left a comment
c0ffeeca7
left a comment
There was a problem hiding this comment.
As this PR is related to a code change, please rebase it against the next branch. One way to do this is:
- Close this PR.
- Switch to the
nextbranch and pull the latestnextbranch. - Create a new branch based on that.
- Push your changes, targeting the next branch (not current`).
There are 2 main branches, next and current. Next is used for code changes, are these documentation changes only apply once the code is merged, at some point in the future. See also https://developers.home-assistant.io/docs/documenting/create-page/
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
home-assistant
Bot
removed
needs-rebase
This pull request adds and fixes documentation for the new STIPS IR Remote integration, which enables Home Assistant to control air conditioners via the STIPS IRU1 device. The documentation covers setup instructions, supported features, requirements, limitations, and troubleshooting steps.
New integration documentation:
source/_integrations/stips_iru1.markdowndescribing the STIPS IR Remote integration, including prerequisites, configuration steps, supported climate features, limitations, and troubleshooting guidance.Related core PR:
Related brands PR: