Logbook context (#16937)
* Convert logbook to use attr * Add context to events * Enhance logbook * Lint * Fix logbook entry * Don't use intermediary classes for logbook entries
This commit is contained in:
1 parent
2e6346ca43
commit
fbc1c41673
4 files changed
+133
-80
No files matched your search
@@ -10,6 +10,7 @@ import logging
|
||||
|
||||
import voluptuous as vol
|
||||
|
||||
from homeassistant.loader import bind_hass
|
||||
from homeassistant.components import sun
|
||||
from homeassistant.components.http import HomeAssistantView
|
||||
from homeassistant.const import (
|
||||
@@ -17,8 +18,9 @@ from homeassistant.const import (
|
||||
CONF_INCLUDE, EVENT_HOMEASSISTANT_START, EVENT_HOMEASSISTANT_STOP,
|
||||
EVENT_LOGBOOK_ENTRY, EVENT_STATE_CHANGED, HTTP_BAD_REQUEST, STATE_NOT_HOME,
|
||||
STATE_OFF, STATE_ON)
|
||||
from homeassistant.core import DOMAIN as HA_DOMAIN
|
||||
from homeassistant.core import State, callback, split_entity_id
|
||||
from homeassistant.core import (
|
||||
DOMAIN as HA_DOMAIN, State, callback, split_entity_id)
|
||||
from homeassistant.components.alexa.smart_home import EVENT_ALEXA_SMART_HOME
|
||||
import homeassistant.helpers.config_validation as cv
|
||||
import homeassistant.util.dt as dt_util
|
||||
|
||||
@@ -53,7 +55,8 @@ CONFIG_SCHEMA = vol.Schema({
|
||||
|
||||
ALL_EVENT_TYPES = [
|
||||
EVENT_STATE_CHANGED, EVENT_LOGBOOK_ENTRY,
|
||||
EVENT_HOMEASSISTANT_START, EVENT_HOMEASSISTANT_STOP
|
||||
EVENT_HOMEASSISTANT_START, EVENT_HOMEASSISTANT_STOP,
|
||||
EVENT_ALEXA_SMART_HOME
|
||||
]
|
||||
|
||||
LOG_MESSAGE_SCHEMA = vol.Schema({
|
||||
@@ -64,11 +67,13 @@ LOG_MESSAGE_SCHEMA = vol.Schema({
|
||||
})
|
||||
|
||||
|
||||
@bind_hass
|
||||
def log_entry(hass, name, message, domain=None, entity_id=None):
|
||||
"""Add an entry to the logbook."""
|
||||
hass.add_job(async_log_entry, hass, name, message, domain, entity_id)
|
||||
|
||||
|
||||
@bind_hass
|
||||
def async_log_entry(hass, name, message, domain=None, entity_id=None):
|
||||
"""Add an entry to the logbook."""
|
||||
data = {
|
||||
@@ -140,30 +145,7 @@ class LogbookView(HomeAssistantView):
|
||||
return await hass.async_add_job(json_events)
|
||||
|
||||
|
||||
class Entry:
|
||||
"""A human readable version of the log."""
|
||||
|
||||
def __init__(self, when=None, name=None, message=None, domain=None,
|
||||
entity_id=None):
|
||||
"""Initialize the entry."""
|
||||
self.when = when
|
||||
self.name = name
|
||||
self.message = message
|
||||
self.domain = domain
|
||||
self.entity_id = entity_id
|
||||
|
||||
def as_dict(self):
|
||||
"""Convert entry to a dict to be used within JSON."""
|
||||
return {
|
||||
'when': self.when,
|
||||
'name': self.name,
|
||||
'message': self.message,
|
||||
'domain': self.domain,
|
||||
'entity_id': self.entity_id,
|
||||
}
|
||||
|
||||
|
||||
def humanify(events):
|
||||
def humanify(hass, events):
|
||||
"""Generate a converted list of events into Entry objects.
|
||||
|
||||
Will try to group events if possible:
|
||||
@@ -224,20 +206,28 @@ def humanify(events):
|
||||
to_state.attributes.get('unit_of_measurement'):
|
||||
continue
|
||||
|
||||
yield Entry(
|
||||
event.time_fired,
|
||||
name=to_state.name,
|
||||
message=_entry_message_from_state(domain, to_state),
|
||||
domain=domain,
|
||||
entity_id=to_state.entity_id)
|
||||
yield {
|
||||
'when': event.time_fired,
|
||||
'name': to_state.name,
|
||||
'message': _entry_message_from_state(domain, to_state),
|
||||
'domain': domain,
|
||||
'entity_id': to_state.entity_id,
|
||||
'context_id': event.context.id,
|
||||
'context_user_id': event.context.user_id
|
||||
}
|
||||
|
||||
elif event.event_type == EVENT_HOMEASSISTANT_START:
|
||||
if start_stop_events.get(event.time_fired.minute) == 2:
|
||||
continue
|
||||
|
||||
yield Entry(
|
||||
event.time_fired, "Home Assistant", "started",
|
||||
domain=HA_DOMAIN)
|
||||
yield {
|
||||
'when': event.time_fired,
|
||||
'name': "Home Assistant",
|
||||
'message': "started",
|
||||
'domain': HA_DOMAIN,
|
||||
'context_id': event.context.id,
|
||||
'context_user_id': event.context.user_id
|
||||
}
|
||||
|
||||
elif event.event_type == EVENT_HOMEASSISTANT_STOP:
|
||||
if start_stop_events.get(event.time_fired.minute) == 2:
|
||||
@@ -245,9 +235,14 @@ def humanify(events):
|
||||
else:
|
||||
action = "stopped"
|
||||
|
||||
yield Entry(
|
||||
event.time_fired, "Home Assistant", action,
|
||||
domain=HA_DOMAIN)
|
||||
yield {
|
||||
'when': event.time_fired,
|
||||
'name': "Home Assistant",
|
||||
'message': action,
|
||||
'domain': HA_DOMAIN,
|
||||
'context_id': event.context.id,
|
||||
'context_user_id': event.context.user_id
|
||||
}
|
||||
|
||||
elif event.event_type == EVENT_LOGBOOK_ENTRY:
|
||||
domain = event.data.get(ATTR_DOMAIN)
|
||||
@@ -258,10 +253,38 @@ def humanify(events):
|
||||
except IndexError:
|
||||
pass
|
||||
|
||||
yield Entry(
|
||||
event.time_fired, event.data.get(ATTR_NAME),
|
||||
event.data.get(ATTR_MESSAGE), domain,
|
||||
entity_id)
|
||||
yield {
|
||||
'when': event.time_fired,
|
||||
'name': event.data.get(ATTR_NAME),
|
||||
'message': event.data.get(ATTR_MESSAGE),
|
||||
'domain': domain,
|
||||
'entity_id': entity_id,
|
||||
'context_id': event.context.id,
|
||||
'context_user_id': event.context.user_id
|
||||
}
|
||||
|
||||
elif event.event_type == EVENT_ALEXA_SMART_HOME:
|
||||
data = event.data
|
||||
entity_id = data.get('entity_id')
|
||||
|
||||
if entity_id:
|
||||
state = hass.states.get(entity_id)
|
||||
name = state.name if state else entity_id
|
||||
message = "send command {}/{} for {}".format(
|
||||
data['namespace'], data['name'], name)
|
||||
else:
|
||||
message = "send command {}/{}".format(
|
||||
data['namespace'], data['name'])
|
||||
|
||||
yield {
|
||||
'when': event.time_fired,
|
||||
'name': 'Amazon Alexa',
|
||||
'message': message,
|
||||
'domain': 'alexa',
|
||||
'entity_id': entity_id,
|
||||
'context_id': event.context.id,
|
||||
'context_user_id': event.context.user_id
|
||||
}
|
||||
|
||||
|
||||
def _get_events(hass, config, start_day, end_day):
|
||||
@@ -279,7 +302,7 @@ def _get_events(hass, config, start_day, end_day):
|
||||
.filter((States.last_updated == States.last_changed)
|
||||
| (States.state_id.is_(None)))
|
||||
events = execute(query)
|
||||
return humanify(_exclude_events(events, config))
|
||||
return humanify(hass, _exclude_events(events, config))
|
||||
|
||||
|
||||
def _exclude_events(events, config):
|
||||
|
||||
Reference in new issue
Block a user