/litterrobot2mqtt

A litter robot API to mqtt bridge process

Primary LanguageC#MIT LicenseMIT

litterrobot2mqtt

Software License Build Status Coverage Status

An experiment to publish Litter Robot statuses to MQTT.

Use

The application can be locally built using dotnet build or you can utilize the multi-architecture Docker image(s).

Example

docker run \
-e LITTERROBOT__LOGIN="youremailaddress@example.com" \
-e LITTERROBOT__PASSWORD="yourpassword" \
-e LITTERROBOT__RESOURCES__0__LRID="69103754" \
-e LITTERROBOT__RESOURCES__0__Slug="main" \
-e LITTERROBOT__MQTT__BROKER="localhost" \
-e LITTERROBOT__MQTT__DISCOVERYENABLED="true" \
mannkind/litterrobot2mqtt:latest

OR

LITTERROBOT__LOGIN="youremailaddress@example.com" \
LITTERROBOT__PASSWORD="yourpassword" \
LITTERROBOT__RESOURCES__0__LRID="69103754" \
LITTERROBOT__RESOURCES__0__Slug="main" \
LITTERROBOT__MQTT__BROKER="localhost" \
LITTERROBOT__MQTT__DISCOVERYENABLED="true" \
./litterrobot2mqtt

Configuration

Configuration happens via environmental variables

LITTERROBOT__LOGIN                              - The Litter Robot Login
LITTERROBOT__PASSWORD                           - The Litter Robot Password
LITTERROBOT__RESOURCES__#__LRID                 - The Litter Robot ID for a specific Litter Robot
LITTERROBOT__RESOURCES__#__Slug                 - The slug to identify the specific Litter Robot ID
LITTERROBOT__POLLINGINTERVAL                    - [OPTIONAL] The delay between litter robot status lookups, defaults to "0.00:00:31"
LITTERROBOT__MQTT__TOPICPREFIX                  - [OPTIONAL] The MQTT topic on which to publish the collection lookup results, defaults to "home/litterrobot"
LITTERROBOT__MQTT__DISCOVERYENABLED             - [OPTIONAL] The MQTT discovery flag for Home Assistant, defaults to false
LITTERROBOT__MQTT__DISCOVERYPREFIX              - [OPTIONAL] The MQTT discovery prefix for Home Assistant, defaults to "homeassistant"
LITTERROBOT__MQTT__DISCOVERYNAME                - [OPTIONAL] The MQTT discovery name for Home Assistant, defaults to "litterrobot"
LITTERROBOT__MQTT__BROKER                       - [OPTIONAL] The MQTT broker, defaults to "test.mosquitto.org"
LITTERROBOT__MQTT__USERNAME                     - [OPTIONAL] The MQTT username, default to ""
LITTERROBOT__MQTT__PASSWORD                     - [OPTIONAL] The MQTT password, default to ""

Prior Implementations

Golang