Home Assistant Unofficial Reference 2024.12.1
const.py
Go to the documentation of this file.
1 """The nut component."""
2 
3 from __future__ import annotations
4 
5 from homeassistant.const import Platform
6 
7 DOMAIN = "nut"
8 
9 PLATFORMS = [Platform.SENSOR]
10 
11 DEFAULT_NAME = "NUT UPS"
12 DEFAULT_HOST = "localhost"
13 DEFAULT_PORT = 3493
14 
15 KEY_STATUS = "ups.status"
16 KEY_STATUS_DISPLAY = "ups.status.display"
17 
18 DEFAULT_SCAN_INTERVAL = 60
19 
20 STATE_TYPES = {
21  "OL": "Online",
22  "OB": "On Battery",
23  "LB": "Low Battery",
24  "HB": "High Battery",
25  "RB": "Battery Needs Replacement",
26  "CHRG": "Battery Charging",
27  "DISCHRG": "Battery Discharging",
28  "BYPASS": "Bypass Active",
29  "CAL": "Runtime Calibration",
30  "OFF": "Offline",
31  "OVER": "Overloaded",
32  "TRIM": "Trimming Voltage",
33  "BOOST": "Boosting Voltage",
34  "FSD": "Forced Shutdown",
35  "ALARM": "Alarm",
36  "HE": "ECO Mode",
37  "TEST": "Battery Testing",
38 }
39 
40 COMMAND_BEEPER_DISABLE = "beeper.disable"
41 COMMAND_BEEPER_ENABLE = "beeper.enable"
42 COMMAND_BEEPER_MUTE = "beeper.mute"
43 COMMAND_BEEPER_TOGGLE = "beeper.toggle"
44 COMMAND_BYPASS_START = "bypass.start"
45 COMMAND_BYPASS_STOP = "bypass.stop"
46 COMMAND_CALIBRATE_START = "calibrate.start"
47 COMMAND_CALIBRATE_STOP = "calibrate.stop"
48 COMMAND_LOAD_OFF = "load.off"
49 COMMAND_LOAD_ON = "load.on"
50 COMMAND_RESET_INPUT_MINMAX = "reset.input.minmax"
51 COMMAND_RESET_WATCHDOG = "reset.watchdog"
52 COMMAND_SHUTDOWN_REBOOT = "shutdown.reboot"
53 COMMAND_SHUTDOWN_REBOOT_GRACEFUL = "shutdown.reboot.graceful"
54 COMMAND_SHUTDOWN_RETURN = "shutdown.return"
55 COMMAND_SHUTDOWN_STAYOFF = "shutdown.stayoff"
56 COMMAND_SHUTDOWN_STOP = "shutdown.stop"
57 COMMAND_TEST_BATTERY_START = "test.battery.start"
58 COMMAND_TEST_BATTERY_START_DEEP = "test.battery.start.deep"
59 COMMAND_TEST_BATTERY_START_QUICK = "test.battery.start.quick"
60 COMMAND_TEST_BATTERY_STOP = "test.battery.stop"
61 COMMAND_TEST_FAILURE_START = "test.failure.start"
62 COMMAND_TEST_FAILURE_STOP = "test.failure.stop"
63 COMMAND_TEST_PANEL_START = "test.panel.start"
64 COMMAND_TEST_PANEL_STOP = "test.panel.stop"
65 COMMAND_TEST_SYSTEM_START = "test.system.start"
66 
67 INTEGRATION_SUPPORTED_COMMANDS = {
68  COMMAND_BEEPER_DISABLE,
69  COMMAND_BEEPER_ENABLE,
70  COMMAND_BEEPER_MUTE,
71  COMMAND_BEEPER_TOGGLE,
72  COMMAND_BYPASS_START,
73  COMMAND_BYPASS_STOP,
74  COMMAND_CALIBRATE_START,
75  COMMAND_CALIBRATE_STOP,
76  COMMAND_LOAD_OFF,
77  COMMAND_LOAD_ON,
78  COMMAND_RESET_INPUT_MINMAX,
79  COMMAND_RESET_WATCHDOG,
80  COMMAND_SHUTDOWN_REBOOT,
81  COMMAND_SHUTDOWN_REBOOT_GRACEFUL,
82  COMMAND_SHUTDOWN_RETURN,
83  COMMAND_SHUTDOWN_STAYOFF,
84  COMMAND_SHUTDOWN_STOP,
85  COMMAND_TEST_BATTERY_START,
86  COMMAND_TEST_BATTERY_START_DEEP,
87  COMMAND_TEST_BATTERY_START_QUICK,
88  COMMAND_TEST_BATTERY_STOP,
89  COMMAND_TEST_FAILURE_START,
90  COMMAND_TEST_FAILURE_STOP,
91  COMMAND_TEST_PANEL_START,
92  COMMAND_TEST_PANEL_STOP,
93  COMMAND_TEST_SYSTEM_START,
94 }