homeassistant.components.isy994.services Namespace Reference

Functions
dict[str, Entity]	async_get_entities (HomeAssistant hass)
None	async_setup_services (HomeAssistant hass)
None	async_unload_services (HomeAssistant hass)
str	valid_isy_commands (Any value)

Variables
string	CONF_CODE = "code"
string	CONF_INIT = "init"
string	CONF_ISY = "isy"
string	CONF_PARAMETER = "parameter"
string	CONF_PARAMETERS = "parameters"
string	CONF_SIZE = "size"
string	CONF_USER_NUM = "user_num"
string	CONF_VALUE = "value"
string	SCHEMA_GROUP = "name-address"
string	SERVICE_DELETE_ZWAVE_LOCK_USER_CODE = "delete_zwave_lock_user_code"
string	SERVICE_GET_ZWAVE_PARAMETER = "get_zwave_parameter"
dictionary	SERVICE_GET_ZWAVE_PARAMETER_SCHEMA = {vol.Required(CONF_PARAMETER): vol.Coerce(int)}
string	SERVICE_RENAME_NODE = "rename_node"
dictionary	SERVICE_RENAME_NODE_SCHEMA = {vol.Required(CONF_NAME): cv.string}
string	SERVICE_SEND_NODE_COMMAND = "send_node_command"
dictionary	SERVICE_SEND_NODE_COMMAND_SCHEMA
string	SERVICE_SEND_PROGRAM_COMMAND = "send_program_command"
	SERVICE_SEND_PROGRAM_COMMAND_SCHEMA
string	SERVICE_SEND_RAW_NODE_COMMAND = "send_raw_node_command"
dictionary	SERVICE_SEND_RAW_NODE_COMMAND_SCHEMA
string	SERVICE_SET_ZWAVE_LOCK_USER_CODE = "set_zwave_lock_user_code"
string	SERVICE_SET_ZWAVE_PARAMETER = "set_zwave_parameter"
dictionary	SERVICE_SET_ZWAVE_PARAMETER_SCHEMA
list	VALID_NODE_COMMANDS
list	VALID_PARAMETER_SIZES = [1, 2, 4]
list	VALID_PROGRAM_COMMANDS
	VolDictType

Detailed Description

ISY Services and Commands.

Function Documentation

async_get_entities()

dict[str, Entity] homeassistant.components.isy994.services.async_get_entities

(

HomeAssistant

hass

)

Get entities for a domain.

Definition at line 128 of file services.py.

async_setup_services()

None homeassistant.components.isy994.services.async_setup_services

(

HomeAssistant

hass

)

Create and register services for the ISY integration.

Definition at line 137 of file services.py.

async_unload_services()

None homeassistant.components.isy994.services.async_unload_services

(

HomeAssistant

hass

)

Unload services for the ISY integration.

Definition at line 235 of file services.py.

valid_isy_commands()

str homeassistant.components.isy994.services.valid_isy_commands

(

Any

value

)

Validate the command is valid.

Definition at line 74 of file services.py.

Variable Documentation

CONF_CODE

string homeassistant.components.isy994.services.CONF_CODE = "code"

Definition at line 42 of file services.py.

CONF_INIT

string homeassistant.components.isy994.services.CONF_INIT = "init"

Definition at line 44 of file services.py.

CONF_ISY

string homeassistant.components.isy994.services.CONF_ISY = "isy"

Definition at line 45 of file services.py.

CONF_PARAMETER

string homeassistant.components.isy994.services.CONF_PARAMETER = "parameter"

Definition at line 39 of file services.py.

CONF_PARAMETERS

string homeassistant.components.isy994.services.CONF_PARAMETERS = "parameters"

Definition at line 40 of file services.py.

CONF_SIZE

string homeassistant.components.isy994.services.CONF_SIZE = "size"

Definition at line 46 of file services.py.

CONF_USER_NUM

string homeassistant.components.isy994.services.CONF_USER_NUM = "user_num"

Definition at line 41 of file services.py.

CONF_VALUE

string homeassistant.components.isy994.services.CONF_VALUE = "value"

Definition at line 43 of file services.py.

SCHEMA_GROUP

string homeassistant.components.isy994.services.SCHEMA_GROUP = "name-address"

Definition at line 83 of file services.py.

SERVICE_DELETE_ZWAVE_LOCK_USER_CODE

string homeassistant.components.isy994.services.SERVICE_DELETE_ZWAVE_LOCK_USER_CODE = "delete_zwave_lock_user_code"

Definition at line 37 of file services.py.

SERVICE_GET_ZWAVE_PARAMETER

string homeassistant.components.isy994.services.SERVICE_GET_ZWAVE_PARAMETER = "get_zwave_parameter"

Definition at line 31 of file services.py.

SERVICE_GET_ZWAVE_PARAMETER_SCHEMA

dictionary homeassistant.components.isy994.services.SERVICE_GET_ZWAVE_PARAMETER_SCHEMA = {vol.Required(CONF_PARAMETER): vol.Coerce(int)}

Definition at line 98 of file services.py.

SERVICE_RENAME_NODE

string homeassistant.components.isy994.services.SERVICE_RENAME_NODE = "rename_node"

Definition at line 33 of file services.py.

SERVICE_RENAME_NODE_SCHEMA

dictionary homeassistant.components.isy994.services.SERVICE_RENAME_NODE_SCHEMA = {vol.Required(CONF_NAME): cv.string}

Definition at line 96 of file services.py.

SERVICE_SEND_NODE_COMMAND

string homeassistant.components.isy994.services.SERVICE_SEND_NODE_COMMAND = "send_node_command"

Definition at line 30 of file services.py.

SERVICE_SEND_NODE_COMMAND_SCHEMA

dictionary homeassistant.components.isy994.services.SERVICE_SEND_NODE_COMMAND_SCHEMA

Initial value:

=  {
    vol.Required(CONF_COMMAND): vol.In(VALID_NODE_COMMANDS)
}

Definition at line 92 of file services.py.

SERVICE_SEND_PROGRAM_COMMAND

string homeassistant.components.isy994.services.SERVICE_SEND_PROGRAM_COMMAND = "send_program_command"

Definition at line 26 of file services.py.

SERVICE_SEND_PROGRAM_COMMAND_SCHEMA

homeassistant.components.isy994.services.SERVICE_SEND_PROGRAM_COMMAND_SCHEMA

Initial value:

=  vol.All(
    cv.has_at_least_one_key(CONF_ADDRESS, CONF_NAME),
    vol.Schema(
        {
            vol.Exclusive(CONF_NAME, SCHEMA_GROUP): cv.string,
            vol.Exclusive(CONF_ADDRESS, SCHEMA_GROUP): cv.string,
            vol.Required(CONF_COMMAND): vol.In(VALID_PROGRAM_COMMANDS),
            vol.Optional(CONF_ISY): cv.string,
        }
    ),
)

Definition at line 115 of file services.py.

SERVICE_SEND_RAW_NODE_COMMAND

string homeassistant.components.isy994.services.SERVICE_SEND_RAW_NODE_COMMAND = "send_raw_node_command"

Definition at line 29 of file services.py.

SERVICE_SEND_RAW_NODE_COMMAND_SCHEMA

dictionary homeassistant.components.isy994.services.SERVICE_SEND_RAW_NODE_COMMAND_SCHEMA

Initial value:

=  {
    vol.Required(CONF_COMMAND): vol.All(cv.string, valid_isy_commands),
    vol.Optional(CONF_VALUE): vol.All(vol.Coerce(int), vol.Range(0, 255)),
    vol.Optional(CONF_UNIT_OF_MEASUREMENT): vol.All(vol.Coerce(int), vol.Range(0, 120)),
    vol.Optional(CONF_PARAMETERS, default={}): {cv.string: cv.string},
}

Definition at line 85 of file services.py.

SERVICE_SET_ZWAVE_LOCK_USER_CODE

string homeassistant.components.isy994.services.SERVICE_SET_ZWAVE_LOCK_USER_CODE = "set_zwave_lock_user_code"

Definition at line 36 of file services.py.

SERVICE_SET_ZWAVE_PARAMETER

string homeassistant.components.isy994.services.SERVICE_SET_ZWAVE_PARAMETER = "set_zwave_parameter"

Definition at line 32 of file services.py.

SERVICE_SET_ZWAVE_PARAMETER_SCHEMA

dictionary homeassistant.components.isy994.services.SERVICE_SET_ZWAVE_PARAMETER_SCHEMA

Initial value:

=  {
    vol.Required(CONF_PARAMETER): vol.Coerce(int),
    vol.Required(CONF_VALUE): vol.Coerce(int),
    vol.Required(CONF_SIZE): vol.All(vol.Coerce(int), vol.In(VALID_PARAMETER_SIZES)),
}

Definition at line 100 of file services.py.

VALID_NODE_COMMANDS

list homeassistant.components.isy994.services.VALID_NODE_COMMANDS

Initial value:

=  [
    "beep",
    "brighten",
    "dim",
    "disable",
    "enable",
    "fade_down",
    "fade_stop",
    "fade_up",
    "fast_off",
    "fast_on",
    "query",
]

Definition at line 48 of file services.py.

VALID_PARAMETER_SIZES

list homeassistant.components.isy994.services.VALID_PARAMETER_SIZES = [1, 2, 4]

Definition at line 71 of file services.py.

VALID_PROGRAM_COMMANDS

list homeassistant.components.isy994.services.VALID_PROGRAM_COMMANDS

Initial value:

=  [
    "run",
    "run_then",
    "run_else",
    "stop",
    "enable",
    "disable",
    "enable_run_at_startup",
    "disable_run_at_startup",
]

Definition at line 61 of file services.py.

VolDictType

homeassistant.components.isy994.services.VolDictType

Definition at line 106 of file services.py.