homeassistant.components.insteon.api.properties Namespace Reference

Functions
def	_bool_schema (name)
def	_byte_schema (name)
def	_float_schema (name)
def	_list_schema (name, values)
def	_multi_select_schema (name, values)
def	_read_only_schema (name, value)
def	get_properties (Device device, show_advanced=False)
def	get_schema (prop, name, groups)
def	property_to_dict (prop)
def	update_property (device, prop_name, value)
None	websocket_change_properties_record (HomeAssistant hass, websocket_api.connection.ActiveConnection connection, dict[str, Any] msg)
None	websocket_get_properties (HomeAssistant hass, websocket_api.connection.ActiveConnection connection, dict[str, Any] msg)
None	websocket_load_properties (HomeAssistant hass, websocket_api.connection.ActiveConnection connection, dict[str, Any] msg)
None	websocket_reset_properties (HomeAssistant hass, websocket_api.connection.ActiveConnection connection, dict[str, Any] msg)
None	websocket_write_properties (HomeAssistant hass, websocket_api.connection.ActiveConnection connection, dict[str, Any] msg)

Variables
list	RAMP_RATE_LIST = [str(seconds) for seconds in RAMP_RATE_SECONDS]
	RAMP_RATE_SECONDS = list(dict.fromkeys(RAMP_RATES_SEC))
list	RELAY_MODES = [str(RelayMode(v)).lower() for v in list(RelayMode)]
string	SHOW_ADVANCED = "show_advanced"
list	TOGGLE_MODES = [str(ToggleMode(v)).lower() for v in list(ToggleMode)]

Detailed Description

Property update methods and schemas.

Function Documentation

_bool_schema()

def homeassistant.components.insteon.api.properties._bool_schema (   name )

private

Definition at line 45 of file properties.py.

_byte_schema()

def homeassistant.components.insteon.api.properties._byte_schema (   name )

private

Definition at line 49 of file properties.py.

_float_schema()

def homeassistant.components.insteon.api.properties._float_schema (   name )

private

Definition at line 53 of file properties.py.

_list_schema()

def homeassistant.components.insteon.api.properties._list_schema (   name,   values  )

private

Definition at line 57 of file properties.py.

_multi_select_schema()

def homeassistant.components.insteon.api.properties._multi_select_schema (   name,   values  )

private

Definition at line 64 of file properties.py.

_read_only_schema()

def homeassistant.components.insteon.api.properties._read_only_schema (   name,   value  )

private

Return a constant value schema.

Definition at line 71 of file properties.py.

get_properties()

def homeassistant.components.insteon.api.properties.get_properties	(	Device	device,
			show_advanced = False
	)

Get the properties of an Insteon device and return the records and schema.

Definition at line 101 of file properties.py.

get_schema()

def homeassistant.components.insteon.api.properties.get_schema	(		prop,
			name,
			groups
	)

Return the correct schema type.

Definition at line 76 of file properties.py.

property_to_dict()

def homeassistant.components.insteon.api.properties.property_to_dict

(

prop

)

Return a property data row.

Definition at line 136 of file properties.py.

update_property()

def homeassistant.components.insteon.api.properties.update_property	(		device,
			prop_name,
			value
	)

Update the value of a device property.

Definition at line 145 of file properties.py.

websocket_change_properties_record()

None homeassistant.components.insteon.api.properties.websocket_change_properties_record	(	HomeAssistant	hass,
		websocket_api.connection.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Add the default All-Link Database records for an Insteon device.

Definition at line 192 of file properties.py.

websocket_get_properties()

None homeassistant.components.insteon.api.properties.websocket_get_properties	(	HomeAssistant	hass,
		websocket_api.connection.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Add the default All-Link Database records for an Insteon device.

Definition at line 167 of file properties.py.

websocket_load_properties()

None homeassistant.components.insteon.api.properties.websocket_load_properties	(	HomeAssistant	hass,
		websocket_api.connection.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Add the default All-Link Database records for an Insteon device.

Definition at line 244 of file properties.py.

websocket_reset_properties()

None homeassistant.components.insteon.api.properties.websocket_reset_properties	(	HomeAssistant	hass,
		websocket_api.connection.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Add the default All-Link Database records for an Insteon device.

Definition at line 275 of file properties.py.

websocket_write_properties()

None homeassistant.components.insteon.api.properties.websocket_write_properties	(	HomeAssistant	hass,
		websocket_api.connection.ActiveConnection	connection,
		dict[str, Any]	msg
	)

Add the default All-Link Database records for an Insteon device.

Definition at line 214 of file properties.py.

Variable Documentation

RAMP_RATE_LIST

list homeassistant.components.insteon.api.properties.RAMP_RATE_LIST = [str(seconds) for seconds in RAMP_RATE_SECONDS]

Definition at line 40 of file properties.py.

RAMP_RATE_SECONDS

homeassistant.components.insteon.api.properties.RAMP_RATE_SECONDS = list(dict.fromkeys(RAMP_RATES_SEC))

Definition at line 38 of file properties.py.

RELAY_MODES

list homeassistant.components.insteon.api.properties.RELAY_MODES = [str(RelayMode(v)).lower() for v in list(RelayMode)]

Definition at line 42 of file properties.py.

SHOW_ADVANCED

string homeassistant.components.insteon.api.properties.SHOW_ADVANCED = "show_advanced"

Definition at line 37 of file properties.py.

TOGGLE_MODES

list homeassistant.components.insteon.api.properties.TOGGLE_MODES = [str(ToggleMode(v)).lower() for v in list(ToggleMode)]

Definition at line 41 of file properties.py.