Skip to content

Entities

jl0906 edited this page Aug 4, 2026 · 1 revision

Entities

BackupCheckup creates one main device and optional detail devices for detected storage agents.

Entity modes

  • Standard: enables primary status, Health, Recovery, integrity, analytics, and problem entities.
  • Expert: additionally enables timestamps, checksums, database details, manual-backup data, native schedule values, and every storage-agent entity.

An entity manually disabled by the user remains disabled. Storage-agent entities are disabled in Standard mode.

Main sensors

Entity Purpose
sensor.backup_checkup_status highest-priority current backup state
sensor.backup_checkup_recommendation recommended next action
sensor.backup_checkup_health_score explained Health Score from 0–100
sensor.backup_checkup_health_rating Excellent, Good, Warning, or Critical
sensor.backup_checkup_problem_count number of simultaneous problems
sensor.backup_checkup_stored_backups monitored regular backup count; update snapshots remain visible in attributes
sensor.backup_checkup_latest_backup_age age in complete 24-hour days
sensor.backup_checkup_latest_backup_size newest regular backup size
sensor.backup_checkup_latest_backup_result complete, partial, or unknown
sensor.backup_checkup_latest_backup_locations locations containing the newest regular backup
sensor.backup_checkup_automatic_backups automatic backup count
sensor.backup_checkup_automatic_backup_age newest automatic backup age
sensor.backup_checkup_latest_automatic_backup_size newest automatic backup size

Age sensors remain at 0 d until 24 hours have elapsed. Exact timestamps and precise values are available in attributes and expert timestamp entities.

Integrity sensors

Entity Purpose
sensor.backup_checkup_integrity_status not_checked, checking, valid, valid_with_warnings, corrupt, unreadable, password_required, aborted, or internal error
sensor.backup_checkup_last_integrity_check latest completed check time
sensor.backup_checkup_integrity_checksum stored SHA-256, Expert detail
sensor.backup_checkup_verified_backup_size downloaded and verified size
sensor.backup_checkup_integrity_check_duration complete-check duration
sensor.backup_checkup_database_integrity_status optional SQLite result

Recovery sensors

Entity Purpose
sensor.backup_checkup_recovery_readiness 0–100 score with checks, deductions, inventory, comparison, and preparedness
sensor.backup_checkup_recovery_status ready, limited, insufficient, or unknown
sensor.backup_checkup_recovery_recommendation highest-priority recovery action
sensor.backup_checkup_restore_simulation_status structural protection-check state and stages
sensor.backup_checkup_runtime_test_status optional isolated runner-test state
sensor.backup_checkup_last_restore_test documented external restore-test timestamp

Analytics sensors

Entity Purpose
sensor.backup_checkup_size_trend increasing, stable, decreasing, or insufficient data
sensor.backup_checkup_average_backup_size average comparable backup size
sensor.backup_checkup_longest_backup_gap longest observed gap, Expert detail
sensor.backup_checkup_automatic_success_rate locally observed success rate
sensor.backup_checkup_consecutive_automatic_failures latest consecutive automatic failures
sensor.backup_checkup_activity_log bounded privacy-safe journal state and attributes

Additional Expert sensors

  • sensor.backup_checkup_manual_backups
  • sensor.backup_checkup_latest_backup
  • sensor.backup_checkup_latest_automatic_backup
  • sensor.backup_checkup_latest_manual_backup
  • sensor.backup_checkup_manual_backup_age
  • sensor.backup_checkup_latest_backup_size_change
  • sensor.backup_checkup_last_automatic_attempt
  • sensor.backup_checkup_last_successful_automatic_event
  • sensor.backup_checkup_next_automatic_backup
  • sensor.backup_checkup_backup_manager_state

Problem binary sensors

binary_sensor.backup_checkup_problem aggregates all problems. Specific causes use the binary_sensor.backup_checkup_ prefix:

  • no_backup
  • backup_stale
  • automatic_backup_overdue
  • automatic_backup_failed
  • automatic_schedule_missing
  • automatic_schedule_overdue
  • backup_manager_unavailable
  • storage_error
  • backup_size_suspicious
  • latest_backup_incomplete
  • backup_not_redundant
  • required_location_missing (Expert)
  • backup_integrity_problem
  • backup_integrity_warning
  • backup_checksum_changed
  • external_copy_missing
  • backup_content_changed
  • recovery_checklist_incomplete
  • external_dependency_unprotected
  • restore_test_overdue
  • recovery_plan_incomplete

Buttons

Entity Function
button.backup_checkup_run_recovery_assessment runs the complete non-destructive backup protection check
button.backup_checkup_verify_latest_backup disabled compatibility alias for the structural pipeline
button.backup_checkup_refresh immediately reloads inventory and evaluation
button.backup_checkup_test_notification sends a test notification when targets are configured
button.backup_checkup_clear_activity_log clears the active journal

Storage-location devices

Expert mode can expose regular backup count, newest backup timestamp, age, size, total stored size, and a problem binary sensor for each native storage agent. Technical update snapshots remain separated in attributes. Agent IDs are normalized for entity IDs, for example sensor.backup_checkup_local_latest_backup.

Clone this wiki locally