{"id":24915527,"url":"https://github.com/hasscc/catlink","last_synced_at":"2026-02-06T23:06:55.147Z","repository":{"id":103682500,"uuid":"434205623","full_name":"hasscc/catlink","owner":"hasscc","description":"🐈️  Catlink scooper component for HomeAssistant","archived":false,"fork":false,"pushed_at":"2024-09-04T19:02:29.000Z","size":108,"stargazers_count":38,"open_issues_count":2,"forks_count":15,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-09T14:09:15.446Z","etag":null,"topics":["catlink","custom-component","home-assistant"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hasscc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-12-02T12:07:18.000Z","updated_at":"2025-01-28T14:53:55.000Z","dependencies_parsed_at":"2024-08-16T11:23:58.972Z","dependency_job_id":"3db1d427-06ca-4875-b836-a0e8c11825c3","html_url":"https://github.com/hasscc/catlink","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/hasscc/catlink","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hasscc%2Fcatlink","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hasscc%2Fcatlink/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hasscc%2Fcatlink/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hasscc%2Fcatlink/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hasscc","download_url":"https://codeload.github.com/hasscc/catlink/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hasscc%2Fcatlink/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264092044,"owners_count":23556223,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["catlink","custom-component","home-assistant"],"created_at":"2025-02-02T07:18:00.397Z","updated_at":"2026-02-06T23:06:55.141Z","avatar_url":"https://github.com/hasscc.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003ch2\u003eCATLINK v2 Integration for Home Assistant\u003c/h2\u003e\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"https://play-lh.googleusercontent.com/eHPhN_fUDhdxMK4JAvlzjB5Mh-H72crLn2U3Khk37lzolNg2CTDgZXkB5bjPiM3CDqM\" alt=\"CatLINK Logo\" width=\"100\"\u003e\n  \u003cspan style=\"font-size: 50px; margin: 0 20px;\"\u003e+\u003c/span\u003e\n  \u003cimg src=\"https://upload.wikimedia.org/wikipedia/en/thumb/4/49/Home_Assistant_logo_%282023%29.svg/2048px-Home_Assistant_logo_%282023%29.svg.png\" alt=\"Home Assistant Logo\" width=\"100\"\u003e\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003ch3\u003eMade easy, for 😸 lovers.\u003c/h3\u003e\n\u003c/div\u003e\n\n\u003cbr\u003e\n\n\u003cdiv align=\"right\"\u003e\n  \u003cspan style=\"margin-right: 10px; font-size: 16px; font-style: italic\"\u003eSpotted the issue?\u003c/span\u003e\n  \u003ca href=\"https://github.com/hasscc/catlink/issues/new?assignees=\u0026labels=bug%2Ctriage\u0026template=bug_report.md\u0026title=%5BBug%5D%3A+\" target=\"_blank\" style=\"text-decoration: none;\"\u003e\u003cspan style=\"background-color: #f44b42; border: none; color: white; padding: 10px 20px; text-align: center; text-decoration: none; display: inline-block; font-size: 16px; margin: 4px 2px; cursor: pointer; border-radius: 4px;\"\u003eReport a Bug\u003c/span\u003e\u003c/a\u003e\n\u003c/div\u003e\n\n---\n\n### Table of Contents\n\n- [Features](#features)\n- [Installation](#installation)\n  - [Easy way](#easy-way)\n  - [Manually](#manually)\n- [Supported Devices and Operations](#supported-devices-and-operations)\n  - [Scooper SE](#supported-devices-and-operations)\n  - [Scooper PRO](#supported-devices-and-operations)\n- [How to Configure?](#how-to-configure)\n- [Services (Optional)](#services-optional)\n- [Changelog](#changelog)\n- [How to contribute?](#how-to-contribute)\n- [Disclaimer on Using Logos](#disclaimer-on-using-logos)\n\nThe CatLINK custom integration provides seamless support for integrating your CatLINK Scooper and Litterbox devices into Home Assistant. This integration allows you to monitor, control, and automate your CatLINK devices directly from your Home Assistant setup, enhancing the convenience and care of your feline friends.\n\n#### Features:\n\n- **Scooper/Litterbox Device Integration**: Effortlessly connect your CatLINK Scooper and Litterbox devices to Home Assistant, enabling centralized control and monitoring within your smart home environment.\n\n- **Real-Time Status Monitoring**: Track essential metrics such as work status, alarm status, weight, litter weight, cleaning times, and more. All relevant data is available in real-time, ensuring you stay informed about your pet's litterbox usage.\n\n- **Mode Selection**: Choose between different modes of operation (Auto, Manual, Time) to customize the behavior of your CatLINK devices according to your needs and preferences.\n\n- **Advanced Actions**: Perform specific actions such as initiating a clean cycle, pausing the device, or changing the litter bag directly from Home Assistant.\n\n- **Comprehensive Logging**: Access detailed event logs for all activities, including manual and auto-clean events, cat visits with associated cat details, and other device operations. This feature helps you keep track of your pets' habits and the device's performance.\n\n- **Customizable Alerts and Automations**: Set up notifications and automate tasks based on the state of your CatLINK devices. For example, receive alerts when the litterbox is full or automatically start a cleaning cycle during quiet times.\n\n- **Entity Attributes**: The integration exposes various attributes related to your CatLINK devices, such as litter weight, total and manual clean times, alarm status, and more, allowing for detailed customization and automation.\n\n---\n\n# Installation:\n\n### Easy way\n[![HACS](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?category=integration\u0026owner=hasscc\u0026repository=catlink)\n\n### Manually\n\n#### Method 1: Manually installation via Samba / SFTP\n\u003e Download and copy `custom_components/catlink` folder to `custom_components` folder in your HomeAssistant config folder\n\n#### Method 2: Onkey shell via SSH / Terminal \u0026 SSH add-on\n```shell\nwget -O - https://get.hacs.vip | DOMAIN=catlink REPO_PATH=hasscc/catlink ARCHIVE_TAG=main bash -\n```\n\n#### Method 3: shell_command service\n1. Copy this code to file `configuration.yaml`\n    ```yaml\n    shell_command:\n      update_catlink: |-\n        wget -O - https://get.hacs.vip | DOMAIN=catlink REPO_PATH=hasscc/catlink ARCHIVE_TAG=main bash -\n    ```\n2. Restart HA core\n3. Call this [`service: shell_command.update_catlink`](https://my.home-assistant.io/redirect/developer_call_service/?service=shell_command.update_catlink) in Developer Tools\n2. Restart HA core again\n\n## Supported Devices and Operations\n\n\u003cdiv style=\"display: flex; justify-content: space-between; flex-wrap: nowrap; gap: 16px;\"\u003e\n\n  \u003cdiv style=\"text-align: center; width: 33.33%;\"\u003e\n    \u003ch3\u003e\u003ca href=\"https://www.catlinkus.com/products/catlink-smart-litter-box-scooper-se\"\u003eScooper SE\u003c/a\u003e\u003c/h3\u003e\n    \u003cimg src=\"https://www.catlinkus.com/cdn/shop/files/CATLINK-Lite-01_757acadb-ebb8-4469-88c6-3ca3dd820706_610x610_crop_center.jpg?v=1691003577\" alt=\"Scooper SE\" width=\"150\"\u003e\n    \u003ch4\u003eOperations\u003c/h4\u003e\n    \u003cul style=\"text-align: left;\"\u003e\n      \u003cli\u003eChanging Operation Mode (Auto, Manual, Time)\u003c/li\u003e\n      \u003cli\u003eActions (Cleaning, Pause, Change Garbage Bag)\u003c/li\u003e\n      \u003cli\u003eWastebin Full flag\u003c/li\u003e\n      \u003cli\u003eLitter weight measurement\u003c/li\u003e\n      \u003cli\u003eLitter days left\u003c/li\u003e\n      \u003cli\u003eDeodorant replacement countdown in days\u003c/li\u003e\n      \u003cli\u003e(NEW) Reset litter and deodorant buttons\u003c/li\u003e\n      \u003cli\u003eOccupacy flag\u003c/li\u003e\n      \u003cli\u003eCleaning count\u003c/li\u003e\n      \u003cli\u003eKnob status\u003c/li\u003e\n      \u003cli\u003eGarbage Tobe status\u003c/li\u003e\n      \u003cli\u003eOnline status\u003c/li\u003e\n      \u003cli\u003eLogs \u0026 Errors\u003c/li\u003e\n      \u003cli\u003eEntities: sensor, binary sensor, select, switch, button\u003c/li\u003e\n    \u003c/ul\u003e\n  \u003c/div\u003e\n\n  \u003cdiv style=\"text-align: center; width: 33.33%;\"\u003e\n    \u003ch3\u003e\u003ca href=\"https://www.catlinkus.com/products/catlink-self-cleaning-cat-litter-box-pro\"\u003eScooper PRO\u003c/a\u003e\u003c/h3\u003e\n    \u003cimg src=\"https://www.catlinkus.com/cdn/shop/files/1500-1500_610x610_crop_center.jpg?v=1691705114\" alt=\"Scooper PRO\" width=\"150\"\u003e\n    \u003ch4\u003eOperations\u003c/h4\u003e\n    \u003cul style=\"text-align: left;\"\u003e\n      \u003cli\u003eChanging Operation Mode (Auto, Manual, Time, Empty)\u003c/li\u003e\n      \u003cli\u003eActions (Start, Pause)\u003c/li\u003e\n      \u003cli\u003eDeodorant replacement countdown in days\u003c/li\u003e\n      \u003cli\u003eLitter days left\u003c/li\u003e\n      \u003cli\u003eLitter weight measurement\u003c/li\u003e\n      \u003cli\u003eReset litter and deodorant buttons\u003c/li\u003e\n      \u003cli\u003eOccupacy flag\u003c/li\u003e\n      \u003cli\u003eCleaning count\u003c/li\u003e\n      \u003cli\u003eTemperature (Celsius)\u003c/li\u003e\n      \u003cli\u003eHumidity\u003c/li\u003e\n      \u003cli\u003eOnline status\u003c/li\u003e\n      \u003cli\u003eLogs \u0026 Error\u003c/li\u003e\n      \u003cli\u003eEntities: sensor, binary sensor, select, switch, button\u003c/li\u003e\n    \u003c/ul\u003e\n  \u003c/div\u003e\n\n  \u003cdiv style=\"text-align: center; width: 33.33%;\"\u003e\n    \u003ch3\u003e\u003ca href=\"https://www.catlinkus.com/products/catlink-ai-feeder-for-only-pet-young\"\u003eFeeder Young\u003c/a\u003e\u003c/h3\u003e\n    \u003cimg src=\"https://web.archive.org/web/20221230071208im_/https://cdn.shopify.com/s/files/1/0641/0056/5251/products/3_cd58df89-6457-45af-a5c7-6ceb01272c40_700x.jpg?v=1657250711\" alt=\"Feeder Young\" width=\"150\"\u003e\n    \u003ch4\u003eOperations\u003c/h4\u003e\n    \u003cul style=\"text-align: left;\"\u003e\n      \u003cli\u003eFeed Button\u003c/li\u003e\n      \u003cli\u003eFood tray weight\u003c/li\u003e\n      \u003cli\u003eOnline status\u003c/li\u003e\n      \u003cli\u003eLogs \u0026 Error\u003c/li\u003e\n      \u003cli\u003eEntities: sensor, binary sensor, button\u003c/li\u003e\n    \u003c/ul\u003e\n  \u003c/div\u003e\n\n\u003c/div\u003e\n\n#### Additional supported devices\n\n\u003cdiv style=\"display: flex; justify-content: space-around;\"\u003e\n\n  \u003cdiv style=\"text-align: center; width: 45%;\"\u003e\n    \u003ch3\u003eOpen-X/C08\u003c/h3\u003e\n    \u003cimg src=\"https://www.catlinkus.com/cdn/shop/files/OPENX9_610x610_crop_center.webp?v=1767769832\" alt=\"Open-X/C08\" width=\"150\"\u003e\n    \u003ch4\u003eOperations\u003c/h4\u003e\n    \u003cul style=\"text-align: left;\"\u003e\n      \u003cli\u003eChanging operation mode (Auto, Manual, Scheduled)\u003c/li\u003e\n      \u003cli\u003eActions (Clean, Pause, Cancel, Pave)\u003c/li\u003e\n      \u003cli\u003eLitter weight, remaining days, and deodorant countdown\u003c/li\u003e\n      \u003cli\u003eQuiet mode, child lock, indicator light, keypad tone\u003c/li\u003e\n      \u003cli\u003eNotice switches and pet stats\u003c/li\u003e\n      \u003cli\u003eEntities: sensor, binary sensor, select, switch, button\u003c/li\u003e\n    \u003c/ul\u003e\n  \u003c/div\u003e\n\n  \u003cdiv style=\"text-align: center; width: 45%;\"\u003e\n    \u003ch3\u003eScooper Pro Ultra (limited support)\u003c/h3\u003e\n    \u003cimg src=\"https://www.catlinkus.com/cdn/shop/files/ULTRA3_832ba0c1-c1b6-4ec0-ba8a-6ec5122897dd_610x610_crop_center.webp?v=1768480746\" alt=\"Scooper Pro Ultra\" width=\"150\"\u003e\n    \u003ch4\u003eOperations\u003c/h4\u003e\n    \u003cul style=\"text-align: left;\"\u003e\n      \u003cli\u003eLitter remaining days\u003c/li\u003e\n      \u003cli\u003eDeodorant countdown\u003c/li\u003e\n      \u003cli\u003eTotal clean time\u003c/li\u003e\n      \u003cli\u003eLogs\u003c/li\u003e\n      \u003cli\u003eEntities: sensor\u003c/li\u003e\n    \u003c/ul\u003e\n  \u003c/div\u003e\n\n\u003c/div\u003e\n\n#### Cats\n\n\u003cdiv style=\"display: flex; justify-content: space-around;\"\u003e\n\n  \u003cdiv style=\"text-align: center; width: 45%;\"\u003e\n    \u003ch3\u003eSmart collars (via the Cats integration)\u003c/h3\u003e\n    \u003cimg src=\"https://play-lh.googleusercontent.com/eHPhN_fUDhdxMK4JAvlzjB5Mh-H72crLn2U3Khk37lzolNg2CTDgZXkB5bjPiM3CDqM\" alt=\"CatLINK smart collar\" width=\"150\"\u003e\n    \u003ch4\u003eOperations\u003c/h4\u003e\n    \u003cul style=\"text-align: left;\"\u003e\n      \u003cli\u003eActivity and status sensors\u003c/li\u003e\n      \u003cli\u003eWeight and body metrics sensors\u003c/li\u003e\n      \u003cli\u003ePresence and last seen tracking\u003c/li\u003e\n      \u003cli\u003eEntities: sensor, binary sensor\u003c/li\u003e\n    \u003c/ul\u003e\n  \u003c/div\u003e\n\n\u003c/div\u003e\n\n\n### How to Configure?\n\n\u003e ! Recommend sharing devices to another account, because you can keep only one login session, which means that you'll have to re-login to CATLINK each time your HA instance pulls the data.\n\nJust use ConfigFlow. Enter your phonenumber (eg. +493034994004) and password. \u003cbr\u003e\nThat's it. \u003cbr\u003e\nIt will automatically discover your Region, Cats \u0026 Devices.\n\n## Services (Optional)\n\n#### Request API\n\n```yaml\nservice: catlink.request_api\ntarget:\n  entity_id: sensor.scooper_xxxxxx_state # Any sensor entity in the account\ndata:\n  api: /token/device/union/list/sorted\n  params:\n    key: val\n```\n\n## Changelog\n\nSee `CHANGELOG.md` for release notes.\n\n### How to contribute?\n\nPlease visit [CONTRIBUTE](/CONTRIBUTE.md), and be aware of [this](/CODE_OF_CONDUCT.md).\n\n---\n\n### Disclaimer on Using Logos\n\n\u003cp style=\"font-size: 12px; color: gray;\"\u003e\n  \u003cstrong\u003eDisclaimer on Using Logos:\u003c/strong\u003e Please note that the logos used in this documentation, including the CatLINK and Home Assistant logos, are the property of their respective owners.\n  \u003cbr\u003e\u003cbr\u003e\n  \u003cem\u003eTrademark Acknowledgment:\u003c/em\u003e The CatLINK and Home Assistant logos are trademarks of their respective companies. This documentation uses these logos solely for informational and illustrative purposes. No endorsement by or affiliation with the trademark holders is implied.\n  \u003cbr\u003e\u003cbr\u003e\n  \u003cem\u003eUsage Restrictions:\u003c/em\u003e Ensure that you have the appropriate permissions or licenses to use these logos in your own materials. Unauthorized use of logos can result in trademark infringement or other legal issues.\n  \u003cbr\u003e\u003cbr\u003e\n  \u003cem\u003eModifications:\u003c/em\u003e If you modify or resize the logos for use in your projects, ensure that the integrity of the logos is maintained and that they are not used in a misleading or inappropriate manner.\n  \u003cbr\u003e\u003cbr\u003e\n  By using these logos in your documentation or materials, you acknowledge and agree to comply with all applicable trademark laws and the usage guidelines set by the respective trademark holders.\n\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhasscc%2Fcatlink","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhasscc%2Fcatlink","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhasscc%2Fcatlink/lists"}