pax_global_header00006660000000000000000000000064135540070670014521gustar00rootroot0000000000000052 comment=62e89aa942f07e296950c5fe350d02a688bff06e Anonym-tsk-starline-62e89aa/000077500000000000000000000000001355400706700160215ustar00rootroot00000000000000Anonym-tsk-starline-62e89aa/.gitignore000066400000000000000000000022721355400706700200140ustar00rootroot00000000000000# Byte-compiled / optimized / DLL files __pycache__/ *.py[cod] *$py.class # C extensions *.so # Distribution / packaging .Python build/ develop-eggs/ dist/ downloads/ eggs/ .eggs/ lib/ lib64/ parts/ sdist/ var/ wheels/ *.egg-info/ .installed.cfg *.egg MANIFEST # PyInstaller # Usually these files are written by a python script from a template # before PyInstaller builds the exe, so as to inject date/other infos into it. *.manifest *.spec # Installer logs pip-log.txt pip-delete-this-directory.txt # Unit test / coverage reports htmlcov/ .tox/ .coverage .coverage.* .cache nosetests.xml coverage.xml *.cover .hypothesis/ .pytest_cache/ # Translations *.mo *.pot # Django stuff: *.log local_settings.py db.sqlite3 # Flask stuff: instance/ .webassets-cache # Scrapy stuff: .scrapy # Sphinx documentation docs/_build/ # PyBuilder target/ # Jupyter Notebook .ipynb_checkpoints # pyenv .python-version # celery beat schedule file celerybeat-schedule # SageMath parsed files *.sage.py # Environments .env .venv env/ venv/ ENV/ env.bak/ venv.bak/ # Spyder project settings .spyderproject .spyproject # Rope project settings .ropeproject # mkdocs documentation /site # mypy .mypy_cache/ *.iml Anonym-tsk-starline-62e89aa/LICENSE000066400000000000000000000261351355400706700170350ustar00rootroot00000000000000 Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. Anonym-tsk-starline-62e89aa/README.md000066400000000000000000000003551355400706700173030ustar00rootroot00000000000000# starline Unofficial python library for StarLine API --- Enjoy my work? Help me out for a couple of :beers: or a :coffee:! [![coffee](https://www.buymeacoffee.com/assets/img/custom_images/black_img.png)](http://yasobe.ru/na/esphome) Anonym-tsk-starline-62e89aa/README.rst000066400000000000000000000000771355400706700175140ustar00rootroot00000000000000starline ======== Unofficial python library for StarLine API. Anonym-tsk-starline-62e89aa/setup.py000066400000000000000000000032471355400706700175410ustar00rootroot00000000000000from __future__ import print_function from setuptools import setup import codecs import os import re here = os.path.abspath(os.path.dirname(__file__)) def read(*parts): return codecs.open(os.path.join(here, *parts), 'r').read() def find_version(*file_paths): version_file = read(*file_paths) version_match = re.search(r"^__version__ = ['\"]([^'\"]*)['\"]", version_file, re.M) if version_match: return version_match.group(1) raise RuntimeError("Unable to find version string.") long_description = read('README.rst') setup( name='starline', version=find_version('starline', '__init__.py'), description='Unofficial python library for StarLine API', long_description=long_description, url='https://github.com/Anonym-tsk/starline/', license='Apache License 2.0', keywords='starline car security', author='Nikolay Vasilchuk', author_email='anonym.tsk@gmail.com', install_requires=[ 'aiohttp>=3.6.1' ], packages=['starline'], include_package_data=True, platforms='any', python_requires='>=3.5', classifiers=[ 'Programming Language :: Python :: 3.5', 'Programming Language :: Python :: 3.6', 'Programming Language :: Python :: 3.7', 'Programming Language :: Python :: 3 :: Only', 'Development Status :: 4 - Beta', 'Intended Audience :: Developers', 'License :: OSI Approved :: Apache Software License', 'Operating System :: OS Independent', 'Topic :: Software Development :: Libraries :: Python Modules', 'Topic :: Software Development :: Libraries :: Application Frameworks', ] ) Anonym-tsk-starline-62e89aa/starline/000077500000000000000000000000001355400706700176425ustar00rootroot00000000000000Anonym-tsk-starline-62e89aa/starline/__init__.py000066400000000000000000000002031355400706700217460ustar00rootroot00000000000000from .auth_api import StarlineAuth from .starline_api import StarlineApi from .device import StarlineDevice __version__ = '0.1.1' Anonym-tsk-starline-62e89aa/starline/auth_api.py000066400000000000000000000054461355400706700220170ustar00rootroot00000000000000"""Auth StarLine API.""" import hashlib import logging from .base_api import BaseApi _LOGGER = logging.getLogger(__name__) class StarlineAuth(BaseApi): """Auth StarLine API class.""" def get_app_code(self, app_id: str, app_secret: str) -> str: """Get application code for getting application token.""" url = "https://id.starline.ru/apiV3/application/getCode/" payload = { "appId": app_id, "secret": hashlib.md5(app_secret.encode(self._encoding)).hexdigest(), } response = self._get(url, params=payload) if response is None: raise Exception("Failed to get application code") if int(response["state"]) == 1: app_code = response["desc"]["code"] _LOGGER.debug("Application code: {}".format(app_code)) return app_code raise Exception("Invalid response state: {}", response["state"]) def get_app_token(self, app_id: str, app_secret: str, app_code: str) -> str: """Get application token for authentication.""" url = "https://id.starline.ru/apiV3/application/getToken/" payload = { "appId": app_id, "secret": hashlib.md5((app_secret + app_code).encode(self._encoding)).hexdigest(), } response = self._get(url, params=payload) if response is None: raise Exception("Failed to get application token") if int(response["state"]) == 1: app_token = response["desc"]["token"] _LOGGER.debug("Application token: {}".format(app_token)) return app_token raise Exception("Invalid response state: {}", response["state"]) def get_slid_user_token(self, app_token: str, user_login: str, user_password: str, sms_code: str = None, captcha_sid: str = None, captcha_code: str = None) -> (bool, dict): """Authenticate user by login, password and application token.""" url = "https://id.starline.ru/apiV3/user/login/" payload = {"token": app_token} data = { "login": user_login, "pass": hashlib.sha1(user_password.encode(self._encoding)).hexdigest(), } if sms_code is not None: data["smsCode"] = sms_code if (captcha_sid is not None) and (captcha_code is not None): data["captchaSid"] = captcha_sid data["captchaCode"] = captcha_code response = self._post(url, params=payload, data=data) if response is None: raise Exception("Failed to get user token") state = int(response["state"]) if (state == 1) or (state == 2) or (state == 0 and "captchaSid" in response["desc"]) or (state == 0 and "phone" in response["desc"]): return state, response["desc"] raise Exception("Invalid response state: {}", state) Anonym-tsk-starline-62e89aa/starline/base_api.py000066400000000000000000000073361355400706700217700ustar00rootroot00000000000000"""Base StarLine API.""" import logging import requests from datetime import datetime from typing import Optional from .const import DEFAULT_CONNECT_TIMEOUT, DEFAULT_READ_TIMEOUT, DEFAULT_ENCODING, GET, POST _LOGGER = logging.getLogger(__name__) class BaseApi: """Base StarLine API class.""" def __init__(self): """Constructor.""" self._session: requests.Session = requests.Session() self._connect_timeout: int = DEFAULT_CONNECT_TIMEOUT self._read_timeout: int = DEFAULT_READ_TIMEOUT self._encoding: str = DEFAULT_ENCODING def set_timeout(self, read_timeout: int, connect_timeout: int = None) -> None: """Set connection timeouts.""" self._read_timeout = read_timeout if connect_timeout is not None: self._connect_timeout = connect_timeout def set_encoding(self, encoding: str) -> None: """Set response encoding.""" self._encoding = encoding def _request(self, method: str, url: str, params: dict = None, data: dict = None, json: dict = None, headers: dict = None) -> Optional[requests.Response]: """Make request.""" try: response = self._session.request( method, url, params=params, data=data, json=json, headers=headers, timeout=(self._connect_timeout, self._read_timeout), ) response.encoding = self._encoding response.raise_for_status() _LOGGER.debug("StarlineApi {} request: {}".format(method, url)) _LOGGER.debug(" Payload: {}".format(params)) _LOGGER.debug(" Data: {}".format(data)) _LOGGER.debug(" JSON: {}".format(json)) _LOGGER.debug(" Headers: {}".format(headers)) _LOGGER.debug(" Response: {}".format(response)) return response except requests.exceptions.RequestException as error: _LOGGER.error("Request failed: %s", error) return None def _get(self, url: str, params: dict = None, headers: dict = None) -> Optional[dict]: """Make GET request.""" response = self._request(GET, url, params=params, headers=headers) if response is None: return None data = response.json() _LOGGER.debug(" Data: {}".format(data)) return data def _post(self, url: str, params: dict = None, data: dict = None, json: dict = None, headers: dict = None) -> Optional[dict]: """Make POST request.""" response = self._request(POST, url, params=params, data=data, json=json, headers=headers) if response is None: return None data = response.json() _LOGGER.debug(" Data: {}".format(data)) return data def get_user_id(self, slid_token: str) -> (str, float, str): """Authenticate user by StarLineID token.""" url = "https://developer.starline.ru/json/v2/auth.slid" data = {"slid_token": slid_token} response = self._request(POST, url, json=data) if response is None: raise Exception("Failed to get SLNet token") json = response.json() if int(json["code"]) != 200: raise Exception(json["codestring"]) slnet_token = None expires_time = datetime.now().timestamp() + (4 * 60 * 60) # Now + 4h for cookie in response.cookies: if cookie.name == 'slnet': slnet_token = cookie.value expires_time = cookie.expires if slnet_token is None: raise Exception("Failed to get SLNet token") _LOGGER.debug("SLNet token: {}".format(slnet_token)) return slnet_token, expires_time, json["user_id"] Anonym-tsk-starline-62e89aa/starline/const.py000066400000000000000000000004501355400706700213410ustar00rootroot00000000000000"""StarLine constants.""" DEFAULT_CONNECT_TIMEOUT = 10 DEFAULT_READ_TIMEOUT = 120 DEFAULT_ENCODING = 'utf-8' GET = 'GET' POST = 'POST' BATTERY_LEVEL_MIN = 11.8 BATTERY_LEVEL_MAX = 13.0 GSM_LEVEL_MIN = 1 GSM_LEVEL_MAX = 30 DEVICE_FUNCTION_POSITION = "position" DEVICE_FUNCTION_STATE = "state" Anonym-tsk-starline-62e89aa/starline/device.py000066400000000000000000000112641355400706700214570ustar00rootroot00000000000000"""StarLine device.""" from typing import Optional, Dict, Any, List from .const import ( BATTERY_LEVEL_MIN, BATTERY_LEVEL_MAX, GSM_LEVEL_MIN, GSM_LEVEL_MAX, DEVICE_FUNCTION_POSITION, DEVICE_FUNCTION_STATE, ) class StarlineDevice: """StarLine device class.""" def __init__(self): """Constructor.""" self._device_id: Optional[str] = None self._imei: Optional[str] = None self._alias: Optional[str] = None self._battery: Optional[int] = None self._ctemp: Optional[int] = None self._etemp: Optional[int] = None self._fw_version: Optional[str] = None self._gsm_lvl: Optional[int] = None self._phone: Optional[str] = None self._status: Optional[int] = None self._ts_activity: Optional[float] = None self._typename: Optional[str] = None self._balance: Dict[str, Dict[str, Any]] = {} self._car_state: Dict[str, bool] = {} self._car_alr_state: Dict[str, bool] = {} self._functions: List[str] = [] self._position: Dict[str, float] = {} def update(self, device_data): """Update data from server.""" self._device_id = str(device_data["device_id"]) self._imei = device_data["imei"] self._alias = device_data["alias"] self._battery = device_data["battery"] self._ctemp = device_data["ctemp"] self._etemp = device_data["etemp"] self._fw_version = device_data["fw_version"] self._gsm_lvl = device_data["gsm_lvl"] self._phone = device_data["phone"] self._status = device_data["status"] self._ts_activity = device_data["ts_activity"] self._typename = device_data["typename"] self._balance = device_data["balance"] self._car_state = device_data["car_state"] self._car_alr_state = device_data["car_alr_state"] self._functions = device_data["functions"] self._position = device_data["position"] def update_car_state(self, car_state): """Update car state from server.""" for key in car_state: if key in self._car_state: self._car_state[key] = car_state[key] in ["1", "true", True] @property def support_position(self): """Is position supported by this device.""" return DEVICE_FUNCTION_POSITION in self._functions @property def support_state(self): """Is state supported by this device.""" return DEVICE_FUNCTION_STATE in self._functions @property def device_id(self): """Device ID.""" return self._device_id @property def fw_version(self): """Firmware version.""" return self._fw_version @property def name(self): """Device name.""" return self._alias @property def typename(self): """Device type name.""" return self._typename @property def position(self): """Car position.""" return self._position @property def online(self): """Is device online.""" return int(self._status) == 1 @property def battery_level(self): """Car battery level.""" return self._battery @property def battery_level_percent(self): """Car battery level percent.""" if self._battery > BATTERY_LEVEL_MAX: return 100 if self._battery < BATTERY_LEVEL_MIN: return 0 return round( (self._battery - BATTERY_LEVEL_MIN) / (BATTERY_LEVEL_MAX - BATTERY_LEVEL_MIN) * 100 ) @property def balance(self): """Device balance.""" return self._balance["active"] @property def car_state(self): """Car state.""" return self._car_state @property def alarm_state(self): """Car alarm level.""" return self._car_alr_state @property def temp_inner(self): """Car inner temperature.""" return self._ctemp @property def temp_engine(self): """Engine temperarure.""" return self._etemp @property def gsm_level(self): """GSM signal level.""" return self._gsm_lvl if self.online else 0 @property def gsm_level_percent(self): """GSM signal level percent.""" if self.gsm_level > GSM_LEVEL_MAX: return 100 if self.gsm_level < GSM_LEVEL_MIN: return 0 return round( (self.gsm_level - GSM_LEVEL_MIN) / (GSM_LEVEL_MAX - GSM_LEVEL_MIN) * 100 ) @property def imei(self): """Device IMEI.""" return self._imei @property def phone(self): """Device phone number.""" return self._phone Anonym-tsk-starline-62e89aa/starline/starline_api.py000066400000000000000000000063011355400706700226660ustar00rootroot00000000000000"""Data StarLine API.""" import logging from typing import Dict, List, Callable, Optional, Any from .base_api import BaseApi from .device import StarlineDevice _LOGGER = logging.getLogger(__name__) class StarlineApi(BaseApi): """Data StarLine API class.""" def __init__(self, user_id: str, slnet_token: str): """Constructor.""" super().__init__() self._user_id: str = user_id self._slnet_token: str = slnet_token self._devices: Dict[str, StarlineDevice] = {} self._available: bool = False self._update_listeners: List[Callable] = [] def _call_listeners(self) -> None: """Call listeners for update notifications.""" for listener in self._update_listeners: listener() def add_update_listener(self, listener: Callable) -> Callable: """Add a listener for update notifications.""" def dispose_(): self._update_listeners.remove(listener) self._update_listeners.append(listener) return dispose_ def update(self) -> None: """Update StarLine data.""" devices = self.get_user_info() if not devices: self._available = False else: self._available = True for device_data in devices: device_id = str(device_data["device_id"]) if device_id not in self._devices: self._devices[device_id] = StarlineDevice() self._devices[device_id].update(device_data) self._call_listeners() @property def devices(self) -> Dict[str, StarlineDevice]: """Devices list.""" return self._devices @property def available(self) -> bool: """Is data available""" return self._available def get_user_info(self) -> Optional[List[Dict[str, Any]]]: """Get user information.""" url = "https://developer.starline.ru/json/v2/user/{}/user_info".format(self._user_id) headers = {"Cookie": "slnet=" + self._slnet_token} response = self._get(url, headers=headers) if response is None: return None code = int(response["code"]) if code == 200: return response["devices"] + response["shared_devices"] return None def set_car_state(self, device_id: str, name: str, state: bool): """Set car state information.""" _LOGGER.debug("Setting car %s state: %s=%d", device_id, name, state) url = "https://developer.starline.ru/json/v1/device/{}/set_param".format(device_id) data = {"type": name, name: 1 if state else 0} headers = {"Cookie": "slnet=" + self._slnet_token} response = self._post(url, json=data, headers=headers) if response is None: return None code = int(response["code"]) if code == 200: self._devices[device_id].update_car_state(response) self._call_listeners() return response return None def set_user_id(self, user_id: str) -> None: """Update user ID.""" self._user_id = user_id def set_slnet_token(self, slnet_token: str) -> None: """Update SLNet token.""" self._slnet_token = slnet_token