├── .gitattributes ├── custom_components └── ryobi_gdo3 │ ├── __init__.py │ ├── manifest.json │ ├── light.py │ ├── cover.py │ └── py_ryobi_gdo.py ├── doorid.py ├── README.md ├── info.md └── LICENSE /.gitattributes: -------------------------------------------------------------------------------- 1 | # Auto detect text files and perform LF normalization 2 | * text=auto 3 | -------------------------------------------------------------------------------- /custom_components/ryobi_gdo3/__init__.py: -------------------------------------------------------------------------------- 1 | """ 2 | Ryobi platform for the cover component. 3 | For more details about this platform, please refer to the documentation 4 | https://home-assistant.io/components/cover.ryobi_gdo/ 5 | """ -------------------------------------------------------------------------------- /custom_components/ryobi_gdo3/manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "domain": "ryobi_gdo3", 3 | "name": "ryobi_gdo3", 4 | "version": "0.6.1", 5 | "documentation": "https://github.com/madj42/ryobi_gdo3", 6 | "dependencies": [], 7 | "codeowners": ["@guillaume1410","@madj42"] 8 | } 9 | -------------------------------------------------------------------------------- /doorid.py: -------------------------------------------------------------------------------- 1 | import requests 2 | username = '' 3 | password = '' 4 | uandp = {'username':username,'password':password} 5 | r = requests.post('https://tti.tiwiconnect.com/api/login',data=uandp) 6 | 7 | s = requests.get('https://tti.tiwiconnect.com/api/devices',params=uandp) 8 | 9 | for result in s.json()['result']: 10 | if 'gdoMasterUnit' in result['deviceTypeIds']: 11 | print(result['metaData']['name'], '- Device ID:', result['varName']) -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Ryobi GDO Custom Component for Home Assistant 2 | 3 | ## First and foremost: 4 | 5 | The overwhelming majority of the work was done by [guillaume1410](https://community.home-assistant.io/u/guillaume1410/). At this point the only changes made have been cleaning up some of the code, the files, and adding control of the light. More may come in the future but at this point, the functionality is there. 6 | 7 | ## Getting your door id: 8 | 9 | To get your door id, download and run the doorid.py file using Python. Make sure to edit the username and password variables in the script beforehand. You'll also need to install the requests module using pip. 10 | 11 | ## Installation: 12 | 13 | Put this in your custom_components folder under ryobi_gdo3 and restart Home Assistant. 14 | 15 | ## Configuration.yaml example: 16 | ``` 17 | cover: 18 | - platform: ryobi_gdo3 19 | username: !secret ryobi_username 20 | password: !secret ryobi_password 21 | device_id: 22 | - !secret ryobi_device_id 23 | 24 | light: 25 | - platform: ryobi_gdo3 26 | username: !secret ryobi_username 27 | password: !secret ryobi_password 28 | device_id: 29 | - !secret ryobi_device_id 30 | ``` 31 | ## Secrets.yaml example: 32 | ``` 33 | ryobi_username: "captain@morgan.com" 34 | ryobi_password: "Bottle0fRum!" 35 | ryobi_device_id: "51324637f136474" 36 | ``` 37 | -------------------------------------------------------------------------------- /info.md: -------------------------------------------------------------------------------- 1 | # Ryobi GDO Custom Component for Home Assistant 2 | 3 | ## First and foremost: 4 | 5 | The overwhelming majority of the work was done by [guillaume1410](https://community.home-assistant.io/u/guillaume1410/). At this point the only changes made have been cleaning up some of the code, the files, and adding control of the light. More may come in the future but at this point, the functionality is there. 6 | 7 | ## Getting your door id: 8 | 9 | To get your door id, download and run the doorid.py file using Python. Make sure to edit the username and password variables in the script beforehand. You'll also need to install the requests module using pip. 10 | 11 | ## Installation: 12 | 13 | Put this in your custom_components folder under ryobi_gdo3 and restart Home Assistant. 14 | 15 | ## Configuration.yaml example: 16 | ``` 17 | cover: 18 | - platform: ryobi_gdo3 19 | username: !secret ryobi_username 20 | password: !secret ryobi_password 21 | device_id: 22 | - !secret ryobi_device_id 23 | 24 | light: 25 | - platform: ryobi_gdo3 26 | username: !secret ryobi_username 27 | password: !secret ryobi_password 28 | device_id: 29 | - !secret ryobi_device_id 30 | ``` 31 | ## Secrets.yaml example: 32 | ``` 33 | ryobi_username: "captain@morgan.com" 34 | ryobi_password: "Bottle0fRum!" 35 | ryobi_device_id: "51324637f136474" 36 | ``` 37 | -------------------------------------------------------------------------------- /custom_components/ryobi_gdo3/light.py: -------------------------------------------------------------------------------- 1 | """ 2 | Ryobi platform for the cover component. 3 | For more details about this platform, please refer to the documentation 4 | https://home-assistant.io/components/cover.ryobi_gdo/ 5 | """ 6 | import logging 7 | import time 8 | import voluptuous as vol 9 | from datetime import timedelta 10 | 11 | import homeassistant.helpers.config_validation as cv 12 | from homeassistant.helpers.entity import DeviceInfo 13 | from homeassistant.components.light import ( 14 | LightEntity, PLATFORM_SCHEMA) 15 | from homeassistant.const import ( 16 | CONF_USERNAME, CONF_PASSWORD, STATE_UNKNOWN, STATE_CLOSED) 17 | 18 | """REQUIREMENTS = ['py-ryobi-gdo==0.0.27']""" 19 | 20 | DOMAIN = "ryobi_gdo3" 21 | _LOGGER = logging.getLogger(__name__) 22 | 23 | SCAN_INTERVAL = timedelta(seconds=60) 24 | 25 | CONF_DEVICE_ID = 'device_id' 26 | 27 | PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({ 28 | vol.Required(CONF_DEVICE_ID): vol.All(cv.ensure_list, [cv.string]), 29 | vol.Required(CONF_PASSWORD): cv.string, 30 | vol.Required(CONF_USERNAME): cv.string, 31 | }) 32 | 33 | def setup_platform(hass, config, add_entities, discovery_info=None): 34 | """Set up the Ryobi lights.""" 35 | from .py_ryobi_gdo import RyobiGDO as ryobi_door 36 | lights = [] 37 | 38 | username = config.get(CONF_USERNAME) 39 | password = config.get(CONF_PASSWORD) 40 | devices = config.get(CONF_DEVICE_ID) 41 | 42 | for device_id in devices: 43 | my_door = ryobi_door(username, password, device_id) 44 | _LOGGER.debug("Getting the API key") 45 | if my_door.get_api_key() is False: 46 | _LOGGER.error("Wrong credentials, no API key retrieved") 47 | return 48 | _LOGGER.debug("Checking if the device ID is present") 49 | if my_door.check_device_id() is False: 50 | _LOGGER.error("%s not in your device list", device_id) 51 | return 52 | _LOGGER.debug("Adding device %s to lights", device_id) 53 | lights.append(RyobiLight(hass, my_door)) 54 | if lights: 55 | _LOGGER.debug("Adding lights") 56 | add_entities(lights, True) 57 | 58 | 59 | class RyobiLight(LightEntity): 60 | """Representation of a ryobi light.""" 61 | 62 | def __init__(self, hass, ryobi_door): 63 | """Initialize the light.""" 64 | self.ryobi_door = ryobi_door 65 | self._name = 'ryobi_gdo_light_{}'.format(ryobi_door.get_device_id()) 66 | self._light_state = None 67 | self.device_id = ryobi_door.get_device_id() 68 | self._attr_unique_id = 'ryobi_gdo_light_{}'.format(ryobi_door.get_device_id()) 69 | 70 | @property 71 | def device_info(self) -> DeviceInfo: 72 | """Return device registry information for this entity.""" 73 | return DeviceInfo( 74 | identifiers = {(DOMAIN, self.device_id)}, 75 | manufacturer = "Ryobi", 76 | model = "GDO", 77 | name = "Ryobi Garage Door Opener", 78 | ) 79 | 80 | @property 81 | def name(self): 82 | """Return the name of the light.""" 83 | return self._name 84 | 85 | @property 86 | def is_on(self): 87 | """Return if the light is off.""" 88 | 89 | if self._light_state == "on": 90 | return True 91 | else: 92 | return False 93 | 94 | @property 95 | def device_class(self): 96 | """Return the class of this device, from component DEVICE_CLASSES.""" 97 | return 'light' 98 | 99 | def turn_off(self, **kwargs): 100 | """Turn off light.""" 101 | _LOGGER.debug("Turning off light") 102 | self.ryobi_door.send_message("lightState", False) 103 | self._light_state = "off" 104 | time.sleep(5) 105 | self.update() 106 | 107 | def turn_on(self, **kwargs): 108 | """Turn on light.""" 109 | _LOGGER.debug("Turning on light") 110 | self.ryobi_door.send_message("lightState", True) 111 | time.sleep(5) 112 | self.update() 113 | 114 | 115 | def update(self): 116 | """Update status from the light.""" 117 | _LOGGER.debug("Updating Ryobi Light status") 118 | self.ryobi_door.update() 119 | self._light_state = self.ryobi_door.get_light_status() 120 | _LOGGER.debug(self._light_state) 121 | -------------------------------------------------------------------------------- /custom_components/ryobi_gdo3/cover.py: -------------------------------------------------------------------------------- 1 | """ 2 | Ryobi platform for the cover component. 3 | For more details about this platform, please refer to the documentation 4 | https://home-assistant.io/components/cover.ryobi_gdo/ 5 | """ 6 | import logging 7 | import time 8 | import voluptuous as vol 9 | from datetime import timedelta 10 | 11 | import homeassistant.helpers.config_validation as cv 12 | from homeassistant.helpers.entity import DeviceInfo 13 | from homeassistant.components.cover import ( 14 | CoverEntity, PLATFORM_SCHEMA, SUPPORT_OPEN, SUPPORT_CLOSE) 15 | from homeassistant.const import ( 16 | CONF_USERNAME, CONF_PASSWORD, STATE_UNKNOWN, STATE_CLOSED) 17 | 18 | """REQUIREMENTS = ['py-ryobi-gdo==0.0.27']""" 19 | 20 | DOMAIN = "ryobi_gdo3" 21 | _LOGGER = logging.getLogger(__name__) 22 | 23 | SCAN_INTERVAL = timedelta(seconds=60) 24 | 25 | CONF_DEVICE_ID = 'device_id' 26 | 27 | PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({ 28 | vol.Required(CONF_DEVICE_ID): vol.All(cv.ensure_list, [cv.string]), 29 | vol.Required(CONF_PASSWORD): cv.string, 30 | vol.Required(CONF_USERNAME): cv.string, 31 | }) 32 | 33 | SUPPORTED_FEATURES = (SUPPORT_OPEN | SUPPORT_CLOSE) 34 | 35 | 36 | def setup_platform(hass, config, add_entities, discovery_info=None): 37 | """Set up the Ryobi covers.""" 38 | from .py_ryobi_gdo import RyobiGDO as ryobi_door 39 | covers = [] 40 | 41 | username = config.get(CONF_USERNAME) 42 | password = config.get(CONF_PASSWORD) 43 | devices = config.get(CONF_DEVICE_ID) 44 | 45 | for device_id in devices: 46 | my_door = ryobi_door(username, password, device_id) 47 | _LOGGER.debug("Getting the API key") 48 | if my_door.get_api_key() is False: 49 | _LOGGER.error("Wrong credentials, no API key retrieved") 50 | return 51 | _LOGGER.debug("Checking if the device ID is present") 52 | if my_door.check_device_id() is False: 53 | _LOGGER.error("%s not in your device list", device_id) 54 | return 55 | _LOGGER.debug("Adding device %s to covers", device_id) 56 | covers.append(RyobiCover(hass, my_door)) 57 | if covers: 58 | _LOGGER.debug("Adding covers") 59 | add_entities(covers, True) 60 | 61 | 62 | class RyobiCover(CoverEntity): 63 | """Representation of a ryobi cover.""" 64 | 65 | def __init__(self, hass, ryobi_door): 66 | """Initialize the cover.""" 67 | self.ryobi_door = ryobi_door 68 | self._name = 'ryobi_gdo_door_{}'.format(ryobi_door.get_device_id()) 69 | self._door_state = None 70 | self.device_id = ryobi_door.get_device_id() 71 | self._attr_unique_id = 'ryobi_gdo_door_{}'.format(ryobi_door.get_device_id()) 72 | 73 | @property 74 | def device_info(self) -> DeviceInfo: 75 | """Return device registry information for this entity.""" 76 | return DeviceInfo( 77 | identifiers = {(DOMAIN, self.device_id)}, 78 | manufacturer = "Ryobi", 79 | model = "GDO", 80 | name = "Ryobi Garage Door Opener", 81 | ) 82 | 83 | @property 84 | def name(self): 85 | """Return the name of the cover.""" 86 | return self._name 87 | 88 | @property 89 | def is_closed(self): 90 | """Return if the cover is closed.""" 91 | if self._door_state == STATE_UNKNOWN: 92 | return False 93 | return self._door_state == STATE_CLOSED 94 | 95 | @property 96 | def device_class(self): 97 | """Return the class of this device, from component DEVICE_CLASSES.""" 98 | return 'garage' 99 | 100 | @property 101 | def supported_features(self): 102 | """Flag supported features.""" 103 | return SUPPORTED_FEATURES 104 | 105 | def close_cover(self, **kwargs): 106 | """Close the cover.""" 107 | _LOGGER.debug("Closing garage door") 108 | self.ryobi_door.close_device() 109 | time.sleep(5) 110 | self.ryobi_door.update() 111 | time.sleep(20) 112 | self.ryobi_door.update() 113 | time.sleep(5) 114 | self.ryobi_door.update() 115 | 116 | def open_cover(self, **kwargs): 117 | """Open the cover.""" 118 | _LOGGER.debug("Opening garage door") 119 | self.ryobi_door.open_device() 120 | time.sleep(5) 121 | self.ryobi_door.update() 122 | time.sleep(5) 123 | self.ryobi_door.update() 124 | time.sleep(5) 125 | self.ryobi_door.update() 126 | 127 | def update(self): 128 | """Update status from the door.""" 129 | _LOGGER.debug("Updating RyobiGDO status") 130 | self.ryobi_door.update() 131 | self._door_state = self.ryobi_door.get_door_status() 132 | -------------------------------------------------------------------------------- /custom_components/ryobi_gdo3/py_ryobi_gdo.py: -------------------------------------------------------------------------------- 1 | import requests 2 | import logging 3 | import websocket 4 | import json 5 | 6 | class RyobiGDO: 7 | """Class for interacting with the Ryobi Garage Door Opener API.""" 8 | 9 | HOST_URI = "tti.tiwiconnect.com" 10 | LOGIN_ENDPOINT = "api/login" 11 | DEVICE_GET_ENDPOINT = "api/devices" 12 | DEVICE_SET_ENDPOINT = "api/wsrpc" 13 | 14 | STATE_DOOR_OPEN = 'open' 15 | STATE_DOOR_CLOSED = 'closed' 16 | STATE_DOOR_OPENING = 'opening' 17 | STATE_LIGHT_ON = 'on' 18 | STATE_LIGHT_OFF = 'off' 19 | 20 | REQUEST_TIMEOUT = 3 21 | 22 | DOOR_STATE = { 23 | '0': STATE_DOOR_CLOSED, 24 | '1': STATE_DOOR_OPEN, 25 | '3': STATE_DOOR_OPENING, 26 | } 27 | 28 | LIGHT_STATE = { 29 | 'False': STATE_LIGHT_OFF, 30 | 'True': STATE_LIGHT_ON, 31 | } 32 | 33 | logger = logging.getLogger(__name__) 34 | 35 | def __init__(self, username, password, device_id): 36 | """Initialize the API object.""" 37 | self.username = username 38 | self.password = password 39 | self.device_id = device_id 40 | self.door_state = None 41 | self.light_state = None 42 | self.battery_level = None 43 | self.api_key = None 44 | from websocket import create_connection 45 | self._connection = create_connection 46 | 47 | def get_api_key(self): 48 | """Getting api_key from Ryobi.""" 49 | auth_ok = False 50 | for attempt in range(5): 51 | try: 52 | resp = requests.post('https://{}/{}'.format(self.HOST_URI, self.LOGIN_ENDPOINT), timeout=self.REQUEST_TIMEOUT, data={ 53 | 'username': self.username, 54 | 'password': self.password 55 | }) 56 | except requests.exceptions.RequestException: 57 | print("Exception while requesting Ryobi to get API Key") 58 | else: 59 | break 60 | if(resp.status_code == 200): 61 | try: 62 | resp_meta = resp.json()['result']['metaData'] 63 | self.api_key = resp_meta['wskAuthAttempts'][0]['apiKey'] 64 | auth_ok = True 65 | except KeyError: 66 | print("Exception while parsing Ryobi answer to get API key") 67 | return False 68 | return auth_ok 69 | 70 | def check_device_id(self): 71 | """Checking device_id from Ryobi.""" 72 | device_found = False 73 | answer = False 74 | for attempt in range(5): 75 | try: 76 | resp = requests.get("https://{}/{}".format(self.HOST_URI, self.DEVICE_GET_ENDPOINT), timeout=self.REQUEST_TIMEOUT, data={ 77 | 'username': self.username, 78 | 'password': self.password 79 | }) 80 | except requests.exceptions.RequestException: 81 | print("Exception while requesting Ryobi to check device ID") 82 | else: 83 | answer = True 84 | break 85 | if(answer == True and resp.status_code == 200): 86 | try: 87 | result = resp.json()['result'] 88 | except KeyError: 89 | return device_found 90 | if len(result) == 0: 91 | print("empty result") 92 | else: 93 | for data in result: 94 | if data['varName'] == self.device_id: 95 | device_found = True 96 | return device_found 97 | 98 | def update(self): 99 | """Update door status from Ryobi.""" 100 | update_ok = False 101 | answer = False 102 | for attempt in range(5): 103 | try: 104 | resp = requests.get("https://{}/{}/{}".format(self.HOST_URI, self.DEVICE_GET_ENDPOINT, self.device_id), timeout=self.REQUEST_TIMEOUT, data={ 105 | 'username': self.username, 106 | 'password': self.password 107 | }) 108 | except requests.exceptions.RequestException: 109 | print("Exception while requesting Ryobi to update device") 110 | else: 111 | answer = True 112 | break 113 | if(answer == True and resp.status_code == 200): 114 | try: 115 | gdo_status = resp.json() 116 | dtm = gdo_status['result'][0]['deviceTypeMap'] 117 | door_state = dtm['garageDoor_7']['at']['doorState']['value'] 118 | self.door_state = self.DOOR_STATE[str(door_state)] 119 | light_state = dtm['garageLight_7']['at']['lightState']['value'] 120 | self.light_state = self.LIGHT_STATE[str(light_state)] 121 | self.battery_level = dtm['backupCharger_8']['at']['chargeLevel']['value'] 122 | update_ok = True 123 | except KeyError: 124 | print("Exception while parsing answer to update device") 125 | return update_ok 126 | return update_ok 127 | 128 | def get_door_status(self): 129 | """Get current door status.""" 130 | return self.door_state 131 | 132 | def get_battery_level(self): 133 | """Get current battery level.""" 134 | return self.battery_level 135 | 136 | def get_light_status(self): 137 | """Get current light status.""" 138 | return self.light_state 139 | 140 | def get_device_id(self): 141 | """Get device_id.""" 142 | return self.device_id 143 | 144 | def close_device(self): 145 | """Close Device.""" 146 | return self.send_message("doorCommand", 0) 147 | 148 | def open_device(self): 149 | """Open Device.""" 150 | return self.send_message("doorCommand", 1) 151 | 152 | def send_message(self, command, value): 153 | """Generic send message.""" 154 | from websocket import _exceptions 155 | ws_auth = False 156 | for attempt in range(5): 157 | try: 158 | websocket = self._connection('wss://{host_uri}/{device_set_endpoint}'.format( 159 | host_uri=self.HOST_URI, 160 | device_set_endpoint=self.DEVICE_SET_ENDPOINT), timeout=self.REQUEST_TIMEOUT) 161 | auth_mssg = json.dumps( 162 | {'jsonrpc': '2.0', 163 | 'id': 3, 164 | 'method': 'srvWebSocketAuth', 165 | 'params': { 166 | 'varName': self.username, 167 | 'apiKey': self.api_key}}) 168 | websocket.send(auth_mssg) 169 | result = websocket.recv() 170 | except Exception as ex: 171 | print("Exception during websocket authentification") 172 | websocket.close() 173 | else: 174 | ws_auth = True 175 | break 176 | if (ws_auth == True): 177 | for attempt in range(5): 178 | try: 179 | pay_load = json.dumps({'jsonrpc': '2.0', 180 | 'method': 'gdoModuleCommand', 181 | 'params': 182 | {'msgType': 16, 183 | 'moduleType': 5, 184 | 'portId': 7, 185 | 'moduleMsg': {command: value}, 186 | 'topic': self.device_id}}) 187 | websocket.send(pay_load) 188 | pay_load = "" 189 | result = websocket.recv() 190 | except Exception as ex: 191 | print("Exception during sending message") 192 | websocket.close() 193 | else: 194 | break 195 | websocket.close() 196 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------