Skip to content

Enhance STIPS IR Remote integration documentation and details #44802

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.

Sign up for GitHub

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

Closed
hanyNaji wants to merge 3 commits into from
Closed

Enhance STIPS IR Remote integration documentation and details #44802

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7374bfe
Create STIPS IR Remote integration documentation
hanyNaji Apr 15, 2026
6f03124
Merge branch 'current' into stips-iru1-docs
hanyNaji Apr 15, 2026
aa8250d
Enhance STIPS IR Remote documentation and details
hanyNaji Apr 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 70 additions & 0 deletions source/_integrations/stips_iru1.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
title: "STIPS IR Remote"
description: "Control AC units through STIPS IRU1 over your local network."
Copy link

Copilot AI Apr 16, 2026

Choose a reason for hiding this comment

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

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”.

Suggested change
description: "Control AC units through STIPS IRU1 over your local network."
description: "Control air conditioners through STIPS IRU1 over your local network."

Copilot uses AI. Check for mistakes.
ha_category:
- Climate
ha_iot_class: "Local Push"
ha_domain: "stips_iru1"
ha_platforms:
- climate
ha_config_flow: true
ha_release: "2026.4"
---

## STIPS IR Remote

Comment on lines +14 to +15
Copy link

Copilot AI Apr 16, 2026

Choose a reason for hiding this comment

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

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.

Suggested change
## STIPS IR Remote

Copilot uses AI. Check for mistakes.
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.
Copy link

Copilot AI Apr 16, 2026

Choose a reason for hiding this comment

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

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.

Copilot uses AI. Check for mistakes.

## Prerequisites

- A STIPS account with access to your IR catalog.
- At least one STIPS IRU1 device linked to your account.
- The IRU1 device and Home Assistant must be on the same local network.
- The IRU1 device should be online and reachable by hostname on your LAN.

## Configuration

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.

Comment on lines +29 to +39
Copy link

Copilot AI Apr 16, 2026

Choose a reason for hiding this comment

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

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.

Suggested change
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.

Copilot uses AI. Check for mistakes.
## Supported functionality

Climate platform support for:

- Protocol AC remotes
- Learned AC remotes
- HVAC mode control
- Target temperature control
- Fan mode control
- Swing mode control, where supported by the remote model
- Turn on and turn off

## Notes

- Internet access is required during setup to fetch catalog data.
- Normal climate command dispatch is local over LAN after setup.
- If the device hostname cannot be resolved, ensure the IRU1 is online and reachable on your network, then reload or reconfigure the integration.

## Limitations

- This initial version supports climate entities only.
- Non-climate remote features are planned for a follow-up release.

## Troubleshooting

If entities appear unavailable or commands fail:

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).
Copy link

Copilot AI Apr 16, 2026

Choose a reason for hiding this comment

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

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”).

Suggested change
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**.

Copilot uses AI. Check for mistakes.
4. Reconfigure the integration if catalog data has changed.
Loading