homeassistant.components.homekit.util Namespace Reference

Variables
	_LOGGER = logging.getLogger(__name__)
	BASIC_INFO_SCHEMA
	CAMERA_SCHEMA
	CODE_SCHEMA
	COVER_SCHEMA
	FEATURE_SCHEMA
	HUMIDIFIER_SCHEMA
string	INVALID_END_CHARS = "-_ "
int	MAX_PORT = 65535
int	MAX_VERSION_PART = 2**32 - 1
	MEDIA_PLAYER_SCHEMA
	NUMBERS_ONLY_RE = re.compile(r"[^\d.]+")
	SENSOR_SCHEMA
	SWITCH_TYPE_SCHEMA
list	VALID_AUDIO_CODECS = [AUDIO_CODEC_OPUS, VIDEO_CODEC_COPY]
list	VALID_VIDEO_CODECS
	VERSION_RE = re.compile(r"([0-9]+)(\.[0-9]+)?(\.[0-9]+)?")

Detailed Description

Collection of useful functions for the HomeKit component.

Variable Documentation

_LOGGER

homeassistant.components.homekit.util._LOGGER = logging.getLogger(__name__)

private

Definition at line 112 of file util.py.

BASIC_INFO_SCHEMA

homeassistant.components.homekit.util.BASIC_INFO_SCHEMA

Initial value:

=  vol.Schema(
    {
        vol.Optional(CONF_NAME): cv.string,
        vol.Optional(CONF_LINKED_BATTERY_SENSOR): cv.entity_domain(sensor.DOMAIN),
        vol.Optional(CONF_LINKED_BATTERY_CHARGING_SENSOR): cv.entity_domain(
            binary_sensor.DOMAIN
        ),
        vol.Optional(
            CONF_LOW_BATTERY_THRESHOLD, default=DEFAULT_LOW_BATTERY_THRESHOLD
        ): cv.positive_int,
    }
)

Definition at line 130 of file util.py.

CAMERA_SCHEMA

homeassistant.components.homekit.util.CAMERA_SCHEMA

Definition at line 147 of file util.py.

CODE_SCHEMA

homeassistant.components.homekit.util.CODE_SCHEMA

Initial value:

=  BASIC_INFO_SCHEMA.extend(
    {vol.Optional(ATTR_CODE, default=None): vol.Any(None, cv.string)}
)

Definition at line 194 of file util.py.

COVER_SCHEMA

homeassistant.components.homekit.util.COVER_SCHEMA

Initial value:

=  BASIC_INFO_SCHEMA.extend(
    {
        vol.Optional(CONF_LINKED_OBSTRUCTION_SENSOR): cv.entity_domain(
            binary_sensor.DOMAIN
        )
    }
)

Definition at line 186 of file util.py.

FEATURE_SCHEMA

homeassistant.components.homekit.util.FEATURE_SCHEMA

Initial value:

=  BASIC_INFO_SCHEMA.extend(
    {vol.Optional(CONF_FEATURE_LIST, default=None): cv.ensure_list}
)

Definition at line 143 of file util.py.

HUMIDIFIER_SCHEMA

homeassistant.components.homekit.util.HUMIDIFIER_SCHEMA

Initial value:

=  BASIC_INFO_SCHEMA.extend(
    {vol.Optional(CONF_LINKED_HUMIDITY_SENSOR): cv.entity_domain(sensor.DOMAIN)}
)

Definition at line 181 of file util.py.

INVALID_END_CHARS

string homeassistant.components.homekit.util.INVALID_END_CHARS = "-_ "

Definition at line 117 of file util.py.

MAX_PORT

int homeassistant.components.homekit.util.MAX_PORT = 65535

Definition at line 121 of file util.py.

MAX_VERSION_PART

int homeassistant.components.homekit.util.MAX_VERSION_PART = 2**32 - 1

Definition at line 118 of file util.py.

MEDIA_PLAYER_SCHEMA

homeassistant.components.homekit.util.MEDIA_PLAYER_SCHEMA

Initial value:

=  vol.Schema(
    {
        vol.Required(CONF_FEATURE): vol.All(
            cv.string,
            vol.In(
                (
                    FEATURE_ON_OFF,
                    FEATURE_PLAY_PAUSE,
                    FEATURE_PLAY_STOP,
                    FEATURE_TOGGLE_MUTE,
                )
            ),
        )
    }
)

Definition at line 198 of file util.py.

NUMBERS_ONLY_RE

homeassistant.components.homekit.util.NUMBERS_ONLY_RE = re.compile(r"[^\d.]+")

Definition at line 115 of file util.py.

SENSOR_SCHEMA

homeassistant.components.homekit.util.SENSOR_SCHEMA

Initial value:

=  BASIC_INFO_SCHEMA.extend(
    {
        vol.Optional(CONF_THRESHOLD_CO): vol.Any(None, cv.positive_int),
        vol.Optional(CONF_THRESHOLD_CO2): vol.Any(None, cv.positive_int),
    }
)

Definition at line 232 of file util.py.

SWITCH_TYPE_SCHEMA

homeassistant.components.homekit.util.SWITCH_TYPE_SCHEMA

Initial value:

=  BASIC_INFO_SCHEMA.extend(
    {
        vol.Optional(CONF_TYPE, default=TYPE_SWITCH): vol.All(
            cv.string,
            vol.In(
                (
                    TYPE_FAUCET,
                    TYPE_OUTLET,
                    TYPE_SHOWER,
                    TYPE_SPRINKLER,
                    TYPE_SWITCH,
                    TYPE_VALVE,
                )
            ),
        )
    }
)

Definition at line 214 of file util.py.

VALID_AUDIO_CODECS

list homeassistant.components.homekit.util.VALID_AUDIO_CODECS = [AUDIO_CODEC_OPUS, VIDEO_CODEC_COPY]

Definition at line 128 of file util.py.

VALID_VIDEO_CODECS

list homeassistant.components.homekit.util.VALID_VIDEO_CODECS

Initial value:

=  [
    VIDEO_CODEC_LIBX264,
    VIDEO_CODEC_H264_OMX,
    VIDEO_CODEC_H264_V4L2M2M,
    AUDIO_CODEC_COPY,
]

Definition at line 122 of file util.py.

VERSION_RE

homeassistant.components.homekit.util.VERSION_RE = re.compile(r"([0-9]+)(\.[0-9]+)?(\.[0-9]+)?")

Definition at line 116 of file util.py.