Home Assistant Unofficial Reference 2024.12.1
Namespaces | Functions | Variables
homeassistant.components.homematic Namespace Reference

Namespaces

 binary_sensor
 
 climate
 
 const
 
 cover
 
 entity
 
 light
 
 lock
 
 notify
 
 sensor
 
 switch
 

Functions

def _create_ha_id (name, channel, param, count)
 
def _device_from_servicecall (hass, service)
 
def _get_devices (hass, discovery_type, keys, interface)
 
def _hm_event_handler (hass, interface, device, caller, attribute, value)
 
def _system_callback_handler (hass, config, src, *args)
 
bool setup (HomeAssistant hass, ConfigType config)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
 CONFIG_SCHEMA
 
int DEFAULT_CHANNEL = 1
 
int DEFAULT_JSONPORT = 80
 
string DEFAULT_LOCAL_IP = "0.0.0.0"
 
int DEFAULT_LOCAL_PORT = 0
 
string DEFAULT_PASSWORD = ""
 
string DEFAULT_PATH = ""
 
int DEFAULT_PORT = 2001
 
bool DEFAULT_RESOLVENAMES = False
 
bool DEFAULT_SSL = False
 
string DEFAULT_USERNAME = "Admin"
 
bool DEFAULT_VERIFY_SSL = False
 
 DEVICE_SCHEMA
 
 SCHEMA_SERVICE_PUT_PARAMSET
 
 SCHEMA_SERVICE_RECONNECT = vol.Schema({})
 
 SCHEMA_SERVICE_SET_DEVICE_VALUE
 
 SCHEMA_SERVICE_SET_INSTALL_MODE
 
 SCHEMA_SERVICE_SET_VARIABLE_VALUE
 
 SCHEMA_SERVICE_VIRTUALKEY
 

Detailed Description

Support for HomeMatic devices.

Function Documentation

◆ _create_ha_id()

def homeassistant.components.homematic._create_ha_id (   name,
  channel,
  param,
  count 
)
private 
Generate a unique entity id.

Definition at line 558 of file __init__.py.

◆ _device_from_servicecall()

def homeassistant.components.homematic._device_from_servicecall (   hass,
  service 
)
private 
Extract HomeMatic device from service call.

Definition at line 611 of file __init__.py.

◆ _get_devices()

def homeassistant.components.homematic._get_devices (   hass,
  discovery_type,
  keys,
  interface 
)
private 
Get the HomeMatic devices for given discovery_type.

Definition at line 482 of file __init__.py.

◆ _hm_event_handler()

def homeassistant.components.homematic._hm_event_handler (   hass,
  interface,
  device,
  caller,
  attribute,
  value 
)
private 
Handle all pyhomematic device events.

Definition at line 579 of file __init__.py.

◆ _system_callback_handler()

def homeassistant.components.homematic._system_callback_handler (   hass,
  config,
  src,
*  args 
)
private 
System callback handler.

Definition at line 419 of file __init__.py.

◆ setup()

bool homeassistant.components.homematic.setup ( HomeAssistant  hass,
ConfigType  config 
) 
Set up the Homematic component.

Definition at line 213 of file __init__.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.homematic._LOGGER = logging.getLogger(__name__)
private

Definition at line 86 of file __init__.py.

◆ CONFIG_SCHEMA

homeassistant.components.homematic.CONFIG_SCHEMA

Definition at line 114 of file __init__.py.

◆ DEFAULT_CHANNEL

int homeassistant.components.homematic.DEFAULT_CHANNEL = 1

Definition at line 98 of file __init__.py.

◆ DEFAULT_JSONPORT

int homeassistant.components.homematic.DEFAULT_JSONPORT = 80

Definition at line 91 of file __init__.py.

◆ DEFAULT_LOCAL_IP

string homeassistant.components.homematic.DEFAULT_LOCAL_IP = "0.0.0.0"

Definition at line 88 of file __init__.py.

◆ DEFAULT_LOCAL_PORT

int homeassistant.components.homematic.DEFAULT_LOCAL_PORT = 0

Definition at line 89 of file __init__.py.

◆ DEFAULT_PASSWORD

string homeassistant.components.homematic.DEFAULT_PASSWORD = ""

Definition at line 95 of file __init__.py.

◆ DEFAULT_PATH

string homeassistant.components.homematic.DEFAULT_PATH = ""

Definition at line 93 of file __init__.py.

◆ DEFAULT_PORT

int homeassistant.components.homematic.DEFAULT_PORT = 2001

Definition at line 92 of file __init__.py.

◆ DEFAULT_RESOLVENAMES

bool homeassistant.components.homematic.DEFAULT_RESOLVENAMES = False

Definition at line 90 of file __init__.py.

◆ DEFAULT_SSL

bool homeassistant.components.homematic.DEFAULT_SSL = False

Definition at line 96 of file __init__.py.

◆ DEFAULT_USERNAME

string homeassistant.components.homematic.DEFAULT_USERNAME = "Admin"

Definition at line 94 of file __init__.py.

◆ DEFAULT_VERIFY_SSL

bool homeassistant.components.homematic.DEFAULT_VERIFY_SSL = False

Definition at line 97 of file __init__.py.

◆ DEVICE_SCHEMA

homeassistant.components.homematic.DEVICE_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Required(CONF_PLATFORM): "homematic",
4  vol.Required(ATTR_NAME): cv.string,
5  vol.Required(ATTR_ADDRESS): cv.string,
6  vol.Required(ATTR_INTERFACE): cv.string,
7  vol.Optional(ATTR_DEVICE_TYPE): cv.string,
8  vol.Optional(ATTR_CHANNEL, default=DEFAULT_CHANNEL): vol.Coerce(int),
9  vol.Optional(ATTR_PARAM): cv.string,
10  vol.Optional(ATTR_UNIQUE_ID): cv.string,
11  }
12 )

Definition at line 101 of file __init__.py.

◆ SCHEMA_SERVICE_PUT_PARAMSET

homeassistant.components.homematic.SCHEMA_SERVICE_PUT_PARAMSET
Initial value:
1 = vol.Schema(
2  {
3  vol.Required(ATTR_INTERFACE): cv.string,
4  vol.Required(ATTR_ADDRESS): vol.All(cv.string, vol.Upper),
5  vol.Required(ATTR_PARAMSET_KEY): vol.All(cv.string, vol.Upper),
6  vol.Required(ATTR_PARAMSET): dict,
7  vol.Optional(ATTR_RX_MODE): vol.All(cv.string, vol.Upper),
8  }
9 )

Definition at line 202 of file __init__.py.

◆ SCHEMA_SERVICE_RECONNECT

homeassistant.components.homematic.SCHEMA_SERVICE_RECONNECT = vol.Schema({})

Definition at line 191 of file __init__.py.

◆ SCHEMA_SERVICE_SET_DEVICE_VALUE

homeassistant.components.homematic.SCHEMA_SERVICE_SET_DEVICE_VALUE
Initial value:
1 = vol.Schema(
2  {
3  vol.Required(ATTR_ADDRESS): vol.All(cv.string, vol.Upper),
4  vol.Required(ATTR_CHANNEL): vol.Coerce(int),
5  vol.Required(ATTR_PARAM): vol.All(cv.string, vol.Upper),
6  vol.Required(ATTR_VALUE): cv.match_all,
7  vol.Optional(ATTR_VALUE_TYPE): vol.In(
8  ["boolean", "dateTime.iso8601", "double", "int", "string"]
9  ),
10  vol.Optional(ATTR_INTERFACE): cv.string,
11  }
12 )

Definition at line 178 of file __init__.py.

◆ SCHEMA_SERVICE_SET_INSTALL_MODE

homeassistant.components.homematic.SCHEMA_SERVICE_SET_INSTALL_MODE
Initial value:
1 = vol.Schema(
2  {
3  vol.Required(ATTR_INTERFACE): cv.string,
4  vol.Optional(ATTR_TIME, default=60): cv.positive_int,
5  vol.Optional(ATTR_MODE, default=1): vol.All(vol.Coerce(int), vol.In([1, 2])),
6  vol.Optional(ATTR_ADDRESS): vol.All(cv.string, vol.Upper),
7  }
8 )

Definition at line 193 of file __init__.py.

◆ SCHEMA_SERVICE_SET_VARIABLE_VALUE

homeassistant.components.homematic.SCHEMA_SERVICE_SET_VARIABLE_VALUE
Initial value:
1 = vol.Schema(
2  {
3  vol.Required(ATTR_NAME): cv.string,
4  vol.Required(ATTR_VALUE): cv.match_all,
5  vol.Optional(ATTR_ENTITY_ID): cv.entity_ids,
6  }
7 )

Definition at line 170 of file __init__.py.

◆ SCHEMA_SERVICE_VIRTUALKEY

homeassistant.components.homematic.SCHEMA_SERVICE_VIRTUALKEY
Initial value:
1 = vol.Schema(
2  {
3  vol.Required(ATTR_ADDRESS): vol.All(cv.string, vol.Upper),
4  vol.Required(ATTR_CHANNEL): vol.Coerce(int),
5  vol.Required(ATTR_PARAM): cv.string,
6  vol.Optional(ATTR_INTERFACE): cv.string,
7  }
8 )

Definition at line 161 of file __init__.py.