homeassistant.components.telnet.switch Namespace Reference

Classes
class	TelnetSwitch

Functions
None	setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback add_entities, DiscoveryInfoType|None discovery_info=None)

Variables
	_LOGGER = logging.getLogger(__name__)
int	DEFAULT_PORT = 23
float	DEFAULT_TIMEOUT = 0.2
	PLATFORM_SCHEMA
	SCAN_INTERVAL = timedelta(seconds=10)
	SWITCH_SCHEMA

Detailed Description

Support for switch controlled using a telnet connection.

Function Documentation

setup_platform()

None homeassistant.components.telnet.switch.setup_platform	(	HomeAssistant	hass,
		ConfigType	config,
		AddEntitiesCallback	add_entities,
		DiscoveryInfoType | None	discovery_info = None
	)

Find and return switches controlled by telnet commands.

Definition at line 59 of file switch.py.

Variable Documentation

_LOGGER

homeassistant.components.telnet.switch._LOGGER = logging.getLogger(__name__)

private

Definition at line 34 of file switch.py.

DEFAULT_PORT

int homeassistant.components.telnet.switch.DEFAULT_PORT = 23

Definition at line 36 of file switch.py.

DEFAULT_TIMEOUT

float homeassistant.components.telnet.switch.DEFAULT_TIMEOUT = 0.2

Definition at line 37 of file switch.py.

PLATFORM_SCHEMA

homeassistant.components.telnet.switch.PLATFORM_SCHEMA

Initial value:

=  SWITCH_PLATFORM_SCHEMA.extend(
    {vol.Required(CONF_SWITCHES): cv.schema_with_slug_keys(SWITCH_SCHEMA)}
)

Definition at line 52 of file switch.py.

SCAN_INTERVAL

homeassistant.components.telnet.switch.SCAN_INTERVAL = timedelta(seconds=10)

Definition at line 56 of file switch.py.

SWITCH_SCHEMA

homeassistant.components.telnet.switch.SWITCH_SCHEMA

Initial value:

=  vol.Schema(
    {
        vol.Required(CONF_COMMAND_OFF): cv.string,
        vol.Required(CONF_COMMAND_ON): cv.string,
        vol.Required(CONF_RESOURCE): cv.string,
        vol.Optional(CONF_VALUE_TEMPLATE): cv.template,
        vol.Optional(CONF_COMMAND_STATE): cv.string,
        vol.Optional(CONF_NAME): cv.string,
        vol.Optional(CONF_PORT, default=DEFAULT_PORT): cv.port,
        vol.Optional(CONF_TIMEOUT, default=DEFAULT_TIMEOUT): vol.Coerce(float),
    }
)

Definition at line 39 of file switch.py.