homeassistant.components.knx.services Namespace Reference

Functions
KNXModule	get_knx_module (HomeAssistant hass)
None	register_knx_services (HomeAssistant hass)
None	service_event_register_modify (HomeAssistant hass, ServiceCall call)
None	service_exposure_register_modify (HomeAssistant hass, ServiceCall call)
None	service_read_to_knx_bus (HomeAssistant hass, ServiceCall call)
None	service_reload_integration (HomeAssistant hass, ServiceCall call)
None	service_send_to_knx_bus (HomeAssistant hass, ServiceCall call)

Variables
	_LOGGER = logging.getLogger(__name__)
	SERVICE_KNX_EVENT_REGISTER_SCHEMA
	SERVICE_KNX_EXPOSURE_REGISTER_SCHEMA
	SERVICE_KNX_READ_SCHEMA
	SERVICE_KNX_SEND_SCHEMA

Detailed Description

KNX integration services.

Function Documentation

get_knx_module()

KNXModule homeassistant.components.knx.services.get_knx_module

(

HomeAssistant

hass

)

Return KNXModule instance.

Definition at line 86 of file services.py.

register_knx_services()

None homeassistant.components.knx.services.register_knx_services

(

HomeAssistant

hass

)

Register KNX integration services.

Definition at line 45 of file services.py.

service_event_register_modify()

None homeassistant.components.knx.services.service_event_register_modify	(	HomeAssistant	hass,
		ServiceCall	call
	)

Service for adding or removing a GroupAddress to the knx_event filter.

Definition at line 106 of file services.py.

service_exposure_register_modify()

None homeassistant.components.knx.services.service_exposure_register_modify	(	HomeAssistant	hass,
		ServiceCall	call
	)

Service for adding or removing an exposure to KNX bus.

Definition at line 159 of file services.py.

service_read_to_knx_bus()

None homeassistant.components.knx.services.service_read_to_knx_bus	(	HomeAssistant	hass,
		ServiceCall	call
	)

Service for sending a GroupValueRead telegram to the KNX bus.

Definition at line 274 of file services.py.

service_reload_integration()

None homeassistant.components.knx.services.service_reload_integration	(	HomeAssistant	hass,
		ServiceCall	call
	)

Reload the integration.

Definition at line 287 of file services.py.

service_send_to_knx_bus()

None homeassistant.components.knx.services.service_send_to_knx_bus	(	HomeAssistant	hass,
		ServiceCall	call
	)

Service for sending an arbitrary KNX message to the KNX bus.

Definition at line 226 of file services.py.

Variable Documentation

_LOGGER

homeassistant.components.knx.services._LOGGER = logging.getLogger(__name__)

private

Definition at line 41 of file services.py.

SERVICE_KNX_EVENT_REGISTER_SCHEMA

homeassistant.components.knx.services.SERVICE_KNX_EVENT_REGISTER_SCHEMA

Initial value:

=  vol.Schema(
    {
        vol.Required(KNX_ADDRESS): vol.All(
            cv.ensure_list,
            [ga_validator],
        ),
        vol.Optional(CONF_TYPE): dpt_base_type_validator,
        vol.Optional(SERVICE_KNX_ATTR_REMOVE, default=False): cv.boolean,
    }
)

Definition at line 94 of file services.py.

SERVICE_KNX_EXPOSURE_REGISTER_SCHEMA

homeassistant.components.knx.services.SERVICE_KNX_EXPOSURE_REGISTER_SCHEMA

Initial value:

=  vol.Any(
    ExposeSchema.EXPOSE_SENSOR_SCHEMA.extend(
        {
            vol.Optional(SERVICE_KNX_ATTR_REMOVE, default=False): cv.boolean,
        }
    ),
    vol.Schema(
        # for removing only `address` is required
        {
            vol.Required(KNX_ADDRESS): ga_validator,
            vol.Required(SERVICE_KNX_ATTR_REMOVE): vol.All(cv.boolean, True),
        },
        extra=vol.ALLOW_EXTRA,
    ),
)

Definition at line 142 of file services.py.

SERVICE_KNX_READ_SCHEMA

homeassistant.components.knx.services.SERVICE_KNX_READ_SCHEMA

Initial value:

=  vol.Schema(
    {
        vol.Required(KNX_ADDRESS): vol.All(
            cv.ensure_list,
            [ga_validator],
        )
    }
)

Definition at line 264 of file services.py.

SERVICE_KNX_SEND_SCHEMA

homeassistant.components.knx.services.SERVICE_KNX_SEND_SCHEMA

Initial value:

=  vol.Any(
    vol.Schema(
        {
            vol.Required(KNX_ADDRESS): vol.All(
                cv.ensure_list,
                [ga_validator],
            ),
            vol.Required(SERVICE_KNX_ATTR_PAYLOAD): cv.match_all,
            vol.Required(SERVICE_KNX_ATTR_TYPE): dpt_base_type_validator,
            vol.Optional(SERVICE_KNX_ATTR_RESPONSE, default=False): cv.boolean,
        }
    ),
    vol.Schema(
        # without type given payload is treated as raw bytes
        {
            vol.Required(KNX_ADDRESS): vol.All(
                cv.ensure_list,
                [ga_validator],
            ),
            vol.Required(SERVICE_KNX_ATTR_PAYLOAD): vol.Any(
                cv.positive_int, [cv.positive_int]
            ),
            vol.Optional(SERVICE_KNX_ATTR_RESPONSE, default=False): cv.boolean,
        }
    ),
)

Definition at line 198 of file services.py.