Skip to content

Latest commit

 

History

History
106 lines (75 loc) · 7.01 KB

README.md

File metadata and controls

106 lines (75 loc) · 7.01 KB
Raw

Purrsong hacs_badge GitHub manifest version (path)

Buy Me A Coffee Donate using Liberapay

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.

Custom component for Home Assistant for monitoring LavvieBot S litter boxes, LavvieScanners, LavvieTags, and associated cats

Prior To Installation

Caution

You will need to create a new account in the PurrSong app and then share an invite from your primary account to the newly created account. If you use your primary account with this custom component, the primary account will get logged out of the app on your mobile device. This can be avoided by creating a dedicated account as previously mentioned.

Installation

With HACS (Recommended)

  1. Open HACS Settings and add this repository (https://github.com/RobertD502/home-assistant-lavviebot) as a Custom Repository (use Integration as the category).
  2. The Purrsong page should automatically load (or find it in the HACS Store)
  3. Click Install

Manual

From this repo, copy the purrsong directory from custom_components and place it inside of your Home Assistant Core installation's custom_components directory.

Warning

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

Setup

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

Tip

If you are unable to use the button above, follow the steps below:

  1. Navigate to the Home Assistant Integrations page (Settings --> Devices & Services)
  2. Click the + ADD INTEGRATION button in the lower right-hand corner
  3. Search for PurrSong

Features

Litter boxes, scanners, tags, and cats are exposed as devices along with their associated entities. See below for entities available.

Litter Box

Entity Entity type Description
Beacon battery sensor Battery level for LavvieBeacon Antenna Module. State is 0 if there is no LavvieBeacon associated with the litter box.
Error time sensor When the error, displayed in the Latest error sensor, occurred.
Humidity sensor Humidity as reported by the litter box.
Last cat used sensor Name of the last cat that used the litter box. Value will be "Unknown" if cat named "Unknown" used the litter box last.
Last seen sensor Displays date and time of the last time litter box communicated with PurrSong servers.
Last used sensor Displays date and time of the last time litter box was used by a cat.
Last used duration sensor Use duration of the cat that used the litter box last. Reported in seconds.
Latest error sensor Descriptive status of the last error in the litter box error logs. Possible states include:
  • Auto-cleaning stopped. Please check if anything is blocking inside the litter tray.
  • Main motor overload occurred
  • Main motor or adapter error
  • Litter auto-refill stopped
  • Unknown error code
Litter bottom amount sensor Weight of litter currently in the litter tray.
Litter type sensor Type of litter being used. Can be Bentonite or Natural.
Minimum bottom weight sensor Minimum weight that litter tray is set to have in it.
Storage refill needed binary_sensor On if fresh litter storage compartment is empty. Otherwise Off. Can be used to set up alerts.
Storage status sensor Descriptive status of the litter level in the fresh litter storage compartment. Possible states include:
  • Refill Needed
  • Almost Empty
  • Full
Temperature sensor Temperature as reported by the litter box.
Use count sensor Displays the total amount of times Lavviebot litter box was used today.
Wait time sensor Minutes litter box is set to wait, after it has been used, before scooping.
Waste drawer full binary_sensor On if the waste drawer is full. Otherwise Off. Can be used to set up alerts.
Waste status sensor Descriptive status of the waste level in the waste drawer. Possible states include:
  • Full
  • Almost Full
  • Empty or Piled
Firmware update update If Lavviebot has a firmware update available, the version of the new firmware will be shown. If Lavviebot firmware is up-to-date, "Up-to-date" will be shown. Use the PurrSong app to update firmware.

LavvieScanner

Entity Entity type Description
WiFi status binary_sensor Shows connection status between the LavvieScanner and your WiFi network.
Firmware update update If a firmware update is available, the version of the new firmware will be shown. If firmware is up-to-date, "Up-to-date" will be shown. Use the PurrSong app to update firmware.
Last seen sensor Displays date and time of the last time LavvieScanner communicated with PurrSong servers.

LavvieTag

Entity Entity type Description
Battery sensor Current battery percentage.
Firmware update update If a firmware update is available, the version of the new firmware will be shown. If firmware is up-to-date, "Up-to-date" will be shown. Use the PurrSong app to update firmware.
Last seen sensor Displays date and time of the last time LavvieTag communicated with PurrSong servers via LavvieScanner or LavvieBeacon.

Cat

Entity Entity type Description
Litter box use count sensor Total number of times cat has used the litter box today.
Litter box use duration sensor Total length of time cat has used the litter box today (in seconds).
Weight sensor Most recent cat weight obtained for the current day.
Resting sensor Only available if cat is using a LavvieTag
Running sensor Only available if cat is using a LavvieTag
Sleeping sensor Only available if cat is using a LavvieTag
Walking sensor Only available if cat is using a LavvieTag
Zoomies sensor Only available if cat is using a LavvieTag