README.md

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). 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.

Installation

HACS (recommended)

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

• 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 litterrobot status_code sensor options.
• Thanks to all contributors!
• Maintained by Patrick Masters / Curious Cat Consulting

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 Hopper status — hopper badge & footer items on LR4 when a LitterHopper is attached - thanks @chrispgriffin & @adude007, @eviljacquiooh
• Hide pet weight chip — optional hide_pet_weight feature flag for multi-cat setups - thanks @semichcsc-byte
• Pet weight graph — auto-detected multi-cat weight graph with history or long-term statistics - thanks @brombomb & @adude007