PetKit Home Assistant Integration

Custom Home Assistant component for controlling and monitoring PetKit devices and pets.

GitHub GitHub manifest.json dynamic (path) Total lines count

A lot of work has been put into creating the backend and this integration. If you enjoy this integration, consider donating by clicking on one of the supported methods above.

*All proceeds go towards helping a local animal rescue.

Discord Server

Join the Home Assistant PetKit discord server to follow development news or to share ideas with other users.

Currently Supported Devices

Feeders

Fresh Element Infinity
Fresh Element Solo
Fresh Element Mini Pro
Fresh Element Gemini
Fresh Element

[!CAUTION] YumShare feeders are NOT currently supported, but will be in the future. Once they are supported this message will be removed.

Litter Boxes

Purifiers

Air Magicube

Water Fountains

Bluetooth only devices that don't use PetKit's BLE relay such as trackers (i.e., PetKit Fit) will not be supported: syncing new data from a bluetooth tracker requires the PetKit mobile app to communicate with the tracker which is not possible when your PetKit account is already in use with this integration.

Prior To Installation

This integration requires using your PetKit account email (number for PetKit China accounts) and password. Third-party account sign-in methods (Facebook, Apple, Twitter) are not supported.

[!CAUTION] If using another PetKit integration that uses the petkit domain, you will need to delete it prior to installing this integration. You'll also need to remove any mention of it from your configuration.yaml file.

[!CAUTION] If you are running Home Assistant as a Docker container, the TZ environment variable must be set.

Important - Please Read:

PetKit Account & Family Sharing Feature:

[!IMPORTANT]

PetKit accounts can only be logged in on one device at a time. Using this integration will result in getting signed out of the mobile app. You can continue using the mobile app by creating a secondary account and sharing devices to it from the main account using the family share feature.

[!CAUTION]

You MUST use the primary (main) account with this integration and not the secondary account that had devices shared to it using the family share feature. Using the secondary account will result in no devices being pulled in by this integration.

If you have a water fountain:

[!NOTE] Note #1: Getting the most recent data from your water fountain, as well as controlling the water fountain, requires that the BLE relay is set up within the PetKit app. Otherwise, you will be limited to data that isn't up-to-date and no ability to control the water fountain as it requires another compatible PetKit device acting as a BLE relay.

[!NOTE] Note #2: If you have the BLE relay set up, please be sure to follow these direction prior to using the integration:

Sign out of the PetKit app and turn off bluetooth on your phone, tablet, etc.

With bluetooth turned off, force close the PetKit app (be sure to do this on any device that was using your account with the PetKit app).

Unplug all PetKit devices. Once all are off, you may plug them in again.

With all devices powered back on, you can turn bluetooth back on (on your mobile device or tablet).

Proceed with the installation and setup instructions for this integration.

Although these steps may seem tedious, they are a necessary evil. The PetKit app will ping the bluetooth endpoints and initiate the relay even with your account signed out. The only way of giving the integration control/the ability to initiate the relay is to sever any bluetooth connection that the app has started.

Using the PetKit app:

If you want to momentarily use the PetKit app with your primary account to change some settings, be sure to disable the PetKit integration before logging into the app. If you don't, you will be asked to reauthenticate. Once you are done making changes within the app, re-enable the integration.

If you needed the BLE relay while using the app (bluetooth turned on on your device), please be sure to follow the steps in Note #2 above in order to sever the BLE relay connection started by the PetKit app.

Installation

With HACS

[!Tip] If you are unable to use the button above, manually search for PetKit in HACS.

Manual

Copy the petkit directory, from custom_components in this repository, and place it inside your Home Assistant Core installation's custom_components directory. Restart Home Assistant prior to moving on to the Setup section.

[!WARNING] If installing manually, in order to be alerted about new releases, you will need to subscribe to releases from this repository.

Setup

[!Tip] If you are unable to use the button above, follow the steps below:

Navigate to the Home Assistant Integrations page (Settings --> Devices & Services)

Click the + ADD INTEGRATION button in the lower right-hand corner

Search for PetKit

[!Caution]

Be sure to select the country associated with your account (Hong Kong users should select Hong Kong, not China).

During setup, set the timezone option to Set Automatically. If the tzlocal library isn't able to fetch your timezone, please manually select your timezone.

The current polling interval is set to 2 minutes (120 seconds). If you would like to set a different polling interval, change the polling interval option (via the UI). Keep in mind, setting the polling interval too short may result in your account getting rate limited/blocked.

Devices

Each PetKit device and pet is represented as a device in Home Assistant. Within each device are several entities described below.

Feeders

Fresh Element Infinity (click to expand)

Each Feeder has the following entities:
| Entity | Entity Type | Additional Comments | |-----------------------------|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `Call pet` | `Button` | Only available if your feeder is online (connected to PetKit's servers). | | `Cancel manual feed` | `Button` | - Only available if your feeder is online (connected to PetKit's servers).
- Will cancel a manual feeding that is currently in progress. | | `Indicator light` | `Switch` | Only available if your feeder is online (connected to PetKit's servers). | | `Manual Feed` | `Number` | - Only available if your feeder is online (connected to PetKit's servers).
- Select the amount of food, in grams, you'd like to dispense immediately.
- Note: valid amount ranges from 5-200 grams in increments of 1 gram. | | `Desiccant days remaining` | `Sensor` | Number of days left before the desiccant needs to be replaced. | | `Food level` | `Binary Sensor` | Allows for determining if there is a food shortage. | | `Child lock` | `Switch` | Only available if your feeder is online (connected to PetKit's servers). | | `Do not disturb` | `Switch` | Only available if your feeder is online (connected to PetKit's servers). | | `Reset desiccant` | `Button` | - Allows you to reset the desiccant back to 30 days after replacing it.
- Only available if your feeder is online (connected to PetKit's servers). | | `Sound` | `Select` | - Allows you to select which sound is played when calling your pet.
- Default sound is selected if no self-recorded sounds are available or selected.
- Only available if your feeder is online (connected to PetKit's servers). | | `Surplus` | `Number` | - Allows for selecting weight in bowl that is considered to be surplus.
- If a surplus amount is selected and surplus control is enabled, planned feedings will stop when the weight of food detected in the bowl is equal to the surplus amount.
- Only available if your feeder is online (connected to PetKit's servers). | | `Surplus control` | `Switch` | - Enable or disable surplus control.
- Only available if your feeder is online (connected to PetKit's servers). | | `System notification sound` | `Switch` | - Enable or disable system notification sound.
- Only available if your feeder is online (connected to PetKit's servers). | | `Voice with dispense` | `Switch` | - Enable or disable sound (selected in Sound entity) to play with every feeding.
- Only available if your feeder is online (connected to PetKit's servers). | | `Volume` | `Number` | - Allows for controlling feeder sound volume.
- Only available if your feeder is online (connected to PetKit's servers). | | `Amount eaten` | `Sensor` | Amount of food your pet has eaten from the bowl today. | | `Battery` | `Binary Sensor` | Indicates if your battery is charging or not charging. | | `Battery status` | `Sensor` | - Will only become available when feeder is running on batteries.
- Indicates the battery level (Normal or Low). | | `Dispensed` | `Sensor` | Amount of food, in grams, dispensed today. | | `Error` | `Sensor` | Identifies any errors reported by the feeder. | | `Food in bowl` | `Sensor` | Amount of food, in grams, that is currently in the bowl. | | `Planned` | `Sensor` | Amount of food, in grams, that the feeder plans to dispense today. | | `Planned dispensed` | `Sensor` | Of the planned amount that is to be dispensed today, amount of food (grams) that has been dispensed. | | `RSSI` | `Sensor` | WiFi connection strength. | | `Status` | `Sensor` | `Normal` = Feeder is connected to PetKit's servers
`Offline` = Feeder is not connected to PetKit servers
`On Batteries` = Feeder is currently being powered by the batteries. | | `Times dispensed` | `Sensor` | Number of times food has been dispensed today. | | `Times eaten` | `Sensor` | Number of times pet ate today. |

Fresh Element Solo (click to expand)

Fresh Element Mini Pro (click to expand)

Fresh Element Gemini (click to expand)

Each Feeder has the following entities:
| Entity | Entity Type | Additional Comments | |-----------------------------|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `Cancel manual feed` | `Button` | - Only available if your feeder is online (connected to PetKit's servers).
- Will cancel a manual feeding that is currently in progress. | | `Indicator light` | `Switch` | Only available if your feeder is online (connected to PetKit's servers). | | `Manual feed` | `Text` | - Allows setting the amount of portions to dispense immediately from hopper 1 and 2.
- Only available if your feeder is online (connected to PetKit's servers).
- Valid text is in the form `number,number`. For example, setting a value of 1,2 will dispense one portion from hopper 1 and 2 portions from hopper 2. Allowed portion sizes for each hooper range from and include 0 to 10. | | `Desiccant days remaining` | `Sensor` | Number of days left before the desiccant needs to be replaced. | | `Food level hopper 1` | `Binary Sensor` | Allows for determining if there is a food shortage in hopper 1. | | `Food level hopper 2` | `Binary Sensor` | Allows for determining if there is a food shortage in hopper 2. | | `Child lock` | `Switch` | Only available if your feeder is online (connected to PetKit's servers). | | `Dispense tone` | `Switch` | Only available if your feeder is online (connected to PetKit's servers). | | `Food replenished` | `Button` | Tells the PetKit servers that you have replenished hopper 1 and 2 with food. If you don't do this after replenishing food, the food level for hoppers 1 and 2 won't update until a manual feeding is sent or until the next scheduled feeding. | | `Food shortage alarm` | `Switch` | Only available if your feeder is online (connected to PetKit's servers). | | `Minimum eating duration` | `Number` | Minimum amount of time, in seconds, pet has to eat food before it is recorded. | | `Reset desiccant` | `Button` | - Allows you to reset the desiccant back to 30 days after replacing it.
- Only available if your feeder is online (connected to PetKit's servers). | | `Average eating time` | `Sensor` | Average amount of time pet(s) have spent eating food. | | `Battery installed` | `Binary Sensor` | If batteries are removed or installed, power cycling the feeder is required for the status to update. | | `Battery status` | `Sensor` | - Will only become available when feeder is running on batteries.
- Indicates the battery level (Normal or Low). | | `Dispensed hopper 1` | `Sensor` | Amount of portions dispensed from hopper 1 today. | | `Dispensed hopper 2` | `Sensor` | Amount of portions dispensed from hopper 2 today. | | `Error` | `Sensor` | Identifies any errors reported by the feeder. | | `Manually dispensed hopper 1` | `Sensor` | Amount of portions manually dispensed from hopper 1 today. | | `Manually dispensed hopper 2` | `Sensor` | Amount of portions manually dispensed from hopper 2 today. | | `Planned dispensed hopper 1` | `Sensor` | Of the planned amount that is to be dispensed today, amount of portions that have been dispensed from hopper 1. | | `Planned dispensed hopper 2` | `Sensor` | Of the planned amount that is to be dispensed today, amount of portions that have been dispensed from hopper 2. | | `Planned hopper 1` | `Sensor` | Amount of portions that the feeder plans to dispense from hopper 1 today. | | `Planned hopper 2` | `Sensor` | Amount of portions that the feeder plans to dispense from hopper 2 today. | | `RSSI` | `Sensor` | WiFi connection strength. | | `Status` | `Sensor` | `Normal` = Feeder is connected to PetKit's servers
`Offline` = Feeder is not connected to PetKit servers
`On Batteries` = If installed, feeder is currently being powered by the batteries. | | `Times dispensed` | `Sensor` | Number of times food has been dispensed today. | | `Times eaten` | `Sensor` | Number of times pet(s) ate today. |

Fresh Element (click to expand)

Each Feeder has the following entities:
| Entity | Entity Type | Additional Comments | |----------------------------|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `Cancel manual feed` | `Button` | - Only available if your feeder is online (connected to PetKit's servers).
- Will cancel a manual feeding that is currently in progress. | | `Indicator light` | `Switch` | Only available if your feeder is online (connected to PetKit's servers). | | `Manual feed` | `Number` | - Allows setting the amount of food (grams) to dispense immediately.
- Only available if your feeder is online (connected to PetKit's servers). | | `Desiccant days remaining` | `Sensor` | Number of days left before the desiccant needs to be replaced. | | `Food level` | `Binary Sensor` | Allows for determining if there is a food shortage. | | `Child lock` | `Switch` | Only available if your feeder is online (connected to PetKit's servers). | | `Reset desiccant` | `Button` | - Allows you to reset the desiccant back to 30 days after replacing it.
- Only available if your feeder is online (connected to PetKit's servers). | | `Start calibration` | `Button` | See note at the bottom of the table for description provided by PetKit. | | `Stop calibration` | `Button` | | | `Battery status` | `Sensor` | - Will only become available when feeder is running on batteries.
- Indicates the battery level (Normal or Low). | | `Error` | `Sensor` | Identifies any errors reported by the feeder. | | `Food Left` | `Sensor` | Identifies the amount of food, as a percentage, left in the feeder. | | `RSSI` | `Sensor` | WiFi connection strength. | | `Status` | `Sensor` | `Normal` = Feeder is connected to PetKit's servers
`Offline` = Feeder is not connected to PetKit servers
`On Batteries` = If installed, feeder is currently being powered by the batteries. | > Feeder Calibration: Calibration is required after every installation and removal of batteries from the feeder. Prior to calibration, be sure to clean out all of the food from the feeder as the calibration process will empty any food that is left in the feeder.

Water Fountains

Eversweet 3 Pro/5 Mini/Solo 2 (click to expand)

Each water fountain has the following entities:
| Entity | Entity Type | Additional Comments | |------------------------|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `Do not disturb` | `Switch` | -`Only available if BLE relay is set up and main BLE relay device is online.`
- Allows for enabling or disabling do not disturb - Use PetKit app to set do not disturb schedule if you plan on using this entity. | | `Light` | `Switch` | `Only available if BLE relay is set up and main BLE relay device is online.` | | `Power` | `Switch` | -`Only available if BLE relay is set up and main BLE relay device is online.`
- Turning power off is equivalent to "Pause" in the PetKit app.
- Turning power on resumes the water fountain in the mode (Normal/Smart) it was in prior to being powered off. | | `Filter` | `Sensor` | Indicates % filter life left. | | `Water level` | `Binary Sensor` | Indicates if water needs to be added to the water fountain. | | `Light brightness` | `Select` | -`Only available if BLE relay is set up and main BLE relay device is online.`
- Only available when light is turned on | | `Mode` | `Select` | -`Only available if BLE relay is set up and main BLE relay device is online.`
- Allows setting mode to Normal or Smart.
- For "Smart mode", use the PetKit app to set the water on and off minutes. | | `Reset filter` | `Button` | `Only available if BLE relay is set up and main BLE relay device is online.` | | `Energy usage` | `Sensor` | | | `Last data update` | `Sensor` | - Date/Time that the water fountain last reported updated data to PetKit servers.
- This can be used to track and identify if the BLE relay is working correctly as this will change whenever the main BLE relay device polls the water fountain.
- If you have the BLE relay set up, this sensor is only concerning if it shows data was updated hours ago. | | `Purified water today` | `Sensor` | Number of times water has been purified. | **Note About Water Fountain Control** > If you have the BLE relay set up in the PetKit app and the main BLE relay device is online, sometimes the bluetooth connection will fail when attempting to send a command (e.g., changing mode, light brightness, etc) . If this happens, it will be noted in the Home Assistant logs. Retrying the command usually results in a subsequent successful connection.

Litter Boxes

Pura X (click to expand)

Each litter box has the following entities:
| Entity | Entity Type | Additional Comments | |------------------------|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `Odor removal` | `Button` | - Activates immediate odor removal
- Only available if litter box is online (Connected to PetKit's servers). | | `Pause Cleaning` | `Button` | Only available if litter box is online (Connected to PetKit's servers). | | `Power` | `Button` | - Turn litter box on/off
- Only available if litter box is online (Connected to PetKit's servers). | | `Start/Resume cleaning` | `Button` | - Start a manual cleaning or resume a cleaning if litter box is currently paused.
- Only available if litter box is online (Connected to PetKit's servers). | | `Average Use` | `Sensor` | Average use duration of the litter box today. | | `Deodorizer` | `Binary Sensor` | Allows for determining if deodorizer needs to be refilled. | | `Last used by` | `Sensor` | Indicates which cat used the litter box last. | | `Litter` | `Binary Sensor` | Allows for determining if the litter needs to be refilled. | | `Times used` | `Sensor` | Number of times litter box was used today. | | `Total use` | `Sensor` | Total number of seconds litter box was used today. | | `Waste bin` | `Binary Sensor` | Allows for determining if the waste bin is full. | | `Auto cleaning` | `Switch` | - Only available if litter box is online (Connected to PetKit's servers).
- Not available if Kitten Mode is turned on. | | `Auto odor removal` | `Switch` | Only available if litter box is online (Connected to PetKit's servers). | | `Avoid repeat cleaning` | `Switch` | - Only available if litter box is online (Connected to PetKit's servers).
- Not available if Auto Cleaning is disabled.
- Not available if Kitten Mode is turned on. | | `Child lock`| `Switch` | Only available if litter box is online (Connected to PetKit's servers). | | `Cleaning delay` | `Number` | - Only available if litter box is online (Connected to PetKit's servers).
- Not available if Auto Cleaning is disabled.
- Not available if Kitten Mode is turned on. | | `Cleaning interval` | `Select` | - Only available if litter box is online (Connected to PetKit's servers).
- Not available if Auto Cleaning is disabled.
- Not available if Avoid repeat cleaning is disabled.
- Not available if Kitten Mode is turned on. | | `Display` | `Switch` | - Turn display on litter box on or off.
- Only available if litter box is online (Connected to PetKit's servers). | | `Do not disturb` | `Switch` | Only available if litter box is online (Connected to PetKit's servers). | | `Kitten mode` | `Switch` | Only available if litter box is online (Connected to PetKit's servers). | | `Light weight cleaning disabled` | `Switch` | - Only available if litter box is online (Connected to PetKit's servers).
- Not available if Auto Cleaning is disabled.
- Not available if Avoid repeat cleaning is disabled.
- Not available if Kitten Mode is turned on. | | `Litter type` | `Select` | Type of litter that is being used in the litter box. | | `Periodic cleaning` | `Switch` | - Only available if litter box is online (Connected to PetKit's servers).
- Not available if Kitten Mode is turned on. | | `Periodic odor removal` | `Switch` | Only available if litter box is online (Connected to PetKit's servers). | | `Deodorizer level` | `Sensor` | Percent of deodorizer remaining. | | `Error` | `Sensor` | Any errors being reported by the litter box. | | `Last event` | `Sensor` | - Last event that occured in the litter box.
- sub_events attribute is used to list any events that are associated with the main event.
- This sensor is used to mimic the timeline that is seen in the PetKit app.
- Please see "Last event states" section below | | `Litter level` | `Sensor` | Percent of litter that is left in the litter box. | | `Litter weight` | `Sensor` | - Weight of litter currently in litter box.
- By default this is in Kg. The unit can be changed in the settings of this entity. | | `Manually paused` | `Binary Sensor` | Indicates if the litter box has been manually paused or not. Please see note below table for additional information. | | `RSSI` | `Sensor` | WiFi connection strength. | > When manually pausing the litter box, the manually paused sensor entity will show a state of On. If cleaning isn't resumed, the litter box will (by default) resume cleaning after 10 minutes - the manually paused entity will return to a state of Off. If you manually pause a cleaning and restart Home Assistant while the litter box is paused, this sensor will have an incorrect state of Off. This is a limitation on PetKit's end as the state of the litter box is not reported by their servers. This behavior is evident when a cleaning is paused from the PetKit app, the app is force closed, and opened again. The goal of this entity is to be able to manually keep track of the state of the litter box since PetKit doesn't do that.

Last event states (click to expand)

Pura MAX (click to expand)

Each litter box has the following entities:
| Entity | Entity Type | Additional Comments | |------------------------|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `Dump litter` | `Button` |
- Only available if litter box is online (Connected to PetKit's servers). | | `Exit maintenance mode` | `Button` |
- Only available if litter box is online (Connected to PetKit's servers). | | `Odor removal` | `Button` | - Activates immediate odor removal
- Only available if litter box is online (Connected to PetKit's servers). | | `Pause cleaning` | `Button` | Only available if litter box is online (Connected to PetKit's servers). | | `Pause exiting maintenance mode` | `Button` | Only available if litter box is online (Connected to PetKit's servers). | | `Pause litter dumping` | `Button` | Only available if litter box is online (Connected to PetKit's servers). | | `Power` | `Button` | - Turn litter box on/off
- Only available if litter box is online (Connected to PetKit's servers). | | `Reset N50 odor eliminator` | `Button` | | | `Reset Pura Air liquid` | `Button` | Only available if litter box has a Pura Air associated with it | | `Resume exiting maintenance mode` | `Button` | Only available if litter box is online (Connected to PetKit's servers). | | `Resume litter dumping` | `Button` | Only available if litter box is online (Connected to PetKit's servers). | | `Start maintenance mode` | `Button` | Only available if litter box is online (Connected to PetKit's servers). | | `Start/Resume cleaning` | `Button` | - Start a manual cleaning or resume a cleaning if litter box is currently paused.
- Only available if litter box is online (Connected to PetKit's servers). | | `Turn light ON` | `Button` | Only available if litter box has a Pura Air associated with it. | | `Average Use` | `Sensor` | Average use duration of the litter box today. | | `Last used by` | `Sensor` | Indicates which cat used the litter box last. | | `Litter` | `Binary Sensor` | Allows for determining if the litter needs to be refilled. | | `Pura Air liquid` | `Binary Sensor` | - Allows for determining if the Pura Air liquid needs to be refilled.
- Only available if litter box has a Pura Air associated with it | | `Times used` | `Sensor` | Number of times litter box was used today. | | `Total use` | `Sensor` | Total number of seconds litter box was used today. | | `Waste bin` | `Binary Sensor` | Allows for determining if the waste bin is full. | | `Auto cleaning` | `Switch` | - Only available if litter box is online (Connected to PetKit's servers).
- Not available if Kitten Mode is turned on. | | `Auto odor removal` | `Switch` | Only available if litter box is online (Connected to PetKit's servers). | | `Avoid repeat cleaning` | `Switch` | - Only available if litter box is online (Connected to PetKit's servers).
- Not available if Auto Cleaning is disabled.
- Not available if Kitten Mode is turned on. | | `Child lock`| `Switch` | Only available if litter box is online (Connected to PetKit's servers). | | `Cleaning delay` | `Number` | - Only available if litter box is online (Connected to PetKit's servers).
- Not available if Auto Cleaning is disabled.
- Not available if Kitten Mode is turned on. | | `Cleaning interval` | `Select` | - Only available if litter box is online (Connected to PetKit's servers).
- Not available if Auto Cleaning is disabled.
- Not available if Avoid repeat cleaning is disabled.
- Not available if Kitten Mode is turned on. | | `Continuous rotation` | `Switch` | - Only available if litter box is online (Connected to PetKit's servers). | | `Deep cleaning` | `Switch` | - Only available if litter box is online (Connected to PetKit's servers).
- Not available if Auto Cleaning is disabled.
- Not available if Avoid repeat cleaning is disabled.
- Not available if Kitten Mode is turned on. | | `Deep deodorization` | `Switch` | - Only available if litter box is online (Connected to PetKit's servers) and has a Pura Air associated with it.
- Not available if Auto Cleaning is disabled.
- Not available if Avoid repeat cleaning is disabled.
- Not available if Kitten Mode is turned on. | | `Display` | `Switch` | - Turn display on litter box on or off.
- Only available if litter box is online (Connected to PetKit's servers). | | `Do not disturb` | `Switch` | Only available if litter box is online (Connected to PetKit's servers). | | `Kitten mode` | `Switch` | Only available if litter box is online (Connected to PetKit's servers). | | `Light weight cleaning disabled` | `Switch` | - Only available if litter box is online (Connected to PetKit's servers).
- Not available if Auto Cleaning is disabled.
- Not available if Avoid repeat cleaning is disabled.
- Not available if Kitten Mode is turned on. | | `Litter type` | `Select` | Type of litter that is being used in the litter box. | | `Periodic cleaning` | `Switch` | - Only available if litter box is online (Connected to PetKit's servers).
- Not available if Kitten Mode is turned on. | | `Periodic odor removal` | `Switch` | Only available if litter box is online (Connected to PetKit's servers). | | `Error` | `Sensor` | Any errors being reported by the litter box. | | `Last event` | `Sensor` | - Last event that occured in the litter box.
- sub_events attribute is used to list any events that are associated with the main event.
- This sensor is used to mimic the timeline that is seen in the PetKit app.
- Please see "Last event states" section below | | `Litter level` | `Sensor` | Percent of litter that is left in the litter box. | | `Litter weight` | `Sensor` | - Weight of litter currently in litter box.
- By default this is in Kg. The unit can be changed in the settings of this entity. | | `N50 odor eliminator` | `Sensor` | - Amount of days left before N50 filter needs to be replaced. | | `Pura Air battery` | `Sensor` | - Only available if litter box has a Pura Air associated with it | | `Pura Air liquid` | `Sensor` | - Only available if litter box has a Pura Air associated with it.
- Amount of liquid left in the Pura Air | | `RSSI` | `Sensor` | WiFi connection strength. | | `State` | `Sensor` | - Current work state of the litter box.
- Please see "State entity states" section below. |

Last event states (click to expand)

The following are all possible event/sub event states and their full descriptions:
| Event/Sub event state | Full Description | |------------------------------------- |------------------------------------------------------------------------------------------------------| | no_events_yet | No events yet | | event_type_unknown | Event type unknown | | cleaning_completed | Cleaning completed | | dumping_over | Dumping Over | | reset_over | Reset over | | spray_over | Spray over | | light_over | Light over | | pet_out | Pet out | | auto_cleaning_completed | Auto cleaning completed | | periodic_cleaning_completed | Periodic cleaning completed | | manual_cleaning_completed | Manual cleaning completed | | auto_cleaning_terminated | Automatic cleaning terminated | | periodic_cleaning_terminated | Periodic cleaning terminated | | manual_cleaning_terminated | Manual cleaning terminated | | auto_cleaning_failed_full | Automatic cleaning failed, waste collection bin is full, please empty promptly | | auto_cleaning_failed_hall_t | Automatic cleaning failure, the litter box's upper cupper cover is not placed properly, please check | | auto_cleaning_failed_falldown | Automatic cleaning failure, the litter box has been knocked down, please check. | | auto_cleaning_failed_other | Automatic cleaning failure, device malfunction, please check. | | scheduled_cleaning_failed_full | Scheduled cleaning failed, waste collection bin is full, please empty promptly | | scheduled_cleaning_failed_hall_t | Scheduled cleaning failure, the litter box's upper cupper cover is not placed properly, please check | | scheduled_cleaning_failed_falldown | Scheduled cleaning failure, the litter box has been knocked down, please check. | | scheduled_cleaning_failed_other | Scheduled cleaning failure, device malfunction, please check. | | manual_cleaning_failed_full | Manual cleaning failed, waste collection bin is full, please empty promptly | | manual_cleaning_failed_hall_t | Manual cleaning failure, the litter box's upper cupper cover is not placed properly, please check | | manual_cleaning_failed_falldown | Manual cleaning failure, the litter box has been knocked down, please check. | | manual_cleaning_failed_other | Manual cleaning failure, device malfunction, please check. | | auto_cleaning_canceled | Automatic cleaning canceled, device in operation | | periodic_cleaning_canceled | Periodic cleaning canceled, device in operation | | manual_cleaning_canceled | Manual cleaning canceled, device in operation | | auto_cleaning_failed_maintenance | Automatic cleaning failed, the device is in maintenance mode | | periodic_cleaning_failed_maintenance | Periodically cleaning failed, the device is in maintenance mode | | auto_cleaning_canceled_kitten | Kitten mode is enabled, auto cleaning is canceled | | periodic_cleaning_canceled_kitten | Kitten mode is enabled, periodically cleaning is canceled | | litter_empty_completed | Cat litter empty completed | | litter_empty_terminated | Cat litter empty terminated | | litter_empty_failed_full | Cat litter empty failed, waste collection bin is full, please empty promptly | | litter_empty_failed_hall_t | Cat litter empty failure, the litter box's cupper cover is not placed properly, please check | | litter_empty_failed_falldown | Cat litter empty failure, the litter box has been knocked down, please check | | litter_empty_failed_other | Cat litter empty failure, device malfunction, please check. | | reset_completed | Device reset completed | | reset_terminated | Device reset terminated | | reset_failed_full | Device reset failed, waste collection bin is full, please empty promptly | | reset_failed_hall_t | Device reset failure, the litter box's cupper cover is not placed properly, please check | | reset_failed_falldown | Device reset failure, the litter box has been knocked down, please check. | | reset_failed_other | Device reset failure, device malfunction, please check. | | maintenance_mode | Maintenance mode | | deodorant_finished | Deodorant finished | | periodic_odor_completed | Periodic odor removal completed | | manual_odor_completed | Manual odor removal completed | | auto_odor_terminated | Automatic odor removal has been terminated. | | periodic_odor_terminated | Periodic odor removal terminated. | | manual_odor_terminated | Manual odor removal terminated. | | auto_odor_failed | Automatic odor removal failed, odor eliminator error | | periodic_odor_failed | Periodic odor removal failure, odor eliminator malfunction | | manual_odor_failed | Manual odor removal failure, odor eliminator malfunction | | auto_odor_canceled | Automatic odor removal has been canceled, the device is running. | | periodic_odor_canceled | Periodic odor removal canceled. Litter Box is working. | | manual_odor_canceled | Manual odor removal canceled. Litter Box is working. | | auto_odor_failed_device | Automatic odor removal failed, no smart spray is connected. | | periodic_odor_failed_device | Periodic odor removal failed. Odor Removal Device disconnected. | | manual_odor_failed_device | Manual odor removal failed. Odor Removal Device disconnected. | | auto_odor_failed_batt | Automatic odor removal failed, please confirm that the battery of smart spray is sufficient. | | periodic_odor_failed_batt | Periodic odor removal failed. Please make sure the Odor Removal Device has sufficient battery. | | manual_odor_failed_batt | Manual odor removal failed. Please make sure the Odor Removal Device has sufficient battery. | | auto_odor_failed_low_batt | Automatic odor removal failed, battery is low. | | periodic_odor_failed_low_batt | Periodic odor removal failed. Odor Removal Device battery low. | | manual_odor_failed_low_batt | Manual odor removal failed. Odor Removal Device battery low. | | cat_stopped_odor | Your cat is using the litter box, deodorization has been canceled | | light_on | The light is ON | | light_already_on | The light is on. There is no need to turn on again. | | light_malfunc | Failing to turn on the light. Device malfunction, please check. | | light_no_device | Failing to turn on the light. Please bind the odor removal device first. | | light_batt_cap | Failing to turn on the light. Please check the battery capacity of the odor removal device. | | light_low_batt | Failing to turn on the light. Low battery capacity of odor removal device. | | no_sub_events | No associated sub events |

State entity states (click to expand)

The following are all possible State entity states and their full descriptions:
| State | Full Description | |------------------------------------- |------------------------------------------------------------------------------------------------------------------------------------------------------| | cleaning_litter_box | Cleaning litter box | | cleaning_litter_box_paused | Litter box cleaning paused | | cleaning_paused_pet_entered | Litter box cleaning paused: Pet entered while in operation, anti-pinch sensors activated, device stopped working. Please check the device ASAP. | | cleaning_paused_system_error | Litter box cleaning paused: System error, operation paused | | cleaning_paused_pet_approach | Litter box cleaning paused: Your cat is approaching, operation paused | | cleaning_paused_pet_using | Litter box cleaning paused: Your cat is using the device, operation paused | | resetting_device | Resetting device | | litter_box_paused | Litter box paused | | paused_pet_entered | Litter box paused: Pet entered while in operation, anti-pinch sensors activated, device stopped working. Please check the device ASAP. | | paused_system_error | Litter box paused: System error, operation paused | | paused_pet_approach | Litter box paused: Your cat is approaching, operation paused | | paused_pet_using | Litter box paused: Your cat is using the device, operation paused | | dumping_litter | Dumping cat litter | | dumping_litter_paused | Dumping cat litter paused | | dumping_paused_pet_entered | Dumping cat litter paused: Pet entered while in operation, anti-pinch sensors activated, device stopped working. Please check the device ASAP. | | dumping_paused_system_error | Dumping cat litter paused: System error, operation paused | | dumping_paused_pet_approach | Dumping cat litter paused: Your cat is approaching, operation paused | | dumping_paused_pet_using | Dumping cat litter paused: Your cat is using the device, operation paused | | resetting | Resetting | | leveling | Leveling cat litter, please wait. | | calibrating | Calibrating litter box, please wait. | | maintenance_mode | In maintenance mode | | maintenance_paused_pet_entered | Maintenance mode paused: Pet entered while in operation, anti-pinch sensors activated, device stopped working. Please check the device ASAP. | | maintenance_paused_cover | Maintenance mode paused: The top cover is not installed, operation paused | | maintenance_paused_system_error | Maintenance mode paused: System error, operation paused | | maintenance_paused_pet_approach | Maintenance mode paused: Your cat is approaching, operation paused | | maintenance_paused_pet_using | Maintenance mode paused: Your cat is using the device, operation paused | | maintenance_paused | Maintenance mode paused | | exit_maintenance | Exiting maintenance mode | | maintenance_exit_paused_pet_entered | Maintenance mode exiting paused: Pet entered while in operation, anti-pinch sensors activated, device stopped working. Please check the device ASAP. | | maintenance_exit_paused_cover | Maintenance mode exiting paused: The top cover is not installed, operation paused | | maintenance_exit_paused_system_error | Maintenance mode exiting paused: System error, operation paused | | maintenance_exit_paused_pet_approach | Maintenance mode exiting paused: Your cat is approaching, operation paused | | maintenance_exit_paused_pet_using | Maintenance mode exiting paused: Your cat is using the device, operation paused | | maintenance_exit_paused | Maintenance mode exiting paused | | idle | Idle |

Purifiers

Air Magicube (click to expand)

Each purifier has the following entities:
| Entity | Entity Type | Additional Comments | |-------------------|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `Indicator light` | `Switch` | Only available if your purifier is online (connected to PetKit's servers) | | `Prompt tone` | `Switch` | Only available if your purifier is online (connected to PetKit's servers). | | `Purifier` | `Fan` | - Only available if purifier is online (Connected to PetKit's servers).
- Can turn the purifier `On` and `Off` and view/change the current mode to one of the following: `auto`, `silent`, `standard`, `strong`. | | `Air purified` | `Sensor` | | | `Humidity` | `Sensor` | | | `Temperature` | `Sensor` | | | `Error` | `Sensor` | Displays any error messages. `Note:` Even though it isn't really an error, An error message is displayed by PetKit if the purifier is in standby mode. | | `Liquid` | `Sensor` | Percent of purifying liquid that remains in the purifier. | | `RSSI` | `Sensor` | WiFi connection strength. |

Pets

Dog (click to expand)

| Entity | Entity Type | Additional Comments | |------------------------|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `Set weight` | `Number` | Set the weight of the dog. |

Cat (click to expand)

| Entity | Entity Type | Additional Comments | |------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `Set weight` | `Number` | Set the weight of the cat. | | `Last use duration` | `Sensor` | - Amount of time spent in the litter box during last use.
- Only available if PetKit account has litter box(es).
- If multiple litter boxes, this will display data obtained from the most recent litter box used.
- Will read 0 after first time setup if pet hasn't used litter box that day. | | `Latest weight` | `Sensor` | - Most recent weight measurement obtained during last litter box use.
- Only available if PetKit account has litter box(es).
- If multiple litter boxes, this will display data obtained from the most recent litter box used.
- By default the unit used is Kg. Unit can be changed in the settings of the entity.
- Will read 0 after first time setup if pet hasn't used litter box that day. |

Help With Translations

A simple way of contributing to this integration is by helping translate the entity names and states to other languages.

If you speak another language, and would like to help:

Inside of custom_components/petkit/translations, you will find two files: en.json and hr.json.
Create a new file and title it based on the 639-1 language code you are creating a translation for in the format <language_code>.json.
Copy the contents from the en.json file to your newly created file.
If you are unsure what needs to be translated from english to the target language, compare the en.json file to the hr.json to see what was translated.
Create a PR with your new language file placed in the translations directory.

RobertD502 / home-assistant-petkit

readme