mirror of
https://github.com/home-assistant/core.git
synced 2025-07-19 11:17:21 +00:00
Add traccar events (#22348)
* Add import_events(), small refactoring, traccar_id I isolated the code that imports traccar tracking data and added a new function that imports the traccar events to make them run in parallel and reduce delay. The events that are imported in hass, will be fired with the prefix "traccar_". Furthermore a traccar_id is now imported in hass entities, useful for matching the traccar hass entities with the traccar hass events in the most accurate way. * bump pytraccar version * Code format fix * Code format fix 2 * Code format fix 3 * Implement requested changes * Add new traccar dependency * Fix line too long * Update device_tracker.py * Update requirements_all.txt
This commit is contained in:
lapy
Martin Hjelmare
parent
a59487a438
commit
2731777c7e
@ -4,7 +4,7 @@ Support for Traccar device tracking.
|
||||
For more details about this platform, please refer to the documentation at
|
||||
https://home-assistant.io/components/device_tracker.traccar/
|
||||
"""
|
||||
from datetime import timedelta
|
||||
from datetime import datetime, timedelta
|
||||
import logging
|
||||
|
||||
import voluptuous as vol
|
||||
@ -13,14 +13,15 @@ from homeassistant.components.device_tracker import PLATFORM_SCHEMA
|
||||
from homeassistant.const import (
|
||||
CONF_HOST, CONF_PORT, CONF_SSL, CONF_VERIFY_SSL,
|
||||
CONF_PASSWORD, CONF_USERNAME, ATTR_BATTERY_LEVEL,
|
||||
CONF_SCAN_INTERVAL, CONF_MONITORED_CONDITIONS)
|
||||
CONF_SCAN_INTERVAL, CONF_MONITORED_CONDITIONS,
|
||||
CONF_EVENT)
|
||||
import homeassistant.helpers.config_validation as cv
|
||||
from homeassistant.helpers.aiohttp_client import async_get_clientsession
|
||||
from homeassistant.helpers.event import async_track_time_interval
|
||||
from homeassistant.util import slugify
|
||||
|
||||
|
||||
REQUIREMENTS = ['pytraccar==0.3.0']
|
||||
REQUIREMENTS = ['pytraccar==0.5.0', 'stringcase==1.2.0']
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
@ -30,6 +31,25 @@ ATTR_GEOFENCE = 'geofence'
|
||||
ATTR_MOTION = 'motion'
|
||||
ATTR_SPEED = 'speed'
|
||||
ATTR_TRACKER = 'tracker'
|
||||
ATTR_TRACCAR_ID = 'traccar_id'
|
||||
|
||||
EVENT_DEVICE_MOVING = 'device_moving'
|
||||
EVENT_COMMAND_RESULT = 'command_result'
|
||||
EVENT_DEVICE_FUEL_DROP = 'device_fuel_drop'
|
||||
EVENT_GEOFENCE_ENTER = 'geofence_enter'
|
||||
EVENT_DEVICE_OFFLINE = 'device_offline'
|
||||
EVENT_DRIVER_CHANGED = 'driver_changed'
|
||||
EVENT_GEOFENCE_EXIT = 'geofence_exit'
|
||||
EVENT_DEVICE_OVERSPEED = 'device_overspeed'
|
||||
EVENT_DEVICE_ONLINE = 'device_online'
|
||||
EVENT_DEVICE_STOPPED = 'device_stopped'
|
||||
EVENT_MAINTENANCE = 'maintenance'
|
||||
EVENT_ALARM = 'alarm'
|
||||
EVENT_TEXT_MESSAGE = 'text_message'
|
||||
EVENT_DEVICE_UNKNOWN = 'device_unknown'
|
||||
EVENT_IGNITION_OFF = 'ignition_off'
|
||||
EVENT_IGNITION_ON = 'ignition_on'
|
||||
EVENT_ALL_EVENTS = 'all_events'
|
||||
|
||||
DEFAULT_SCAN_INTERVAL = timedelta(seconds=30)
|
||||
SCAN_INTERVAL = DEFAULT_SCAN_INTERVAL
|
||||
@ -43,6 +63,25 @@ PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
|
||||
vol.Optional(CONF_VERIFY_SSL, default=True): cv.boolean,
|
||||
vol.Optional(CONF_MONITORED_CONDITIONS,
|
||||
default=[]): vol.All(cv.ensure_list, [cv.string]),
|
||||
vol.Optional(CONF_EVENT,
|
||||
default=[]): vol.All(cv.ensure_list,
|
||||
[vol.Any(EVENT_DEVICE_MOVING,
|
||||
EVENT_COMMAND_RESULT,
|
||||
EVENT_DEVICE_FUEL_DROP,
|
||||
EVENT_GEOFENCE_ENTER,
|
||||
EVENT_DEVICE_OFFLINE,
|
||||
EVENT_DRIVER_CHANGED,
|
||||
EVENT_GEOFENCE_EXIT,
|
||||
EVENT_DEVICE_OVERSPEED,
|
||||
EVENT_DEVICE_ONLINE,
|
||||
EVENT_DEVICE_STOPPED,
|
||||
EVENT_MAINTENANCE,
|
||||
EVENT_ALARM,
|
||||
EVENT_TEXT_MESSAGE,
|
||||
EVENT_DEVICE_UNKNOWN,
|
||||
EVENT_IGNITION_OFF,
|
||||
EVENT_IGNITION_ON,
|
||||
EVENT_ALL_EVENTS)]),
|
||||
})
|
||||
|
||||
|
||||
@ -58,7 +97,7 @@ async def async_setup_scanner(hass, config, async_see, discovery_info=None):
|
||||
scanner = TraccarScanner(
|
||||
api, hass, async_see,
|
||||
config.get(CONF_SCAN_INTERVAL, SCAN_INTERVAL),
|
||||
config[CONF_MONITORED_CONDITIONS])
|
||||
config[CONF_MONITORED_CONDITIONS], config[CONF_EVENT])
|
||||
|
||||
return await scanner.async_init()
|
||||
|
||||
@ -66,8 +105,12 @@ async def async_setup_scanner(hass, config, async_see, discovery_info=None):
|
||||
class TraccarScanner:
|
||||
"""Define an object to retrieve Traccar data."""
|
||||
|
||||
def __init__(self, api, hass, async_see, scan_interval, custom_attributes):
|
||||
def __init__(self, api, hass, async_see, scan_interval,
|
||||
custom_attributes,
|
||||
event_types):
|
||||
"""Initialize."""
|
||||
from stringcase import camelcase
|
||||
self._event_types = {camelcase(evt): evt for evt in event_types}
|
||||
self._custom_attributes = custom_attributes
|
||||
self._scan_interval = scan_interval
|
||||
self._async_see = async_see
|
||||
@ -89,6 +132,12 @@ class TraccarScanner:
|
||||
"""Update info from Traccar."""
|
||||
_LOGGER.debug('Updating device data.')
|
||||
await self._api.get_device_info(self._custom_attributes)
|
||||
self._hass.async_create_task(self.import_device_data())
|
||||
if self._event_types:
|
||||
self._hass.async_create_task(self.import_events())
|
||||
|
||||
async def import_device_data(self):
|
||||
"""Import device data from Traccar."""
|
||||
for devicename in self._api.device_info:
|
||||
device = self._api.device_info[devicename]
|
||||
attr = {}
|
||||
@ -105,6 +154,8 @@ class TraccarScanner:
|
||||
attr[ATTR_BATTERY_LEVEL] = device['battery']
|
||||
if device.get('motion') is not None:
|
||||
attr[ATTR_MOTION] = device['motion']
|
||||
if device.get('traccar_id') is not None:
|
||||
attr[ATTR_TRACCAR_ID] = device['traccar_id']
|
||||
for custom_attr in self._custom_attributes:
|
||||
if device.get(custom_attr) is not None:
|
||||
attr[custom_attr] = device[custom_attr]
|
||||
@ -112,3 +163,27 @@ class TraccarScanner:
|
||||
dev_id=slugify(device['device_id']),
|
||||
gps=(device.get('latitude'), device.get('longitude')),
|
||||
attributes=attr)
|
||||
|
||||
async def import_events(self):
|
||||
"""Import events from Traccar."""
|
||||
device_ids = [device['id'] for device in self._api.devices]
|
||||
end_interval = datetime.utcnow()
|
||||
start_interval = end_interval - self._scan_interval
|
||||
events = await self._api.get_events(
|
||||
device_ids=device_ids,
|
||||
from_time=start_interval,
|
||||
to_time=end_interval,
|
||||
event_types=self._event_types.keys())
|
||||
if events is not None:
|
||||
for event in events:
|
||||
device_name = next((
|
||||
dev.get('name') for dev in self._api.devices()
|
||||
if dev.get('id') == event['deviceId']), None)
|
||||
self._hass.bus.async_fire(
|
||||
'traccar_' + self._event_types.get(event["type"]), {
|
||||
'device_traccar_id': event['deviceId'],
|
||||
'device_name': device_name,
|
||||
'type': event['type'],
|
||||
'serverTime': event['serverTime'],
|
||||
'attributes': event['attributes']
|
||||
})
|
||||
|
||||
@ -1433,7 +1433,7 @@ pytile==2.0.6
|
||||
pytouchline==0.7
|
||||
|
||||
# homeassistant.components.traccar.device_tracker
|
||||
pytraccar==0.3.0
|
||||
pytraccar==0.5.0
|
||||
|
||||
# homeassistant.components.trackr.device_tracker
|
||||
pytrackr==0.0.5
|
||||
@ -1653,6 +1653,7 @@ statsd==3.2.1
|
||||
steamodd==4.21
|
||||
|
||||
# homeassistant.components.thermoworks_smoke.sensor
|
||||
# homeassistant.components.traccar.device_tracker
|
||||
stringcase==1.2.0
|
||||
|
||||
# homeassistant.components.ecovacs
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user