Functions
None	_async_activate_eco_mode_with_duration (HomeAssistant hass, ServiceCall service)

None	_async_activate_eco_mode_with_period (HomeAssistant hass, ServiceCall service)

None	_async_activate_vacation (HomeAssistant hass, ServiceCall service)

None	_async_deactivate_eco_mode (HomeAssistant hass, ServiceCall service)

None	_async_deactivate_vacation (HomeAssistant hass, ServiceCall service)

None	_async_dump_hap_config (HomeAssistant hass, ServiceCall service)

def	_async_reset_energy_counter (HomeAssistant hass, ServiceCall service)

def	_async_set_home_cooling_mode (HomeAssistant hass, ServiceCall service)

AsyncHome\|None	_get_home (HomeAssistant hass, str hapid)

None	_set_active_climate_profile (HomeAssistant hass, ServiceCall service)

None	async_setup_services (HomeAssistant hass)

def	async_unload_services (HomeAssistant hass)

Variables
	_LOGGER = logging.getLogger(__name__)

string	ATTR_ACCESSPOINT_ID = "accesspoint_id"

string	ATTR_ANONYMIZE = "anonymize"

string	ATTR_CLIMATE_PROFILE_INDEX = "climate_profile_index"

string	ATTR_CONFIG_OUTPUT_FILE_PREFIX = "config_output_file_prefix"

string	ATTR_CONFIG_OUTPUT_PATH = "config_output_path"

string	ATTR_COOLING = "cooling"

string	ATTR_DURATION = "duration"

string	ATTR_ENDTIME = "endtime"

string	DEFAULT_CONFIG_FILE_PREFIX = "hmip-config"

list	HMIPC_SERVICES

	SCHEMA_ACTIVATE_ECO_MODE_WITH_DURATION

	SCHEMA_ACTIVATE_ECO_MODE_WITH_PERIOD

	SCHEMA_ACTIVATE_VACATION

	SCHEMA_DEACTIVATE_ECO_MODE

	SCHEMA_DEACTIVATE_VACATION

	SCHEMA_DUMP_HAP_CONFIG

	SCHEMA_RESET_ENERGY_COUNTER

	SCHEMA_SET_ACTIVE_CLIMATE_PROFILE

	SCHEMA_SET_HOME_COOLING_MODE

string	SERVICE_ACTIVATE_ECO_MODE_WITH_DURATION = "activate_eco_mode_with_duration"

string	SERVICE_ACTIVATE_ECO_MODE_WITH_PERIOD = "activate_eco_mode_with_period"

string	SERVICE_ACTIVATE_VACATION = "activate_vacation"

string	SERVICE_DEACTIVATE_ECO_MODE = "deactivate_eco_mode"

string	SERVICE_DEACTIVATE_VACATION = "deactivate_vacation"

string	SERVICE_DUMP_HAP_CONFIG = "dump_hap_config"

string	SERVICE_RESET_ENERGY_COUNTER = "reset_energy_counter"

string	SERVICE_SET_ACTIVE_CLIMATE_PROFILE = "set_active_climate_profile"

string	SERVICE_SET_HOME_COOLING_MODE = "set_home_cooling_mode"

Detailed Description

Support for HomematicIP Cloud devices.

Function Documentation

◆ _async_activate_eco_mode_with_duration()

None homeassistant.components.homematicip_cloud.services._async_activate_eco_mode_with_duration	(	HomeAssistant	hass,
		ServiceCall	service
	)

private

Service to activate eco mode with duration.

Definition at line 228 of file services.py.

◆ _async_activate_eco_mode_with_period()

None homeassistant.components.homematicip_cloud.services._async_activate_eco_mode_with_period	(	HomeAssistant	hass,
		ServiceCall	service
	)

private

Service to activate eco mode with period.

Definition at line 242 of file services.py.

◆ _async_activate_vacation()

None homeassistant.components.homematicip_cloud.services._async_activate_vacation	(	HomeAssistant	hass,
		ServiceCall	service
	)

private

Service to activate vacation.

Definition at line 256 of file services.py.

◆ _async_deactivate_eco_mode()

None homeassistant.components.homematicip_cloud.services._async_deactivate_eco_mode	(	HomeAssistant	hass,
		ServiceCall	service
	)

private

Service to deactivate eco mode.

Definition at line 269 of file services.py.

◆ _async_deactivate_vacation()

None homeassistant.components.homematicip_cloud.services._async_deactivate_vacation	(	HomeAssistant	hass,
		ServiceCall	service
	)

private

Service to deactivate vacation.

Definition at line 279 of file services.py.

◆ _async_dump_hap_config()

None homeassistant.components.homematicip_cloud.services._async_dump_hap_config	(	HomeAssistant	hass,
		ServiceCall	service
	)

private

Service to dump the configuration of a Homematic IP Access Point.

Definition at line 308 of file services.py.

◆ _async_reset_energy_counter()

def homeassistant.components.homematicip_cloud.services._async_reset_energy_counter	(	HomeAssistant	hass,
		ServiceCall	service
	)

private

Service to reset the energy counter.

Definition at line 332 of file services.py.

◆ _async_set_home_cooling_mode()

def homeassistant.components.homematicip_cloud.services._async_set_home_cooling_mode	(	HomeAssistant	hass,
		ServiceCall	service
	)

private

Service to set the cooling mode.

Definition at line 348 of file services.py.

◆ _get_home()

AsyncHome \| None homeassistant.components.homematicip_cloud.services._get_home	(	HomeAssistant	hass,
		str	hapid
	)

private

Return a HmIP home.

Definition at line 360 of file services.py.

◆ _set_active_climate_profile()

None homeassistant.components.homematicip_cloud.services._set_active_climate_profile	(	HomeAssistant	hass,
		ServiceCall	service
	)

private

Service to set the active climate profile.

Definition at line 289 of file services.py.

◆ async_setup_services()

None homeassistant.components.homematicip_cloud.services.async_setup_services ( HomeAssistant hass )

Set up the HomematicIP Cloud services.

Definition at line 122 of file services.py.

◆ async_unload_services()

def homeassistant.components.homematicip_cloud.services.async_unload_services ( HomeAssistant hass )

Unload HomematicIP Cloud services.

Definition at line 219 of file services.py.

Variable Documentation

◆ _LOGGER

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

private

Definition at line 26 of file services.py.

◆ ATTR_ACCESSPOINT_ID

string homeassistant.components.homematicip_cloud.services.ATTR_ACCESSPOINT_ID = "accesspoint_id"

Definition at line 28 of file services.py.

◆ ATTR_ANONYMIZE

string homeassistant.components.homematicip_cloud.services.ATTR_ANONYMIZE = "anonymize"

Definition at line 29 of file services.py.

◆ ATTR_CLIMATE_PROFILE_INDEX

string homeassistant.components.homematicip_cloud.services.ATTR_CLIMATE_PROFILE_INDEX = "climate_profile_index"

Definition at line 30 of file services.py.

◆ ATTR_CONFIG_OUTPUT_FILE_PREFIX

string homeassistant.components.homematicip_cloud.services.ATTR_CONFIG_OUTPUT_FILE_PREFIX = "config_output_file_prefix"

Definition at line 31 of file services.py.

◆ ATTR_CONFIG_OUTPUT_PATH

string homeassistant.components.homematicip_cloud.services.ATTR_CONFIG_OUTPUT_PATH = "config_output_path"

Definition at line 32 of file services.py.

◆ ATTR_COOLING

string homeassistant.components.homematicip_cloud.services.ATTR_COOLING = "cooling"

Definition at line 35 of file services.py.

◆ ATTR_DURATION

string homeassistant.components.homematicip_cloud.services.ATTR_DURATION = "duration"

Definition at line 33 of file services.py.

◆ ATTR_ENDTIME

string homeassistant.components.homematicip_cloud.services.ATTR_ENDTIME = "endtime"

Definition at line 34 of file services.py.

◆ DEFAULT_CONFIG_FILE_PREFIX

string homeassistant.components.homematicip_cloud.services.DEFAULT_CONFIG_FILE_PREFIX = "hmip-config"

Definition at line 37 of file services.py.

◆ HMIPC_SERVICES

list homeassistant.components.homematicip_cloud.services.HMIPC_SERVICES

Initial value:

 =  [
     SERVICE_ACTIVATE_ECO_MODE_WITH_DURATION,
     SERVICE_ACTIVATE_ECO_MODE_WITH_PERIOD,
     SERVICE_ACTIVATE_VACATION,
     SERVICE_DEACTIVATE_ECO_MODE,
     SERVICE_DEACTIVATE_VACATION,
     SERVICE_DUMP_HAP_CONFIG,
     SERVICE_RESET_ENERGY_COUNTER,
     SERVICE_SET_ACTIVE_CLIMATE_PROFILE,
     SERVICE_SET_HOME_COOLING_MODE,
 ]

Definition at line 49 of file services.py.

◆ SCHEMA_ACTIVATE_ECO_MODE_WITH_DURATION

homeassistant.components.homematicip_cloud.services.SCHEMA_ACTIVATE_ECO_MODE_WITH_DURATION

Initial value:

 =  vol.Schema(
     {
         vol.Required(ATTR_DURATION): cv.positive_int,
         vol.Optional(ATTR_ACCESSPOINT_ID): vol.All(str, vol.Length(min=24, max=24)),
     }
 )

Definition at line 61 of file services.py.

◆ SCHEMA_ACTIVATE_ECO_MODE_WITH_PERIOD

homeassistant.components.homematicip_cloud.services.SCHEMA_ACTIVATE_ECO_MODE_WITH_PERIOD

Initial value:

 =  vol.Schema(
     {
         vol.Required(ATTR_ENDTIME): cv.datetime,
         vol.Optional(ATTR_ACCESSPOINT_ID): vol.All(str, vol.Length(min=24, max=24)),
     }
 )

Definition at line 68 of file services.py.

◆ SCHEMA_ACTIVATE_VACATION

homeassistant.components.homematicip_cloud.services.SCHEMA_ACTIVATE_VACATION

Initial value:

 =  vol.Schema(
     {
         vol.Required(ATTR_ENDTIME): cv.datetime,
         vol.Required(ATTR_TEMPERATURE, default=18.0): vol.All(
             vol.Coerce(float), vol.Range(min=0, max=55)
         ),
         vol.Optional(ATTR_ACCESSPOINT_ID): vol.All(str, vol.Length(min=24, max=24)),
     }
 )

Definition at line 75 of file services.py.

◆ SCHEMA_DEACTIVATE_ECO_MODE

homeassistant.components.homematicip_cloud.services.SCHEMA_DEACTIVATE_ECO_MODE

Initial value:

 =  vol.Schema(
     {vol.Optional(ATTR_ACCESSPOINT_ID): vol.All(str, vol.Length(min=24, max=24))}
 )

Definition at line 85 of file services.py.

◆ SCHEMA_DEACTIVATE_VACATION

homeassistant.components.homematicip_cloud.services.SCHEMA_DEACTIVATE_VACATION

Initial value:

 =  vol.Schema(
     {vol.Optional(ATTR_ACCESSPOINT_ID): vol.All(str, vol.Length(min=24, max=24))}
 )

Definition at line 89 of file services.py.

◆ SCHEMA_DUMP_HAP_CONFIG

homeassistant.components.homematicip_cloud.services.SCHEMA_DUMP_HAP_CONFIG

Initial value:

 =  vol.Schema(
     {
         vol.Optional(ATTR_CONFIG_OUTPUT_PATH): cv.string,
         vol.Optional(
             ATTR_CONFIG_OUTPUT_FILE_PREFIX, default=DEFAULT_CONFIG_FILE_PREFIX
         ): cv.string,
         vol.Optional(ATTR_ANONYMIZE, default=True): cv.boolean,
     }
 )

Definition at line 100 of file services.py.

◆ SCHEMA_RESET_ENERGY_COUNTER

homeassistant.components.homematicip_cloud.services.SCHEMA_RESET_ENERGY_COUNTER

Initial value:

 =  vol.Schema(
     {vol.Required(ATTR_ENTITY_ID): comp_entity_ids}
 )

Definition at line 110 of file services.py.

◆ SCHEMA_SET_ACTIVE_CLIMATE_PROFILE

homeassistant.components.homematicip_cloud.services.SCHEMA_SET_ACTIVE_CLIMATE_PROFILE

Initial value:

 =  vol.Schema(
     {
         vol.Required(ATTR_ENTITY_ID): comp_entity_ids,
         vol.Required(ATTR_CLIMATE_PROFILE_INDEX): cv.positive_int,
     }
 )

Definition at line 93 of file services.py.

◆ SCHEMA_SET_HOME_COOLING_MODE

homeassistant.components.homematicip_cloud.services.SCHEMA_SET_HOME_COOLING_MODE

Initial value:

 =  vol.Schema(
     {
         vol.Optional(ATTR_COOLING, default=True): cv.boolean,
         vol.Optional(ATTR_ACCESSPOINT_ID): vol.All(str, vol.Length(min=24, max=24)),
     }
 )

Definition at line 114 of file services.py.

◆ SERVICE_ACTIVATE_ECO_MODE_WITH_DURATION

string homeassistant.components.homematicip_cloud.services.SERVICE_ACTIVATE_ECO_MODE_WITH_DURATION = "activate_eco_mode_with_duration"

Definition at line 39 of file services.py.

◆ SERVICE_ACTIVATE_ECO_MODE_WITH_PERIOD

string homeassistant.components.homematicip_cloud.services.SERVICE_ACTIVATE_ECO_MODE_WITH_PERIOD = "activate_eco_mode_with_period"

Definition at line 40 of file services.py.

◆ SERVICE_ACTIVATE_VACATION

string homeassistant.components.homematicip_cloud.services.SERVICE_ACTIVATE_VACATION = "activate_vacation"

Definition at line 41 of file services.py.

◆ SERVICE_DEACTIVATE_ECO_MODE

string homeassistant.components.homematicip_cloud.services.SERVICE_DEACTIVATE_ECO_MODE = "deactivate_eco_mode"

Definition at line 42 of file services.py.

◆ SERVICE_DEACTIVATE_VACATION

string homeassistant.components.homematicip_cloud.services.SERVICE_DEACTIVATE_VACATION = "deactivate_vacation"

Definition at line 43 of file services.py.

◆ SERVICE_DUMP_HAP_CONFIG

string homeassistant.components.homematicip_cloud.services.SERVICE_DUMP_HAP_CONFIG = "dump_hap_config"

Definition at line 44 of file services.py.

◆ SERVICE_RESET_ENERGY_COUNTER

string homeassistant.components.homematicip_cloud.services.SERVICE_RESET_ENERGY_COUNTER = "reset_energy_counter"

Definition at line 45 of file services.py.

◆ SERVICE_SET_ACTIVE_CLIMATE_PROFILE

string homeassistant.components.homematicip_cloud.services.SERVICE_SET_ACTIVE_CLIMATE_PROFILE = "set_active_climate_profile"

Definition at line 46 of file services.py.

◆ SERVICE_SET_HOME_COOLING_MODE

string homeassistant.components.homematicip_cloud.services.SERVICE_SET_HOME_COOLING_MODE = "set_home_cooling_mode"

Definition at line 47 of file services.py.

Home Assistant Unofficial Reference 2024.12.1

Functions

Variables

Detailed Description

Function Documentation

◆ _async_activate_eco_mode_with_duration()

◆ _async_activate_eco_mode_with_period()

◆ _async_activate_vacation()

◆ _async_deactivate_eco_mode()

◆ _async_deactivate_vacation()

◆ _async_dump_hap_config()

◆ _async_reset_energy_counter()

◆ _async_set_home_cooling_mode()

◆ _get_home()

◆ _set_active_climate_profile()

◆ async_setup_services()

◆ async_unload_services()

Variable Documentation

◆ _LOGGER

◆ ATTR_ACCESSPOINT_ID

◆ ATTR_ANONYMIZE

◆ ATTR_CLIMATE_PROFILE_INDEX

◆ ATTR_CONFIG_OUTPUT_FILE_PREFIX

◆ ATTR_CONFIG_OUTPUT_PATH

◆ ATTR_COOLING

◆ ATTR_DURATION

◆ ATTR_ENDTIME

◆ DEFAULT_CONFIG_FILE_PREFIX

◆ HMIPC_SERVICES

◆ SCHEMA_ACTIVATE_ECO_MODE_WITH_DURATION

◆ SCHEMA_ACTIVATE_ECO_MODE_WITH_PERIOD

◆ SCHEMA_ACTIVATE_VACATION

◆ SCHEMA_DEACTIVATE_ECO_MODE

◆ SCHEMA_DEACTIVATE_VACATION

◆ SCHEMA_DUMP_HAP_CONFIG

◆ SCHEMA_RESET_ENERGY_COUNTER

◆ SCHEMA_SET_ACTIVE_CLIMATE_PROFILE

◆ SCHEMA_SET_HOME_COOLING_MODE

◆ SERVICE_ACTIVATE_ECO_MODE_WITH_DURATION

◆ SERVICE_ACTIVATE_ECO_MODE_WITH_PERIOD

◆ SERVICE_ACTIVATE_VACATION

◆ SERVICE_DEACTIVATE_ECO_MODE

◆ SERVICE_DEACTIVATE_VACATION

◆ SERVICE_DUMP_HAP_CONFIG

◆ SERVICE_RESET_ENERGY_COUNTER

◆ SERVICE_SET_ACTIVE_CLIMATE_PROFILE

◆ SERVICE_SET_HOME_COOLING_MODE