Skip to content

Commit

Permalink
Document new Home Assistant Repairs device & entities (#306)
Browse files Browse the repository at this point in the history
  • Loading branch information
frenck authored Aug 11, 2023
1 parent 542779b commit df8539c
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 0 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
53 changes: 53 additions & 0 deletions documentation/integrations/repairs.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,59 @@ Spook adds many new services to the repairs integration so that you can create y

Spook does not provide any new devices or entities for this integration.

```{figure} ../images/integrations/repairs/devices_entities.png
:alt: Screenshot of the the new Repairs device and its entities in the Home Assistant UI.
:align: center
```

### Buttons

#### Ignore all

_Default {term}`entity ID <Entity ID>`: `button.ignore_all_issues`_

Adds a button to ignore all issues currently raised in the repairs dashboard.

:::{tip}
This might sometimes seem helpful; however, ignoring an issue is not a solution. It is better to fix the issue, remove the integration that is causing it, or report a bug.

Every issue raised by Home Assistant (and also Spook) should be solvable. If not, it is a bug and should be reported.
:::

#### Unignore all

_Default {term}`entity ID <Entity ID>`: `button.unignore_all_issues`_

Adds a button to unignore all repair issues currently still active (but previously ignored).

### Events

#### Repair

_Default {term}`entity ID <Entity ID>`: `event.repair`_

This event entity triggers when a new repair issue is raised, or an existing one is updated or removed.

### Sensors

#### Active issues

_Default {term}`entity ID <Entity ID>`: `sensor.active_issues`_

This sensor shows the number of active issues currently raised in the repairs dashboard.

#### Ignored issues

_Default {term}`entity ID <Entity ID>`: `sensor.ignored_issues`_

This sensor shows the number of ignored issues currently raised in the repairs dashboard.

#### Total issues

_Default {term}`entity ID <Entity ID>`: `sensor.issues`_

This sensor shows the total number of issues known to the repairs dashboard.

## Services

Spook adds the following new service to your Home Assistant instance:
Expand Down

0 comments on commit df8539c

Please sign in to comment.