homeassistant.components.nut.const Namespace Reference

Variables
string	COMMAND_BEEPER_DISABLE = "beeper.disable"
string	COMMAND_BEEPER_ENABLE = "beeper.enable"
string	COMMAND_BEEPER_MUTE = "beeper.mute"
string	COMMAND_BEEPER_TOGGLE = "beeper.toggle"
string	COMMAND_BYPASS_START = "bypass.start"
string	COMMAND_BYPASS_STOP = "bypass.stop"
string	COMMAND_CALIBRATE_START = "calibrate.start"
string	COMMAND_CALIBRATE_STOP = "calibrate.stop"
string	COMMAND_LOAD_OFF = "load.off"
string	COMMAND_LOAD_ON = "load.on"
string	COMMAND_RESET_INPUT_MINMAX = "reset.input.minmax"
string	COMMAND_RESET_WATCHDOG = "reset.watchdog"
string	COMMAND_SHUTDOWN_REBOOT = "shutdown.reboot"
string	COMMAND_SHUTDOWN_REBOOT_GRACEFUL = "shutdown.reboot.graceful"
string	COMMAND_SHUTDOWN_RETURN = "shutdown.return"
string	COMMAND_SHUTDOWN_STAYOFF = "shutdown.stayoff"
string	COMMAND_SHUTDOWN_STOP = "shutdown.stop"
string	COMMAND_TEST_BATTERY_START = "test.battery.start"
string	COMMAND_TEST_BATTERY_START_DEEP = "test.battery.start.deep"
string	COMMAND_TEST_BATTERY_START_QUICK = "test.battery.start.quick"
string	COMMAND_TEST_BATTERY_STOP = "test.battery.stop"
string	COMMAND_TEST_FAILURE_START = "test.failure.start"
string	COMMAND_TEST_FAILURE_STOP = "test.failure.stop"
string	COMMAND_TEST_PANEL_START = "test.panel.start"
string	COMMAND_TEST_PANEL_STOP = "test.panel.stop"
string	COMMAND_TEST_SYSTEM_START = "test.system.start"
string	DEFAULT_HOST = "localhost"
string	DEFAULT_NAME = "NUT UPS"
int	DEFAULT_PORT = 3493
int	DEFAULT_SCAN_INTERVAL = 60
string	DOMAIN = "nut"
dictionary	INTEGRATION_SUPPORTED_COMMANDS
string	KEY_STATUS = "ups.status"
string	KEY_STATUS_DISPLAY = "ups.status.display"
list	PLATFORMS = [Platform.SENSOR]
dictionary	STATE_TYPES

Detailed Description

The nut component.

Variable Documentation

COMMAND_BEEPER_DISABLE

string homeassistant.components.nut.const.COMMAND_BEEPER_DISABLE = "beeper.disable"

Definition at line 40 of file const.py.

COMMAND_BEEPER_ENABLE

string homeassistant.components.nut.const.COMMAND_BEEPER_ENABLE = "beeper.enable"

Definition at line 41 of file const.py.

COMMAND_BEEPER_MUTE

string homeassistant.components.nut.const.COMMAND_BEEPER_MUTE = "beeper.mute"

Definition at line 42 of file const.py.

COMMAND_BEEPER_TOGGLE

string homeassistant.components.nut.const.COMMAND_BEEPER_TOGGLE = "beeper.toggle"

Definition at line 43 of file const.py.

COMMAND_BYPASS_START

string homeassistant.components.nut.const.COMMAND_BYPASS_START = "bypass.start"

Definition at line 44 of file const.py.

COMMAND_BYPASS_STOP

string homeassistant.components.nut.const.COMMAND_BYPASS_STOP = "bypass.stop"

Definition at line 45 of file const.py.

COMMAND_CALIBRATE_START

string homeassistant.components.nut.const.COMMAND_CALIBRATE_START = "calibrate.start"

Definition at line 46 of file const.py.

COMMAND_CALIBRATE_STOP

string homeassistant.components.nut.const.COMMAND_CALIBRATE_STOP = "calibrate.stop"

Definition at line 47 of file const.py.

COMMAND_LOAD_OFF

string homeassistant.components.nut.const.COMMAND_LOAD_OFF = "load.off"

Definition at line 48 of file const.py.

COMMAND_LOAD_ON

string homeassistant.components.nut.const.COMMAND_LOAD_ON = "load.on"

Definition at line 49 of file const.py.

COMMAND_RESET_INPUT_MINMAX

string homeassistant.components.nut.const.COMMAND_RESET_INPUT_MINMAX = "reset.input.minmax"

Definition at line 50 of file const.py.

COMMAND_RESET_WATCHDOG

string homeassistant.components.nut.const.COMMAND_RESET_WATCHDOG = "reset.watchdog"

Definition at line 51 of file const.py.

COMMAND_SHUTDOWN_REBOOT

string homeassistant.components.nut.const.COMMAND_SHUTDOWN_REBOOT = "shutdown.reboot"

Definition at line 52 of file const.py.

COMMAND_SHUTDOWN_REBOOT_GRACEFUL

string homeassistant.components.nut.const.COMMAND_SHUTDOWN_REBOOT_GRACEFUL = "shutdown.reboot.graceful"

Definition at line 53 of file const.py.

COMMAND_SHUTDOWN_RETURN

string homeassistant.components.nut.const.COMMAND_SHUTDOWN_RETURN = "shutdown.return"

Definition at line 54 of file const.py.

COMMAND_SHUTDOWN_STAYOFF

string homeassistant.components.nut.const.COMMAND_SHUTDOWN_STAYOFF = "shutdown.stayoff"

Definition at line 55 of file const.py.

COMMAND_SHUTDOWN_STOP

string homeassistant.components.nut.const.COMMAND_SHUTDOWN_STOP = "shutdown.stop"

Definition at line 56 of file const.py.

COMMAND_TEST_BATTERY_START

string homeassistant.components.nut.const.COMMAND_TEST_BATTERY_START = "test.battery.start"

Definition at line 57 of file const.py.

COMMAND_TEST_BATTERY_START_DEEP

string homeassistant.components.nut.const.COMMAND_TEST_BATTERY_START_DEEP = "test.battery.start.deep"

Definition at line 58 of file const.py.

COMMAND_TEST_BATTERY_START_QUICK

string homeassistant.components.nut.const.COMMAND_TEST_BATTERY_START_QUICK = "test.battery.start.quick"

Definition at line 59 of file const.py.

COMMAND_TEST_BATTERY_STOP

string homeassistant.components.nut.const.COMMAND_TEST_BATTERY_STOP = "test.battery.stop"

Definition at line 60 of file const.py.

COMMAND_TEST_FAILURE_START

string homeassistant.components.nut.const.COMMAND_TEST_FAILURE_START = "test.failure.start"

Definition at line 61 of file const.py.

COMMAND_TEST_FAILURE_STOP

string homeassistant.components.nut.const.COMMAND_TEST_FAILURE_STOP = "test.failure.stop"

Definition at line 62 of file const.py.

COMMAND_TEST_PANEL_START

string homeassistant.components.nut.const.COMMAND_TEST_PANEL_START = "test.panel.start"

Definition at line 63 of file const.py.

COMMAND_TEST_PANEL_STOP

string homeassistant.components.nut.const.COMMAND_TEST_PANEL_STOP = "test.panel.stop"

Definition at line 64 of file const.py.

COMMAND_TEST_SYSTEM_START

string homeassistant.components.nut.const.COMMAND_TEST_SYSTEM_START = "test.system.start"

Definition at line 65 of file const.py.

DEFAULT_HOST

string homeassistant.components.nut.const.DEFAULT_HOST = "localhost"

Definition at line 12 of file const.py.

DEFAULT_NAME

string homeassistant.components.nut.const.DEFAULT_NAME = "NUT UPS"

Definition at line 11 of file const.py.

DEFAULT_PORT

int homeassistant.components.nut.const.DEFAULT_PORT = 3493

Definition at line 13 of file const.py.

DEFAULT_SCAN_INTERVAL

int homeassistant.components.nut.const.DEFAULT_SCAN_INTERVAL = 60

Definition at line 18 of file const.py.

DOMAIN

string homeassistant.components.nut.const.DOMAIN = "nut"

Definition at line 7 of file const.py.

INTEGRATION_SUPPORTED_COMMANDS

dictionary homeassistant.components.nut.const.INTEGRATION_SUPPORTED_COMMANDS

Initial value:

=  {
    COMMAND_BEEPER_DISABLE,
    COMMAND_BEEPER_ENABLE,
    COMMAND_BEEPER_MUTE,
    COMMAND_BEEPER_TOGGLE,
    COMMAND_BYPASS_START,
    COMMAND_BYPASS_STOP,
    COMMAND_CALIBRATE_START,
    COMMAND_CALIBRATE_STOP,
    COMMAND_LOAD_OFF,
    COMMAND_LOAD_ON,
    COMMAND_RESET_INPUT_MINMAX,
    COMMAND_RESET_WATCHDOG,
    COMMAND_SHUTDOWN_REBOOT,
    COMMAND_SHUTDOWN_REBOOT_GRACEFUL,
    COMMAND_SHUTDOWN_RETURN,
    COMMAND_SHUTDOWN_STAYOFF,
    COMMAND_SHUTDOWN_STOP,
    COMMAND_TEST_BATTERY_START,
    COMMAND_TEST_BATTERY_START_DEEP,
    COMMAND_TEST_BATTERY_START_QUICK,
    COMMAND_TEST_BATTERY_STOP,
    COMMAND_TEST_FAILURE_START,
    COMMAND_TEST_FAILURE_STOP,
    COMMAND_TEST_PANEL_START,
    COMMAND_TEST_PANEL_STOP,
    COMMAND_TEST_SYSTEM_START,
}

Definition at line 67 of file const.py.

KEY_STATUS

string homeassistant.components.nut.const.KEY_STATUS = "ups.status"

Definition at line 15 of file const.py.

KEY_STATUS_DISPLAY

string homeassistant.components.nut.const.KEY_STATUS_DISPLAY = "ups.status.display"

Definition at line 16 of file const.py.

PLATFORMS

list homeassistant.components.nut.const.PLATFORMS = [Platform.SENSOR]

Definition at line 9 of file const.py.

STATE_TYPES

dictionary homeassistant.components.nut.const.STATE_TYPES

Initial value:

=  {
    "OL": "Online",
    "OB": "On Battery",
    "LB": "Low Battery",
    "HB": "High Battery",
    "RB": "Battery Needs Replacement",
    "CHRG": "Battery Charging",
    "DISCHRG": "Battery Discharging",
    "BYPASS": "Bypass Active",
    "CAL": "Runtime Calibration",
    "OFF": "Offline",
    "OVER": "Overloaded",
    "TRIM": "Trimming Voltage",
    "BOOST": "Boosting Voltage",
    "FSD": "Forced Shutdown",
    "ALARM": "Alarm",
    "HE": "ECO Mode",
    "TEST": "Battery Testing",
}

Definition at line 20 of file const.py.