Skip to article frontmatterSkip to article content
Enhanced integrations

Repairs

Can we fix it? No, we are not Bob the Builder. 👷

The Home Assistant repairs icon



The repairs integration brings the repairs dashboards into Home Assistant, which informs you about issues found in your Home Assistant instance. Other integrations (like Spook 👻 itself) provide these raised repair issues, so you can keep your system healthy and in a working state.

The issues raised always apply to your situation and system, so you can be sure the issues raised are relevant to you.

Spook enhances the integration by providing services that allow you to raise and manage your own repair issues.

Screenshot of the repairs services Spook adds to Home Assistant, taken from the developer tools.

Figure 1:Spook adds many new services to the repairs integration so that you can create your own.

Devices & entities¶

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

Screenshot of the the new Repairs device and its entities in the Home Assistant UI.

Buttons¶

Ignore all¶

Default entity ID: button.ignore_all_issues

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

Unignore all¶

Default entity ID: button.unignore_all_issues

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

Events¶

Repair¶

Default 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 entity ID: sensor.active_issues

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

Ignored issues¶

Default entity ID: sensor.ignored_issues

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

Total issues¶

Default 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:

Create issue¶

Create and raise your own issues in the repairs dashboard. For example, to raise low battery reports for your devices or to raise an issue when a device becomes unreachable.

Screenshot of the repairs create issue service call in the developer tools.
Screenshot of the repairs issue raised by the previous screenshot.
Service properties
ServiceRepairs: Create issue 👻
Service namerepairs.create
Service targetsNo targets
Service responseNo response
Spook's influenceNewly added service
Developer toolsTry this service Open your Home Assistant instance and show your service developer tools with a specific service selected.
Service call data
AttributeTypeRequiredDefault / Example
titlestringYes
descriptionstringYes
issue_idstringNoRandomly generated
domainstringNoIntegration domain, defaults to spook.
severitystringNowarning (default), error, or critical
persistentbooleanNofalse

Setting an issue_id can be helpful, as you can use it to update the issue later on. If you create an issue with the same issue ID again, it will update the issue with the new data. The issue ID can also be used to remove the issue with the repairs.remove service.

The domain can be set to any integration domain. For example, if you set it to automation, the issue will show up as a repair issue for the automation integration. It defaults to the spook integration when not provided.

The persistent attribute can be set to true to indicate it should survive a Home Assistant restart. It defaults to false when not provided.

Ignore all issues¶

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

Screenshot of the repairs ignore all issues service call in the developer tools.
Service properties
ServiceRepairs: Ignore all issues 👻
Service namerepairs.ignore_all
Service targetsNo targets
Service responseNo response
Spook's influenceNewly added service
Developer toolsTry this service Open your Home Assistant instance and show your service developer tools with a specific service selected.

Remove issue¶

Remove an issue from the repairs integration.

Screenshot of the repairs remove issue service call in the developer tools.
Service properties
ServiceRepairs: Remove issue 👻
Service namerepairs.remove
Service targetsNo targets
Service responseNo response
Spook's influenceNewly added service
Developer toolsTry this service Open your Home Assistant instance and show your service developer tools with a specific service selected.
Service call data
AttributeTypeRequiredDefault / Example
issue_idstringYes

The issue_id must be an issue ID you have used with the repairs.create service.

Unignore all issues¶

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

Screenshot of the repairs unignore all issues service call in the developer tools.
Service properties
ServiceRepairs: Unignore all issues 👻
Service namerepairs.unignore_all
Service targetsNo targets
Service responseNo response
Spook's influenceNewly added service
Developer toolsTry this service Open your Home Assistant instance and show your service developer tools with a specific service selected.

Repairs¶

Spook has no repair detections for this integration.

Uses cases¶

Some use cases for the enhancements Spook provides for this integration:

  • Creating and raising your own issues has lots of possibilities. For example, you could create an issue when a device is low on battery or when a device is offline for a long time. You could also create an issue when a device is not responding to commands or when a device is not responding to commands in a certain time frame. The possibilities are endless.

Blueprints & tutorials¶

There are currently no known blueprints or tutorials for the enhancements Spook provides for this integration. If you created one or stumbled upon one, please let us know in our discussion forums.

Features requests, ideas, and support¶

If you have an idea on how to further enhance this integration, for example, by adding a new service, entity, or repairs detection; feel free to let us know in our discussion forums.

Are you stuck using these new features? Or maybe you’ve run into a bug? Please check the Support page on where to go for help.