Whisker App for Homey

This is the official Homey integration for Whisker devices, supporting the Litter-Robot 3, Litter-Robot 4, and Pets. It brings your Whisker devices into your Homey based smart home with automations, insights, and monitoring.

🙏 Special Thanks

This app builds on the work of pylitterbot — huge thanks to natekspencer for figuring out the Whisker API and maintaining the Python integration!

🧠 Features

Bring automation and insights to your Whisker devices with Homey Flows and device capabilities:

📊 Litter-Robot 3 Capabilities

Status & Monitoring:

• litter_robot_status – Device status (ready, cycling, etc.)
• clean_cycle_status – Status of the cleaning cycle
• alarm_connectivity – Device connectivity status
• last_seen – When device was last online
• alarm_problem – Hardware fault detection

Cat Detection & Presence:

• alarm_cat_detected – Cat presence alarm

Waste Management:

• alarm_waste_drawer_full – Waste drawer full indicator
• measure_waste_drawer_level_percentage – Waste drawer fill level (%)
• measure_clean_cycles_since_empty – Cycles since last empty
• measure_scoops_saved_count – Estimated scoops saved
• reset_waste_drawer – Reset waste drawer counter

Litter Management:

• measure_odometer_clean_cycles – Total clean cycles

Sleep Mode:

• alarm_sleep_mode_active – Sleep mode is currently active
• alarm_sleep_mode_scheduled – Sleep mode is scheduled
• sleep_mode_start_time – When Sleep Mode activates
• sleep_mode_end_time – When Sleep Mode ends
• sleep_mode_enabled – Enable/disable sleep mode

Controls & Settings:

• cycle_delay – Set delay before cycle starts (3/7/15 minutes)
• key_pad_lock_out – Lock/unlock the keypad
• night_light_enabled – Enable/disable globe light
• start_clean_cycle – Start cleaning
• onoff – Power on/off

📊 Litter-Robot 4 Capabilities

Status & Monitoring:

• litter_robot_status – Device status (ready, cycling, etc.)
• clean_cycle_status – Status of the cleaning cycle
• alarm_connectivity – Device connectivity status
• last_seen – When device was last online

Cat Detection & Presence:

• alarm_cat_detected – Cat presence alarm
• measure_weight – Cat weight measurement (for pet tracking)

Waste Management:

• alarm_waste_drawer_full – Waste drawer full indicator
• measure_waste_drawer_level_percentage – Waste drawer fill level (%)
• measure_scoops_saved_count – Estimated scoops saved

Litter Management:

• measure_litter_level_percentage – Litter level (%)
• measure_odometer_clean_cycles – Total clean cycles

LitterHopper:

• alarm_litter_hopper_empty – LitterHopper empty alarm
• litter_hopper_enabled – Enable/disable LitterHopper control
• litter_hopper_status – LitterHopper status monitoring

Sleep Mode:

• alarm_sleep_mode_active – Sleep mode is currently active
• alarm_sleep_mode_scheduled – Sleep mode is scheduled
• sleep_mode_start_time – When Sleep Mode activates
• sleep_mode_end_time – When Sleep Mode ends

Controls & Settings:

• clean_cycle_wait_time – Set delay before cycle starts
• key_pad_lock_out – Lock/unlock the keypad
• night_light_mode – Off / On / Auto
• panel_brightness – Panel LED brightness
• start_clean_cycle – Start cleaning
• start_empty_cycle – Start emptying
• short_reset_press – Trigger soft reset

🐱 Pet Information Capabilities

• measure_weight – Pet's current weight
• label_gender – Pet's gender
• label_food – Pet's diet information
• label_environment – Pet's environment type
• label_birthday – Pet's birthday
• label_breed – Pet's breed information
• label_age – Pet's age
• alarm_health_concern – Health concerns detected

🔁 Flow Triggers (When...)

Litter-Robot 3:

• Waste drawer becomes full
• Waste drawer is no longer full
• Cat detected
• Cat not detected
• Sleep mode activated
• Sleep mode deactivated
• Sleep mode becomes scheduled
• Sleep mode becomes unscheduled
• Multiple clean cycles completed
• Problem details provided
• A cleaning cycle is finished
• The cleaning status changes
• The Litter-Robot status changes
• Device goes offline
• Device comes back online

Litter-Robot 4:

• Waste drawer becomes full
• Waste drawer is no longer full
• Cat detected
• Cat not detected
• Sleep mode activated
• Sleep mode deactivated
• Multiple clean cycles completed
• Problem details provided
• LitterHopper becomes empty
• LitterHopper is no longer empty
• LitterHopper is enabled
• LitterHopper is disabled
• A cleaning cycle is finished
• The cleaning status changes
• The Litter-Robot status changes

Pet Information:

• Health concern detected
• Age changed
• Environment changed
• Diet changed

📥 Flow Conditions (And...)

Litter-Robot 3:

• Is a cat detected?
• Is sleep mode active?
• Is sleep mode scheduled?
• Is the waste drawer full?
• What is the current cleaning status?
• What is the current Litter-Robot status?

Litter-Robot 4:

• Is a cat detected?
• Is sleep mode active?
• Is sleep mode scheduled?
• Is the waste drawer full?
• Is the robot currently cleaning?
• Is the LitterHopper empty?
• Is the LitterHopper enabled?
• What is the current cleaning status?
• What is the current Litter-Robot status?

Pet Information:

• Is it the pet's birthday today?
• Is it X days until the pet's birthday?

🛠 Flow Actions (Then...)

Litter-Robot 3:

• Start a clean cycle
• Lock or unlock the keypad
• Turn on/off/toggle globe light
• Set cycle delay (3/7/15 minutes)
• Reset waste drawer

Litter-Robot 4:

• Start a clean cycle
• Start an empty cycle
• Lock or unlock the keypad
• Set night light mode (off/on/auto)
• Set panel brightness
• Set clean cycle wait time
• Press reset (short press)
• Enable/disable LitterHopper

📦 Supported Devices

• ✅ Litter-Robot 3 - Full support with all capabilities
• ✅ Litter-Robot 4 - Full support with all capabilities including LitterHopper
• ✅ Pet Information - Complete pet monitoring and health tracking
• 🟡 Feeder-Robot (integration planned — hardware sample needed)

Support for additional Whisker devices would be great — but we'll need sample hardware to build and test those integrations.

🚀 Installation

You can try the app in two ways:

✅ Option 1: Install the test build via Homey App Store

👉 Install the latest test version via Homey

Note: Can be used on both Homey Cloud as well as Homey Pro.

---

🛠️ Option 2: Manual installation via Homey CLI

git clone https://github.com/Doekse/whisker-homey.git
cd whisker-homey
npm install
homey app install