Skip to content

Repository files navigation

CashPilot for Home Assistant

CashPilot for Home Assistant

GitHub Release Tests License GitHub Stars HACS

A Home Assistant custom integration that monitors your CashPilot passive income dashboard. Track earnings, service health, and manage containers directly from HA.

The CashPilot device page in Home Assistant: total, today and month earnings, active services, fleet workers and a Collect earnings button

Features

  • Earnings overview -- total, today, and monthly earnings as sensors
  • Per-service monitoring -- balance, health score, uptime, CPU, and memory for every deployed service
  • Service control -- start, stop, and restart individual services via switches and buttons
  • Fleet overview -- online workers and running containers (if fleet mode is configured)
  • Manual collection -- trigger an earnings refresh on demand
  • Refreshes every 5 minutes -- see polling interval

Quick start

  1. In HACS, search for CashPilot, download it and restart Home Assistant. Or open it in HACS directly:

    Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.

  2. Go to Settings > Devices & Services > Add Integration and pick CashPilot.

  3. Enter the URL of your CashPilot instance (e.g., http://cashpilot:8080) and your CashPilot username and password.

Needs Home Assistant 2024.1.0 or later and a CashPilot instance it can reach. Manual install and details are in Getting started.

Documentation

  • Getting started: prerequisites, HACS, manual install, configuration, polling interval
  • Usage: every sensor, switch and button, per device
  • Example automations: daily earnings notification, service down alert, auto-restart
  • Development: tests and coverage
  • Related projects: the CashPilot family and other Home Assistant integrations by GeiserX

Bugs and feature requests go to the issue tracker.

License

GPL-3.0-or-later