Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.shelly.const Namespace Reference

Variables

string API_WS_URL = "/api/shelly/ws"
 
int BLOCK_EXPECTED_SLEEP_PERIOD = 43200
 
int BLOCK_WRONG_SLEEP_PERIOD = 21600
 
 COMPONENT_ID_PATTERN = re.compile(r"[a-z\d]+:\d+")
 
string CONF_BLE_SCANNER_MODE = "ble_scanner_mode"
 
string CONF_GEN = "gen"
 
tuple DEVICES_WITHOUT_FIRMWARE_CHANGELOG
 
int ENTRY_RELOAD_COOLDOWN = 60
 
 Final
 
string FIRMWARE_UNSUPPORTED_ISSUE_ID = "firmware_unsupported_{unique}"
 
tuple GAS_VALVE_OPEN_STATES = ("opening", "opened")
 
string GEN1_RELEASE_URL = "https://shelly-api-docs.shelly.cloud/gen1/#changelog"
 
string GEN2_RELEASE_URL = "https://shelly-api-docs.shelly.cloud/gen2/changelog/"
 
 Logger
 
int MAX_PUSH_UPDATE_FAILURES = 5
 
string NOT_CALIBRATED_ISSUE_ID = "not_calibrated_{unique}"
 
string OTA_BEGIN = "ota_begin"
 
string OTA_ERROR = "ota_error"
 
string OTA_PROGRESS = "ota_progress"
 
string OTA_SUCCESS = "ota_success"
 
string PUSH_UPDATE_ISSUE_ID = "push_update_{unique}"
 
float RPC_MIN_TRANSITION_TIME_SEC = 0.5
 
int RPC_RECONNECT_INTERVAL = 60
 
list SHELLY_GAS_MODELS = [MODEL_GAS]
 
 SHIX3_1_INPUTS_EVENTS_TYPES = BLOCK_INPUTS_EVENTS_TYPES
 
dictionary VIRTUAL_COMPONENTS_MAP
 
dictionary VIRTUAL_NUMBER_MODE_MAP
 

Detailed Description

Constants for the Shelly integration.

Variable Documentation

◆ API_WS_URL

string homeassistant.components.shelly.const.API_WS_URL = "/api/shelly/ws"

Definition at line 257 of file const.py.

◆ BLOCK_EXPECTED_SLEEP_PERIOD

int homeassistant.components.shelly.const.BLOCK_EXPECTED_SLEEP_PERIOD = 43200

Definition at line 197 of file const.py.

◆ BLOCK_WRONG_SLEEP_PERIOD

int homeassistant.components.shelly.const.BLOCK_WRONG_SLEEP_PERIOD = 21600

Definition at line 196 of file const.py.

◆ COMPONENT_ID_PATTERN

homeassistant.components.shelly.const.COMPONENT_ID_PATTERN = re.compile(r"[a-z\d]+:\d+")

Definition at line 259 of file const.py.

◆ CONF_BLE_SCANNER_MODE

string homeassistant.components.shelly.const.CONF_BLE_SCANNER_MODE = "ble_scanner_mode"

Definition at line 206 of file const.py.

◆ CONF_GEN

string homeassistant.components.shelly.const.CONF_GEN = "gen"

Definition at line 240 of file const.py.

◆ DEVICES_WITHOUT_FIRMWARE_CHANGELOG

tuple homeassistant.components.shelly.const.DEVICES_WITHOUT_FIRMWARE_CHANGELOG
Initial value:
1 = (
2  MODEL_WALL_DISPLAY,
3  MODEL_MOTION,
4  MODEL_MOTION_2,
5  MODEL_VALVE,
6 )

Definition at line 233 of file const.py.

◆ ENTRY_RELOAD_COOLDOWN

int homeassistant.components.shelly.const.ENTRY_RELOAD_COOLDOWN = 60

Definition at line 202 of file const.py.

◆ Final

homeassistant.components.shelly.const.Final

Definition at line 32 of file const.py.

◆ FIRMWARE_UNSUPPORTED_ISSUE_ID

string homeassistant.components.shelly.const.FIRMWARE_UNSUPPORTED_ISSUE_ID = "firmware_unsupported_{unique}"

Definition at line 222 of file const.py.

◆ GAS_VALVE_OPEN_STATES

tuple homeassistant.components.shelly.const.GAS_VALVE_OPEN_STATES = ("opening", "opened")

Definition at line 224 of file const.py.

◆ GEN1_RELEASE_URL

string homeassistant.components.shelly.const.GEN1_RELEASE_URL = "https://shelly-api-docs.shelly.cloud/gen1/#changelog"

Definition at line 231 of file const.py.

◆ GEN2_RELEASE_URL

string homeassistant.components.shelly.const.GEN2_RELEASE_URL = "https://shelly-api-docs.shelly.cloud/gen2/changelog/"

Definition at line 232 of file const.py.

◆ Logger

homeassistant.components.shelly.const.Logger

Definition at line 34 of file const.py.

◆ MAX_PUSH_UPDATE_FAILURES

int homeassistant.components.shelly.const.MAX_PUSH_UPDATE_FAILURES = 5

Definition at line 217 of file const.py.

◆ NOT_CALIBRATED_ISSUE_ID

string homeassistant.components.shelly.const.NOT_CALIBRATED_ISSUE_ID = "not_calibrated_{unique}"

Definition at line 220 of file const.py.

◆ OTA_BEGIN

string homeassistant.components.shelly.const.OTA_BEGIN = "ota_begin"

Definition at line 226 of file const.py.

◆ OTA_ERROR

string homeassistant.components.shelly.const.OTA_ERROR = "ota_error"

Definition at line 227 of file const.py.

◆ OTA_PROGRESS

string homeassistant.components.shelly.const.OTA_PROGRESS = "ota_progress"

Definition at line 228 of file const.py.

◆ OTA_SUCCESS

string homeassistant.components.shelly.const.OTA_SUCCESS = "ota_success"

Definition at line 229 of file const.py.

◆ PUSH_UPDATE_ISSUE_ID

string homeassistant.components.shelly.const.PUSH_UPDATE_ISSUE_ID = "push_update_{unique}"

Definition at line 218 of file const.py.

◆ RPC_MIN_TRANSITION_TIME_SEC

float homeassistant.components.shelly.const.RPC_MIN_TRANSITION_TIME_SEC = 0.5

Definition at line 43 of file const.py.

◆ RPC_RECONNECT_INTERVAL

int homeassistant.components.shelly.const.RPC_RECONNECT_INTERVAL = 60

Definition at line 94 of file const.py.

◆ SHELLY_GAS_MODELS

list homeassistant.components.shelly.const.SHELLY_GAS_MODELS = [MODEL_GAS]

Definition at line 204 of file const.py.

◆ SHIX3_1_INPUTS_EVENTS_TYPES

homeassistant.components.shelly.const.SHIX3_1_INPUTS_EVENTS_TYPES = BLOCK_INPUTS_EVENTS_TYPES

Definition at line 149 of file const.py.

◆ VIRTUAL_COMPONENTS_MAP

dictionary homeassistant.components.shelly.const.VIRTUAL_COMPONENTS_MAP
Initial value:
1 = {
2  "binary_sensor": {"types": ["boolean"], "modes": ["label"]},
3  "number": {"types": ["number"], "modes": ["field", "slider"]},
4  "select": {"types": ["enum"], "modes": ["dropdown"]},
5  "sensor": {"types": ["enum", "number", "text"], "modes": ["label"]},
6  "switch": {"types": ["boolean"], "modes": ["toggle"]},
7  "text": {"types": ["text"], "modes": ["field"]},
8 }

Definition at line 242 of file const.py.

◆ VIRTUAL_NUMBER_MODE_MAP

dictionary homeassistant.components.shelly.const.VIRTUAL_NUMBER_MODE_MAP
Initial value:
1 = {
2  "field": NumberMode.BOX,
3  "slider": NumberMode.SLIDER,
4 }

Definition at line 251 of file const.py.