Catlink scooper smart litter box

Hello everyone. I am quite new to HA even though I have dabbled many times before. I am trying to add the catlink integration. I have copied the files to the custom_components/catlink directory and added the blurb to the configuration yaml.

And restarted HA.

But how do I know this is working? In Integrations, Catlink still doesn’t show up as a “Configured” integration and a search for “scooper” under Entities doesn’t show anything either.

as far as I remember you wont see the integration in the integrations-page. please check if you find an entity with scooper in its name. In my HA it looks like as following:

Thanks, Andrew. I see those entities now.

Is there a way to create a “status card” to show info from these entities in HA? Sorry if this is very basic info. I am a “hobby power user” and have tinkered with all kinds of hardware/software hacks for decades but HA and API related programming is brand new to me.

Oh nevermind. I think I got it working. For those other newbies:

  1. It seems this integration is still working as of March 2024 - despite the LONG list of errors in HA’s log in relation to the various deprecations

  2. In Australia at least, you need to remove the first zero of your log in number.

  3. You won’t find it listed as one of the installed integrations after you install it. If your install is successful, you will find various “entities” with “scooper” in their names

  4. Catlink only allows one log in at a time, so your phone app might be logged out as a result. You might be able to get around this by creating another account using email and then invite that account to share the Catlink device. But I haven’t tried.

  5. To see the Catlink entities, create a “card” on the dashboard and add every “scooper” entities to it.

  6. It seems to me that the “Cat litter full” info from the “Scooper-Luxury-Pro-X info” field is provided in Chinese. I am not sure if it can be modified to English. Does anyone know which file to mod and/or how?

That’s how far I got so far. Thanks all.

Hey Jinster,

Same as you, have spent countless hours today trying to work out why I can’t pull the entities.

With config yaml -

  • did you add area code to your mobile number or just 4xxxxxxxx
  • did you add api_base or leave blank
  • did you add scan interval?

With services request
Did you just copy and past the services snippet?

Thanks!

Also receiving this error on the log?
2024-03-10 17:25:35.223 WARNING (MainThread) [homeassistant.helpers.service] Referenced entities sensor.scooper_xxxxxx_state are missing or not currently available

RE above - removed the 61 and looks like my request was accepted but no luck still.

catlink:
  # Single account
  phone:     4xxxxxxxx # Username of Catlink APP
  password:  xxxxxxx # Password
  phone_iac: 61   # Optional, International access code, default is 86 (China)
  api_base:  https://app-sgp.catlinks.cn/api/   # Optional, default is China server: https://app.catlinks.cn/api/
  scan_interval: 00:05:00 # Optional, default is 00:01:00

The above is my code. And it works. Remove 61 and 0 from your phone. Add 61 to phone iac.

Hey Jinster,

I love you.

  • Jonogg

Hi, I am in the US and I tried the default api_base and the “app-spg” api base. Both don’t work. Does anyone know which link is for the US users? Thanks.

Hi … i am desperate. I tried everything. I think everything is correct but i always obtain wrong password. I removed all special characters from pass but nothing helps. Can anybody here confirm that the integration is still functional ?

My config

catlink:
  # Single account
  phone: 775xxxxxx # My phone number
  password: mypassword
  phone_iac: 420 #czech republic
  api_base: https://app-sh.catlinks.cn/api/ # i tried also another api base and make there an account but the same error
  scan_interval: 00:01:00
  language: "en_GB"

and from my HA log

* Login 775xxxxxxx failed: [{'returnCode': 2002, 'toast': False, 'msg': 'Wrong password', 'data': {}, 'timestamp': '1730660318280', 'success': False}, {'platform': 'ANDROID', 'internationalCode': 420, 'mobile': '775xxxxxx', 'password': 'xxxxEDITEDxxxx', 'noncestr': 1730660317317, 'sign': 'DE5D9F037E4FAEB6041FC2112D0CD311'}]

still working, actually if I remember correctly you only have to install the integration via HACS and then go to Integrations and search for Catlink where you can enter your data.

I dont have the config in config.yaml anymore and it works just fine.

integrations i have but there is information that it is not possible to setup - only in configuration.yaml

I mean this integration

Hey everyone! :wave:

I’m also having trouble with this integration. I set up everything, adding the hasscc/catlink integration and adding the code to my configuration.yaml as instructed, but I keep running into issues with the API login.

Here’s my situation:

  • I’ve tried using both an email-based account and a phone-number-based account, ensuring the credentials are correct.
  • My device appears online and works perfectly in the Catlink app, so I know it’s not a connectivity issue.
  • I tested the API directly via curl, and while the connection works, the API consistently returns an error like:
    {"returnCode": 1000, "msg": "Device offline or other faults", "success": false}
    
  • I’m using the Euroamerican server node (https://app-usa.catlinks.cn/api/) as my account is registered there.

It seems like the integration might be outdated or isn’t fully compatible with the current Catlink API. I’ve also noticed that the GitHub repo hasn’t been updated in a few months, which might explain some of these issues.

If anyone has managed to get this working recently or has insights into debugging the integration further, I’d really appreciate the help! Alternatively, if someone has had success reverse-engineering the API or knows of another solution, please share. :blush:

Thanks in advance!