Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.deconz.services Namespace Reference

Functions

None async_configure_service (DeconzHub hub, ReadOnlyDict data)
 
None async_refresh_devices_service (DeconzHub hub)
 
None async_remove_orphaned_entries_service (DeconzHub hub)
 
None async_setup_services (HomeAssistant hass)
 

Variables

string DECONZ_SERVICES = "deconz_services"
 
 SELECT_GATEWAY_SCHEMA = vol.All(vol.Schema({vol.Optional(CONF_BRIDGE_ID): str}))
 
string SERVICE_CONFIGURE_DEVICE = "configure"
 
 SERVICE_CONFIGURE_DEVICE_SCHEMA
 
string SERVICE_DATA = "data"
 
string SERVICE_DEVICE_REFRESH = "device_refresh"
 
string SERVICE_ENTITY = "entity"
 
string SERVICE_FIELD = "field"
 
string SERVICE_REMOVE_ORPHANED_ENTRIES = "remove_orphaned_entries"
 
dictionary SERVICE_TO_SCHEMA
 
tuple SUPPORTED_SERVICES
 

Detailed Description

deCONZ services.

Function Documentation

◆ async_configure_service()

None homeassistant.components.deconz.services.async_configure_service ( DeconzHub  hub,
ReadOnlyDict  data 
)
Set attribute of device in deCONZ.

Entity is used to resolve to a device path (e.g. '/lights/1').
Field is a string representing either a full path
(e.g. '/lights/1/state') when entity is not specified, or a
subpath (e.g. '/state') when used together with entity.
Data is a json object with what data you want to alter
e.g. data={'on': true}.
{
    "field": "/lights/1/state",
    "data": {"on": true}
}
See Dresden Elektroniks REST API documentation for details:
http://dresden-elektronik.github.io/deconz-rest-doc/rest/

Definition at line 102 of file services.py.

◆ async_refresh_devices_service()

None homeassistant.components.deconz.services.async_refresh_devices_service ( DeconzHub  hub)
Refresh available devices from deCONZ.

Definition at line 132 of file services.py.

◆ async_remove_orphaned_entries_service()

None homeassistant.components.deconz.services.async_remove_orphaned_entries_service ( DeconzHub  hub)
Remove orphaned deCONZ entries from device and entity registries.

Definition at line 140 of file services.py.

◆ async_setup_services()

None homeassistant.components.deconz.services.async_setup_services ( HomeAssistant  hass)
Set up services for deCONZ integration.

Definition at line 56 of file services.py.

Variable Documentation

◆ DECONZ_SERVICES

string homeassistant.components.deconz.services.DECONZ_SERVICES = "deconz_services"

Definition at line 19 of file services.py.

◆ SELECT_GATEWAY_SCHEMA

homeassistant.components.deconz.services.SELECT_GATEWAY_SCHEMA = vol.All(vol.Schema({vol.Optional(CONF_BRIDGE_ID): str}))

Definition at line 40 of file services.py.

◆ SERVICE_CONFIGURE_DEVICE

string homeassistant.components.deconz.services.SERVICE_CONFIGURE_DEVICE = "configure"

Definition at line 25 of file services.py.

◆ SERVICE_CONFIGURE_DEVICE_SCHEMA

homeassistant.components.deconz.services.SERVICE_CONFIGURE_DEVICE_SCHEMA
Initial value:
1 = vol.All(
2  vol.Schema(
3  {
4  vol.Optional(SERVICE_ENTITY): cv.entity_id,
5  vol.Optional(SERVICE_FIELD): cv.matches_regex("/.*"),
6  vol.Required(SERVICE_DATA): dict,
7  vol.Optional(CONF_BRIDGE_ID): str,
8  }
9  ),
10  cv.has_at_least_one_key(SERVICE_ENTITY, SERVICE_FIELD),
11 )

Definition at line 26 of file services.py.

◆ SERVICE_DATA

string homeassistant.components.deconz.services.SERVICE_DATA = "data"

Definition at line 23 of file services.py.

◆ SERVICE_DEVICE_REFRESH

string homeassistant.components.deconz.services.SERVICE_DEVICE_REFRESH = "device_refresh"

Definition at line 38 of file services.py.

◆ SERVICE_ENTITY

string homeassistant.components.deconz.services.SERVICE_ENTITY = "entity"

Definition at line 22 of file services.py.

◆ SERVICE_FIELD

string homeassistant.components.deconz.services.SERVICE_FIELD = "field"

Definition at line 21 of file services.py.

◆ SERVICE_REMOVE_ORPHANED_ENTRIES

string homeassistant.components.deconz.services.SERVICE_REMOVE_ORPHANED_ENTRIES = "remove_orphaned_entries"

Definition at line 39 of file services.py.

◆ SERVICE_TO_SCHEMA

dictionary homeassistant.components.deconz.services.SERVICE_TO_SCHEMA
Initial value:
1 = {
2  SERVICE_CONFIGURE_DEVICE: SERVICE_CONFIGURE_DEVICE_SCHEMA,
3  SERVICE_DEVICE_REFRESH: SELECT_GATEWAY_SCHEMA,
4  SERVICE_REMOVE_ORPHANED_ENTRIES: SELECT_GATEWAY_SCHEMA,
5 }

Definition at line 48 of file services.py.

◆ SUPPORTED_SERVICES

tuple homeassistant.components.deconz.services.SUPPORTED_SERVICES
Initial value:
1 = (
2  SERVICE_CONFIGURE_DEVICE,
3  SERVICE_DEVICE_REFRESH,
4  SERVICE_REMOVE_ORPHANED_ENTRIES,
5 )

Definition at line 42 of file services.py.