Feature Request: Scooper Open-X Support

[intrepidsilence]

There is a newly released box. I have access to it and would be happy to help you get it supported.

I am happy to run any unit tests, discovery code, tcp dumps, etc to help out.

Just let me know what you need and I will get it done.

[meeowgler]

I'm expecting my Open-X to arrive shortly after Christmas. What we will need to do is confirm if everything in the LitterBox class works the same way. It's possible that only the DevicesCoordinator only needs the new deviceType. To get this value, we just need to make a call to the API.

[meeowgler]

So it seems that the Open-X is basically identical to the Scooper SE (LitterBox class) in terms of features and modes.

To get this working now, install the integration, then edit custom_components/catlink/modules/devices_coordinator.py.

Edit just one line.
case "LITTER_BOX_599": # SCOOPER C1

To
case "LITTER_BOX_599" | "C08": # Scooper SE, Open-X

The comment is optional.

[usr-was-taken]

Well, this will only make it partially work at best. For some reason, I cannot manually start a cleaning cycle.

I did try to call it using a small script.
Where I got this in response:

{
  "endpoint": "token/litterbox/actionCmd",
  "params": {
    "deviceId": "0000000", // Redacted
    "cmd": "01"
  },
  "response": {
    "returnCode": 4006,
    "toast": false,
    "msg": "The knob is set to Empty mode.",
    "data": {},
    "timestamp": "1768152945703",
    "success": false
  }
}

Also called litter box info:

{
  "endpoint": "token/litterbox/info",
  "params": {
    "deviceId": "0000000" // Redacted
  },
  "response": {
    "returnCode": 0,
    "toast": false,
    "msg": null,
    "data": {
      "deviceInfo": {
        "deviceType": null,
        "iotId": null,
        "deviceId": "0000000", // Redacted
        "mac": "2442E320409D",
        "deviceName": "SCOOPER C08",
        "master": 2,
        "defaultStatus": 1,
        "currentMessage": "The knob is set to Empty mode.",
        "currentMessageType": null,
        "errorAlertFlag": true,
        "workStatus": "00",
        "runStatus": null,
        "indicatorLight": "CLOSED",
        "paneltone": "00",
        "warningtone": null,
        "safeTime": "5",
        "alarmStatus": null,
        "temperature": null,
        "humidity": null,
        "weight": null,
        "catLitterWeight": 0.0,
        "workModel": "01",
        "keyLock": "00",
        "timingSettings": [
          {
            "id": "105440",
            "deviceId": "0000000", // Redacted
            "customerId": "000000", // Redacted
            "timingHour": "08",
            "timingMin": "00",
            "status": 0,
            "repeat": "1,2,3,4,5,6,7",
            "createTime": 1768077798000,
            "updateTime": null
          },
          {
            "id": "105441",
            "deviceId": "0000000", // Redacted
            "customerId": "000000", // Redacted
            "timingHour": "12",
            "timingMin": "00",
            "status": 0,
            "repeat": "1,2,3,4,5,6,7",
            "createTime": 1768077798000,
            "updateTime": null
          },
          {
            "id": "105442",
            "deviceId": "0000000", // Redacted
            "customerId": "000000", // Redacted
            "timingHour": "16",
            "timingMin": "00",
            "status": 0,
            "repeat": "1,2,3,4,5,6,7",
            "createTime": 1768077798000,
            "updateTime": null
          },
          {
            "id": "105443",
            "deviceId": "0000000", // Redacted
            "customerId": "000000", // Redacted
            "timingHour": "20",
            "timingMin": "00",
            "status": 0,
            "repeat": "1,2,3,4,5,6,7",
            "createTime": 1768077798000,
            "updateTime": null
          }
        ],
        "nearEnableTiming": {
          "id": "105440",
          "deviceId": "0000000", // Redacted
          "customerId": "000000", // Redacted
          "timingHour": "08",
          "timingMin": "00",
          "status": 0,
          "repeat": "1,2,3,4,5,6,7",
          "createTime": 1768077798000,
          "updateTime": null
        },
        "sharers": [
          {
            "id": "27633",
            "userId": "000000", // Redacted
            "nickname": "user",
            "avatar": null,
            "master": 1,
            "mobile": "00000000" // Redacted
          },
          {
            "id": "27650",
            "userId": "000000", // Redacted
            "nickname": "user2",
            "avatar": null,
            "master": 2,
            "mobile": "00000000" // Redacted
          },
          {
            "id": "27658",
            "userId": "000000", // Redacted
            "nickname": "user3",
            "avatar": null,
            "master": 2,
            "mobile": "00000000" // Redacted
          }
        ],
        "quietEnable": false,
        "quietTimes": "23:00-07:00",
        "firmwareVersion": "V04.08",
        "model": "00",
        "timezoneId": "Europe/Berlin",
        "gmt": "GMT+01:00",
        "catLitterPaveSecond": 13,
        "currentThreshold": null,
        "inductionTimes": "0",
        "manualTimes": "0",
        "timerTimes": "0",
        "clearTimes": "0",
        "deodorantCountdown": 59,
        "litterCountdown": 13,
        "showBuyBtn": null,
        "goodUrl": null,
        "mallCode": null,
        "autoUpdatePetWeight": true,
        "allTimingToggle": true,
        "online": true,
        "proModel": null,
        "supportWeightCalibration": true,
        "emptyStatus": "00",
        "cleanStatus": "00",
        "deviceErrorList": [
          {
            "errkey": "left_knob_abnormal",
            "errDesc": "The knob is set to Empty mode.",
            "title": "The knob is set to Empty mode.",
            "reason": "1.Knob not properly turned: The knob has not been rotated to the \"Clean\" position.\n2.Knob stuck: The knob may be stuck due to dirt, dust, or other debris, preventing smooth rotation and causing the device to detect an abnormal status.\n3.Ongoing emptying process: If the device is currently performing the emptying function, this alert is normal. Once the emptying task is complete, please rotate the knob to the \"Clean\" position.",
            "solution": "1.Turn the knob correctly: Ensure that the knob is rotated to the \"Clean\" position, and refer to the device manual to confirm the correct rotation direction and position.\n2.Check for a Jammed Knob: Make sure the knob is not obstructed by any objects. Carefully observe if the knob turns smoothly, and if necessary, gently try to move the knob to release it from a jammed state.",
            "url": "https://image-usa.catlinks.cn//errorGuide/c02/leftKnobAbnormal.png",
            "solutionUrl": null,
            "errorCheckTips": [
              "Please rotate the left knob so that the empty pad inside the  globe is attached to the wall."
            ]
          }
        ],
        "errorJumpType": 1,
        "litterType": 0,
        "toiletUseTimes": null,
        "toiletSettingTimes": null,
        "emptyState": false,
        "hour": 17,
        "minute": 45,
        "garbageStatus": "00",
        "clickAble": null,
        "realModel": "00",
        "toiletSliceFlag": true,
        "fullTimes": 0,
        "fullCloseTimes": 3,
        "boxFullSensitivity": 1,
        "voiceEnable": 0,
        "fiveMinBurial": null,
        "autoBurial": false,
        "continuousCleaning": false,
        "multiCatReg": 1,
        "multiCatBuyFlag": 1,
        "deodorantEnable": false,
        "replaceGarbageBag": null,
        "deviceWeight": null,
        "kittenModel": false,
        "freshSysInstall": null,
        "autoSwitch": null,
        "timerSwitch": null,
        "sandPaveLevel": null,
        "sandBoxInstall": null,
        "offScreenDuration": null,
        "sandboxBalance": null,
        "catLitterBalance": null,
        "finalStatus": null,
        "softModel": null,
        "totalCleanTimes": null,
        "infraredSwitch": null,
        "dn": null,
        "watermark": null,
        "atmosphereLightSwitch": null,
        "cameraSwitch": null,
        "fillLight": null,
        "curtainStatusSwitch": null,
        "experiencePlanSwitch": null,
        "visualCloudStorageRecordVo": null,
        "deviceVipFlag": null,
        "lastHeartBeatTimestamp": "1768149907172",
        "ccareCountdownTimestamp": "0",
        "ccareTempEntrance": false,
        "highEdition": false
      }
    },
    "timestamp": "1768149959605",
    "success": true
  }
}

I don't know if the error is specific to mine, but the app has not said anything, just API complaining.

[EuleMitKeule]

🎉 Ho ho ho, Merry Christmas and a Happy New Year! As a present to all of you proud Open-X/C08 owners, I have created a completely new python library and home assistant integration specifically for this type of litter box (at least for now): 🎊

https://github.com/eulemitkeule/pycatlink

Features:

• Config flow for easy setup
• Devices are created for litter box and each pet
• Extensive sensor and control entities for nearly all control options supported by the official app
• Extensive diagnostic and configuration options exposed via entities
• English and german translations

This is in beta, I haven't tested each feature, but most stuff seems to work.

See for yourself:

Litter Box

Pets

For now this only works for C08 (Open-X) devices, but i built the library and integration in such a way that owners of other devices should easily be able to integrate those other devices. I currently only own the C08 so I can't really help with that.

For feedback, bug reports and feature requests please feel free to open an issue at https://github.com/eulemitkeule/pycatlink/issues

[milosljubenovic]

Hey everyone 👋

I’ve just released a new version, v2.1.1-beta, which adds support for the Scooper Open-X 🎉
👉 https://github.com/hasscc/catlink/releases/tag/v2.1.1-beta

Unfortunately, I don’t own this device myself, so I’ll need a volunteer (or two!) to help test it in the wild 🧪🐾

Any help would be hugely appreciated.
Thanks a lot for contributing! 🐱💙

[cromelex]

I've just ordered an Open-X and will be happy to test once I receive it.

[cromelex]

Only just received the unit but can confirm that generally, the integration is working. I can trigger the cleaning/ child lock/ lights / etc and I seem to be able to get all the data points as expected.

I will provide some more feedback over the next few days once the cats start using it etc.

[meeowgler]

Great work! Is there a way to expose individual pet data?

[cromelex]

Great work! Is there a way to expose individual pet data?

It seems to expose individual pets as separate devices.

I only just added this so I have no records other than the manually entered data, but it seems to have the info per pet:

[milosljubenovic]

Nice! 🐱
Cats are separated "Devices" altho it is "deanimalizing" them, but it was the only reasonable way to integrate it to HA.

Happy Catting guys, let me know if you have anything else in mind that I can do for this device :)

[cromelex]

Just wanted to report that everything seems to be working as expected for me. Data is updating, control via the integration is also working, and haven't had any issues to report!

Thanks again for the great work!