Network UPS Tools (NUT) Companion Modules

This module connects directly to a NUT server (upsd) over TCP — the same service you're talking to when you run upsc or send LIST VAR <upsname> from a terminal.

Setup

1. Target IP: the machine plugged into your UPS
2. Port: default NUT port is 3493.
3. UPS name: the name of the UPS as configured in ups.conf on the server (commonly just ups).
4. Username / Password (optional): only required if you want to send instant commands (INSTCMD) like starting a battery test. Read-only polling normally works without credentials, depending on your upsd.users config.
5. Poll interval: how often (in seconds) the module re-requests data from the server. 5–10s is a sensible default for status boards.

Variables

The module exposes the common NUT variables as Companion variables (battery_charge, ups_status, ups_load, input_voltage, battery_runtime, battery_runtime_formatted, ups_test_result, ups_timer_shutdown, and more). See the Variables tab on the connection once it's running for the full list — some fields are UPS/driver dependent and may not populate if your hardware doesn't report them.

Feedbacks

• UPS Status Is: change button style based on status codes (OL, OB, LB, etc).
• Load Above Threshold: highlight when ups.load exceeds a value you set.
• Battery Charge Below Threshold: highlight on low charge.

Actions

• Refresh Now: force an immediate poll instead of waiting for the interval.
• Send Instant Command: send any NUT INSTCMD (e.g. test.battery.start.quick, beeper.toggle). Requires configured credentials with instcmd permission.
• Force Shutdown (FSD): sends the NUT master-level shutdown flag. Guarded behind a confirmation option in the action — use with care.

---

How to install

• Download companion-module-nut-ups-1.0.0.tgz
• In Companion click on Modules, then click the "Import module package" button. Upload the .tgz file
• Go to Connections and search for NUT
• Install by clicking the Add button
• Input your UPS host IP address