Home Assistant Unofficial Reference 2024.12.1
Classes | Functions | Variables
homeassistant.components.zwave_js.api Namespace Reference

Classes

class  FirmwareUploadView
 

Functions

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

Variables

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

Detailed Description

Websocket API for Z-Wave JS.

Function Documentation

◆ _async_get_entry()

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 
)
private 
Get config entry and client from message data.

Definition at line 241 of file api.py.

◆ _async_get_node()

Node | None homeassistant.components.zwave_js.api._async_get_node ( HomeAssistant  hass,
ActiveConnection  connection,
dict  msg,
str   device_id 
)
private 
Get node from message data.

Definition at line 301 of file api.py.

◆ _get_controller_firmware_update_progress_dict()

dict[str, int | float] homeassistant.components.zwave_js.api._get_controller_firmware_update_progress_dict ( ControllerFirmwareUpdateProgress  progress)
private 
Get a dictionary of a controller's firmware update progress.

Definition at line 2098 of file api.py.

◆ _get_controller_statistics_dict()

dict[str, int] homeassistant.components.zwave_js.api._get_controller_statistics_dict ( ControllerStatistics  statistics)
private 
Get dictionary of controller statistics.

Definition at line 2401 of file api.py.

◆ _get_node_firmware_update_progress_dict()

dict[str, int | float] homeassistant.components.zwave_js.api._get_node_firmware_update_progress_dict ( NodeFirmwareUpdateProgress  progress)
private 
Get a dictionary of a node's firmware update progress.

Definition at line 2085 of file api.py.

◆ _get_node_statistics_dict()

dict[str, Any] homeassistant.components.zwave_js.api._get_node_statistics_dict ( HomeAssistant  hass,
NodeStatistics   statistics 
)
private 
Get dictionary of node statistics.

Definition at line 2477 of file api.py.

◆ _P()

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)
private 
Decorate async function to handle FailedCommand and send relevant error.

Definition at line 339 of file api.py.

◆ async_get_entry()

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) 
Decorate async function to get entry.

Definition at line 274 of file api.py.

◆ async_get_node()

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) 
Decorate async function to get node.

Definition at line 316 of file api.py.

◆ async_register_api()

None homeassistant.components.zwave_js.api.async_register_api ( HomeAssistant  hass) 
Register all of our api endpoints.

Definition at line 390 of file api.py.

◆ filename_is_present_if_logging_to_file()

dict homeassistant.components.zwave_js.api.filename_is_present_if_logging_to_file ( dict  obj) 
Validate that filename is provided if log_to_file is True.

Definition at line 1837 of file api.py.

◆ node_status()

dict[str, Any] homeassistant.components.zwave_js.api.node_status ( Node  node) 
Get node status.

Definition at line 371 of file api.py.

◆ websocket_abort_firmware_update()

None homeassistant.components.zwave_js.api.websocket_abort_firmware_update ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]  msg,
Node  node 
) 
Abort a firmware update.

Definition at line 2054 of file api.py.

◆ websocket_add_node()

None homeassistant.components.zwave_js.api.websocket_add_node ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]  msg,
ConfigEntry  entry,
Client  client,
Driver  driver 
) 
Add a node to the Z-Wave network.

Definition at line 675 of file api.py.

◆ websocket_begin_rebuilding_routes()

None homeassistant.components.zwave_js.api.websocket_begin_rebuilding_routes ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]  msg,
ConfigEntry  entry,
Client  client,
Driver  driver 
) 
Begin rebuilding Z-Wave routes.

Definition at line 1446 of file api.py.

◆ websocket_check_for_config_updates()

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 
) 
Check for config updates.

Definition at line 2359 of file api.py.

◆ websocket_data_collection_status()

None homeassistant.components.zwave_js.api.websocket_data_collection_status ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]  msg,
ConfigEntry  entry,
Client  client,
Driver  driver 
) 
Return data collection preference and status.

Definition at line 2027 of file api.py.

◆ websocket_get_config_parameters()

None homeassistant.components.zwave_js.api.websocket_get_config_parameters ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]  msg,
Node   node 
) 
Get a list of configuration parameters for a Z-Wave node.

Definition at line 1736 of file api.py.

◆ websocket_get_integration_settings()

None homeassistant.components.zwave_js.api.websocket_get_integration_settings ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]  msg 
) 
Get Z-Wave JS integration wide configuration.

Definition at line 2697 of file api.py.

◆ websocket_get_log_config()

None homeassistant.components.zwave_js.api.websocket_get_log_config ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]  msg,
ConfigEntry  entry,
Client  client,
Driver  driver 
) 
Get log configuration for the Z-Wave JS driver.

Definition at line 1965 of file api.py.

◆ websocket_get_node_firmware_update_capabilities()

None homeassistant.components.zwave_js.api.websocket_get_node_firmware_update_capabilities ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]  msg,
Node  node 
) 
Get a node's firmware update capabilities.

Definition at line 2243 of file api.py.

◆ websocket_get_provisioning_entries()

None homeassistant.components.zwave_js.api.websocket_get_provisioning_entries ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]  msg,
ConfigEntry  entry,
Client  client,
Driver  driver 
) 
Get provisioning entries (entries that have been pre-provisioned).

Definition at line 1001 of file api.py.

◆ websocket_get_raw_config_parameter()

None homeassistant.components.zwave_js.api.websocket_get_raw_config_parameter ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]  msg,
Node  node 
) 
Get a custom config parameter value for a Z-Wave node.

Definition at line 1818 of file api.py.

◆ websocket_grant_security_classes()

None homeassistant.components.zwave_js.api.websocket_grant_security_classes ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]  msg,
ConfigEntry  entry,
Client  client,
Driver  driver 
) 
Choose SecurityClass grants as part of S2 inclusion process.

Definition at line 857 of file api.py.

◆ websocket_hard_reset_controller()

None homeassistant.components.zwave_js.api.websocket_hard_reset_controller ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]  msg,
ConfigEntry  entry,
Client  client,
Driver  driver 
) 
Hard reset controller.

Definition at line 2580 of file api.py.

◆ websocket_install_config_update()

None homeassistant.components.zwave_js.api.websocket_install_config_update ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]  msg,
ConfigEntry  entry,
Client  client,
Driver  driver 
) 
Check for config updates.

Definition at line 2388 of file api.py.

◆ websocket_invoke_cc_api()

None homeassistant.components.zwave_js.api.websocket_invoke_cc_api ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]  msg,
Node  node 
) 
Call invokeCCAPI on the node or provided endpoint.

Definition at line 2659 of file api.py.

◆ websocket_is_any_ota_firmware_update_in_progress()

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 
) 
Get whether any firmware updates are in progress.

Definition at line 2264 of file api.py.

◆ websocket_is_node_firmware_update_in_progress()

None homeassistant.components.zwave_js.api.websocket_is_node_firmware_update_in_progress ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]  msg,
Node  node 
) 
Get whether firmware update is in progress for given node.

Definition at line 2075 of file api.py.

◆ websocket_network_status()

None homeassistant.components.zwave_js.api.websocket_network_status ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]   msg 
) 
Get the status of the Z-Wave JS network.

Definition at line 468 of file api.py.

◆ websocket_node_alerts()

None homeassistant.components.zwave_js.api.websocket_node_alerts ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]  msg,
Node  node 
) 
Get the alerts for a Z-Wave JS node.

Definition at line 630 of file api.py.

◆ websocket_node_capabilities()

None homeassistant.components.zwave_js.api.websocket_node_capabilities ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]  msg,
Node  node 
) 
Get node endpoints with their support command classes.

Definition at line 2621 of file api.py.

◆ websocket_node_metadata()

None homeassistant.components.zwave_js.api.websocket_node_metadata ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]  msg,
Node  node 
) 
Get the metadata of a Z-Wave JS node.

Definition at line 600 of file api.py.

◆ websocket_node_status()

None homeassistant.components.zwave_js.api.websocket_node_status ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]  msg,
Node  node 
) 
Get the status of a Z-Wave JS node.

Definition at line 582 of file api.py.

◆ websocket_parse_qr_code_string()

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 
) 
Parse a QR Code String and return QRProvisioningInformation dict.

Definition at line 1025 of file api.py.

◆ websocket_provision_smart_start_node()

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 
) 
Pre-provision a smart start node.

Definition at line 915 of file api.py.

◆ websocket_rebuild_node_routes()

None homeassistant.components.zwave_js.api.websocket_rebuild_node_routes ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]  msg,
Node  node 
) 
Heal a node on the Z-Wave network.

Definition at line 1553 of file api.py.

◆ websocket_refresh_node_cc_values()

None homeassistant.components.zwave_js.api.websocket_refresh_node_cc_values ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]  msg,
Node  node 
) 
Refresh node values for a particular CommandClass.

Definition at line 1653 of file api.py.

◆ websocket_refresh_node_info()

None homeassistant.components.zwave_js.api.websocket_refresh_node_info ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]  msg,
Node  node 
) 
Re-interview a node.

Definition at line 1581 of file api.py.

◆ websocket_refresh_node_values()

None homeassistant.components.zwave_js.api.websocket_refresh_node_values ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]  msg,
Node  node 
) 
Refresh node values.

Definition at line 1631 of file api.py.

◆ websocket_remove_failed_node()

None homeassistant.components.zwave_js.api.websocket_remove_failed_node ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]  msg,
Node  node 
) 
Remove a failed node from the Z-Wave network.

Definition at line 1402 of file api.py.

◆ websocket_remove_node()

None homeassistant.components.zwave_js.api.websocket_remove_node ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]  msg,
ConfigEntry  entry,
Client  client,
Driver  driver 
) 
Remove a node from the Z-Wave network.

Definition at line 1158 of file api.py.

◆ websocket_replace_failed_node()

None homeassistant.components.zwave_js.api.websocket_replace_failed_node ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]  msg,
Node  node 
) 
Replace a failed node with a new node.

Definition at line 1238 of file api.py.

◆ websocket_set_config_parameter()

None homeassistant.components.zwave_js.api.websocket_set_config_parameter ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]  msg,
Node  node 
) 
Set a config parameter value for a Z-Wave node.

Definition at line 1688 of file api.py.

◆ websocket_set_raw_config_parameter()

None homeassistant.components.zwave_js.api.websocket_set_raw_config_parameter ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]  msg,
Node  node 
) 
Set a custom config parameter value for a Z-Wave node.

Definition at line 1785 of file api.py.

◆ websocket_stop_exclusion()

None homeassistant.components.zwave_js.api.websocket_stop_exclusion ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]  msg,
ConfigEntry  entry,
Client  client,
Driver  driver 
) 
Cancel removing a node from the Z-Wave network.

Definition at line 1130 of file api.py.

◆ websocket_stop_inclusion()

None homeassistant.components.zwave_js.api.websocket_stop_inclusion ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]  msg,
ConfigEntry  entry,
Client  client,
Driver  driver 
) 
Cancel adding a node to the Z-Wave network.

Definition at line 1103 of file api.py.

◆ websocket_stop_rebuilding_routes()

None homeassistant.components.zwave_js.api.websocket_stop_rebuilding_routes ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]  msg,
ConfigEntry  entry,
Client  client,
Driver  driver 
) 
Stop rebuilding Z-Wave routes.

Definition at line 1526 of file api.py.

◆ websocket_subscribe_controller_statistics()

None homeassistant.components.zwave_js.api.websocket_subscribe_controller_statistics ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]  msg,
ConfigEntry  entry,
Client  client,
Driver  driver 
) 
Subscribe to the statistics updates for a controller.

Definition at line 2427 of file api.py.

◆ websocket_subscribe_firmware_update_status()

None homeassistant.components.zwave_js.api.websocket_subscribe_firmware_update_status ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]  msg,
Node  node 
) 
Subscribe to the status of a firmware update.

Definition at line 2120 of file api.py.

◆ websocket_subscribe_log_updates()

None homeassistant.components.zwave_js.api.websocket_subscribe_log_updates ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]  msg,
ConfigEntry  entry,
Client  client,
Driver  driver 
) 
Subscribe to log message events from the server.

Definition at line 1854 of file api.py.

◆ websocket_subscribe_node_statistics()

None homeassistant.components.zwave_js.api.websocket_subscribe_node_statistics ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]  msg,
Node  node 
) 
Subscribe to the statistics updates for a node.

Definition at line 2524 of file api.py.

◆ websocket_subscribe_node_status()

None homeassistant.components.zwave_js.api.websocket_subscribe_node_status ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]  msg,
Node  node 
) 
Subscribe to node status update events of a Z-Wave JS node.

Definition at line 541 of file api.py.

◆ websocket_subscribe_rebuild_routes_progress()

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 
) 
Subscribe to rebuild Z-Wave routes status updates.

Definition at line 1473 of file api.py.

◆ websocket_supports_feature()

None homeassistant.components.zwave_js.api.websocket_supports_feature ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]  msg,
ConfigEntry  entry,
Client  client,
Driver  driver 
) 
Check if controller supports a particular feature.

Definition at line 1077 of file api.py.

◆ websocket_try_parse_dsk_from_qr_code_string()

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 
) 
Try to parse a DSK string from a QR code.

Definition at line 1051 of file api.py.

◆ websocket_unprovision_smart_start_node()

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 
) 
Unprovision a smart start node.

Definition at line 968 of file api.py.

◆ websocket_update_data_collection_preference()

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 
) 
Update preference for data collection and enable/disable collection.

Definition at line 1992 of file api.py.

◆ websocket_update_log_config()

None homeassistant.components.zwave_js.api.websocket_update_log_config ( HomeAssistant  hass,
ActiveConnection  connection,
dict[str, Any]  msg,
ConfigEntry  entry,
Client  client,
Driver  driver 
) 
Update the driver log config.

Definition at line 1941 of file api.py.

◆ websocket_validate_dsk_and_enter_pin()

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 
) 
Validate DSK and enter PIN as part of S2 inclusion process.

Definition at line 885 of file api.py.

Variable Documentation

◆ ADDITIONAL_PROPERTIES

string homeassistant.components.zwave_js.api.ADDITIONAL_PROPERTIES = "additional_properties"

Definition at line 171 of file api.py.

◆ APPLICATION_VERSION

string homeassistant.components.zwave_js.api.APPLICATION_VERSION = "applicationVersion"

Definition at line 167 of file api.py.

◆ CLIENT_SIDE_AUTH

string homeassistant.components.zwave_js.api.CLIENT_SIDE_AUTH = "clientSideAuth"

Definition at line 133 of file api.py.

◆ COMMAND_CLASS_ID

string homeassistant.components.zwave_js.api.COMMAND_CLASS_ID = "command_class_id"

Definition at line 106 of file api.py.

◆ CONFIG

string homeassistant.components.zwave_js.api.CONFIG = "config"

Definition at line 116 of file api.py.

◆ DATA_UNSUBSCRIBE

string homeassistant.components.zwave_js.api.DATA_UNSUBSCRIBE = "unsubs"

Definition at line 98 of file api.py.

◆ DEVICE_ID

string homeassistant.components.zwave_js.api.DEVICE_ID = "device_id"

Definition at line 105 of file api.py.

◆ DSK

string homeassistant.components.zwave_js.api.DSK = "dsk"

Definition at line 158 of file api.py.

◆ ENABLED

string homeassistant.components.zwave_js.api.ENABLED = "enabled"

Definition at line 120 of file api.py.

◆ ENDPOINT

string homeassistant.components.zwave_js.api.ENDPOINT = "endpoint"

Definition at line 110 of file api.py.

◆ ENTRY_ID

string homeassistant.components.zwave_js.api.ENTRY_ID = "entry_id"

Definition at line 102 of file api.py.

◆ ERR_NOT_LOADED

string homeassistant.components.zwave_js.api.ERR_NOT_LOADED = "not_loaded"

Definition at line 103 of file api.py.

◆ FEATURE

string homeassistant.components.zwave_js.api.FEATURE = "feature"

Definition at line 175 of file api.py.

◆ FILENAME

string homeassistant.components.zwave_js.api.FILENAME = "filename"

Definition at line 119 of file api.py.

◆ FORCE_CONSOLE

string homeassistant.components.zwave_js.api.FORCE_CONSOLE = "force_console"

Definition at line 121 of file api.py.

◆ FORCE_SECURITY

string homeassistant.components.zwave_js.api.FORCE_SECURITY = "force_security"

Definition at line 153 of file api.py.

◆ GENERIC_DEVICE_CLASS

string homeassistant.components.zwave_js.api.GENERIC_DEVICE_CLASS = "genericDeviceClass"

Definition at line 161 of file api.py.

◆ ID

string homeassistant.components.zwave_js.api.ID = "id"

Definition at line 101 of file api.py.

◆ INCLUSION_STRATEGY

string homeassistant.components.zwave_js.api.INCLUSION_STRATEGY = "inclusion_strategy"

Definition at line 136 of file api.py.

◆ INSTALLER_ICON_TYPE

string homeassistant.components.zwave_js.api.INSTALLER_ICON_TYPE = "installerIconType"

Definition at line 163 of file api.py.

◆ LEVEL

string homeassistant.components.zwave_js.api.LEVEL = "level"

Definition at line 117 of file api.py.

◆ LOG_TO_FILE

string homeassistant.components.zwave_js.api.LOG_TO_FILE = "log_to_file"

Definition at line 118 of file api.py.

◆ MANUFACTURER_ID

string homeassistant.components.zwave_js.api.MANUFACTURER_ID = "manufacturerId"

Definition at line 164 of file api.py.

◆ MAX_INCLUSION_REQUEST_INTERVAL

string homeassistant.components.zwave_js.api.MAX_INCLUSION_REQUEST_INTERVAL = "maxInclusionRequestInterval"

Definition at line 168 of file api.py.

◆ MINIMUM_QR_STRING_LENGTH

int homeassistant.components.zwave_js.api.MINIMUM_QR_STRING_LENGTH = 52

Definition at line 179 of file api.py.

◆ NODE_ID

string homeassistant.components.zwave_js.api.NODE_ID = "node_id"

Definition at line 104 of file api.py.

◆ OPTED_IN

string homeassistant.components.zwave_js.api.OPTED_IN = "opted_in"

Definition at line 129 of file api.py.

◆ PIN

string homeassistant.components.zwave_js.api.PIN = "pin"

Definition at line 152 of file api.py.

◆ PLANNED_PROVISIONING_ENTRY

string homeassistant.components.zwave_js.api.PLANNED_PROVISIONING_ENTRY = "planned_provisioning_entry"

Definition at line 154 of file api.py.

◆ PLANNED_PROVISIONING_ENTRY_SCHEMA

homeassistant.components.zwave_js.api.PLANNED_PROVISIONING_ENTRY_SCHEMA
Initial value:
1 = vol.All(
2  vol.Schema(
3  {
4  vol.Required(DSK): str,
5  vol.Required(SECURITY_CLASSES): vol.All(
6  cv.ensure_list,
7  [vol.Coerce(SecurityClass)],
8  ),
9  vol.Optional(STATUS, default=ProvisioningEntryStatus.ACTIVE): vol.Coerce(
10  ProvisioningEntryStatus
11  ),
12  vol.Optional(REQUESTED_SECURITY_CLASSES): vol.All(
13  cv.ensure_list, [vol.Coerce(SecurityClass)]
14  ),
15  },
16  # Provisioning entries can have extra keys for SmartStart
17  extra=vol.ALLOW_EXTRA,
18  ),
19  ProvisioningEntry.from_dict,
20 )

Definition at line 183 of file api.py.

◆ PRODUCT_ID

string homeassistant.components.zwave_js.api.PRODUCT_ID = "productId"

Definition at line 166 of file api.py.

◆ PRODUCT_TYPE

string homeassistant.components.zwave_js.api.PRODUCT_TYPE = "productType"

Definition at line 165 of file api.py.

◆ PROPERTY

string homeassistant.components.zwave_js.api.PROPERTY = "property"

Definition at line 108 of file api.py.

◆ PROPERTY_KEY

string homeassistant.components.zwave_js.api.PROPERTY_KEY = "property_key"

Definition at line 109 of file api.py.

◆ QR_CODE_STRING

string homeassistant.components.zwave_js.api.QR_CODE_STRING = "qr_code_string"

Definition at line 156 of file api.py.

◆ QR_CODE_STRING_SCHEMA

homeassistant.components.zwave_js.api.QR_CODE_STRING_SCHEMA = vol.All(str, vol.Length(min=MINIMUM_QR_STRING_LENGTH))

Definition at line 238 of file api.py.

◆ QR_PROVISIONING_INFORMATION

string homeassistant.components.zwave_js.api.QR_PROVISIONING_INFORMATION = "qr_provisioning_information"

Definition at line 155 of file api.py.

◆ QR_PROVISIONING_INFORMATION_SCHEMA

homeassistant.components.zwave_js.api.QR_PROVISIONING_INFORMATION_SCHEMA

Definition at line 204 of file api.py.

◆ REQUESTED_SECURITY_CLASSES

string homeassistant.components.zwave_js.api.REQUESTED_SECURITY_CLASSES = "requestedSecurityClasses"

Definition at line 173 of file api.py.

◆ SECURITY_CLASSES

string homeassistant.components.zwave_js.api.SECURITY_CLASSES = "securityClasses"

Definition at line 132 of file api.py.

◆ SPECIFIC_DEVICE_CLASS

string homeassistant.components.zwave_js.api.SPECIFIC_DEVICE_CLASS = "specificDeviceClass"

Definition at line 162 of file api.py.

◆ STATUS

string homeassistant.components.zwave_js.api.STATUS = "status"

Definition at line 125 of file api.py.

◆ STRATEGY

string homeassistant.components.zwave_js.api.STRATEGY = "strategy"

Definition at line 176 of file api.py.

◆ SUPPORTED_PROTOCOLS

string homeassistant.components.zwave_js.api.SUPPORTED_PROTOCOLS = "supportedProtocols"

Definition at line 170 of file api.py.

◆ TYPE

string homeassistant.components.zwave_js.api.TYPE = "type"

Definition at line 107 of file api.py.

◆ UUID

string homeassistant.components.zwave_js.api.UUID = "uuid"

Definition at line 169 of file api.py.

◆ VALUE

string homeassistant.components.zwave_js.api.VALUE = "value"

Definition at line 111 of file api.py.

◆ VALUE_FORMAT

string homeassistant.components.zwave_js.api.VALUE_FORMAT = "value_format"

Definition at line 113 of file api.py.

◆ VALUE_ID

string homeassistant.components.zwave_js.api.VALUE_ID = "value_id"

Definition at line 124 of file api.py.

◆ VALUE_SIZE

string homeassistant.components.zwave_js.api.VALUE_SIZE = "value_size"

Definition at line 112 of file api.py.

◆ VERSION

string homeassistant.components.zwave_js.api.VERSION = "version"

Definition at line 160 of file api.py.