150 lines
4.9 KiB
Python
150 lines
4.9 KiB
Python
"""
|
|
This component provides HA sensor support for Amcrest IP cameras.
|
|
|
|
For more details about this platform, please refer to the documentation at
|
|
https://home-assistant.io/components/sensor.amcrest/
|
|
"""
|
|
from datetime import timedelta
|
|
import logging
|
|
|
|
import voluptuous as vol
|
|
import homeassistant.helpers.config_validation as cv
|
|
|
|
from homeassistant.components.sensor import PLATFORM_SCHEMA
|
|
from homeassistant.const import (
|
|
CONF_HOST, CONF_NAME, CONF_MONITORED_CONDITIONS,
|
|
CONF_USERNAME, CONF_PASSWORD, CONF_PORT, STATE_UNKNOWN)
|
|
from homeassistant.helpers.entity import Entity
|
|
import homeassistant.loader as loader
|
|
|
|
from requests.exceptions import HTTPError, ConnectTimeout
|
|
|
|
REQUIREMENTS = ['amcrest==1.1.9']
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
NOTIFICATION_ID = 'amcrest_notification'
|
|
NOTIFICATION_TITLE = 'Amcrest Sensor Setup'
|
|
|
|
DEFAULT_NAME = 'Amcrest'
|
|
DEFAULT_PORT = 80
|
|
SCAN_INTERVAL = timedelta(seconds=10)
|
|
|
|
# Sensor types are defined like: Name, units, icon
|
|
SENSOR_TYPES = {
|
|
'motion_detector': ['Motion Detected', None, 'run'],
|
|
'sdcard': ['SD Used', '%', 'sd'],
|
|
'ptz_preset': ['PTZ Preset', None, 'camera-iris'],
|
|
}
|
|
|
|
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
|
|
vol.Required(CONF_HOST): cv.string,
|
|
vol.Required(CONF_USERNAME): cv.string,
|
|
vol.Required(CONF_PASSWORD): cv.string,
|
|
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
|
|
vol.Optional(CONF_PORT, default=DEFAULT_PORT): cv.port,
|
|
vol.Required(CONF_MONITORED_CONDITIONS, default=[]):
|
|
vol.All(cv.ensure_list, [vol.In(SENSOR_TYPES)]),
|
|
})
|
|
|
|
|
|
def setup_platform(hass, config, add_devices, discovery_info=None):
|
|
"""Set up a sensor for an Amcrest IP Camera."""
|
|
from amcrest import AmcrestCamera
|
|
|
|
camera = AmcrestCamera(
|
|
config.get(CONF_HOST), config.get(CONF_PORT),
|
|
config.get(CONF_USERNAME), config.get(CONF_PASSWORD)).camera
|
|
|
|
persistent_notification = loader.get_component('persistent_notification')
|
|
try:
|
|
camera.current_time
|
|
except (ConnectTimeout, HTTPError) as ex:
|
|
_LOGGER.error("Unable to connect to Amcrest camera: %s", str(ex))
|
|
persistent_notification.create(
|
|
hass, 'Error: {}<br />'
|
|
'You will need to restart hass after fixing.'
|
|
''.format(ex),
|
|
title=NOTIFICATION_TITLE,
|
|
notification_id=NOTIFICATION_ID)
|
|
return False
|
|
|
|
sensors = []
|
|
for sensor_type in config.get(CONF_MONITORED_CONDITIONS):
|
|
sensors.append(AmcrestSensor(config, camera, sensor_type))
|
|
|
|
add_devices(sensors, True)
|
|
|
|
return True
|
|
|
|
|
|
class AmcrestSensor(Entity):
|
|
"""A sensor implementation for Amcrest IP camera."""
|
|
|
|
def __init__(self, device_info, camera, sensor_type):
|
|
"""Initialize a sensor for Amcrest camera."""
|
|
super(AmcrestSensor, self).__init__()
|
|
self._attrs = {}
|
|
self._camera = camera
|
|
self._sensor_type = sensor_type
|
|
self._name = '{0}_{1}'.format(device_info.get(CONF_NAME),
|
|
SENSOR_TYPES.get(self._sensor_type)[0])
|
|
self._icon = 'mdi:{}'.format(SENSOR_TYPES.get(self._sensor_type)[2])
|
|
self._state = STATE_UNKNOWN
|
|
|
|
@property
|
|
def name(self):
|
|
"""Return the name of the sensor."""
|
|
return self._name
|
|
|
|
@property
|
|
def state(self):
|
|
"""Return the state of the sensor."""
|
|
return self._state
|
|
|
|
@property
|
|
def device_state_attributes(self):
|
|
"""Return the state attributes."""
|
|
return self._attrs
|
|
|
|
@property
|
|
def icon(self):
|
|
"""Icon to use in the frontend, if any."""
|
|
return self._icon
|
|
|
|
@property
|
|
def unit_of_measurement(self):
|
|
"""Return the units of measurement."""
|
|
return SENSOR_TYPES.get(self._sensor_type)[1]
|
|
|
|
def update(self):
|
|
"""Get the latest data and updates the state."""
|
|
_LOGGER.debug("Pulling data from %s sensor.", self._name)
|
|
|
|
try:
|
|
version, build_date = self._camera.software_information
|
|
self._attrs['Build Date'] = build_date.split('=')[-1]
|
|
self._attrs['Version'] = version.split('=')[-1]
|
|
except ValueError:
|
|
self._attrs['Build Date'] = 'Not Available'
|
|
self._attrs['Version'] = 'Not Available'
|
|
|
|
try:
|
|
self._attrs['Serial Number'] = self._camera.serial_number
|
|
except ValueError:
|
|
self._attrs['Serial Number'] = 'Not Available'
|
|
|
|
if self._sensor_type == 'motion_detector':
|
|
self._state = self._camera.is_motion_detected
|
|
self._attrs['Record Mode'] = self._camera.record_mode
|
|
|
|
elif self._sensor_type == 'ptz_preset':
|
|
self._state = self._camera.ptz_presets_count
|
|
|
|
elif self._sensor_type == 'sdcard':
|
|
sd_used = self._camera.storage_used
|
|
sd_total = self._camera.storage_total
|
|
self._attrs['Total'] = '{0} {1}'.format(*sd_total)
|
|
self._attrs['Used'] = '{0} {1}'.format(*sd_used)
|
|
self._state = self._camera.storage_used_percent
|