Add Room Support Documentation (#26491)

* Add Room Support Documentation & Cleanup

* Removed Cleanup Content

* Tiny tweak

---------

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
Mark Adkins 2024-04-23 10:18:18 -04:00 committed by GitHub
parent d593a64274
commit 288d8d393e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 30 additions and 1 deletions

View File

@ -21,7 +21,7 @@ The `sharkiq` integration allows you to control your [Shark IQ](https://www.shar
## Services
Currently supported services are:
Currently supported [`vacuum`](/integrations/vacuum/) services are:
- `start`
- `pause`
@ -30,4 +30,33 @@ Currently supported services are:
- `locate`
- `set_fan_speed`
### Room Targeting
In addition to the [`vacuum`](/integrations/vacuum/) services, this integration supports room targeting.
This allows you to select specific rooms that you want cleaned, instead of doing a whole-home clean.
```yaml
service: sharkiq.clean_room
data:
rooms:
- "Entry"
- "Living Room"
target:
entity_id: vacuum.my_vacuum
```
**Important Note:** The list of rooms must be written _exactly_ as they appear in the Shark Clean app. If you want exact names that the service will understand,
look for the `Rooms` attribute of your Shark Robot Vacuum in Home Assistant. This will be populated with the rooms that the robot has configured, as they will be
understood by the service.
If you want to use the area selector in the service's UI, you need to format the area names exactly as they appear in the vacuum's `Rooms` attribute. You may also check the attribute using Home Assistant's [Developer Tools](https://www.home-assistant.io/docs/tools/dev-tools/).
<p class='img'>
<img src='/images/integrations/sharkiq/sharkiq-room-service-attributes.png' />
</p>
## Troubleshooting
### Integration Disconnecting
If the integration frequently disconnects and you have an ad blocker runner like [Pi-hole](https://pi-hole.net/) or [AdGuard](https://adguard.com) add `ads-field.aylanetworks.com` to the Allow list . This domain is needed for the connection and can be part of the automatic blocking because of `ads` being part of the subdomain.
If `pause` does not work for you, then it is not supported by your vacuum. The `stop` service will provide similar functionality.

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB