home_io_control.cover Namespace Reference

Functions
	device_supports_position_control (value)
	favorite_button_id (parent_id)
	favorite_button_name (config)
	device_name_sensor_id (parent_id)
	device_name_sensor_name (config)
	to_code (config)

Variables
list	DEPENDENCIES = ["home_io_control"]
str	CONF_DEVICE_ID = "io_device_id"
str	CONF_INVERT_POSITION = "invert_position"
str	CONF_LINKED_REMOTES = "linked_remotes"
str	CONF_DEVICE_TYPE = "io_device_type"
str	CONF_SUBTYPE = "io_subtype"
str	CONF_STATUS_POLL_INTERVAL = "status_poll_interval"
	IOHomeCover = home_io_control_ns.class_("IOHomeCover", cover.Cover, cg.Component)
	IOHomeCoverFavoriteButton
	IOHomeDeviceNameTextSensor
dict	POSITION_CONTROL_DEVICE_TYPES
tuple	CONFIG_SCHEMA

Function Documentation

device_name_sensor_id()

home_io_control.cover.device_name_sensor_id

(

parent_id

)

Generate a unique ID for the diagnostic device-name text sensor.

Definition at line 88 of file cover.py.

device_name_sensor_name()

home_io_control.cover.device_name_sensor_name

(

config

)

Derive the device-name sensor name from the parent entity name.

Definition at line 97 of file cover.py.

device_supports_position_control()

home_io_control.cover.device_supports_position_control

(

value

)

Check if the given device type value supports 0-100% position control.

Definition at line 66 of file cover.py.

favorite_button_id()

home_io_control.cover.favorite_button_id

(

parent_id

)

Generate a unique ID for the favorite-position button child entity.

Definition at line 71 of file cover.py.

favorite_button_name()

home_io_control.cover.favorite_button_name

(

config

)

Derive the favorite-position button name from the parent cover name.

Definition at line 80 of file cover.py.

to_code()

home_io_control.cover.to_code

(

config

)

Definition at line 123 of file cover.py.

Here is the call graph for this function:

Variable Documentation

CONF_DEVICE_ID

str home_io_control.cover.CONF_DEVICE_ID = "io_device_id"

Definition at line 30 of file cover.py.

CONF_DEVICE_TYPE

str home_io_control.cover.CONF_DEVICE_TYPE = "io_device_type"

Definition at line 33 of file cover.py.

CONF_INVERT_POSITION

str home_io_control.cover.CONF_INVERT_POSITION = "invert_position"

Definition at line 31 of file cover.py.

CONF_LINKED_REMOTES

str home_io_control.cover.CONF_LINKED_REMOTES = "linked_remotes"

Definition at line 32 of file cover.py.

CONF_STATUS_POLL_INTERVAL

str home_io_control.cover.CONF_STATUS_POLL_INTERVAL = "status_poll_interval"

Definition at line 35 of file cover.py.

CONF_SUBTYPE

str home_io_control.cover.CONF_SUBTYPE = "io_subtype"

Definition at line 34 of file cover.py.

CONFIG_SCHEMA

tuple home_io_control.cover.CONFIG_SCHEMA

Initial value:

=  (
    cover.cover_schema(IOHomeCover)
    .extend(
        {
            cv.GenerateID(CONF_HOME_IO_CONTROL_ID): cv.use_id(
                IOHomeControlComponent
            ),
            cv.Required(CONF_DEVICE_ID): validate_device_id,
            cv.Optional(CONF_INVERT_POSITION): cv.boolean,
            cv.Optional(CONF_DEVICE_TYPE): validate_device_type,
            cv.Optional(CONF_SUBTYPE): cv.int_range(min=0, max=63),
            cv.Optional(CONF_LINKED_REMOTES): cv.ensure_list(validate_device_id),
            cv.Optional(CONF_STATUS_POLL_INTERVAL): validate_status_poll_interval,
        }
    )
    .extend(cv.COMPONENT_SCHEMA)
)

Definition at line 104 of file cover.py.

DEPENDENCIES

list home_io_control.cover.DEPENDENCIES = ["home_io_control"]

Definition at line 28 of file cover.py.

IOHomeCover

home_io_control.cover.IOHomeCover = home_io_control_ns.class_("IOHomeCover", cover.Cover, cg.Component)

Definition at line 37 of file cover.py.

IOHomeCoverFavoriteButton

home_io_control.cover.IOHomeCoverFavoriteButton

Initial value:

=  home_io_control_ns.class_(
    "IOHomeCoverFavoriteButton", button.Button, cg.Component
)

Definition at line 38 of file cover.py.

IOHomeDeviceNameTextSensor

home_io_control.cover.IOHomeDeviceNameTextSensor

Initial value:

=  home_io_control_ns.class_(
    "IOHomeDeviceNameTextSensor", text_sensor.TextSensor, cg.Component
)

Definition at line 41 of file cover.py.

POSITION_CONTROL_DEVICE_TYPES

dict home_io_control.cover.POSITION_CONTROL_DEVICE_TYPES

Initial value:

=  {
    0x01,  # venetian_blind
    0x02,  # roller_shutter
    0x03,  # awning
    0x04,  # window_opener
    0x05,  # garage_opener
    0x07,  # gate_opener
    0x08,  # rolling_door_opener
    0x0A,  # blind
    0x0B,  # screen
    0x0D,  # dual_shutter
    0x10,  # horizontal_awning
    0x11,  # external_venetian_blind
    0x12,  # louvre_blind
    0x13,  # curtain_track
    0x18,  # swinging_shutter
}

Definition at line 47 of file cover.py.