Skip to content
homeassistant-extrasPublic

Latest commit

 

History

92 Commits

Folders and files

Repository files navigation

Whisker Card

Litter-Robot status and controls in a single Lovelace card

Whisker Card preview

Home Assistant hacs_badge

GitHub Release GitHub Pre-Release GitHub Tag GitHub branch status

stars home commits license

Overview

Whisker Card is a custom Lovelace card for Home Assistant that shows your Litter-Robot at a glance, using the official Litter-Robot integration (litterrobot). On Litter-Robot 4 with a LitterHopper attached, the card can also show hopper connection and refill status.

Documentation

Full documentation is available at: homeassistant-extras.github.io/whisker

Quick Start

type: custom:whisker-card
device_id: YOUR_DEVICE_ID

Replace YOUR_DEVICE_ID with the id from the device page in Home Assistant, or use the UI editor to pick the device.

Want a shorter card? The hide_image feature flag drops the robot photo and keeps everything else:

Default card, hide_image, and hide_image with a cleaning reminder

Installation

HACS (recommended)

HACS

  1. Open HACS in Home Assistant.
  2. Open the menu → Custom repositories.
  3. Add https://github.com/homeassistant-extras/whisker and category Dashboard.
  4. Install Whisker Card and restart if prompted.

Manual installation

  1. Download whisker.js from the latest release (dist/whisker.js).
  2. Copy to www/community/whisker/.
  3. Add the Lovelace resource — see Installation for configuration.yaml details.

Contributing

License

This project is licensed under the MIT License. See the LICENSE file.

Acknowledgments

contributors

ko-fi

Project Roadmap

  • Litter-Robot device discovery via translation_key mapping
  • Visual card — status, gauges, pet weight, last seen
  • Tap / hold actions on status icons (cycle / reset vs more-info)
  • Controls dialog with native entity rows
  • Lovelace card editor (device selector + title)
  • Automated tests (Mocha)
  • Gauge percentages — optional percentage labels on litter/waste gauges - thanks reddit!
  • Customizable footer — choose footer metrics and order - thanks @alicia86
  • Model-aware artwork — auto-detects Litter-Robot model - thanks @adude007
  • Litter-Robot 3 artwork — Beige and Grey LR3 images, auto-detected from the device - thanks reddit!
  • Litter Hopper status — hopper badge & footer items on LR4 when a LitterHopper is attached - thanks @chrispgriffin & @adude007, @eviljacquiooh
  • Pet weight — shown via the footer (pet_weight) and the auto-detected weight graph (the standalone chip was retired) - thanks @semichcsc-byte
  • Pet weight graph — auto-detected multi-cat weight graph with history or long-term statistics - thanks @brombomb & @adude007
  • Pet visits graph — auto-detected per-cat daily litter box visit counts - thanks @alicia86, @adude007
  • Mini layout — compact low-profile card for wall-mount dashboards - thanks @davidcoulson
  • SVG level graphic: Opt-in silhouette with colored litter/waste zones instead of bars - thanks @timb320tg
  • Pet card — standalone whisker-pet-card for per-cat weight and visits - thanks @christasich
  • Hide robot image — hide_image drops the photo but keeps the full card - thanks @GeekStreetSolutions

Releases

Packages

Used by

Contributors

Languages