92 lines
2.6 KiB
Python
92 lines
2.6 KiB
Python
"""
|
|
LIRC interface to receive signals from an infrared remote control.
|
|
|
|
For more details about this component, please refer to the documentation at
|
|
https://home-assistant.io/components/lirc/
|
|
"""
|
|
# pylint: disable=import-error,no-member
|
|
import threading
|
|
import time
|
|
import logging
|
|
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.const import (
|
|
EVENT_HOMEASSISTANT_STOP, EVENT_HOMEASSISTANT_START)
|
|
|
|
REQUIREMENTS = ['python-lirc==1.2.3']
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
BUTTON_NAME = 'button_name'
|
|
|
|
DOMAIN = 'lirc'
|
|
|
|
EVENT_IR_COMMAND_RECEIVED = 'ir_command_received'
|
|
|
|
ICON = 'mdi:remote'
|
|
|
|
CONFIG_SCHEMA = vol.Schema({
|
|
DOMAIN: vol.Schema({}),
|
|
}, extra=vol.ALLOW_EXTRA)
|
|
|
|
|
|
def setup(hass, config):
|
|
"""Set up the LIRC capability."""
|
|
import lirc
|
|
|
|
# blocking=True gives unexpected behavior (multiple responses for 1 press)
|
|
# also by not blocking, we allow hass to shut down the thread gracefully
|
|
# on exit.
|
|
lirc.init('home-assistant', blocking=False)
|
|
lirc_interface = LircInterface(hass)
|
|
|
|
def _start_lirc(_event):
|
|
lirc_interface.start()
|
|
|
|
def _stop_lirc(_event):
|
|
lirc_interface.stopped.set()
|
|
|
|
hass.bus.listen_once(EVENT_HOMEASSISTANT_START, _start_lirc)
|
|
hass.bus.listen_once(EVENT_HOMEASSISTANT_STOP, _stop_lirc)
|
|
|
|
return True
|
|
|
|
|
|
class LircInterface(threading.Thread):
|
|
"""
|
|
This interfaces with the lirc daemon to read IR commands.
|
|
|
|
When using lirc in blocking mode, sometimes repeated commands get produced
|
|
in the next read of a command so we use a thread here to just wait
|
|
around until a non-empty response is obtained from lirc.
|
|
"""
|
|
|
|
def __init__(self, hass):
|
|
"""Construct a LIRC interface object."""
|
|
threading.Thread.__init__(self)
|
|
self.daemon = True
|
|
self.stopped = threading.Event()
|
|
self.hass = hass
|
|
|
|
def run(self):
|
|
"""Run the loop of the LIRC interface thread."""
|
|
import lirc
|
|
_LOGGER.debug("LIRC interface thread started")
|
|
while not self.stopped.isSet():
|
|
try:
|
|
code = lirc.nextcode() # list; empty if no buttons pressed
|
|
except lirc.NextCodeError:
|
|
_LOGGER.warning("Error reading next code from LIRC")
|
|
code = None
|
|
# interpret result from python-lirc
|
|
if code:
|
|
code = code[0]
|
|
_LOGGER.info("Got new LIRC code %s", code)
|
|
self.hass.bus.fire(
|
|
EVENT_IR_COMMAND_RECEIVED, {BUTTON_NAME: code})
|
|
else:
|
|
time.sleep(0.2)
|
|
lirc.deinit()
|
|
_LOGGER.debug('LIRC interface thread stopped')
|