Homebridge Litter Robot Plugin

This is an accessory plugin for Homebridge allowing limited control and event notifications of Litter Robot devices.

What does this plugin do?

This plugin makes calls to the Litter Robot API to get status of litter robot(s) associated with the account. It creates four devices for each Litter Robot it finds, Power Switch, Night Light Switch, Occupancy Sensor and Filter Maintenance.

The Power Switch will turn activate the power of the Litter Robot.

The Nightlight Switch will turn on/off the nightlight.

The Occupancy Sensor will trigger when the Drawer Full status is indicated.

The Filter Maintenance is not supported in Home App as of iOS 14.x. It is available in the Eve App.

TBD:

• Add Cycle Stateless Switch to trigger the Cycle

Install

If you have already installed homebridge globally, just install

npm install -g homebridge-litter-robot

Alternatively, add the dependency into your local project with

npm install -S homebridge-litter-robot

Configuration

The plugin registers itself as LitterRobot. You have the following options:

| Option | Default | | -------------------- | -------------------------------------------- | | email | | | password | | | pollingInterval | 0 - No Polling. Must be at least 5000 ms | | hideNightlightSwitch | false | | hidePowerSwitch | false | | hideOccupancySensor | false | | hideFilter | false | | hideCycleSwitch | false |

The email and password are the values you use to login to the app.

The hide* settings will configure the plugin to not create the associated device type.

Example config.json

{
  "bridge": {
    "name": "Homebridge",
    "username": "CC:22:3D:E3:CE:30",
    "port": 51826,
    "pin": "031-45-154"
  },
  "description": "This is an example configuration file with Litter Robot plugin.",

  "platforms": [
        {
            "platform" : "LitterRobot",

            "name" : "Litter Robot",

            "email": "<[email protected]>",

            "password": "<password>",

            "pollingInterval": 60000,

            "hideNightlightSwitch": false,

            "hidePowerSwitch": false,

            "hideOccupancySensor": false,

            "hideFilter": false,

            "hideCycleSwitch": false


        }
    ]
}

License

Copyright 2019-2021 by Michael Leo. Licensed under Apache Version 2.0 .