Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

version

ZeroMouse - Home Assistant Integration

Version Downloads Validate HACS Validation HACS Community Forum

Logo

Home Assistant integration for the ZeroMouse Smart Cat Flap. Monitors cat activity, detects prey, and controls flap settings — all from Home Assistant.

Features

  • AI-powered detection — classifies entries as clean, prey, inconclusive, or leaving
  • Live event GIFs — animated previews of the most recent detection and last prey event
  • Remote controls — block unknown cats, block prey, set inconclusive handling mode, adjust prey block duration
  • Device health — Wi-Fi RSSI, firmware version, MQTT errors, PIR trigger count, boot count
  • Cloud-polled — reads from the ZeroMouse cloud API (same backend as the official app)

Installation

Via HACS

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

Manually

  1. Download the latest release
  2. Copy the custom_components/zeromouse folder into your Home Assistant config/custom_components/
  3. Restart Home Assistant

Configuration

Open your Home Assistant instance and start setting up a new integration.

  1. Go to Settings -> Devices & Services -> Add Integration
  2. Search for ZeroMouse
  3. Enter your ZeroMouse app login credentials (email and password)
  4. The integration will attempt to discover your devices automatically
  5. Select your device from the list, or enter the Owner ID and Device ID manually

Options

After setup, configure via Settings -> Devices & Services -> ZeroMouse -> Configure:

Option Default Description
Poll interval 60 seconds How often to fetch new events from the cloud
Include exits On Include "Leaving detected" events in the Last Event sensor/image

Entities

Sensors

Entity Description
Last Event Classification of the most recent event (e.g. "No prey detected", "Prey detected")
Last Event Time Timestamp of the most recent event (uses actual event time from the cloud)
Last Prey Time Timestamp of the most recent prey detection event
Wi-Fi RSSI Device Wi-Fi signal strength
Device Event Count Lifetime event count
IR Sensor Status Raw proximity/IR sensor reading
Firmware Version Current firmware version
MQTT Error Count MQTT connection error count
PIR Trigger Count Motion sensor trigger count
AI Personalization Status AI training progress (0-100%)
Feedback Score User feedback score (0-100%)
Block Count Times the RFID mechanism blocked entry
Unblock Count Times a normal entry occurred
Boot Count Device reboot count

Binary Sensors

Entity Description
Connected Whether the device is currently connected
Prey Detected Whether prey was detected in the last event

Switches

Entity Description
Block Unknown Cats Deny entry to cats not in your known-cat clusters
Block Prey Deny entry to any cat detected carrying prey

Numbers

Entity Description
Prey Block Duration How long the flap stays blocked after prey detection (10-3600 seconds)

Selects

Entity Description
Inconclusive Handling Mode How to handle inconclusive events: Smart mode, Always allow, Always block

Images

Entity Description
Last Event GIF of the most recent detection event
Last Prey Detected GIF of the most recent prey event

Troubleshooting

Integration fails to authenticate

  • Verify you're using the same email and password as the ZeroMouse app
  • Check that your ZeroMouse account is active

Entities show as unavailable

  • Check the device is online in the ZeroMouse app
  • Review the Home Assistant logs for connection errors
  • Try increasing the poll interval in options

Contributing

Contributions are welcome! Please open an issue or pull request on GitHub.

About

Home Assistant integration for ZeroMouse Smart Cat Flap

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages