Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.rflink Namespace Reference

Namespaces

 
 
 
 
 
 
 
 

Functions

bool async_setup (HomeAssistant hass, ConfigType config)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
string CONF_IGNORE_DEVICES = "ignore_devices"
 
string CONF_KEEPALIVE_IDLE = "tcp_keepalive_idle_timer"
 
string CONF_RECONNECT_INTERVAL = "reconnect_interval"
 
string CONF_WAIT_FOR_ACK = "wait_for_ack"
 
 CONFIG_SCHEMA
 
int CONNECTION_TIMEOUT = 10
 
int DEFAULT_RECONNECT_INTERVAL = 10
 
int DEFAULT_TCP_KEEPALIVE_IDLE_TIMER = 3600
 
string DOMAIN = "rflink"
 
list RFLINK_GROUP_COMMANDS = ["allon", "alloff"]
 
 SEND_COMMAND_SCHEMA
 
string SERVICE_SEND_COMMAND = "send_command"
 
string SIGNAL_EVENT = "rflink_event"
 

Detailed Description

Support for Rflink devices.

Function Documentation

◆ async_setup()

bool homeassistant.components.rflink.async_setup ( HomeAssistant  hass,
ConfigType  config 
)
Set up the Rflink component.

Definition at line 90 of file __init__.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.rflink._LOGGER = logging.getLogger(__name__)
private

Definition at line 43 of file __init__.py.

◆ CONF_IGNORE_DEVICES

string homeassistant.components.rflink.CONF_IGNORE_DEVICES = "ignore_devices"

Definition at line 45 of file __init__.py.

◆ CONF_KEEPALIVE_IDLE

string homeassistant.components.rflink.CONF_KEEPALIVE_IDLE = "tcp_keepalive_idle_timer"

Definition at line 48 of file __init__.py.

◆ CONF_RECONNECT_INTERVAL

string homeassistant.components.rflink.CONF_RECONNECT_INTERVAL = "reconnect_interval"

Definition at line 46 of file __init__.py.

◆ CONF_WAIT_FOR_ACK

string homeassistant.components.rflink.CONF_WAIT_FOR_ACK = "wait_for_ack"

Definition at line 47 of file __init__.py.

◆ CONFIG_SCHEMA

homeassistant.components.rflink.CONFIG_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  DOMAIN: vol.Schema(
4  {
5  vol.Required(CONF_PORT): vol.Any(cv.port, cv.string),
6  vol.Optional(CONF_HOST): cv.string,
7  vol.Optional(CONF_WAIT_FOR_ACK, default=True): cv.boolean,
8  vol.Optional(
9  CONF_KEEPALIVE_IDLE, default=DEFAULT_TCP_KEEPALIVE_IDLE_TIMER
10  ): int,
11  vol.Optional(
12  CONF_RECONNECT_INTERVAL, default=DEFAULT_RECONNECT_INTERVAL
13  ): int,
14  vol.Optional(CONF_IGNORE_DEVICES, default=[]): vol.All(
15  cv.ensure_list, [cv.string]
16  ),
17  }
18  )
19  },
20  extra=vol.ALLOW_EXTRA,
21 )

Definition at line 63 of file __init__.py.

◆ CONNECTION_TIMEOUT

int homeassistant.components.rflink.CONNECTION_TIMEOUT = 10

Definition at line 52 of file __init__.py.

◆ DEFAULT_RECONNECT_INTERVAL

int homeassistant.components.rflink.DEFAULT_RECONNECT_INTERVAL = 10

Definition at line 50 of file __init__.py.

◆ DEFAULT_TCP_KEEPALIVE_IDLE_TIMER

int homeassistant.components.rflink.DEFAULT_TCP_KEEPALIVE_IDLE_TIMER = 3600

Definition at line 51 of file __init__.py.

◆ DOMAIN

string homeassistant.components.rflink.DOMAIN = "rflink"

Definition at line 56 of file __init__.py.

◆ RFLINK_GROUP_COMMANDS

list homeassistant.components.rflink.RFLINK_GROUP_COMMANDS = ["allon", "alloff"]

Definition at line 54 of file __init__.py.

◆ SEND_COMMAND_SCHEMA

homeassistant.components.rflink.SEND_COMMAND_SCHEMA
Initial value:
1 = vol.Schema(
2  {vol.Required(CONF_DEVICE_ID): cv.string, vol.Required(CONF_COMMAND): cv.string}
3 )

Definition at line 85 of file __init__.py.

◆ SERVICE_SEND_COMMAND

string homeassistant.components.rflink.SERVICE_SEND_COMMAND = "send_command"

Definition at line 58 of file __init__.py.

◆ SIGNAL_EVENT

string homeassistant.components.rflink.SIGNAL_EVENT = "rflink_event"

Definition at line 60 of file __init__.py.