homeassistant.components.kira Namespace Reference

Namespaces
	remote
	sensor

Functions
def	load_codes (path)
bool	setup (HomeAssistant hass, ConfigType config)

Variables
	_LOGGER = logging.getLogger(__name__)
	CODE_SCHEMA
string	CODES_YAML = f"{DOMAIN}_codes.yaml"
string	CONF_REMOTE = "remote"
string	CONF_REMOTES = "remotes"
string	CONF_SENSOR = "sensor"
	CONFIG_SCHEMA
string	DEFAULT_HOST = "0.0.0.0"
int	DEFAULT_PORT = 65432
string	DOMAIN = "kira"
	REMOTE_SCHEMA
	SENSOR_SCHEMA

Detailed Description

KIRA interface to receive UDP packets from an IR-IP bridge.

Function Documentation

load_codes()

def homeassistant.components.kira.load_codes

(

path

)

Load KIRA codes from specified file.

Definition at line 80 of file __init__.py.

setup()

bool homeassistant.components.kira.setup	(	HomeAssistant	hass,
		ConfigType	config
	)

Set up the KIRA component.

Definition at line 98 of file __init__.py.

Variable Documentation

_LOGGER

homeassistant.components.kira._LOGGER = logging.getLogger(__name__)

private

Definition at line 30 of file __init__.py.

CODE_SCHEMA

homeassistant.components.kira.CODE_SCHEMA

Initial value:

=  vol.Schema(
    {
        vol.Required(CONF_NAME): cv.string,
        vol.Required(CONF_CODE): cv.string,
        vol.Optional(CONF_TYPE): cv.string,
        vol.Optional(CONF_DEVICE): cv.string,
        vol.Optional(CONF_REPEAT): cv.positive_int,
    }
)

Definition at line 41 of file __init__.py.

CODES_YAML

string homeassistant.components.kira.CODES_YAML = f"{DOMAIN}_codes.yaml"

Definition at line 39 of file __init__.py.

CONF_REMOTE

string homeassistant.components.kira.CONF_REMOTE = "remote"

Definition at line 37 of file __init__.py.

CONF_REMOTES

string homeassistant.components.kira.CONF_REMOTES = "remotes"

Definition at line 35 of file __init__.py.

CONF_SENSOR

string homeassistant.components.kira.CONF_SENSOR = "sensor"

Definition at line 36 of file __init__.py.

CONFIG_SCHEMA

homeassistant.components.kira.CONFIG_SCHEMA

Initial value:

=  vol.Schema(
    {
        DOMAIN: vol.Schema(
            {
                vol.Optional(CONF_SENSORS): [SENSOR_SCHEMA],
                vol.Optional(CONF_REMOTES): [REMOTE_SCHEMA],
            }
        )
    },
    extra=vol.ALLOW_EXTRA,
)

Definition at line 67 of file __init__.py.

DEFAULT_HOST

string homeassistant.components.kira.DEFAULT_HOST = "0.0.0.0"

Definition at line 32 of file __init__.py.

DEFAULT_PORT

int homeassistant.components.kira.DEFAULT_PORT = 65432

Definition at line 33 of file __init__.py.

DOMAIN

string homeassistant.components.kira.DOMAIN = "kira"

Definition at line 28 of file __init__.py.

REMOTE_SCHEMA

homeassistant.components.kira.REMOTE_SCHEMA

Initial value:

=  vol.Schema(
    {
        vol.Optional(CONF_NAME, default=DOMAIN): vol.Exclusive(cv.string, "remotes"),
        vol.Required(CONF_HOST): cv.string,
        vol.Optional(CONF_PORT, default=DEFAULT_PORT): cv.port,
    }
)

Definition at line 59 of file __init__.py.

SENSOR_SCHEMA

homeassistant.components.kira.SENSOR_SCHEMA

Initial value:

=  vol.Schema(
    {
        vol.Optional(CONF_NAME, default=DOMAIN): vol.Exclusive(cv.string, "sensors"),
        vol.Optional(CONF_HOST, default=DEFAULT_HOST): cv.string,
        vol.Optional(CONF_PORT, default=DEFAULT_PORT): cv.port,
    }
)

Definition at line 51 of file __init__.py.