Convert amcrest binary sensors from poll to stream (#32818)
* Convert amcrest binary sensors from poll to stream - Bump amcrest package to 1.6.0. - For online binary sensor poll camera periodically to test communications in case configuration & usage results in no other communication to camera. - Start a separate thread to call camera's event_stream method since it never returns. - Convert all received events into signals that cause corresponding sensors to update. - Use camera's generic event_channels_happened method to update sensors at startup, and whenever camera comes back online after being unavailable. * Changes per review * Changes per review 2 * Changes per review 3 - Move event stream decoding to amcrest package. - Change name of event processing threads so global counter is no longer required. - Bump amcrest package to 1.7.0.
This commit is contained in:
1 parent
d8e3e9abaa
commit
0ed7bc3b8e
6 files changed
+130
-32
No files matched your search
@@ -42,6 +42,8 @@ from .const import (
|
||||
DATA_AMCREST,
|
||||
DEVICES,
|
||||
DOMAIN,
|
||||
SENSOR_EVENT_CODE,
|
||||
SERVICE_EVENT,
|
||||
SERVICE_UPDATE,
|
||||
)
|
||||
from .helpers import service_signal
|
||||
@@ -96,9 +98,11 @@ AMCREST_SCHEMA = vol.Schema(
|
||||
vol.Optional(CONF_FFMPEG_ARGUMENTS, default=DEFAULT_ARGUMENTS): cv.string,
|
||||
vol.Optional(CONF_SCAN_INTERVAL, default=SCAN_INTERVAL): cv.time_period,
|
||||
vol.Optional(CONF_BINARY_SENSORS): vol.All(
|
||||
cv.ensure_list, [vol.In(BINARY_SENSORS)]
|
||||
cv.ensure_list, [vol.In(BINARY_SENSORS)], vol.Unique()
|
||||
),
|
||||
vol.Optional(CONF_SENSORS): vol.All(
|
||||
cv.ensure_list, [vol.In(SENSORS)], vol.Unique()
|
||||
),
|
||||
vol.Optional(CONF_SENSORS): vol.All(cv.ensure_list, [vol.In(SENSORS)]),
|
||||
vol.Optional(CONF_CONTROL_LIGHT, default=True): cv.boolean,
|
||||
}
|
||||
)
|
||||
@@ -119,6 +123,8 @@ class AmcrestChecker(Http):
|
||||
self._wrap_errors = 0
|
||||
self._wrap_lock = threading.Lock()
|
||||
self._wrap_login_err = False
|
||||
self._wrap_event_flag = threading.Event()
|
||||
self._wrap_event_flag.set()
|
||||
self._unsub_recheck = None
|
||||
super().__init__(
|
||||
host,
|
||||
@@ -134,16 +140,22 @@ class AmcrestChecker(Http):
|
||||
"""Return if camera's API is responding."""
|
||||
return self._wrap_errors <= MAX_ERRORS and not self._wrap_login_err
|
||||
|
||||
@property
|
||||
def available_flag(self):
|
||||
"""Return threading event flag that indicates if camera's API is responding."""
|
||||
return self._wrap_event_flag
|
||||
|
||||
def _start_recovery(self):
|
||||
self._wrap_event_flag.clear()
|
||||
dispatcher_send(self._hass, service_signal(SERVICE_UPDATE, self._wrap_name))
|
||||
self._unsub_recheck = track_time_interval(
|
||||
self._hass, self._wrap_test_online, RECHECK_INTERVAL
|
||||
)
|
||||
|
||||
def command(self, cmd, retries=None, timeout_cmd=None, stream=False):
|
||||
def command(self, *args, **kwargs):
|
||||
"""amcrest.Http.command wrapper to catch errors."""
|
||||
try:
|
||||
ret = super().command(cmd, retries, timeout_cmd, stream)
|
||||
ret = super().command(*args, **kwargs)
|
||||
except LoginError as ex:
|
||||
with self._wrap_lock:
|
||||
was_online = self.available
|
||||
@@ -172,6 +184,7 @@ class AmcrestChecker(Http):
|
||||
self._unsub_recheck()
|
||||
self._unsub_recheck = None
|
||||
_LOGGER.error("%s camera back online", self._wrap_name)
|
||||
self._wrap_event_flag.set()
|
||||
dispatcher_send(self._hass, service_signal(SERVICE_UPDATE, self._wrap_name))
|
||||
return ret
|
||||
|
||||
@@ -184,6 +197,31 @@ class AmcrestChecker(Http):
|
||||
pass
|
||||
|
||||
|
||||
def _monitor_events(hass, name, api, event_codes):
|
||||
event_codes = ",".join(event_codes)
|
||||
while True:
|
||||
api.available_flag.wait()
|
||||
try:
|
||||
for code, start in api.event_actions(event_codes, retries=5):
|
||||
signal = service_signal(SERVICE_EVENT, name, code)
|
||||
_LOGGER.debug("Sending signal: '%s': %s", signal, start)
|
||||
dispatcher_send(hass, signal, start)
|
||||
except AmcrestError as error:
|
||||
_LOGGER.warning(
|
||||
"Error while processing events from %s camera: %r", name, error
|
||||
)
|
||||
|
||||
|
||||
def _start_event_monitor(hass, name, api, event_codes):
|
||||
thread = threading.Thread(
|
||||
target=_monitor_events,
|
||||
name=f"Amcrest {name}",
|
||||
args=(hass, name, api, event_codes),
|
||||
daemon=True,
|
||||
)
|
||||
thread.start()
|
||||
|
||||
|
||||
def setup(hass, config):
|
||||
"""Set up the Amcrest IP Camera component."""
|
||||
hass.data.setdefault(DATA_AMCREST, {DEVICES: {}, CAMERAS: []})
|
||||
@@ -230,6 +268,13 @@ def setup(hass, config):
|
||||
{CONF_NAME: name, CONF_BINARY_SENSORS: binary_sensors},
|
||||
config,
|
||||
)
|
||||
event_codes = [
|
||||
BINARY_SENSORS[sensor_type][SENSOR_EVENT_CODE]
|
||||
for sensor_type in binary_sensors
|
||||
if BINARY_SENSORS[sensor_type][SENSOR_EVENT_CODE] is not None
|
||||
]
|
||||
if event_codes:
|
||||
_start_event_monitor(hass, name, api, event_codes)
|
||||
|
||||
if sensors:
|
||||
discovery.load_platform(
|
||||
|
||||
Reference in new issue
Block a user