Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.zwave_js Namespace Reference

Namespaces

 addon
 
 api
 
 binary_sensor
 
 button
 
 climate
 
 config_flow
 
 config_validation
 
 const
 
 cover
 
 device_action
 
 device_automation_helpers
 
 device_condition
 
 device_trigger
 
 diagnostics
 
 discovery
 
 discovery_data_template
 
 entity
 
 event
 
 fan
 
 helpers
 
 humidifier
 
 light
 
 lock
 
 logbook
 
 migrate
 
 number
 
 repairs
 
 scripts
 
 select
 
 sensor
 
 services
 
 siren
 
 switch
 
 trigger
 
 triggers
 
 update
 

Classes

class  ControllerEvents
 
class  DriverEvents
 
class  NodeEvents
 

Functions

AddonManager _get_addon_manager (HomeAssistant hass)
 
None async_ensure_addon_running (HomeAssistant hass, ConfigEntry entry)
 
bool async_remove_config_entry_device (HomeAssistant hass, ConfigEntry config_entry, dr.DeviceEntry device_entry)
 
None async_remove_entry (HomeAssistant hass, ConfigEntry entry)
 
bool async_setup (HomeAssistant hass, ConfigType config)
 
bool async_setup_entry (HomeAssistant hass, ConfigEntry entry)
 
bool async_unload_entry (HomeAssistant hass, ConfigEntry entry)
 
None client_listen (HomeAssistant hass, ConfigEntry entry, ZwaveClient client, asyncio.Event driver_ready)
 
None disconnect_client (HomeAssistant hass, ConfigEntry entry)
 
None start_client (HomeAssistant hass, ConfigEntry entry, ZwaveClient client)
 

Variables

 CONFIG_SCHEMA
 
int CONNECT_TIMEOUT = 10
 
string DATA_CLIENT_LISTEN_TASK = "client_listen_task"
 
string DATA_DRIVER_EVENTS = "driver_events"
 
string DATA_START_CLIENT_TASK = "start_client_task"
 

Detailed Description

The Z-Wave JS integration.

Function Documentation

◆ _get_addon_manager()

AddonManager homeassistant.components.zwave_js._get_addon_manager ( HomeAssistant  hass)
private
Ensure that Z-Wave JS add-on is updated and running.

Definition at line 1145 of file __init__.py.

◆ async_ensure_addon_running()

None homeassistant.components.zwave_js.async_ensure_addon_running ( HomeAssistant  hass,
ConfigEntry  entry 
)
Ensure that Z-Wave JS add-on is installed and running.

Definition at line 1057 of file __init__.py.

◆ async_remove_config_entry_device()

bool homeassistant.components.zwave_js.async_remove_config_entry_device ( HomeAssistant  hass,
ConfigEntry  config_entry,
dr.DeviceEntry   device_entry 
)
Remove a config entry from a device.

Definition at line 1025 of file __init__.py.

◆ async_remove_entry()

None homeassistant.components.zwave_js.async_remove_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Remove a config entry.

Definition at line 1003 of file __init__.py.

◆ async_setup()

bool homeassistant.components.zwave_js.async_setup ( HomeAssistant  hass,
ConfigType  config 
)
Set up the Z-Wave JS component.

Definition at line 149 of file __init__.py.

◆ async_setup_entry()

bool homeassistant.components.zwave_js.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Set up Z-Wave JS from a config entry.

Definition at line 166 of file __init__.py.

◆ async_unload_entry()

bool homeassistant.components.zwave_js.async_unload_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Unload a config entry.

Definition at line 975 of file __init__.py.

◆ client_listen()

None homeassistant.components.zwave_js.client_listen ( HomeAssistant  hass,
ConfigEntry  entry,
ZwaveClient  client,
asyncio.Event  driver_ready 
)
Listen with the client.

Definition at line 926 of file __init__.py.

◆ disconnect_client()

None homeassistant.components.zwave_js.disconnect_client ( HomeAssistant  hass,
ConfigEntry  entry 
)
Disconnect client.

Definition at line 952 of file __init__.py.

◆ start_client()

None homeassistant.components.zwave_js.start_client ( HomeAssistant  hass,
ConfigEntry  entry,
ZwaveClient   client 
)
Start listening with the client.

Definition at line 213 of file __init__.py.

Variable Documentation

◆ CONFIG_SCHEMA

homeassistant.components.zwave_js.CONFIG_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  DOMAIN: vol.Schema(
4  {
5  vol.Optional(CONF_INSTALLER_MODE, default=False): cv.boolean,
6  }
7  )
8  },
9  extra=vol.ALLOW_EXTRA,
10 )

Definition at line 137 of file __init__.py.

◆ CONNECT_TIMEOUT

int homeassistant.components.zwave_js.CONNECT_TIMEOUT = 10

Definition at line 132 of file __init__.py.

◆ DATA_CLIENT_LISTEN_TASK

string homeassistant.components.zwave_js.DATA_CLIENT_LISTEN_TASK = "client_listen_task"

Definition at line 133 of file __init__.py.

◆ DATA_DRIVER_EVENTS

string homeassistant.components.zwave_js.DATA_DRIVER_EVENTS = "driver_events"

Definition at line 134 of file __init__.py.

◆ DATA_START_CLIENT_TASK

string homeassistant.components.zwave_js.DATA_START_CLIENT_TASK = "start_client_task"

Definition at line 135 of file __init__.py.