[RFC] Add Tag integration (#38727)

Co-authored-by: Paulus Schoutsen <paulus@home-assistant.io>
This commit is contained in:
David F. MulcaheyandPaulus Schoutsen authored and GitHub committed 2020-08-11 11:08:47 +02:00
1 parent bd3f075060
commit 227d7c0a99
9 files changed
+246

No files matched your search

@@ -16,6 +16,7 @@
"ssdp",
"sun",
"system_health",
"tag",
"updater",
"zeroconf",
"zone",
+124
View File
@@ -0,0 +1,124 @@
"""The Tag integration."""
import logging
import typing
import voluptuous as vol
from homeassistant.const import CONF_ID, CONF_NAME
from homeassistant.core import HomeAssistant, callback
from homeassistant.exceptions import HomeAssistantError
from homeassistant.helpers import collection
import homeassistant.helpers.config_validation as cv
from homeassistant.helpers.storage import Store
from homeassistant.loader import bind_hass
import homeassistant.util.dt as dt_util
from .const import DOMAIN
_LOGGER = logging.getLogger(__name__)
DEVICE_ID = "device_id"
EVENT_TAG_SCANNED = "tag_scanned"
LAST_SCANNED = "last_scanned"
STORAGE_KEY = DOMAIN
STORAGE_VERSION = 1
TAG_ID = "tag_id"
TAGS = "tags"
CREATE_FIELDS = {
vol.Required(CONF_ID): cv.string,
vol.Optional(TAG_ID): cv.string,
vol.Optional(CONF_NAME): vol.All(str, vol.Length(min=1)),
vol.Optional("description"): cv.string,
vol.Optional(LAST_SCANNED): cv.datetime,
}
UPDATE_FIELDS = {
vol.Optional(CONF_NAME): vol.All(str, vol.Length(min=1)),
vol.Optional("description"): cv.string,
vol.Optional(LAST_SCANNED): cv.datetime,
}
class TagIDExistsError(HomeAssistantError):
"""Raised when an item is not found."""
def __init__(self, item_id: str):
"""Initialize tag id exists error."""
super().__init__(f"Tag with id: {item_id} already exists.")
self.item_id = item_id
class TagIDManager(collection.IDManager):
"""ID manager for tags."""
def generate_id(self, suggestion: str) -> str:
"""Generate an ID."""
if self.has_id(suggestion):
raise TagIDExistsError(suggestion)
return suggestion
class TagStorageCollection(collection.StorageCollection):
"""Tag collection stored in storage."""
CREATE_SCHEMA = vol.Schema(CREATE_FIELDS)
UPDATE_SCHEMA = vol.Schema(UPDATE_FIELDS)
async def _process_create_data(self, data: typing.Dict) -> typing.Dict:
"""Validate the config is valid."""
if TAG_ID in data:
data[CONF_ID] = data.pop(TAG_ID)
data = self.CREATE_SCHEMA(data)
# make last_scanned JSON serializeable
if LAST_SCANNED in data:
data[LAST_SCANNED] = str(data[LAST_SCANNED])
return data
@callback
def _get_suggested_id(self, info: typing.Dict) -> str:
"""Suggest an ID based on the config."""
return info[CONF_ID]
async def _update_data(self, data: dict, update_data: typing.Dict) -> typing.Dict:
"""Return a new updated data object."""
data = {**data, **self.UPDATE_SCHEMA(update_data)}
# make last_scanned JSON serializeable
if LAST_SCANNED in data:
data[LAST_SCANNED] = str(data[LAST_SCANNED])
return data
async def async_setup(hass: HomeAssistant, config: dict):
"""Set up the Tag component."""
hass.data[DOMAIN] = {}
id_manager = TagIDManager()
hass.data[DOMAIN][TAGS] = storage_collection = TagStorageCollection(
Store(hass, STORAGE_VERSION, STORAGE_KEY),
logging.getLogger(f"{__name__}_storage_collection"),
id_manager,
)
await storage_collection.async_load()
collection.StorageCollectionWebsocket(
storage_collection, DOMAIN, DOMAIN, CREATE_FIELDS, UPDATE_FIELDS
).async_setup(hass)
return True
@bind_hass
async def async_scan_tag(hass, tag_id, device_id, context=None):
"""Handle when a tag is scanned."""
if DOMAIN not in hass.config.components:
raise HomeAssistantError("tag component has not been set up.")
hass.bus.async_fire(
EVENT_TAG_SCANNED, {TAG_ID: tag_id, DEVICE_ID: device_id}, context=context
)
helper = hass.data[DOMAIN][TAGS]
if tag_id in helper.data:
await helper.async_update_item(tag_id, {LAST_SCANNED: dt_util.utcnow()})
else:
await helper.async_create_item(
{CONF_ID: tag_id, LAST_SCANNED: dt_util.utcnow()}
)
_LOGGER.debug("Tag: %s scanned by device: %s", tag_id, device_id)
+3
View File
@@ -0,0 +1,3 @@
"""Constants for the Tag integration."""
DOMAIN = "tag"
@@ -0,0 +1,12 @@
{
"domain": "tag",
"name": "Tag",
"config_flow": false,
"documentation": "https://www.home-assistant.io/integrations/tag",
"requirements": [],
"ssdp": [],
"zeroconf": [],
"homekit": {},
"dependencies": [],
"codeowners": ["@balloob", "@dmulcahey"]
}
@@ -0,0 +1,3 @@
{
"title": "Tag"
}
@@ -0,0 +1,3 @@
{
"title": "Tag"
}