Home Assistant Unofficial Reference 2024.12.1
Classes | Namespaces | Functions | Variables
api.py File Reference

Go to the source code of this file.

Classes

class  homeassistant.components.zwave_js.api.FirmwareUploadView
 

Namespaces

 homeassistant.components.zwave_js.api
 

Functions

tuple[ConfigEntry, Client, Driver]|tuple[None, None, None] homeassistant.components.zwave_js.api._async_get_entry (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, str entry_id)
 
Node|None homeassistant.components.zwave_js.api._async_get_node (HomeAssistant hass, ActiveConnection connection, dict msg, str device_id)
 
dict[str, int|float] homeassistant.components.zwave_js.api._get_controller_firmware_update_progress_dict (ControllerFirmwareUpdateProgress progress)
 
dict[str, int] homeassistant.components.zwave_js.api._get_controller_statistics_dict (ControllerStatistics statistics)
 
dict[str, int|float] homeassistant.components.zwave_js.api._get_node_firmware_update_progress_dict (NodeFirmwareUpdateProgress progress)
 
dict[str, Any] homeassistant.components.zwave_js.api._get_node_statistics_dict (HomeAssistant hass, NodeStatistics statistics)
 
Callable[ Concatenate[HomeAssistant, ActiveConnection, dict[str, Any], _P], Coroutine[Any, Any, None],] homeassistant.components.zwave_js.api._P (Callable[Concatenate[HomeAssistant, ActiveConnection, dict[str, Any], _P], Coroutine[Any, Any, None],] orig_func)
 
Callable[[HomeAssistant, ActiveConnection, dict[str, Any]], Coroutine[Any, Any, None]] homeassistant.components.zwave_js.api.async_get_entry (Callable[[HomeAssistant, ActiveConnection, dict[str, Any], ConfigEntry, Client, Driver], Coroutine[Any, Any, None],] orig_func)
 
Callable[[HomeAssistant, ActiveConnection, dict[str, Any]], Coroutine[Any, Any, None]] homeassistant.components.zwave_js.api.async_get_node (Callable[[HomeAssistant, ActiveConnection, dict[str, Any], Node], Coroutine[Any, Any, None],] orig_func)
 
None homeassistant.components.zwave_js.api.async_register_api (HomeAssistant hass)
 
dict homeassistant.components.zwave_js.api.filename_is_present_if_logging_to_file (dict obj)
 
dict[str, Any] homeassistant.components.zwave_js.api.node_status (Node node)
 
None homeassistant.components.zwave_js.api.websocket_abort_firmware_update (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, Node node)
 
None homeassistant.components.zwave_js.api.websocket_add_node (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, ConfigEntry entry, Client client, Driver driver)
 
None homeassistant.components.zwave_js.api.websocket_begin_rebuilding_routes (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, ConfigEntry entry, Client client, Driver driver)
 
None homeassistant.components.zwave_js.api.websocket_check_for_config_updates (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, ConfigEntry entry, Client client, Driver driver)
 
None homeassistant.components.zwave_js.api.websocket_data_collection_status (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, ConfigEntry entry, Client client, Driver driver)
 
None homeassistant.components.zwave_js.api.websocket_get_config_parameters (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, Node node)
 
None homeassistant.components.zwave_js.api.websocket_get_integration_settings (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
 
None homeassistant.components.zwave_js.api.websocket_get_log_config (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, ConfigEntry entry, Client client, Driver driver)
 
None homeassistant.components.zwave_js.api.websocket_get_node_firmware_update_capabilities (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, Node node)
 
None homeassistant.components.zwave_js.api.websocket_get_provisioning_entries (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, ConfigEntry entry, Client client, Driver driver)
 
None homeassistant.components.zwave_js.api.websocket_get_raw_config_parameter (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, Node node)
 
None homeassistant.components.zwave_js.api.websocket_grant_security_classes (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, ConfigEntry entry, Client client, Driver driver)
 
None homeassistant.components.zwave_js.api.websocket_hard_reset_controller (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, ConfigEntry entry, Client client, Driver driver)
 
None homeassistant.components.zwave_js.api.websocket_install_config_update (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, ConfigEntry entry, Client client, Driver driver)
 
None homeassistant.components.zwave_js.api.websocket_invoke_cc_api (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, Node node)
 
None homeassistant.components.zwave_js.api.websocket_is_any_ota_firmware_update_in_progress (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, ConfigEntry entry, Client client, Driver driver)
 
None homeassistant.components.zwave_js.api.websocket_is_node_firmware_update_in_progress (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, Node node)
 
None homeassistant.components.zwave_js.api.websocket_network_status (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg)
 
None homeassistant.components.zwave_js.api.websocket_node_alerts (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, Node node)
 
None homeassistant.components.zwave_js.api.websocket_node_capabilities (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, Node node)
 
None homeassistant.components.zwave_js.api.websocket_node_metadata (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, Node node)
 
None homeassistant.components.zwave_js.api.websocket_node_status (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, Node node)
 
None homeassistant.components.zwave_js.api.websocket_parse_qr_code_string (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, ConfigEntry entry, Client client, Driver driver)
 
None homeassistant.components.zwave_js.api.websocket_provision_smart_start_node (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, ConfigEntry entry, Client client, Driver driver)
 
None homeassistant.components.zwave_js.api.websocket_rebuild_node_routes (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, Node node)
 
None homeassistant.components.zwave_js.api.websocket_refresh_node_cc_values (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, Node node)
 
None homeassistant.components.zwave_js.api.websocket_refresh_node_info (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, Node node)
 
None homeassistant.components.zwave_js.api.websocket_refresh_node_values (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, Node node)
 
None homeassistant.components.zwave_js.api.websocket_remove_failed_node (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, Node node)
 
None homeassistant.components.zwave_js.api.websocket_remove_node (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, ConfigEntry entry, Client client, Driver driver)
 
None homeassistant.components.zwave_js.api.websocket_replace_failed_node (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, Node node)
 
None homeassistant.components.zwave_js.api.websocket_set_config_parameter (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, Node node)
 
None homeassistant.components.zwave_js.api.websocket_set_raw_config_parameter (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, Node node)
 
None homeassistant.components.zwave_js.api.websocket_stop_exclusion (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, ConfigEntry entry, Client client, Driver driver)
 
None homeassistant.components.zwave_js.api.websocket_stop_inclusion (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, ConfigEntry entry, Client client, Driver driver)
 
None homeassistant.components.zwave_js.api.websocket_stop_rebuilding_routes (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, ConfigEntry entry, Client client, Driver driver)
 
None homeassistant.components.zwave_js.api.websocket_subscribe_controller_statistics (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, ConfigEntry entry, Client client, Driver driver)
 
None homeassistant.components.zwave_js.api.websocket_subscribe_firmware_update_status (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, Node node)
 
None homeassistant.components.zwave_js.api.websocket_subscribe_log_updates (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, ConfigEntry entry, Client client, Driver driver)
 
None homeassistant.components.zwave_js.api.websocket_subscribe_node_statistics (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, Node node)
 
None homeassistant.components.zwave_js.api.websocket_subscribe_node_status (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, Node node)
 
None homeassistant.components.zwave_js.api.websocket_subscribe_rebuild_routes_progress (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, ConfigEntry entry, Client client, Driver driver)
 
None homeassistant.components.zwave_js.api.websocket_supports_feature (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, ConfigEntry entry, Client client, Driver driver)
 
None homeassistant.components.zwave_js.api.websocket_try_parse_dsk_from_qr_code_string (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, ConfigEntry entry, Client client, Driver driver)
 
None homeassistant.components.zwave_js.api.websocket_unprovision_smart_start_node (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, ConfigEntry entry, Client client, Driver driver)
 
None homeassistant.components.zwave_js.api.websocket_update_data_collection_preference (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, ConfigEntry entry, Client client, Driver driver)
 
None homeassistant.components.zwave_js.api.websocket_update_log_config (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, ConfigEntry entry, Client client, Driver driver)
 
None homeassistant.components.zwave_js.api.websocket_validate_dsk_and_enter_pin (HomeAssistant hass, ActiveConnection connection, dict[str, Any] msg, ConfigEntry entry, Client client, Driver driver)
 

Variables

string homeassistant.components.zwave_js.api.ADDITIONAL_PROPERTIES = "additional_properties"
 
string homeassistant.components.zwave_js.api.APPLICATION_VERSION = "applicationVersion"
 
string homeassistant.components.zwave_js.api.CLIENT_SIDE_AUTH = "clientSideAuth"
 
string homeassistant.components.zwave_js.api.COMMAND_CLASS_ID = "command_class_id"
 
string homeassistant.components.zwave_js.api.CONFIG = "config"
 
string homeassistant.components.zwave_js.api.DATA_UNSUBSCRIBE = "unsubs"
 
string homeassistant.components.zwave_js.api.DEVICE_ID = "device_id"
 
string homeassistant.components.zwave_js.api.DSK = "dsk"
 
string homeassistant.components.zwave_js.api.ENABLED = "enabled"
 
string homeassistant.components.zwave_js.api.ENDPOINT = "endpoint"
 
string homeassistant.components.zwave_js.api.ENTRY_ID = "entry_id"
 
string homeassistant.components.zwave_js.api.ERR_NOT_LOADED = "not_loaded"
 
string homeassistant.components.zwave_js.api.FEATURE = "feature"
 
string homeassistant.components.zwave_js.api.FILENAME = "filename"
 
string homeassistant.components.zwave_js.api.FORCE_CONSOLE = "force_console"
 
string homeassistant.components.zwave_js.api.FORCE_SECURITY = "force_security"
 
string homeassistant.components.zwave_js.api.GENERIC_DEVICE_CLASS = "genericDeviceClass"
 
string homeassistant.components.zwave_js.api.ID = "id"
 
string homeassistant.components.zwave_js.api.INCLUSION_STRATEGY = "inclusion_strategy"
 
string homeassistant.components.zwave_js.api.INSTALLER_ICON_TYPE = "installerIconType"
 
string homeassistant.components.zwave_js.api.LEVEL = "level"
 
string homeassistant.components.zwave_js.api.LOG_TO_FILE = "log_to_file"
 
string homeassistant.components.zwave_js.api.MANUFACTURER_ID = "manufacturerId"
 
string homeassistant.components.zwave_js.api.MAX_INCLUSION_REQUEST_INTERVAL = "maxInclusionRequestInterval"
 
int homeassistant.components.zwave_js.api.MINIMUM_QR_STRING_LENGTH = 52
 
string homeassistant.components.zwave_js.api.NODE_ID = "node_id"
 
string homeassistant.components.zwave_js.api.OPTED_IN = "opted_in"
 
string homeassistant.components.zwave_js.api.PIN = "pin"
 
string homeassistant.components.zwave_js.api.PLANNED_PROVISIONING_ENTRY = "planned_provisioning_entry"
 
 homeassistant.components.zwave_js.api.PLANNED_PROVISIONING_ENTRY_SCHEMA
 
string homeassistant.components.zwave_js.api.PRODUCT_ID = "productId"
 
string homeassistant.components.zwave_js.api.PRODUCT_TYPE = "productType"
 
string homeassistant.components.zwave_js.api.PROPERTY = "property"
 
string homeassistant.components.zwave_js.api.PROPERTY_KEY = "property_key"
 
string homeassistant.components.zwave_js.api.QR_CODE_STRING = "qr_code_string"
 
 homeassistant.components.zwave_js.api.QR_CODE_STRING_SCHEMA = vol.All(str, vol.Length(min=MINIMUM_QR_STRING_LENGTH))
 
string homeassistant.components.zwave_js.api.QR_PROVISIONING_INFORMATION = "qr_provisioning_information"
 
 homeassistant.components.zwave_js.api.QR_PROVISIONING_INFORMATION_SCHEMA
 
string homeassistant.components.zwave_js.api.REQUESTED_SECURITY_CLASSES = "requestedSecurityClasses"
 
string homeassistant.components.zwave_js.api.SECURITY_CLASSES = "securityClasses"
 
string homeassistant.components.zwave_js.api.SPECIFIC_DEVICE_CLASS = "specificDeviceClass"
 
string homeassistant.components.zwave_js.api.STATUS = "status"
 
string homeassistant.components.zwave_js.api.STRATEGY = "strategy"
 
string homeassistant.components.zwave_js.api.SUPPORTED_PROTOCOLS = "supportedProtocols"
 
string homeassistant.components.zwave_js.api.TYPE = "type"
 
string homeassistant.components.zwave_js.api.UUID = "uuid"
 
string homeassistant.components.zwave_js.api.VALUE = "value"
 
string homeassistant.components.zwave_js.api.VALUE_FORMAT = "value_format"
 
string homeassistant.components.zwave_js.api.VALUE_ID = "value_id"
 
string homeassistant.components.zwave_js.api.VALUE_SIZE = "value_size"
 
string homeassistant.components.zwave_js.api.VERSION = "version"