Overview
Open-source Lovelace dashboard cards for the Whisker and Litter-Robot integration in Home Assistant, giving pet owners clear visibility into litter status, cycles, and device health without leaving their smart-home UI. Built with TypeScript for the frontend stack, distributed via HACS, and maintained under the homeassistant-extras GitHub organization for easy install and updates.
README
Whisker Card
Litter-Robot status and controls in a single Lovelace card
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).
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.
Installation
HACS (recommended)
- Open HACS in Home Assistant.
- Open the menu → Custom repositories.
- Add
https://github.com/homeassistant-extras/whiskerand category Dashboard. - Install Whisker Card and restart if prompted.
Manual installation
- Download
whisker.jsfrom the latest release (dist/whisker.js). - Copy to
www/community/whisker/. - Add the Lovelace resource — see Installation for
configuration.yamldetails.
Contributing
- Join the Discussions — Share feedback or ask questions.
- Report Issues — Bugs, model-specific gaps, or feature requests (issue templates).
- Submit Pull Requests — See contributing guidelines when available.
- Discord — Extra help or chat.
- More homeassistant-extras projects
License
This project is licensed under the MIT License. See the LICENSE file.
Acknowledgments
- Built with Lit.
- Status mapping aligns with Home Assistant’s
litterrobotstatus_code sensor options. - Thanks to all contributors!
- Maintained by Patrick Masters / Curious Cat Consulting
Project Roadmap
- Litter-Robot device discovery via
translation_keymapping - 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