homeassistant.components.generic_hygrostat Namespace Reference

Namespaces
	config_flow
	humidifier

Functions
bool	async_setup (HomeAssistant hass, ConfigType config)
bool	async_setup_entry (HomeAssistant hass, ConfigEntry entry)
bool	async_unload_entry (HomeAssistant hass, ConfigEntry entry)
None	config_entry_update_listener (HomeAssistant hass, ConfigEntry entry)

Variables
string	CONF_AWAY_FIXED = "away_fixed"
string	CONF_AWAY_HUMIDITY = "away_humidity"
string	CONF_DEVICE_CLASS = "device_class"
string	CONF_DRY_TOLERANCE = "dry_tolerance"
string	CONF_HUMIDIFIER = "humidifier"
string	CONF_INITIAL_STATE = "initial_state"
string	CONF_KEEP_ALIVE = "keep_alive"
string	CONF_MAX_HUMIDITY = "max_humidity"
string	CONF_MIN_DUR = "min_cycle_duration"
string	CONF_MIN_HUMIDITY = "min_humidity"
string	CONF_SENSOR = "target_sensor"
string	CONF_STALE_DURATION = "sensor_stale_duration"
string	CONF_TARGET_HUMIDITY = "target_humidity"
string	CONF_WET_TOLERANCE = "wet_tolerance"
	CONFIG_SCHEMA
string	DEFAULT_NAME = "Generic Hygrostat"
int	DEFAULT_TOLERANCE = 3
string	DOMAIN = "generic_hygrostat"
	HYGROSTAT_SCHEMA

Detailed Description

The generic_hygrostat component.

Function Documentation

async_setup()

bool homeassistant.components.generic_hygrostat.async_setup	(	HomeAssistant	hass,
		ConfigType	config
	)

Set up the Generic Hygrostat component.

Definition at line 67 of file __init__.py.

async_setup_entry()

bool homeassistant.components.generic_hygrostat.async_setup_entry	(	HomeAssistant	hass,
		ConfigEntry	entry
	)

Set up from a config entry.

Definition at line 82 of file __init__.py.

async_unload_entry()

bool homeassistant.components.generic_hygrostat.async_unload_entry	(	HomeAssistant	hass,
		ConfigEntry	entry
	)

Unload a config entry.

Definition at line 101 of file __init__.py.

config_entry_update_listener()

None homeassistant.components.generic_hygrostat.config_entry_update_listener	(	HomeAssistant	hass,
		ConfigEntry	entry
	)

Update listener, called when the config entry options are changed.

Definition at line 96 of file __init__.py.

Variable Documentation

CONF_AWAY_FIXED

string homeassistant.components.generic_hygrostat.CONF_AWAY_FIXED = "away_fixed"

Definition at line 29 of file __init__.py.

CONF_AWAY_HUMIDITY

string homeassistant.components.generic_hygrostat.CONF_AWAY_HUMIDITY = "away_humidity"

Definition at line 28 of file __init__.py.

CONF_DEVICE_CLASS

string homeassistant.components.generic_hygrostat.CONF_DEVICE_CLASS = "device_class"

Definition at line 22 of file __init__.py.

CONF_DRY_TOLERANCE

string homeassistant.components.generic_hygrostat.CONF_DRY_TOLERANCE = "dry_tolerance"

Definition at line 24 of file __init__.py.

CONF_HUMIDIFIER

string homeassistant.components.generic_hygrostat.CONF_HUMIDIFIER = "humidifier"

Definition at line 17 of file __init__.py.

CONF_INITIAL_STATE

string homeassistant.components.generic_hygrostat.CONF_INITIAL_STATE = "initial_state"

Definition at line 27 of file __init__.py.

CONF_KEEP_ALIVE

string homeassistant.components.generic_hygrostat.CONF_KEEP_ALIVE = "keep_alive"

Definition at line 26 of file __init__.py.

CONF_MAX_HUMIDITY

string homeassistant.components.generic_hygrostat.CONF_MAX_HUMIDITY = "max_humidity"

Definition at line 20 of file __init__.py.

CONF_MIN_DUR

string homeassistant.components.generic_hygrostat.CONF_MIN_DUR = "min_cycle_duration"

Definition at line 23 of file __init__.py.

CONF_MIN_HUMIDITY

string homeassistant.components.generic_hygrostat.CONF_MIN_HUMIDITY = "min_humidity"

Definition at line 19 of file __init__.py.

CONF_SENSOR

string homeassistant.components.generic_hygrostat.CONF_SENSOR = "target_sensor"

Definition at line 18 of file __init__.py.

CONF_STALE_DURATION

string homeassistant.components.generic_hygrostat.CONF_STALE_DURATION = "sensor_stale_duration"

Definition at line 30 of file __init__.py.

CONF_TARGET_HUMIDITY

string homeassistant.components.generic_hygrostat.CONF_TARGET_HUMIDITY = "target_humidity"

Definition at line 21 of file __init__.py.

CONF_WET_TOLERANCE

string homeassistant.components.generic_hygrostat.CONF_WET_TOLERANCE = "wet_tolerance"

Definition at line 25 of file __init__.py.

CONFIG_SCHEMA

homeassistant.components.generic_hygrostat.CONFIG_SCHEMA

Initial value:

=  vol.Schema(
    {DOMAIN: vol.All(cv.ensure_list, [HYGROSTAT_SCHEMA])},
    extra=vol.ALLOW_EXTRA,
)

Definition at line 61 of file __init__.py.

DEFAULT_NAME

string homeassistant.components.generic_hygrostat.DEFAULT_NAME = "Generic Hygrostat"

Definition at line 34 of file __init__.py.

DEFAULT_TOLERANCE

int homeassistant.components.generic_hygrostat.DEFAULT_TOLERANCE = 3

Definition at line 33 of file __init__.py.

DOMAIN

string homeassistant.components.generic_hygrostat.DOMAIN = "generic_hygrostat"

Definition at line 15 of file __init__.py.

HYGROSTAT_SCHEMA

homeassistant.components.generic_hygrostat.HYGROSTAT_SCHEMA

Initial value:

=  vol.Schema(
    {
        vol.Required(CONF_HUMIDIFIER): cv.entity_id,
        vol.Required(CONF_SENSOR): cv.entity_id,
        vol.Optional(CONF_DEVICE_CLASS): vol.In(
            [HumidifierDeviceClass.HUMIDIFIER, HumidifierDeviceClass.DEHUMIDIFIER]
        ),
        vol.Optional(CONF_MAX_HUMIDITY): vol.Coerce(float),
        vol.Optional(CONF_MIN_DUR): vol.All(cv.time_period, cv.positive_timedelta),
        vol.Optional(CONF_MIN_HUMIDITY): vol.Coerce(float),
        vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
        vol.Optional(CONF_DRY_TOLERANCE, default=DEFAULT_TOLERANCE): vol.Coerce(float),
        vol.Optional(CONF_WET_TOLERANCE, default=DEFAULT_TOLERANCE): vol.Coerce(float),
        vol.Optional(CONF_TARGET_HUMIDITY): vol.Coerce(float),
        vol.Optional(CONF_KEEP_ALIVE): vol.All(cv.time_period, cv.positive_timedelta),
        vol.Optional(CONF_INITIAL_STATE): cv.boolean,
        vol.Optional(CONF_AWAY_HUMIDITY): vol.Coerce(int),
        vol.Optional(CONF_AWAY_FIXED): cv.boolean,
        vol.Optional(CONF_STALE_DURATION): vol.All(
            cv.time_period, cv.positive_timedelta
        ),
        vol.Optional(CONF_UNIQUE_ID): cv.string,
    }
)

Definition at line 36 of file __init__.py.