{"id":17802060,"url":"https://github.com/tlkamp/litter-api","last_synced_at":"2025-09-22T04:32:32.761Z","repository":{"id":45217944,"uuid":"354994793","full_name":"tlkamp/litter-api","owner":"tlkamp","description":"An API for the Litter Robot 3 Connect","archived":false,"fork":false,"pushed_at":"2023-10-28T16:37:46.000Z","size":36,"stargazers_count":8,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-01-11T23:41:40.412Z","etag":null,"topics":["go","golang","hacktoberfest","iot","litter-robot","litterbox"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tlkamp.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2021-04-05T22:58:01.000Z","updated_at":"2024-12-28T22:02:10.000Z","dependencies_parsed_at":"2023-10-01T16:50:08.582Z","dependency_job_id":null,"html_url":"https://github.com/tlkamp/litter-api","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tlkamp%2Flitter-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tlkamp%2Flitter-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tlkamp%2Flitter-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tlkamp%2Flitter-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tlkamp","download_url":"https://codeload.github.com/tlkamp/litter-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":233824413,"owners_count":18736001,"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":["go","golang","hacktoberfest","iot","litter-robot","litterbox"],"created_at":"2024-10-27T12:40:34.292Z","updated_at":"2025-09-22T04:32:27.441Z","avatar_url":"https://github.com/tlkamp.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Litter API  [![Go Report Badge]][Go Report] [![GoDocBadge]][GoDocLink]\n\nLitter API is an interface to the [Litter Robot](https://www.litter-robot.com/) API.\n\n**This is an experimental API.** The upstream Litter Robot API is not publicly documented and may cause breaking\nchanges with no notice. Breaking changes will be handled as soon as possible.\n\n## Examples\n\n```go\npackage main\n\nimport (\n\t\"fmt\"\n\tlr \"github.com/tlkamp/litter-api/v2/pkg/client\"\n)\n\nfunc main() {\n\tapi := lr.New(\"your-email\", \"your-password\")\n\n\tctx := context.Background()\n\n\terr := api.Login(ctx)\n\tif err != nil {\n\t\tfmt.Println(\"Error logging in - \", err)\n\t}\n\n\tif err := api.FetchRobots(ctx); err != nil {\n\t\tfmt.Println(\"Error fetching robots - \", err)\n\t}\n\n\tfor _, robot := range api.Robots() {\n\t\tfmt.Println(robot.LitterRobotID, \"-\", robot.Name)\n\t\tapi.Cycle(ctx, robot.LitterRobotID)\n\t}\n}\n```\n\n## Unit Status\nThe unit status is represented by a non-negative integer.\n\n| **String** | **Int** | **Description**                      |\n|------------|---------|--------------------------------------|\n| RDY        | 0       | Ready                                |\n| CCP        | 1       | Clean Cycle in Progress              |\n| CCC        | 2       | Clean Cycle Complete                 |\n| CSF        | 3       | Cat Sensor Fault                     |\n| DF1        | 4       | Drawer full - will still cycle       |\n| DF2        | 5       | Drawer full - will still cycle       |\n| CST        | 6       | Cat Sensor Timing                    |\n| CSI        | 7       | Cat Sensor Interrupt                 |\n| BR         | 8       | Bonnet Removed                       |\n| P          | 9       | Paused                               |\n| OFF        | 10      | Off                                  |\n| SDF        | 11      | Drawer full - will not cycle         |\n| DFS        | 12      | Drawer full - will not cycle         |\n\n[Go Report Badge]: https://goreportcard.com/badge/github.com/tlkamp/litter-api\n[Go Report]: https://goreportcard.com/report/github.com/tlkamp/litter-api\n[GoDocBadge]: https://godoc.org/github.com/tlkamp/litter-api?status.svg\n[GoDocLink]: https://godoc.org/github.com/tlkamp/litter-api\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftlkamp%2Flitter-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftlkamp%2Flitter-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftlkamp%2Flitter-api/lists"}