169 lines
4.9 KiB
Python
169 lines
4.9 KiB
Python
"""Support for custom shell commands to turn a switch on/off."""
|
|
import logging
|
|
import subprocess
|
|
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.switch import (
|
|
ENTITY_ID_FORMAT,
|
|
PLATFORM_SCHEMA,
|
|
SwitchDevice,
|
|
)
|
|
from homeassistant.const import (
|
|
CONF_COMMAND_OFF,
|
|
CONF_COMMAND_ON,
|
|
CONF_COMMAND_STATE,
|
|
CONF_FRIENDLY_NAME,
|
|
CONF_SWITCHES,
|
|
CONF_VALUE_TEMPLATE,
|
|
)
|
|
import homeassistant.helpers.config_validation as cv
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
SWITCH_SCHEMA = vol.Schema(
|
|
{
|
|
vol.Optional(CONF_COMMAND_OFF, default="true"): cv.string,
|
|
vol.Optional(CONF_COMMAND_ON, default="true"): cv.string,
|
|
vol.Optional(CONF_COMMAND_STATE): cv.string,
|
|
vol.Optional(CONF_FRIENDLY_NAME): cv.string,
|
|
vol.Optional(CONF_VALUE_TEMPLATE): cv.template,
|
|
}
|
|
)
|
|
|
|
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(
|
|
{vol.Required(CONF_SWITCHES): cv.schema_with_slug_keys(SWITCH_SCHEMA)}
|
|
)
|
|
|
|
|
|
def setup_platform(hass, config, add_entities, discovery_info=None):
|
|
"""Find and return switches controlled by shell commands."""
|
|
devices = config.get(CONF_SWITCHES, {})
|
|
switches = []
|
|
|
|
for object_id, device_config in devices.items():
|
|
value_template = device_config.get(CONF_VALUE_TEMPLATE)
|
|
|
|
if value_template is not None:
|
|
value_template.hass = hass
|
|
|
|
switches.append(
|
|
CommandSwitch(
|
|
hass,
|
|
object_id,
|
|
device_config.get(CONF_FRIENDLY_NAME, object_id),
|
|
device_config.get(CONF_COMMAND_ON),
|
|
device_config.get(CONF_COMMAND_OFF),
|
|
device_config.get(CONF_COMMAND_STATE),
|
|
value_template,
|
|
)
|
|
)
|
|
|
|
if not switches:
|
|
_LOGGER.error("No switches added")
|
|
return False
|
|
|
|
add_entities(switches)
|
|
|
|
|
|
class CommandSwitch(SwitchDevice):
|
|
"""Representation a switch that can be toggled using shell commands."""
|
|
|
|
def __init__(
|
|
self,
|
|
hass,
|
|
object_id,
|
|
friendly_name,
|
|
command_on,
|
|
command_off,
|
|
command_state,
|
|
value_template,
|
|
):
|
|
"""Initialize the switch."""
|
|
self._hass = hass
|
|
self.entity_id = ENTITY_ID_FORMAT.format(object_id)
|
|
self._name = friendly_name
|
|
self._state = False
|
|
self._command_on = command_on
|
|
self._command_off = command_off
|
|
self._command_state = command_state
|
|
self._value_template = value_template
|
|
|
|
@staticmethod
|
|
def _switch(command):
|
|
"""Execute the actual commands."""
|
|
_LOGGER.info("Running command: %s", command)
|
|
|
|
success = subprocess.call(command, shell=True) == 0
|
|
|
|
if not success:
|
|
_LOGGER.error("Command failed: %s", command)
|
|
|
|
return success
|
|
|
|
@staticmethod
|
|
def _query_state_value(command):
|
|
"""Execute state command for return value."""
|
|
_LOGGER.info("Running state command: %s", command)
|
|
|
|
try:
|
|
return_value = subprocess.check_output(command, shell=True)
|
|
return return_value.strip().decode("utf-8")
|
|
except subprocess.CalledProcessError:
|
|
_LOGGER.error("Command failed: %s", command)
|
|
|
|
@staticmethod
|
|
def _query_state_code(command):
|
|
"""Execute state command for return code."""
|
|
_LOGGER.info("Running state command: %s", command)
|
|
return subprocess.call(command, shell=True) == 0
|
|
|
|
@property
|
|
def should_poll(self):
|
|
"""Only poll if we have state command."""
|
|
return self._command_state is not None
|
|
|
|
@property
|
|
def name(self):
|
|
"""Return the name of the switch."""
|
|
return self._name
|
|
|
|
@property
|
|
def is_on(self):
|
|
"""Return true if device is on."""
|
|
return self._state
|
|
|
|
@property
|
|
def assumed_state(self):
|
|
"""Return true if we do optimistic updates."""
|
|
return self._command_state is None
|
|
|
|
def _query_state(self):
|
|
"""Query for state."""
|
|
if not self._command_state:
|
|
_LOGGER.error("No state command specified")
|
|
return
|
|
if self._value_template:
|
|
return CommandSwitch._query_state_value(self._command_state)
|
|
return CommandSwitch._query_state_code(self._command_state)
|
|
|
|
def update(self):
|
|
"""Update device state."""
|
|
if self._command_state:
|
|
payload = str(self._query_state())
|
|
if self._value_template:
|
|
payload = self._value_template.render_with_possible_json_value(payload)
|
|
self._state = payload.lower() == "true"
|
|
|
|
def turn_on(self, **kwargs):
|
|
"""Turn the device on."""
|
|
if CommandSwitch._switch(self._command_on) and not self._command_state:
|
|
self._state = True
|
|
self.schedule_update_ha_state()
|
|
|
|
def turn_off(self, **kwargs):
|
|
"""Turn the device off."""
|
|
if CommandSwitch._switch(self._command_off) and not self._command_state:
|
|
self._state = False
|
|
self.schedule_update_ha_state()
|