Skip to content
A litter robot API to mqtt bridge process
Go Makefile
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore
.travis.yml
Dockerfile.template
LICENSE.md
Makefile
README.md
bridge.go
commandChan.go
config.go
globalClientConfig.go
go.mod
go.sum
main.go
mqttClient.go
mqttClientConfig.go
mqttClient_test.go
serviceClient.go
serviceClientConfig.go
stateChan.go
types.go
wire.go
wire_gen.go

README.md

litterrobot2mqtt

Software License Travis CI Coverage Status Go Report Card

Installation

Via Docker

docker run -d --name="litterrobot2mqtt" -v /etc/localtime:/etc/localtime:ro mannkind/litterrobot2mqtt

Via Make

git clone https://github.com/mannkind/litterrobot2mqtt
cd litterrobot2mqtt
make
./litterrobot2mqtt

Configuration

Configuration happens via environmental variables

LITTERROBOT_LOCAL       - [OPTIONAL] The flag that indicates that you want to use the local API (requires additonal setup)
LITTERROBOT_EMAIL       - [OPTIONAL] The username/email for the Litter Robot API (required, if not using the local API)
LITTERROBOT_PASSWORD    - [OPTIONAL] The password for the Litter Robot API (required, if not using the local API)
LITTERROBOT_APIKEY      - [OPTIONAL] The API Key for the Litter Robot API, defaults to "Gmdfw5Cq3F3Mk6xvvO0inHATJeoDv6C3KfwfOuh0" which is the API Key for the iOS app
LITTERROBOT_KNOWN       - [OPTIONAL] The list of Litter Robot IDs from the API, e.g. "3a2aac320c65cb,3a2aac321c65cc"
MQTT_TOPICPREFIX        - [OPTIONAL] The MQTT topic on which to publish the receiver status, defaults to "litterrobot"
MQTT_DISCOVERY          - [OPTIONAL] The MQTT discovery flag for Home Assistant, defaults to false
MQTT_DISCOVERYPREFIX    - [OPTIONAL] The MQTT discovery prefix for Home Assistant, defaults to "homeassistant"
MQTT_DISCOVERYNAME      - [OPTIONAL] The MQTT discovery name for Home Assistant, defaults to "litterrobot"
MQTT_CLIENTID           - [OPTIONAL] The clientId, defaults to ""
MQTT_BROKER             - [OPTIONAL] The MQTT broker, defaults to "tcp://mosquitto.org:1883"
MQTT_USERNAME           - [OPTIONAL] The MQTT username, default to ""
MQTT_PASSWORD           - [OPTIONAL] The MQTT password, default to ""
You can’t perform that action at this time.