Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.xiaomi_miio.remote Namespace Reference

Classes

class  XiaomiMiioRemote
 

Functions

None async_setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback async_add_entities, DiscoveryInfoType|None discovery_info=None)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
 COMMAND_SCHEMA
 
string CONF_COMMANDS = "commands"
 
string CONF_SLOT = "slot"
 
string DATA_KEY = "remote.xiaomi_miio"
 
int DEFAULT_SLOT = 1
 
int DEFAULT_TIMEOUT = 10
 
 PLATFORM_SCHEMA
 

Detailed Description

Support for the Xiaomi IR Remote (Chuangmi IR).

Function Documentation

◆ async_setup_platform()

None homeassistant.components.xiaomi_miio.remote.async_setup_platform ( HomeAssistant  hass,
ConfigType  config,
AddEntitiesCallback  async_add_entities,
DiscoveryInfoType | None   discovery_info = None 
)
Set up the Xiaomi IR Remote (Chuangmi IR) platform.

Definition at line 69 of file remote.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.xiaomi_miio.remote._LOGGER = logging.getLogger(__name__)
private

Definition at line 38 of file remote.py.

◆ COMMAND_SCHEMA

homeassistant.components.xiaomi_miio.remote.COMMAND_SCHEMA
Initial value:
1 = vol.Schema(
2  {vol.Required(CONF_COMMAND): vol.All(cv.ensure_list, [cv.string])}
3 )

Definition at line 48 of file remote.py.

◆ CONF_COMMANDS

string homeassistant.components.xiaomi_miio.remote.CONF_COMMANDS = "commands"

Definition at line 43 of file remote.py.

◆ CONF_SLOT

string homeassistant.components.xiaomi_miio.remote.CONF_SLOT = "slot"

Definition at line 42 of file remote.py.

◆ DATA_KEY

string homeassistant.components.xiaomi_miio.remote.DATA_KEY = "remote.xiaomi_miio"

Definition at line 40 of file remote.py.

◆ DEFAULT_SLOT

int homeassistant.components.xiaomi_miio.remote.DEFAULT_SLOT = 1

Definition at line 46 of file remote.py.

◆ DEFAULT_TIMEOUT

int homeassistant.components.xiaomi_miio.remote.DEFAULT_TIMEOUT = 10

Definition at line 45 of file remote.py.

◆ PLATFORM_SCHEMA

homeassistant.components.xiaomi_miio.remote.PLATFORM_SCHEMA
Initial value:
1 = REMOTE_PLATFORM_SCHEMA.extend(
2  {
3  vol.Optional(CONF_NAME): cv.string,
4  vol.Required(CONF_HOST): cv.string,
5  vol.Optional(CONF_TIMEOUT, default=DEFAULT_TIMEOUT): cv.positive_int,
6  vol.Optional(CONF_SLOT, default=DEFAULT_SLOT): vol.All(
7  int, vol.Range(min=1, max=1000000)
8  ),
9  vol.Required(CONF_TOKEN): vol.All(str, vol.Length(min=32, max=32)),
10  vol.Optional(CONF_COMMANDS, default={}): cv.schema_with_slug_keys(
11  COMMAND_SCHEMA
12  ),
13  },
14  extra=vol.ALLOW_EXTRA,
15 )

Definition at line 52 of file remote.py.