Whisker

    The Whisker integration allows you to monitor and control your Wi-Fi-enabled, automatic, self-cleaning litter box and pet feeders. If you have pet profiles set up, you can also track your pet's weight.

    Prerequisites

    Before using this integration, you’ll need a Whisker account and a Wi-Fi-enabled Litter-Robot or Feeder-Robot linked to it. You can do this via the Whisker app.

    配置

    此集成可通过 UI 配置。前往 设置 > 设备与服务 添加。

    Username:
    description: "The email address of your Whisker account."
Password:
    description: "The password of your Whisker account."

    Entities

    Litter-Robot

    EntityDomainDescription
    Litter boxvacuumMain entity that represents a Litter-Robot unit.
    Night light modeswitchWhen turned on, automatically turns on the night light in darker settings, only for Litter-Robot 3.
    Panel lockoutswitchWhen turned on, disables the buttons on the unit to prevent changes to settings.
    Last seensensorDisplays the time the unit was last seen / reported an update.
    Litter levelsensorDisplays the litter level, only for Litter-Robot 4.
    Pet weightsensorDisplays the last measured pet weight, only for Litter-Robot 4.
    Sleep mode start timesensorWhen sleep mode is enabled, displays the current or next sleep mode start time.
    Sleep mode end timesensorWhen sleep mode is enabled, displays the current or last sleep mode end time.
    Status codesensorDisplays the status code (Clean Cycle in Progress, Ready, Drawer Full, etc.).
    Total cyclessensorDisplays the total cycles.
    Waste drawersensorDisplays the current waste drawer level.
    Power statusbinary_sensorIndicates whether power is currently connected.
    Sleep modebinary_sensorIndicates whether sleep mode is enabled.
    Sleepingbinary_sensorIndicates whether sleep mode is currently active.
    Clean cycle wait time minutesselectView and select the clean cycle wait time.
    Globe brightnessselectView and select the brightness level for the globe light, only for Litter-Robot 4.
    Globe lightselectView and select the globe light setting, only for Litter-Robot 4.
    Panel brightnessselectView and select the panel brightness, only for Litter-Robot 4.
    ResetbuttonButton to reset the robot, clearing any errors and potentially triggering a cycle, only for Litter-Robot 4.
    Reset waste drawerbuttonButton to reset the waste drawer level to 0%, only for Litter-Robot 3.
    FirmwareupdateView and update to the latest firmware, only for Litter-Robot 4.

    Feeder-Robot

    EntityDomainDescription
    Give snackbuttonButton to dispense a single snack portion.
    Meal insert sizeselectView and select the meal insert size.
    Food dispensed todaysensorDisplays the amount of food, in cups, by the feeder.
    Food levelsensorDisplays the approximate food level remaining in the hopper.
    Last feedingsensorDisplays the timestamp of the last dispensed meal or snack.
    Next feedingsensorDisplays the timestamp of the next scheduled meal.
    Gravity modeswitchWhen turned on, the unit will keep the bowl full by checking the food level every 6 hours.
    Night light modeswitchWhen turned on, automatically turns on the night light in darker settings.
    Panel lockoutswitchWhen turned on, disables the buttons on the unit to prevent changes to settings.

    Pet

    EntityDomainDescription
    Visits todaysensorPet's daily visits to the Litter-Robot.
    WeightsensorPet's weight.

    Actions

    Actions are utilized for additional functionality that is available in the Whisker (previously Litter-Robot) companion app. The following are currently available:

    set_sleep_mode

    Enables (with start_time parameter) or disables sleep mode on the Litter-Robot. Currently, this is limited to only the Litter-Robot 3. To make changes to the sleep schedule on your Litter-Robot 4, please continue to use the Whisker app.

    ParameterTypeRequiredDescription
    enabledboolyesSet to true to enable and false to disable.
    start_timestringnoTime at which the unit will enter sleep mode and prevent an automatic clean cycle for 8 hours. This param uses the 24-hour format string %H:%M:%S, with seconds being optional, and is based on the timezone configured for your Home Assistant installation. As such, 10:30:00 would indicate 10:30 AM, whereas 22:30:00 would indicate 10:30 PM.

    Example of setting the sleep mode to begin at 10:30 PM.

    action: litterrobot.set_sleep_mode
target:
  entity_id: vacuum.litter_robot_litter_box
data:
  enabled: true
  start_time: "22:30:00"

    Removing the integration

    This integration follows standard integration removal. No extra steps are required.

    To remove an integration instance from Home Assistant

    1. Go to Settings > Devices & services and select the integration card.
    2. From the list of devices, select the integration instance you want to remove.
    3. Next to the entry, select the three-dot menu. Then, select Delete.