1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457
|
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""Communicate with VOC server."""
import logging
from datetime import timedelta
from json import dumps as to_json
from collections import OrderedDict
from sys import argv
from urllib.parse import urljoin
import asyncio
from aiohttp import ClientSession, ClientTimeout, BasicAuth
from aiohttp.hdrs import METH_GET, METH_POST
from .util import (
json_serialize,
is_valid_path,
find_path,
json_loads,
read_config,
)
__version__ = "0.10.4"
_LOGGER = logging.getLogger(__name__)
SERVICE_URL = "https://vocapi{region}.wirelesscar.net/customerapi/rest/v3.0/"
DEFAULT_SERVICE_URL = SERVICE_URL.format(region="")
HEADERS = {
"X-Device-Id": "Device",
"X-OS-Type": "Android",
"X-Originator-Type": "App",
"X-OS-Version": "22",
"Content-Type": "application/json",
}
TIMEOUT = timedelta(seconds=30)
class Connection:
"""Connection to the VOC server."""
def __init__(
self, session, username, password, service_url=None, region=None, **_
):
"""Initialize."""
_LOGGER.info("%s %s %s", __name__, __version__, __file__)
self._session = session
self._auth = BasicAuth(username, password)
self._service_url = (
SERVICE_URL.format(region="-" + region)
if region
else service_url or DEFAULT_SERVICE_URL
)
self._state = {}
_LOGGER.debug("Using service <%s>", self._service_url)
_LOGGER.debug("User: <%s>", username)
async def _request(self, method, url, **kwargs):
"""Perform a query to the online service."""
try:
_LOGGER.debug("Request for %s", url)
async with self._session.request(
method,
url,
headers=HEADERS,
auth=self._auth,
timeout=ClientTimeout(total=TIMEOUT.seconds),
**kwargs
) as response:
response.raise_for_status()
res = await response.json(loads=json_loads)
_LOGGER.debug("Received %s", res)
return res
except Exception as error:
_LOGGER.warning(
"Failure when communicating with the server: %s",
error,
exc_info=True,
)
raise
def _make_url(self, ref, rel=None):
return urljoin(rel or self._service_url, ref)
async def get(self, url, rel=None):
"""Perform a query to the online service."""
return await self._request(METH_GET, self._make_url(url, rel))
async def post(self, url, rel=None, **data):
"""Perform a query to the online service."""
return await self._request(
METH_POST, self._make_url(url, rel), json=data
)
async def update(self, journal=False, reset=False):
"""Update status."""
try:
_LOGGER.info("Updating")
if not self._state or reset:
_LOGGER.info("Querying vehicles")
user = await self.get("customeraccounts")
_LOGGER.debug("Account for <%s> received", user["username"])
self._state = {}
for vehicle in user["accountVehicleRelations"]:
rel = await self.get(vehicle)
if rel.get("status") == "Verified":
url = rel["vehicle"] + "/"
state = await self.get("attributes", rel=url)
self._state.update({url: state})
else:
_LOGGER.warning("vehichle not verified")
for vehicle in self.vehicles:
await vehicle.update(journal=journal)
_LOGGER.debug("State: %s", self._state)
return True
except (OSError, LookupError) as error:
_LOGGER.warning("Could not query server: %s", error)
async def update_vehicle(self, vehicle, journal=False):
url = vehicle._url
self._state[url].update(await self.get("status", rel=url))
self._state[url].update(await self.get("position", rel=url))
if journal:
self._state[url].update(await self.get("trips", rel=url))
@property
def vehicles(self):
"""Return vehicle state."""
return (Vehicle(self, url) for url in self._state)
def vehicle(self, vin):
"""Return vehicle for given vin."""
return next(
(
vehicle
for vehicle in self.vehicles
if vehicle.unique_id == vin.lower()
),
None,
)
def vehicle_attrs(self, vehicle_url):
return self._state.get(vehicle_url)
class Vehicle(object):
"""Convenience wrapper around the state returned from the server."""
def __init__(self, conn, url):
self._connection = conn
self._url = url
async def update(self, journal=False):
await self._connection.update_vehicle(self, journal)
@property
def attrs(self):
return self._connection.vehicle_attrs(self._url)
def has_attr(self, attr):
return is_valid_path(self.attrs, attr)
def get_attr(self, attr):
return find_path(self.attrs, attr)
@property
def unique_id(self):
return (self.registration_number or self.vin).lower()
@property
def position(self):
return self.attrs.get("position")
@property
def registration_number(self):
return self.attrs.get("registrationNumber")
@property
def vin(self):
return self.attrs.get("vin")
@property
def model_year(self):
return self.attrs.get("modelYear")
@property
def vehicle_type(self):
return self.attrs.get("vehicleType")
@property
def odometer(self):
return self.attrs.get("odometer")
@property
def fuel_amount_level(self):
return self.attrs.get("fuelAmountLevel")
@property
def distance_to_empty(self):
return self.attrs.get("distanceToEmpty")
@property
def is_honk_and_blink_supported(self):
return self.attrs.get("honkAndBlinkSupported")
@property
def doors(self):
return self.attrs.get("doors")
@property
def windows(self):
return self.attrs.get("windows")
@property
def is_lock_supported(self):
return self.attrs.get("lockSupported")
@property
def is_unlock_supported(self):
return self.attrs.get("unlockSupported")
@property
def is_locked(self):
return self.attrs.get("carLocked")
@property
def heater(self):
return self.attrs.get("heater")
@property
def is_remote_heater_supported(self):
return self.attrs.get("remoteHeaterSupported")
@property
def is_preclimatization_supported(self):
return self.attrs.get("preclimatizationSupported")
@property
def is_journal_supported(self):
return self.attrs.get("journalLogSupported") and self.attrs.get(
"journalLogEnabled"
)
@property
def is_engine_running(self):
engine_remote_start_status = (
self.attrs.get("ERS", {}).get("status") or ""
)
return (
self.attrs.get("engineRunning")
or "on" in engine_remote_start_status
)
@property
def is_engine_start_supported(self):
return self.attrs.get("engineStartSupported") and self.attrs.get("ERS")
async def get(self, query):
"""Perform a query to the online service."""
return await self._connection.get(query, self._url)
async def post(self, query, **data):
"""Perform a query to the online service."""
return await self._connection.post(query, self._url, **data)
async def call(self, method, **data):
"""Make remote method call."""
try:
res = await self.post(method, **data)
if "service" not in res or "status" not in res:
_LOGGER.warning("Failed to execute: %s", res["status"])
return
if res["status"] not in ["Queued", "Started"]:
_LOGGER.warning("Failed to execute: %s", res["status"])
return
# if Queued -> wait?
service_url = res["service"]
res = await self.get(service_url)
if "status" not in res:
_LOGGER.warning("Message not delivered")
return
# if still Queued -> wait?
if res["status"] not in [
"MessageDelivered",
"Successful",
"Started",
]:
_LOGGER.warning("Message not delivered: %s", res["status"])
return
_LOGGER.debug("Message delivered")
return True
except Exception as error:
_LOGGER.warning("Failure to execute: %s", error)
@staticmethod
def any_open(doors):
"""
>>> Vehicle.any_open({'frontLeftWindowOpen': False,
... 'frontRightWindowOpen': False,
... 'timestamp': 'foo'})
False
>>> Vehicle.any_open({'frontLeftWindowOpen': True,
... 'frontRightWindowOpen': False,
... 'timestamp': 'foo'})
True
"""
return doors and any(doors[door] for door in doors if "Open" in door)
@property
def any_window_open(self):
return self.any_open(self.windows)
@property
def any_door_open(self):
return self.any_open(self.doors)
@property
def position_supported(self):
"""Return true if vehicle has position."""
return "position" in self.attrs
@property
def heater_supported(self):
"""Return true if vehicle has heater."""
return (
self.is_remote_heater_supported
or self.is_preclimatization_supported
) and "heater" in self.attrs
@property
def is_heater_on(self):
"""Return status of heater."""
return (
self.heater_supported
and "status" in self.heater
and self.heater["status"] != "off"
)
@property
def trips(self):
"""Return trips."""
return self.attrs.get("trips")
async def honk_and_blink(self):
"""Honk and blink."""
if self.is_honk_and_blink_supported:
await self.call("honkAndBlink")
async def lock(self):
"""Lock."""
if self.is_lock_supported:
await self.call("lock")
await self.update()
else:
_LOGGER.warning("Lock not supported")
async def unlock(self):
"""Unlock."""
if self.is_unlock_supported:
await self.call("unlock")
await self.update()
else:
_LOGGER.warning("Unlock not supported")
async def start_engine(self):
if self.is_engine_start_supported:
await self.call("engine/start", runtime=15)
await self.update()
else:
_LOGGER.warning("Engine start not supported.")
async def stop_engine(self):
if self.is_engine_start_supported:
await self.call("engine/stop")
await self.update()
else:
_LOGGER.warning("Engine stop not supported.")
async def start_heater(self):
"""Turn on/off heater."""
if self.is_remote_heater_supported:
await self.call("heater/start")
await self.update()
elif self.is_preclimatization_supported:
await self.call("preclimatization/start")
await self.update()
else:
_LOGGER.warning("No heater or preclimatization support.")
async def stop_heater(self):
"""Turn on/off heater."""
if self.is_remote_heater_supported:
await self.call("heater/stop")
await self.update()
elif self.is_preclimatization_supported:
await self.call("preclimatization/stop")
await self.update()
else:
_LOGGER.warning("No heater or preclimatization support.")
def __str__(self):
return "%s (%s/%s) %s" % (
self.registration_number or "?",
self.vehicle_type or "?",
self.model_year or "?",
self.vin or "?",
)
def dashboard(self, **config):
from .dashboard import Dashboard
return Dashboard(self, **config)
@property
def json(self):
"""Return JSON representation."""
return to_json(
OrderedDict(sorted(self.attrs.items())),
indent=4,
default=json_serialize,
)
async def main():
"""Main method."""
if "-v" in argv:
logging.basicConfig(level=logging.INFO)
elif "-vv" in argv:
logging.basicConfig(level=logging.DEBUG)
else:
logging.basicConfig(level=logging.ERROR)
async with ClientSession() as session:
connection = Connection(session, **read_config())
if await connection.update():
for vehicle in connection.vehicles:
print(vehicle)
if __name__ == "__main__":
loop = asyncio.get_event_loop()
loop.run(main())
|