mirror of
https://github.com/home-assistant/core
synced 2024-08-31 05:57:13 +02:00
78 lines
2.2 KiB
Python
78 lines
2.2 KiB
Python
"""Support for USCIS Case Status."""
|
|
from datetime import timedelta
|
|
import logging
|
|
|
|
import uscisstatus
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.sensor import PLATFORM_SCHEMA, SensorEntity
|
|
from homeassistant.const import CONF_NAME
|
|
from homeassistant.helpers import config_validation as cv
|
|
from homeassistant.util import Throttle
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
DEFAULT_NAME = "USCIS"
|
|
|
|
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(
|
|
{
|
|
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
|
|
vol.Required("case_id"): cv.string,
|
|
}
|
|
)
|
|
|
|
|
|
def setup_platform(hass, config, add_entities, discovery_info=None):
|
|
"""Set up the platform in Home Assistant and Case Information."""
|
|
uscis = UscisSensor(config["case_id"], config[CONF_NAME])
|
|
uscis.update()
|
|
if uscis.valid_case_id:
|
|
add_entities([uscis])
|
|
else:
|
|
_LOGGER.error("Setup USCIS Sensor Fail check if your Case ID is Valid")
|
|
|
|
|
|
class UscisSensor(SensorEntity):
|
|
"""USCIS Sensor will check case status on daily basis."""
|
|
|
|
MIN_TIME_BETWEEN_UPDATES = timedelta(hours=24)
|
|
|
|
CURRENT_STATUS = "current_status"
|
|
LAST_CASE_UPDATE = "last_update_date"
|
|
|
|
def __init__(self, case, name):
|
|
"""Initialize the sensor."""
|
|
self._state = None
|
|
self._case_id = case
|
|
self._attributes = None
|
|
self.valid_case_id = None
|
|
self._name = name
|
|
|
|
@property
|
|
def name(self):
|
|
"""Return the name."""
|
|
return self._name
|
|
|
|
@property
|
|
def state(self):
|
|
"""Return the state."""
|
|
return self._state
|
|
|
|
@property
|
|
def extra_state_attributes(self):
|
|
"""Return the state attributes."""
|
|
return self._attributes
|
|
|
|
@Throttle(MIN_TIME_BETWEEN_UPDATES)
|
|
def update(self):
|
|
"""Fetch data from the USCIS website and update state attributes."""
|
|
try:
|
|
status = uscisstatus.get_case_status(self._case_id)
|
|
self._attributes = {self.CURRENT_STATUS: status["status"]}
|
|
self._state = status["date"]
|
|
self.valid_case_id = True
|
|
|
|
except ValueError:
|
|
_LOGGER("Please Check that you have valid USCIS case id")
|
|
self.valid_case_id = False
|