Last Updated:

Uptime Kuma Integration for Home Assistant

S.C.O.R.E.OrganizationScheduling

Overview

Uptime Kuma helps homeowners monitor the uptime and status of their online services and websites, ensuring that their digital infrastructure remains healthy. By integrating with Home Assistant, users can receive real-time alerts and visualizations of their system’s performance directly from their smart home dashboard.

Organization icon

Benefits

  • Immediate notifications when a service goes down, allowing for quick troubleshooting.
  • Centralized monitoring of multiple services and websites from one interface.
  • Enhanced peace of mind knowing the status of essential services is constantly tracked.

Intent

The purpose of Uptime Kuma is to provide homeowners with a reliable way to oversee their digital services. By monitoring the uptime and status of these services, users can ensure their home tech ecosystem operates smoothly and efficiently.

Preconditions

  • Home Assistant must be installed and configured.
  • Uptime Kuma must be set up to monitor desired services.
  • Stable internet connection for accurate monitoring.
  • Home Assistant installed and configured.
  • Integration available and authenticated: Zigbee2MQTT.
  • Device installed and reachable: Energy Monitoring.

Actors

  • Homeowner
  • Family member
  • Guest

Trigger

The capability is triggered by a scheduled check of service statuses or when a change in service availability is detected.

Workflow Diagram

flowchart TD
    A[Service Status Check] -->|check| B{{Is Service Up?}}
    B -->|Yes| C[Log Status]
    B -->|No| D[Send Alert]
    D --> E[Log Downtime]
    C --> F[Exit]

Workflow Description

1. Initiate Status Check

A scheduled job runs to check the status of the monitored services.

2. Evaluate Service Status

The system determines whether each service is operational or down.

3. Log Status

If the service is up, the current status is logged in the system for future reference.

4. Send Alert

If a service is down, an immediate alert is sent to the homeowner through Home Assistant notifications.

5. Log Downtime

The downtime is recorded for analysis and tracking service reliability over time.

Postconditions

After the capability completes, users have an updated view of their service statuses and receive alerts about any issues, ensuring they can take timely action.

Optional Enhancements

  • Integrate with additional monitoring tools for enhanced data analysis.
  • Set up automated recovery actions for certain services.
  • Provide historical uptime statistics for better decision-making.

Recommended Components

Recommended ApplicationsRecommended IntegrationsRecommended Devices
Home AssistantZigbee2MQTT, ESPHomeEnergy Monitoring, Temperature Sensors

Source Examples