Skip to content

Available Items

Yoichi Takizawa edited this page Feb 15, 2026 · 2 revisions

Available Items

Item List

Option Description HTML Element ID Example Output
--status Device status / デバイスステータス value_DeviceStatus Online
--load UPS load (%) / UPS負荷 value_RealPowerPct 19.0
--runtime Runtime remaining (min) / ランタイム残り時間 value_RuntimeRemaining 29
--voltage Input voltage (VAC) / 入力電圧 value_InputVoltage 102.0
--battery Battery charge (%) / バッテリー充電 value_BatteryCharge 100.0
--batteryvoltage Battery voltage (VDC) / バッテリー電圧 value_VoltageDC 13.7

Default Behavior

If no option is specified, --load is used by default.

python3 apcget.py 192.168.1.100 admin password
# Same as: python3 apcget.py 192.168.1.100 admin password --load

Multiple Items

Multiple options can be specified. Values are output separated by spaces, in the order listed in the table above.

python3 apcget.py 192.168.1.100 admin password --load --runtime --voltage
# Output: 19.0 29 102.0

Output Format

  • Units (%, VAC, VDC, min) are not included in the output
  • Numeric values are output as-is from PowerChute (e.g., 19.0, 102.0, 29)
  • --status returns a text string (e.g., "Online", "オンライン")

JSON Output

The --json option outputs all items as a single JSON object:

python3 apcget.py 192.168.1.100 admin password --json
{"status": "Online", "load": "19.0", "runtime": "29", "voltage": "102.0", "battery": "100.0", "batteryvoltage": "13.7"}

This is useful for integration with Home Assistant, scripts, and other tools. See MQTT Integration for Home Assistant setup.

Clone this wiki locally