├── hacs.json ├── web └── images │ ├── homekit.png │ ├── logo_1024.png │ └── michaelknightopen.jpg ├── custom_components └── yale_doorman_via_smarthub │ ├── hub.login │ ├── manifest.json │ ├── services.yaml │ ├── const.py │ ├── entity.py │ ├── translations │ ├── en.json │ └── sv.json │ ├── binary_sensor.py │ ├── config_flow.py │ ├── lock.py │ ├── api.py │ └── __init__.py ├── .github └── workflows │ ├── hassfest.yaml │ └── validate.yaml ├── info.md ├── README.md └── LICENSE /hacs.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "Yale Doorman via Smart Hub", 3 | "domains": ["lock"], 4 | "iot_class": ["Cloud Polling"] 5 | } -------------------------------------------------------------------------------- /web/images/homekit.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jockesyk/homeassistant-yale-doorman-via-smarthub/HEAD/web/images/homekit.png -------------------------------------------------------------------------------- /web/images/logo_1024.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jockesyk/homeassistant-yale-doorman-via-smarthub/HEAD/web/images/logo_1024.png -------------------------------------------------------------------------------- /web/images/michaelknightopen.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jockesyk/homeassistant-yale-doorman-via-smarthub/HEAD/web/images/michaelknightopen.jpg -------------------------------------------------------------------------------- /custom_components/yale_doorman_via_smarthub/hub.login: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jockesyk/homeassistant-yale-doorman-via-smarthub/HEAD/custom_components/yale_doorman_via_smarthub/hub.login -------------------------------------------------------------------------------- /.github/workflows/hassfest.yaml: -------------------------------------------------------------------------------- 1 | name: Validate with hassfest 2 | 3 | on: 4 | push: 5 | pull_request: 6 | schedule: 7 | - cron: "0 0 * * *" 8 | 9 | jobs: 10 | validate: 11 | runs-on: "ubuntu-latest" 12 | steps: 13 | - uses: "actions/checkout@v2" 14 | - uses: home-assistant/actions/hassfest@master 15 | -------------------------------------------------------------------------------- /.github/workflows/validate.yaml: -------------------------------------------------------------------------------- 1 | name: Validate 2 | 3 | on: 4 | push: 5 | pull_request: 6 | schedule: 7 | - cron: "0 0 * * *" 8 | 9 | jobs: 10 | validate: 11 | runs-on: "ubuntu-latest" 12 | steps: 13 | - uses: "actions/checkout@v2" 14 | - name: HACS validation 15 | uses: "hacs/action@main" 16 | with: 17 | category: "integration" 18 | -------------------------------------------------------------------------------- /info.md: -------------------------------------------------------------------------------- 1 | # homeassistant-yale-doorman-via-smarthub 2 | A Home Assistant integration to control a Yale Doorman lock via the Yale Smart Hub. 3 | So far only tested on a single Yale Doorman V2N. 4 | 5 | Doorman 6 | 7 | # Thank You 8 | Buy Me A Coffee
-------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # homeassistant-yale-doorman-via-smarthub 2 | A Home Assistant integration to control a Yale Doorman lock via the Yale Smart Hub. 3 | So far only tested on a single Yale Doorman V2N. 4 | 5 | Doorman 6 | 7 | # Thank You 8 | Buy Me A Coffee
-------------------------------------------------------------------------------- /custom_components/yale_doorman_via_smarthub/manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "domain": "yale_doorman_via_smarthub", 3 | "name": "Yale Doorman via Smart Hub", 4 | "documentation": "https://github.com/jockesyk/homeassistant-yale-doorman-via-smarthub", 5 | "issue_tracker": "https://github.com/jockesyk/homeassistant-yale-doorman-via-smarthub/issues", 6 | "requirements": [], 7 | "dependencies": [], 8 | "codeowners": ["@jockesyk"], 9 | "config_flow": true, 10 | "version": "0.0.8", 11 | "iot_class": "cloud_polling" 12 | } -------------------------------------------------------------------------------- /custom_components/yale_doorman_via_smarthub/services.yaml: -------------------------------------------------------------------------------- 1 | download_yale_event_log: 2 | name: Download Yale Event Log 3 | description: Download the event log from the Yale API, optionally across multiple pages. 4 | fields: 5 | pages: 6 | description: "Number of pages to fetch, or '*' to fetch all available pages." 7 | required: false 8 | example: "2" 9 | selector: 10 | text: 11 | response: 12 | description: "Result from request:" 13 | fields: 14 | event_log_table: 15 | description: "Formatted data" 16 | selector: 17 | object: 18 | total_rows_returned: 19 | description: "Number of rows" 20 | selector: 21 | object: 22 | pages_fetched: 23 | description: "Number of pages fetched" 24 | selector: 25 | number: 26 | -------------------------------------------------------------------------------- /custom_components/yale_doorman_via_smarthub/const.py: -------------------------------------------------------------------------------- 1 | NAME = "Yale Doorman via Smart Hub" 2 | DOMAIN = "yale_doorman_via_smarthub" 3 | DOMAIN_DATA = f"{DOMAIN}_data" 4 | VERSION = "0.0.3" 5 | ISSUE_URL = "https://github.com/jockesyk/homeassistant-yale-doorman-via-smarthub/issues" 6 | MANUFACTURER = "Yale" 7 | MODEL = "Doorman" 8 | HUBNAME = "Yale Smart Hub" 9 | 10 | BINARY_SENSOR_DEVICE_CLASS = "door" 11 | 12 | LOCK = "lock" 13 | BINARY_SENSOR = "binary_sensor" 14 | PLATFORMS = [LOCK, BINARY_SENSOR] 15 | 16 | CONF_USERNAME = "username" 17 | CONF_PASSWORD = "password" 18 | CONF_PINCODE = "pincode" 19 | CONF_ENABLE_BINARY_SENSOR = "enable_binary_sensor" 20 | 21 | BITWISE_CLOSED = 16 22 | BITWISE_LOCKED = 1 23 | 24 | STARTUP_MESSAGE = f""" 25 | ------------------------------------------------------------------- 26 | {NAME} 27 | Version: {VERSION} 28 | This is a custom integration! 29 | If you have any issues with this you need to open an issue here: 30 | {ISSUE_URL} 31 | ------------------------------------------------------------------- 32 | """ 33 | -------------------------------------------------------------------------------- /custom_components/yale_doorman_via_smarthub/entity.py: -------------------------------------------------------------------------------- 1 | from homeassistant.helpers.update_coordinator import CoordinatorEntity 2 | 3 | from .const import ( 4 | DOMAIN, 5 | MANUFACTURER, 6 | MODEL 7 | ) 8 | 9 | class YaleDoormanViaSmarthubEntity(CoordinatorEntity): 10 | 11 | def __init__(self, coordinator, config_entry): 12 | super().__init__(coordinator) 13 | self.config_entry = config_entry 14 | 15 | @property 16 | def unique_id(self): 17 | try: 18 | self._unique_id = self.coordinator.data["data"]["device_status"][self.idx]["device_id"] 19 | self._area = int(self.coordinator.data["data"]["device_status"][self.idx]["area"]) 20 | self._zone = int(self.coordinator.data["data"]["device_status"][self.idx]["no"]) 21 | self.old_unique_id = self._unique_id 22 | except Exception as exception: 23 | self._unique_id = self.old_unique_id 24 | 25 | return self._unique_id 26 | 27 | @property 28 | def device_info(self): 29 | return { 30 | "identifiers": {(DOMAIN, self.unique_id)}, 31 | "name": self.name, 32 | "model": MODEL, 33 | "manufacturer": MANUFACTURER, 34 | } 35 | 36 | @property 37 | def name(self): 38 | try: 39 | name = self.coordinator.data["data"]["device_status"][self.idx]["name"] 40 | self.old_name = name 41 | except Exception as exception: 42 | name = self.old_name 43 | 44 | return name 45 | -------------------------------------------------------------------------------- /custom_components/yale_doorman_via_smarthub/translations/en.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Yale Doorman via Smart Hub", 3 | "config": { 4 | "step": { 5 | "user": { 6 | "title": "Yale Doorman via Smart Hub", 7 | "description": "Enter the login information to access your Yale Smart Hub. If you want to be able to unlock the door using automations, also enter the PIN-code to use.", 8 | "data": { 9 | "username": "Username", 10 | "password": "Password", 11 | "pincode": "PIN-code", 12 | "enable_binary_sensor": "Show the door sensor as a separate entity" 13 | } 14 | } 15 | }, 16 | "error": { 17 | "auth": "Username/Password is wrong." 18 | } 19 | }, "options": { 20 | "step": { 21 | "user": { 22 | "title": "Yale Doorman via Smart Hub", 23 | "description": "Enter the login information to access your Yale Smart Hub. If you want to be able to unlock the door using automations, also enter the PIN-code to use.", 24 | "data": { 25 | "username": "Username", 26 | "password": "Password", 27 | "pincode": "PIN-code", 28 | "enable_binary_sensor": "Show the door sensor as a separate entity" 29 | } 30 | } 31 | } 32 | }, "responses": { 33 | "event_type": { 34 | "1301": "Yale hub - no powersupply", 35 | "1302": "Yale Hub - battery low", 36 | "1602": "Periodical test", 37 | "1801": "Unlocked from inside", 38 | "1802": "Unlocked from outside, token or keypad", 39 | "1803": "Unlocked by app", 40 | "1807": "Auto-relocked", 41 | "1812": "Lock added to the system", 42 | "1815": "Failed to lock", 43 | "1816": "Locked after a failed lock", 44 | "3801": "Locked from inside", 45 | "3802": "Locked with star button", 46 | "3803": "Locked with app", 47 | "3812": "Lock removed from the system" 48 | } 49 | } 50 | } 51 | -------------------------------------------------------------------------------- /custom_components/yale_doorman_via_smarthub/translations/sv.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "Yale Doorman via Smart Hub", 3 | "config": { 4 | "step": { 5 | "user": { 6 | "title": "Yale Doorman via Smart Hub", 7 | "description": "Ange inloggningsinformationen till din Yale Smart Hub. Om du vill kunna automatisera uppl\u00e5sning, ange ocks\u00e5 PIN-koden.", 8 | "data": { 9 | "username": "Anv\u00e4ndarnamn", 10 | "password": "L\u00f6senord", 11 | "pincode": "PIN-kod", 12 | "enable_binary_sensor": "Visa d\u00f6rr-sensorn som en egen entitet" 13 | } 14 | } 15 | }, 16 | "error": { 17 | "auth": "Felaktigt anv\u00e4ndarnamn eller l\u00f6senord" 18 | } 19 | }, "options": { 20 | "step": { 21 | "user": { 22 | "title": "Yale Doorman via Smart Hub", 23 | "description": "Ange inloggningsinformationen till din Yale Smart Hub. Om du vill kunna automatisera uppl\u00e5sning, ange ocks\u00e5 PIN-koden.", 24 | "data": { 25 | "username": "Anv\u00e4ndarnamn", 26 | "password": "L\u00f6senord", 27 | "pincode": "PIN-kod", 28 | "enable_binary_sensor": "Visa d\u00f6rr-sensorn som en egen entitet" 29 | } 30 | } 31 | } 32 | }, "responses": { 33 | "event_type": { 34 | "1301": "Yale hub - ingen str\u00f6mf\u00f6rs\u00f6rjning", 35 | "1302": "Yale Hub - l\u00e5g batteriniv\u00e5", 36 | "1602": "Periodiskt test", 37 | "1801": "Uppl\u00e5st inifr\u00e5n", 38 | "1802": "Uppl\u00e5st utifr\u00e5n med tagg eller kod", 39 | "1803": "Uppl\u00e5st av app", 40 | "1807": "Automatisk l\u00e5sning", 41 | "1812": "L\u00e5s tillagt i systemet", 42 | "1815": "L\u00e5sning misslyckades", 43 | "1816": "L\u00e5st efter misslyckad l\u00e5sning", 44 | "3801": "L\u00e5st från insidan", 45 | "3802": "L\u00e5st med *-knappen", 46 | "3803": "L\u00e5st med appen", 47 | "3812": "L\u00e5s borttaget fr\u00e5n systemet" 48 | } 49 | } 50 | } 51 | -------------------------------------------------------------------------------- /custom_components/yale_doorman_via_smarthub/binary_sensor.py: -------------------------------------------------------------------------------- 1 | from homeassistant.components.binary_sensor import BinarySensorEntity 2 | 3 | from .const import ( 4 | BINARY_SENSOR_DEVICE_CLASS, 5 | DOMAIN, 6 | CONF_ENABLE_BINARY_SENSOR, 7 | BITWISE_LOCKED, 8 | BITWISE_CLOSED 9 | ) 10 | 11 | from .entity import YaleDoormanViaSmarthubEntity 12 | 13 | import logging 14 | _LOGGER: logging.Logger = logging.getLogger(__package__) 15 | 16 | async def async_setup_entry(hass, entry, async_add_entities): 17 | try: 18 | coordinator = hass.data[DOMAIN][entry.entry_id] 19 | status = await coordinator.api.async_status() 20 | doors = [] 21 | idx = 0 22 | for device_status in status["data"]["device_status"]: 23 | door = YaleDoormanViaSmarthubBinarySensor(coordinator, entry, idx) 24 | doors.append(door) 25 | idx = idx + 1 26 | async_add_entities(doors, True) 27 | except Exception as exception: 28 | _LOGGER.error(exception) 29 | 30 | class YaleDoormanViaSmarthubBinarySensor(YaleDoormanViaSmarthubEntity, BinarySensorEntity): 31 | def __init__(self, coordinator, config_entry, idx): 32 | super().__init__(coordinator, config_entry) 33 | self.idx = idx 34 | 35 | @property 36 | def disabled_by(self): 37 | if self.config_entry.data.get(CONF_ENABLE_BINARY_SENSOR): 38 | return None 39 | return "integration" 40 | 41 | @property 42 | def device_class(self): 43 | return BINARY_SENSOR_DEVICE_CLASS 44 | 45 | @property 46 | def is_on(self): 47 | try: 48 | door_status = int(self.coordinator.data["data"]["device_status"][self.idx]["minigw_lock_status"],16) 49 | self.old_door_status = door_status 50 | except Exception as exception: 51 | try: 52 | door_status = self.old_door_status 53 | except Exception as exception2: 54 | door_status = 0 55 | 56 | if door_status & BITWISE_CLOSED: 57 | return False 58 | return True 59 | 60 | @property 61 | def icon(self): 62 | try: 63 | door_status = int(self.coordinator.data["data"]["device_status"][self.idx]["minigw_lock_status"],16) 64 | self.old_door_status = door_status 65 | except Exception as exception: 66 | try: 67 | door_status = self.old_door_status 68 | except Exception as exception2: 69 | door_status = 0 70 | 71 | if door_status & BITWISE_CLOSED: 72 | if door_status & BITWISE_LOCKED: 73 | return "mdi:door-closed-lock" 74 | return "mdi:door-closed" 75 | return "mdi:door-open" 76 | 77 | @property 78 | def is_locked(self): 79 | try: 80 | door_status = int(self.coordinator.data["data"]["device_status"][self.idx]["minigw_lock_status"],16) 81 | self.old_door_status = door_status 82 | 83 | except Exception as exception: 84 | try: 85 | door_status = self.old_door_status 86 | except Exception as exception2: 87 | door_status = 0 88 | 89 | if door_status & BITWISE_CLOSED: 90 | if door_status & BITWISE_LOCKED: 91 | return True 92 | return False 93 | 94 | @property 95 | def extra_state_attributes(self): 96 | lock = "unlocked" 97 | if self.is_locked: 98 | lock = "locked" 99 | return { 100 | "lock": lock 101 | } -------------------------------------------------------------------------------- /custom_components/yale_doorman_via_smarthub/config_flow.py: -------------------------------------------------------------------------------- 1 | from homeassistant import config_entries 2 | from homeassistant.core import callback 3 | from homeassistant.helpers.aiohttp_client import async_create_clientsession 4 | import voluptuous as vol 5 | import logging 6 | 7 | from .api import YaleDoormanViaSmarthubApiClient 8 | 9 | from .const import ( 10 | CONF_PASSWORD, 11 | CONF_USERNAME, 12 | CONF_PINCODE, 13 | CONF_ENABLE_BINARY_SENSOR, 14 | BINARY_SENSOR, 15 | DOMAIN, 16 | PLATFORMS, 17 | ) 18 | 19 | _LOGGER: logging.Logger = logging.getLogger(__package__) 20 | 21 | class YaleDoormanViaSmarthubFlowHandler(config_entries.ConfigFlow, domain=DOMAIN): 22 | 23 | VERSION = 1 24 | CONNECTION_CLASS = config_entries.CONN_CLASS_CLOUD_POLL 25 | 26 | def __init__(self): 27 | self._errors = {} 28 | 29 | async def async_step_user(self, user_input=None): 30 | self._errors = {} 31 | 32 | if user_input is not None: 33 | 34 | try: 35 | session = async_create_clientsession(self.hass) 36 | client = YaleDoormanViaSmarthubApiClient(user_input[CONF_USERNAME], user_input[CONF_PASSWORD], session) 37 | result = await client.async_login() 38 | if result: 39 | return self.async_create_entry( 40 | title = user_input[CONF_USERNAME], 41 | data = user_input, 42 | ) 43 | except Exception as exception: 44 | _LOGGER.error(exception) 45 | self._errors["base"] = "auth" 46 | 47 | return await self._show_config_form(user_input) 48 | 49 | @staticmethod 50 | @callback 51 | def async_get_options_flow(config_entry): 52 | return YaleDoormanViaSmarthubOptionsFlowHandler(config_entry) 53 | 54 | async def _show_config_form(self, user_input): 55 | return self.async_show_form( 56 | step_id="user", 57 | data_schema=vol.Schema( 58 | { 59 | vol.Required(CONF_USERNAME): str, 60 | vol.Required(CONF_PASSWORD): str, 61 | vol.Optional(CONF_PINCODE): str, 62 | vol.Required(CONF_ENABLE_BINARY_SENSOR, default = False): bool 63 | } 64 | ), 65 | errors=self._errors, 66 | ) 67 | 68 | class YaleDoormanViaSmarthubOptionsFlowHandler(config_entries.OptionsFlow): 69 | 70 | def __init__(self, config_entry): 71 | self.config_entry = config_entry 72 | self.options = dict(config_entry.options) 73 | 74 | async def async_step_init(self, user_input=None): 75 | return await self.async_step_user() 76 | 77 | async def async_step_user(self, user_input=None): 78 | if user_input is not None: 79 | self.options.update(user_input) 80 | return await self._update_options() 81 | 82 | return self.async_show_form( 83 | step_id="user", 84 | data_schema=vol.Schema( 85 | { 86 | vol.Required(CONF_USERNAME, default = self.config_entry.data.get(CONF_USERNAME)): str, 87 | vol.Required(CONF_PASSWORD, default = self.config_entry.data.get(CONF_PASSWORD)): str, 88 | vol.Optional(CONF_PINCODE, default = self.config_entry.data.get(CONF_PINCODE)): str, 89 | vol.Required(CONF_ENABLE_BINARY_SENSOR, default = self.config_entry.data.get(CONF_ENABLE_BINARY_SENSOR)): bool 90 | } 91 | ), 92 | ) 93 | 94 | async def _update_options(self): 95 | reload_entities = False 96 | if self.config_entry.data.get(CONF_ENABLE_BINARY_SENSOR) != self.options.get(CONF_ENABLE_BINARY_SENSOR): 97 | reload_entities = True 98 | 99 | self.config_entry.data = self.options 100 | 101 | if reload_entities: 102 | if self.options.get(CONF_ENABLE_BINARY_SENSOR): 103 | #coordinator.platforms.append(BINARY_SENSOR) 104 | #self.hass.async_add_job(self.hass.config_entries.async_forward_entry_setup(self.config_entry, BINARY_SENSOR)) 105 | pass 106 | else: 107 | #self.hass.config_entries.async_forward_entry_unload(self.config_entry, BINARY_SENSOR) 108 | pass 109 | 110 | return self.async_create_entry( 111 | title=self.config_entry.data.get(CONF_USERNAME), data=self.options 112 | ) 113 | -------------------------------------------------------------------------------- /custom_components/yale_doorman_via_smarthub/lock.py: -------------------------------------------------------------------------------- 1 | from homeassistant.components.lock import LockEntity 2 | 3 | from .const import ( 4 | DOMAIN, 5 | CONF_PINCODE, 6 | BITWISE_LOCKED, 7 | BITWISE_CLOSED 8 | ) 9 | 10 | from .entity import YaleDoormanViaSmarthubEntity 11 | from .api import YaleDoormanViaSmarthubApiClient 12 | 13 | import logging 14 | _LOGGER: logging.Logger = logging.getLogger(__package__) 15 | 16 | async def async_setup_entry(hass, entry, async_add_entities): 17 | try: 18 | coordinator = hass.data[DOMAIN][entry.entry_id] 19 | status = await coordinator.api.async_status() 20 | locks = [] 21 | idx = 0 22 | for device_status in status["data"]["device_status"]: 23 | lock = YaleDoormanViaSmarthubLock(coordinator, entry, idx) 24 | locks.append(lock) 25 | idx = idx + 1 26 | async_add_entities(locks, True) 27 | except Exception as exception: 28 | _LOGGER.error(exception) 29 | 30 | class YaleDoormanViaSmarthubLock(YaleDoormanViaSmarthubEntity, LockEntity): 31 | 32 | def __init__(self, coordinator, config_entry, idx): 33 | super().__init__(coordinator, config_entry) 34 | self.idx = idx 35 | 36 | async def async_lock(self, **kwargs): 37 | success = await self.coordinator.api.async_lock(self.unique_id,self._area,self._zone) 38 | if success: 39 | door_status = 15 40 | data = self.coordinator.data 41 | data["data"]["device_status"][self.idx]["minigw_lock_status"] = str(door_status) 42 | self.coordinator.async_set_updated_data(data) 43 | else: 44 | _LOGGER.info("Lock failed") 45 | 46 | async def async_unlock(self, **kwargs): 47 | pincode = self.config_entry.data.get(CONF_PINCODE) 48 | success = await self.coordinator.api.async_unlock(self.unique_id,self._area,self._zone,pincode) 49 | if success: 50 | door_status = 14 51 | data = self.coordinator.data 52 | data["data"]["device_status"][self.idx]["minigw_lock_status"] = str(door_status) 53 | self.coordinator.async_set_updated_data(data) 54 | else: 55 | _LOGGER.info("Unlock failed") 56 | 57 | @property 58 | def is_locked(self): 59 | try: 60 | door_status = int(self.coordinator.data["data"]["device_status"][self.idx]["minigw_lock_status"],16) 61 | self.old_door_status = door_status 62 | 63 | except Exception as exception: 64 | try: 65 | door_status = self.old_door_status 66 | except Exception as exception2: 67 | door_status = 0 68 | 69 | if door_status & BITWISE_CLOSED: 70 | if door_status & BITWISE_LOCKED: 71 | return True 72 | return False 73 | 74 | @property 75 | def is_door_open(self): 76 | try: 77 | door_status = int(self.coordinator.data["data"]["device_status"][self.idx]["minigw_lock_status"],16) 78 | self.old_door_status = door_status 79 | except Exception as exception: 80 | try: 81 | door_status = self.old_door_status 82 | except Exception as exception2: 83 | door_status = 0 84 | 85 | if door_status & BITWISE_CLOSED: 86 | return False 87 | return True 88 | 89 | @property 90 | def code_format(self): 91 | try: 92 | pincode = self.config_entry.data.get(CONF_PINCODE) 93 | if pincode: 94 | return None 95 | except Exception as exception: 96 | pass 97 | 98 | return "%d{6}" 99 | 100 | @property 101 | def icon(self): 102 | try: 103 | door_status = int(self.coordinator.data["data"]["device_status"][self.idx]["minigw_lock_status"],16) 104 | self.old_door_status = door_status 105 | except Exception as exception: 106 | try: 107 | door_status = self.old_door_status 108 | except Exception as exception2: 109 | door_status = 0 110 | 111 | if door_status & BITWISE_CLOSED: 112 | if door_status & BITWISE_LOCKED: 113 | return "mdi:lock" 114 | return "mdi:lock-open-variant" 115 | return "mdi:door-open" 116 | 117 | @property 118 | def extra_state_attributes(self): 119 | door = "closed" 120 | if self.is_door_open: 121 | door = "open" 122 | return { 123 | "door": door 124 | } 125 | -------------------------------------------------------------------------------- /custom_components/yale_doorman_via_smarthub/api.py: -------------------------------------------------------------------------------- 1 | import logging 2 | import asyncio 3 | import socket 4 | from typing import Optional 5 | import aiohttp 6 | import async_timeout 7 | from datetime import datetime, timedelta 8 | import pickle 9 | import os 10 | 11 | TIMEOUT = 10 12 | 13 | 14 | _LOGGER: logging.Logger = logging.getLogger(__package__) 15 | 16 | HEADERS = {"Content-type": "application/json; charset=UTF-8"} 17 | 18 | 19 | class YaleDoormanViaSmarthubApiClient: 20 | def __init__( 21 | self, username: str, password: str, session: aiohttp.ClientSession 22 | ) -> None: 23 | self._username = username 24 | self._password = password 25 | self._session = session 26 | 27 | async def async_login(self): 28 | try: 29 | if self._access_token is not None: 30 | if self._token_expires > datetime.now(): 31 | return True 32 | else: 33 | # Refresh token 34 | # Left as an exercise to the reader :) 35 | pass 36 | 37 | except Exception as exception: 38 | pass 39 | 40 | with open(os.path.join(os.path.dirname(__file__),"hub.login"), 'rb') as f: 41 | hub_login = pickle.load(f) 42 | 43 | auth = aiohttp.BasicAuth(hub_login["u"], hub_login["p"]) 44 | url = "https://mob.yalehomesystem.co.uk/yapi/o/token/" 45 | data = {"grant_type": "password", "username": self._username, "password": self._password} 46 | headers = {"Accept": "application/json"} 47 | result = await self.api_wrapper("post",url,data,headers,auth) 48 | try: 49 | self._access_token = result["access_token"] 50 | self._refresh_token = result["refresh_token"] 51 | self._token_expires = datetime.now() + timedelta(seconds=result["expires_in"]) 52 | return True 53 | except Exception as exception: 54 | _LOGGER.info(exception) 55 | return False 56 | 57 | async def async_status(self) -> dict: 58 | try: 59 | await self.async_login() 60 | url = "https://mob.yalehomesystem.co.uk/yapi/api/panel/cycle/" 61 | headers = {"Authorization": f"Bearer {self._access_token}"} 62 | data = {} 63 | result = await self.api_wrapper("get",url,data,headers) 64 | return result 65 | except Exception as exception: 66 | _LOGGER.info(exception) 67 | 68 | async def async_lock(self, device_id: str, area: int = 1, zone: int = 1) -> bool: 69 | try: 70 | await self.async_login() 71 | 72 | data = aiohttp.FormData() 73 | data.add_field("area",area) 74 | data.add_field("zone",zone) 75 | data.add_field("device_sid",device_id) 76 | data.add_field("device_type","device_type.door_lock") 77 | data.add_field("request_value",1) 78 | 79 | headers = { 80 | "Authorization": f"Bearer {self._access_token}" 81 | } 82 | 83 | url = "https://mob.yalehomesystem.co.uk/yapi/api/panel/device_control/" 84 | 85 | result = await self.api_wrapper("post", url, data, headers) 86 | if result["code"] == "000": 87 | return True 88 | except Exception as exception: 89 | _LOGGER.info(exception) 90 | return False 91 | 92 | async def async_unlock(self, device_id: str, area: int = 1, zone: int = 1, pincode: str = "") -> bool: 93 | try: 94 | await self.async_login() 95 | 96 | data = aiohttp.FormData() 97 | data.add_field("area",area) 98 | data.add_field("zone",zone) 99 | data.add_field("pincode",pincode) 100 | 101 | headers = { 102 | "Authorization": f"Bearer {self._access_token}" 103 | } 104 | 105 | url = "https://mob.yalehomesystem.co.uk/yapi/api/minigw/unlock/" 106 | 107 | result = await self.api_wrapper("post", url, data, headers) 108 | if result["code"] == "000": 109 | return True 110 | except Exception as exception: 111 | _LOGGER.info(exception) 112 | return False 113 | 114 | async def api_wrapper(self, method: str, url: str, data: dict = {}, headers: dict = {}, auth = None) -> dict: 115 | try: 116 | async with async_timeout.timeout(TIMEOUT): 117 | if method == "get": 118 | response = await self._session.get(url, headers=headers, auth=auth) 119 | result = await response.json() 120 | return result 121 | elif method == "put": 122 | await self._session.put(url, headers=headers, json=data, auth=auth) 123 | elif method == "patch": 124 | await self._session.patch(url, headers=headers, json=data, auth=auth) 125 | elif method == "post": 126 | response = await self._session.post(url, headers=headers, data=data, auth=auth) 127 | result = await response.json() 128 | return result 129 | 130 | except asyncio.TimeoutError as exception: 131 | _LOGGER.error( 132 | "Timeout error fetching information from %s - %s", 133 | url, 134 | exception, 135 | ) 136 | 137 | except (KeyError, TypeError) as exception: 138 | _LOGGER.error( 139 | "Error parsing information from %s - %s", 140 | url, 141 | exception, 142 | ) 143 | except (aiohttp.ClientError, socket.gaierror) as exception: 144 | _LOGGER.error( 145 | "Error fetching information from %s - %s", 146 | url, 147 | exception, 148 | ) 149 | except Exception as exception: 150 | _LOGGER.error("Something really wrong happened! - %s", exception) 151 | 152 | async def async_get_yale_event_log(self, page_number: str = "1") -> dict: 153 | """ 154 | Download the last month's event log from Yale API. 155 | """ 156 | try: 157 | url = f"https://mob.yalehomesystem.co.uk/yapi/api/event/report/?page_num={page_number}&set_utc=0" 158 | data = {} 159 | headers = { 160 | "Authorization": f"Bearer {self._access_token}" 161 | } 162 | _LOGGER.info("Downloaded page %s from Yale event log. url: %s", page_number, url) 163 | return await self.api_wrapper("get", url, data, headers) 164 | 165 | except Exception as exception: 166 | _LOGGER.error("Failed to fetch Yale event log (page %s): %s", page_number, exception) 167 | -------------------------------------------------------------------------------- /custom_components/yale_doorman_via_smarthub/__init__.py: -------------------------------------------------------------------------------- 1 | import asyncio 2 | from datetime import timedelta 3 | import logging 4 | import os 5 | import json 6 | 7 | from homeassistant.config_entries import ConfigEntry 8 | from homeassistant.core import HomeAssistant, ServiceCall, SupportsResponse 9 | from homeassistant.helpers.typing import ConfigType 10 | from homeassistant.helpers.translation import async_get_translations 11 | from homeassistant.exceptions import ConfigEntryNotReady 12 | from homeassistant.helpers.aiohttp_client import async_get_clientsession 13 | from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed 14 | from homeassistant.util.json import load_json 15 | 16 | from .api import YaleDoormanViaSmarthubApiClient 17 | 18 | from .const import ( 19 | CONF_PASSWORD, 20 | CONF_USERNAME, 21 | CONF_ENABLE_BINARY_SENSOR, 22 | DOMAIN, 23 | PLATFORMS, 24 | LOCK, 25 | BINARY_SENSOR, 26 | STARTUP_MESSAGE, 27 | ) 28 | 29 | SCAN_INTERVAL = timedelta(seconds=30) 30 | 31 | _LOGGER: logging.Logger = logging.getLogger(__package__) 32 | 33 | async def async_setup(hass: HomeAssistant, config: ConfigType): 34 | return True 35 | 36 | async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry): 37 | if hass.data.get(DOMAIN) is None: 38 | hass.data.setdefault(DOMAIN, {}) 39 | _LOGGER.info(STARTUP_MESSAGE) 40 | 41 | username = entry.data.get(CONF_USERNAME) 42 | password = entry.data.get(CONF_PASSWORD) 43 | enable_binary_sensor = entry.data.get(CONF_ENABLE_BINARY_SENSOR) 44 | 45 | session = async_get_clientsession(hass) 46 | client = YaleDoormanViaSmarthubApiClient(username, password, session) 47 | 48 | coordinator = YaleDoormanViaSmarthubDataUpdateCoordinator(hass, client=client) 49 | await coordinator.async_refresh() 50 | 51 | if not coordinator.last_update_success: 52 | raise ConfigEntryNotReady 53 | 54 | hass.data[DOMAIN][entry.entry_id] = coordinator 55 | 56 | coordinator.platforms.append(LOCK) 57 | if enable_binary_sensor: 58 | coordinator.platforms.append(BINARY_SENSOR) 59 | await hass.config_entries.async_forward_entry_setups(entry, coordinator.platforms) 60 | 61 | entry.add_update_listener(async_reload_entry) 62 | 63 | async def handle_download_log(call: ServiceCall) -> dict: 64 | """Handles the service action to download the event log.""" 65 | _LOGGER.info("Calling service action to download Yale event log") 66 | 67 | try: 68 | coordinator: YaleDoormanViaSmarthubDataUpdateCoordinator = hass.data[DOMAIN][entry.entry_id] 69 | 70 | device_map = {} # Will store (area, zone) -> "Name" 71 | 72 | try: 73 | # Get device list from coordinator data (like in entity.py) 74 | device_list = coordinator.data.get("data", {}).get("device_status", []) 75 | for device in device_list: 76 | try: 77 | area = int(device.get("area")) 78 | zone = int(device.get("no")) 79 | name = device.get("name") 80 | if area is not None and zone is not None and name: 81 | device_map[(area, zone)] = name 82 | except (TypeError, ValueError): 83 | continue 84 | 85 | _LOGGER.debug(f"Built device map: {device_map}") 86 | except Exception as e: 87 | _LOGGER.error(f"Failed to build device map from coordinator data: {e}") 88 | 89 | # Get page count from service call 90 | max_pages = int(call.data.get("pages", 1)) 91 | all_events = [] 92 | 93 | for page_num in range(1, max_pages + 1): 94 | log_data = await coordinator.api.async_get_yale_event_log(page_number=str(page_num)) 95 | log_events = log_data.get("data", []) 96 | _LOGGER.info(f"Downloaded page {str(page_num)} with {len(log_events)} events") 97 | all_events.extend(log_events) 98 | 99 | language = hass.config.language or "en" 100 | 101 | path = os.path.join(os.path.dirname(__file__), "translations", f"{language}.json") 102 | fallback_path = os.path.join(os.path.dirname(__file__), "translations", "en.json") 103 | try: 104 | with open(path, encoding="utf-8") as f: 105 | translations = json.load(f) 106 | except FileNotFoundError: 107 | with open(fallback_path, encoding="utf-8") as f: 108 | translations = json.load(f) 109 | 110 | event_type_map = translations.get("responses", {}).get("event_type", {}) 111 | 112 | formatted_events = [] 113 | for event in log_events: 114 | event_id = str(event.get("event_type")) 115 | event_area = event.get("area") 116 | event_zone = event.get("zone") 117 | device_key = None 118 | device_name = "System" 119 | 120 | try: 121 | area_int = int(event_area) 122 | zone_int = int(event_zone) 123 | 124 | if area_int > 0: 125 | device_key = (area_int, zone_int) 126 | device_name = device_map.get( 127 | device_key, 128 | f"Unknown Device (A:{area_int}, Z:{zone_int})" 129 | ) 130 | except (TypeError, ValueError): 131 | pass 132 | 133 | translated_event = event_type_map.get(event_id, f"Unknown event {event_id}") 134 | 135 | if event_id in range(1301,1399) or event_id in ["1602"]: 136 | formatted_events.append({ 137 | "Time": event.get("time", "N/A"), 138 | "Event": translated_event, 139 | }) 140 | elif event_id in ["1801", "1807", "1815", "1816", "3801", "3802"]: 141 | formatted_events.append({ 142 | "Time": event.get("time", "N/A"), 143 | "Event": translated_event, 144 | "Device": device_name, 145 | }) 146 | else: 147 | formatted_events.append({ 148 | "Time": event.get("time", "N/A"), 149 | "Event": translated_event, 150 | "Device": device_name, 151 | "Name": event.get("name", ""), 152 | }) 153 | 154 | return { 155 | "event_log_table": formatted_events, 156 | "total_rows_returned": len(formatted_events), 157 | "pages_fetched": max_pages 158 | # "log_data": log_data 159 | } 160 | 161 | except Exception as e: 162 | _LOGGER.error(f"Could not download Yale event log: {e}") 163 | raise 164 | 165 | hass.services.async_register( 166 | DOMAIN, 167 | "download_yale_event_log", 168 | handle_download_log, 169 | supports_response=SupportsResponse.ONLY 170 | ) 171 | #end 172 | return True 173 | 174 | class YaleDoormanViaSmarthubDataUpdateCoordinator(DataUpdateCoordinator): 175 | 176 | def __init__(self, hass: HomeAssistant, client: YaleDoormanViaSmarthubApiClient) -> None: 177 | self.api = client 178 | self.platforms = [] 179 | 180 | super().__init__(hass, _LOGGER, name=DOMAIN, update_interval=SCAN_INTERVAL) 181 | 182 | async def _async_update_data(self): 183 | try: 184 | status = await self.api.async_status() 185 | return status 186 | except Exception as exception: 187 | _LOGGER.info(exception) 188 | raise UpdateFailed() from exception 189 | 190 | async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool: 191 | coordinator = hass.data[DOMAIN][entry.entry_id] 192 | unloaded = all( 193 | await asyncio.gather( 194 | *[ 195 | hass.config_entries.async_forward_entry_unload(entry, platform) 196 | for platform in PLATFORMS 197 | if platform in coordinator.platforms 198 | ] 199 | ) 200 | ) 201 | if unloaded: 202 | hass.data[DOMAIN].pop(entry.entry_id) 203 | 204 | return unloaded 205 | 206 | async def async_reload_entry(hass: HomeAssistant, entry: ConfigEntry) -> None: 207 | await async_unload_entry(hass, entry) 208 | await async_setup_entry(hass, entry) -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------