Eaton UPS Companion to MQTT Publisher
Project description
euc2mqtt
A tool for publishing status data from a local Eaton UPS Companion service to Homeassistant.
Quick Start
The following quick start guide should get you up and running from a blank Homeassistant installation. Feel free to skip a step if your system is already configured.
Install mosquitto
- In Homeassistant, navigate to Settings, Add-ons
- Click the Add-on store button
- Search for Mosquitto broker and select the result
- Click on Install
Create a new Homeassistant user for data ingest
As mosquitto requires authentication, I heavily suggest creating a new user for data ingest.
- In Homeassistant, navigate to Settings, People
- Click on Add person, input a user name
- Check Allow person to log in
- Enter all required fields
- Check Can only log in from local network
Get the application
Windows binaries are provided on the GitHub Releases page.**
If you prefer to use your own Python insallation, a pre-built package is hosted on PyPI and can be installed and updated using the pip
utility:
pip install -U euc2mqtt
Run it!
[!NOTE] This tool needs to run on the same host as Eaton UPS Companion, as EUC in its default configuration only accepts connections on
localhost:4679
.
Open a terminal and run the tool, providing the broker hostname (your Homeassistant hostname), username and the password!
Option 1: Standalone application
.\euc2mqtt --mqtt <broker hostname> --username <user> --password <password>
Option 2: Run as Python module
python -m euc2mqtt --mqtt <broker hostname> --username <user> --password <password>
More info
A more in-depth description of available command line parameters can be viewed by appending -h
at the end of your input. For example:
> .\euc2mqtt -h
usage: euc2mqtt [-h] [--name NAME] [--mqtt MQTT] [--euc EUC] [--username USERNAME] [--password PASSWORD] [--interval INTERVAL] [--full-update FULL_UPDATE] [--logfile LOGFILE] [--verbose]
MQTT Publisher for Eaton UPS Companion status messages to Home Assistant. See https://github.com/islandcontroller/euc2mqtt for more info!
options:
-h, --help show this help message and exit
--name NAME Device name
--mqtt MQTT MQTT broker hostname and port (hostname[:port])
--euc EUC Eaton UPS Companion hostname and port (hostname[:port])
--username USERNAME Username for MQTT broker authentication
--password PASSWORD Password for MQTT broker authentication
--interval INTERVAL Update interval in seconds
--full-update FULL_UPDATE
Number of incremental dataset fetches between full updates
--logfile LOGFILE Output log messages to a file
--verbose Enable verbose logging```
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.