├── .gitignore ├── requirements.txt ├── README.md ├── __main__.py ├── nuki.py └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | nuki.yaml 2 | .idea/ 3 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | aiohttp==3.8.1 2 | bleak==0.14.0 3 | PyNaCl==1.3.0 4 | PyYAML==6.0 5 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # RaspiNukiBridge 2 | Simple [Nuki Bridge](https://nuki.io/en/bridge/) implementation using asyncio. 3 | 4 | Minimal implementation of the Nuki Bridge protocols in python (both HTTP and BLE), I use it on a raspberry pi zero W and a Nuki smartlock V2. 5 | Right now **pairing**, **lock**, **unlock**, **unlatch** and HTTP callbacks are implemented, it works fine with the [Homeassistant Nuki integration](https://www.home-assistant.io/integrations/nuki/) and the [hass_nuki_ng integration](https://github.com/kvj/hass_nuki_ng). 6 | 7 | Nuki documentation: 8 | https://developer.nuki.io/page/nuki-smart-lock-api-2/2/#heading--lock-action 9 | https://developer.nuki.io/page/nuki-bridge-http-api-1-13/4/#heading--lockstate 10 | 11 | This is heavily inspired by the work of [Jandebeule](https://github.com/jandebeule/nukiPyBridge). 12 | 13 | ## Related projects 14 | 15 | - [Nuki Telegram Bot](https://github.com/lmerega/nuki_telegram_bot) – Self-hosted Telegram bot that controls a Nuki Smart Lock **exclusively via RaspiNukiBridge**. 16 | Supports per-user permissions, admin inline keyboards, secure unlatch confirmation, EN/IT localization and systemd-friendly deployment. 17 | 18 | - [Nuki Web Control](https://github.com/lmerega/nuki-web-control) – Small Flask web UI to control a Nuki Smart Lock via RaspiNukiBridge. 19 | Provides live lock status (lock state, door state, battery, timestamp) and actions (lock, unlock, unlatch, lock'n'go), with English/Italian UI. 20 | 21 | # Installation 22 | 23 | > ### Raspberry Pi 3B+ and 4 only 24 | > DOWNGRADE Bluez. [See comment](https://github.com/dauden1184/RaspiNukiBridge/issues/1#issuecomment-1103969957). 25 | > ``` 26 | > wget http://ftp.hk.debian.org/debian/pool/main/b/bluez/bluez_5.50-1.2~deb10u2_armhf.deb 27 | > sudo apt install ./bluez_5.50-1.2~deb10u2_armhf.deb 28 | > ``` 29 | > Reboot the Raspberry Pi 30 | 31 | Clone the repository. 32 | ``` 33 | git clone https://github.com/dauden1184/RaspiNukiBridge.git 34 | ``` 35 | 36 | Install the requirements. 37 | ``` 38 | pip install -r requirements.txt 39 | ``` 40 | 41 | Generate a new configuration file. 42 | ``` 43 | python . --generate-config > nuki.yaml 44 | ``` 45 | 46 | This will generate a nuki.yaml file similar to this: 47 | ``` 48 | server: 49 | host: 0.0.0.0 50 | port: 8080 51 | name: RaspiNukiBridge 52 | app_id: xxxxxxxxx 53 | token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 54 | ``` 55 | **app_id** and **token** are generate randomly. 56 | **app_id** is needed to communicate with the smartlock over bluetooth. 57 | **token** is the api token used for the HTTP calls (this is needed when configuring the homeassistant nuki integration). 58 | 59 | 60 | Pair the smartlock (this must be done only once). 61 | You need to find the MAC address of your nuki smartlock, you can use a BLE scanner app. 62 | Press for 6 seconds the button on the nuki to set it in pairing mode (the ring will turn on). 63 | After that: 64 | ``` 65 | python . --pair MAC_ADDRESS 66 | ``` 67 | 68 | Sometimes the bluetooth connection fails, try a few times if it happens. 69 | If the pairing procedure is successfull, you will find these lines on the screen: 70 | ``` 71 | INFO:root:Generatig keys for Nuki XX:XX:XX:XX:XX:XX 72 | INFO:root:bridge_public_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 73 | INFO:root:bridge_private_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 74 | . 75 | . other stuff 76 | . 77 | INFO:root:Pairing completed, nuki_public_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 78 | INFO:root:Pairing completed, auth_id: xxxxxxxx 79 | ``` 80 | 81 | You can now edit the nuki.yaml file created before and add those lines like this at the end of the file: 82 | ``` 83 | smartlock: 84 | - address: XX:XX:XX:XX:XX:XX 85 | bridge_public_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 86 | bridge_private_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 87 | nuki_public_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 88 | auth_id: xxxxxxxx 89 | ``` 90 | 91 | # Usage 92 | 93 | ## Test manually 94 | ``` 95 | python . --lock 96 | python . --unlock 97 | ``` 98 | 99 | ## Bridge server for HA 100 | Save the file and start the bridge: 101 | ``` 102 | python . 103 | ``` 104 | Install either: 105 | 1. [hass_nuki_ng integration](https://github.com/kvj/hass_nuki_ng) 106 | 2. [Homeassistant Nuki integration](https://www.home-assistant.io/integrations/nuki/) 107 | # Advanced 108 | ## Connection timeout and retries 109 | 110 | In case of issues during the bluetooth connection to the nuki device, it is possible to set a higher connection timeout and the number of retries with the fields `connection_timeout` (default is 10 seconds) and `retry` (default is 3) like this: 111 | 112 | ``` 113 | smartlock: 114 | - address: XX:XX:XX:XX:XX:XX 115 | bridge_public_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 116 | bridge_private_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 117 | nuki_public_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 118 | auth_id: xxxxxxxx 119 | connection_timeout: 30 120 | retry: 5 121 | ``` 122 | 123 | ## Start automatically at boot 124 | 125 | Create a new systemd service: 126 | 127 | ``` 128 | sudo nano /etc/systemd/system/nukibridge.service 129 | ``` 130 | 131 | Put this content in the file (change 'user' and 'WorkingDirectory' to your needs): 132 | 133 | ``` 134 | [Unit] 135 | Description=Nuki bridge 136 | After=network-online.target 137 | 138 | [Service] 139 | Type=simple 140 | Restart=always 141 | RestartSec=1 142 | User=pi 143 | WorkingDirectory=/home/pi/RaspiNukiBridge/ 144 | ExecStart=python . 145 | 146 | [Install] 147 | WantedBy=multi-user.target 148 | ``` 149 | 150 | Enable the service and start it: 151 | 152 | ``` 153 | sudo systemctl daemon-reload 154 | sudo systemctl enable nukibridge.service 155 | sudo systemctl start nukibridge.service 156 | ``` 157 | -------------------------------------------------------------------------------- /__main__.py: -------------------------------------------------------------------------------- 1 | import asyncio 2 | import json 3 | import logging 4 | import random 5 | import yaml 6 | import datetime 7 | import hashlib 8 | import argparse 9 | import uuid 10 | import sys 11 | 12 | import nacl 13 | from nacl.public import PrivateKey 14 | from aiohttp import web, ClientSession 15 | 16 | from nuki import Nuki, NukiManager, BridgeType, DeviceType 17 | 18 | LOG_FORMAT = "%(asctime)s.%(msecs)03d|%(levelname).1s|%(filename)s:%(lineno)d|%(message)s" 19 | 20 | logger = logging.getLogger("raspinukibridge") 21 | handler = logging.StreamHandler(sys.stdout) 22 | handler.setFormatter(logging.Formatter(fmt=LOG_FORMAT, datefmt="%Y-%m-%d %H:%M:%S")) 23 | logger.addHandler(handler) 24 | 25 | logging.getLogger("aiohttp").addHandler(handler) 26 | logging.getLogger("aiohttp").setLevel(logging.ERROR) 27 | logging.getLogger("bleak").addHandler(handler) 28 | logging.getLogger("bleak").setLevel(logging.ERROR) 29 | 30 | 31 | class WebServer: 32 | 33 | def __init__(self, host, port, token, server_id, nuki_manager): 34 | self._host = host 35 | self._port = port 36 | self._token = token 37 | self._hashed_token = hashlib.sha256(str(self._token).encode('utf-8')).digest() 38 | self._hashed_token_box = nacl.secret.SecretBox(self._hashed_token) 39 | self._used_token = {} 40 | self.nuki_manager = nuki_manager 41 | self._start_datetime = None 42 | self._server_id = server_id & 0xFFFFFFFF # Truncate server_id to 32 bit, OpenHub doesn't like it too big 43 | self._http_callbacks = [None, None, None] # Nuki Bridge support up to 3 callbacks 44 | 45 | def start(self): 46 | app = web.Application() 47 | app.add_routes([web.get('/info', self.nuki_info), 48 | web.get('/list', self.nuki_list), 49 | web.get('/lock', self.nuki_lock), 50 | web.get('/unlock', self.nuki_unlock), 51 | web.get('/lockAction', self.nuki_lockaction), 52 | web.get('/lockState', self.nuki_state), 53 | web.get('/callback/add', self.callback_add), 54 | web.get('/callback/list', self.callback_list), 55 | web.get('/callback/remove', self.callback_remove)]) 56 | app.on_startup.append(self._startup) 57 | web.run_app(app, host=self._host, port=self._port) 58 | 59 | @staticmethod 60 | def _get_nuki_last_state(nuki): 61 | state = {"mode": nuki.last_state["nuki_state"].value, 62 | "state": nuki.last_state["lock_state"].value, 63 | "stateName": nuki.last_state["lock_state"].name, 64 | "batteryCritical": nuki.is_battery_critical, 65 | "batteryCharging": nuki.is_battery_charging, 66 | "batteryChargeState": nuki.battery_percentage, 67 | "keypadBatteryCritical": False, # How to get this from bt api? 68 | "doorsensorState": nuki.last_state["door_sensor_state"].value, 69 | "doorsensorStateName": nuki.last_state["door_sensor_state"].name, 70 | "ringactionTimestamp": None, # How to get this from bt api? 71 | "ringactionState": None, # How to get this from bt api? 72 | "timestamp": nuki.last_state["current_time"].isoformat().split(".")[0], 73 | "success": True, 74 | } 75 | 76 | if nuki.device_type == DeviceType.OPENER: 77 | state["ringactionTimestamp"] = nuki.last_state["current_time"].isoformat().split(".")[0] 78 | state["ringactionState"] = nuki.last_state["last_lock_action_completion_status"] 79 | 80 | return state 81 | 82 | async def _newstate(self, nuki): 83 | logger.info(f"Nuki new state: {nuki.last_state}") 84 | if any(self._http_callbacks): 85 | async with ClientSession() as session: 86 | for url in filter(None, self._http_callbacks): 87 | try: 88 | data = {"nukiId": nuki.config["id"], 89 | "deviceType": nuki.device_type.value} # How to get this from bt api? 90 | data.update(self._get_nuki_last_state(nuki)) 91 | async with session.post(url, data=json.dumps(data)) as resp: 92 | await resp.text() 93 | except: 94 | logger.exception(f"Error on http callbak {url}") 95 | 96 | async def _startup(self, _app): 97 | self._start_datetime = datetime.datetime.now() 98 | await self.nuki_manager.start_scanning() 99 | 100 | async def callback_add(self, request): 101 | if not self._check_token(request): 102 | raise web.HTTPForbidden() 103 | callback_url = request.query["url"] 104 | for i, call in enumerate(self._http_callbacks): 105 | if not call: 106 | self._http_callbacks[i] = callback_url 107 | break 108 | if not self.nuki_manager.newstate_callback: 109 | self.nuki_manager.newstate_callback = self._newstate 110 | logger.info(f"Add http callback: {callback_url}") 111 | return web.Response(text=json.dumps({"success": True})) 112 | 113 | async def callback_list(self, request): 114 | if not self._check_token(request): 115 | raise web.HTTPForbidden() 116 | resp = {"callbacks": [{"id": url_id, "url": url} for url_id, url in enumerate(self._http_callbacks) if url]} 117 | return web.Response(text=json.dumps(resp)) 118 | 119 | async def callback_remove(self, request): 120 | if not self._check_token(request): 121 | raise web.HTTPForbidden() 122 | url_id = request.query["id"] 123 | self._http_callbacks[int(url_id)] = None 124 | return web.Response(text=json.dumps({"success": True})) 125 | 126 | async def nuki_list(self, request): 127 | if not self._check_token(request): 128 | raise web.HTTPForbidden() 129 | resp = [{"nukiId": nuki.config["id"], 130 | "deviceType": nuki.device_type.value, # How to get this from bt api? 131 | "name": nuki.config["name"], 132 | "lastKnownState": self._get_nuki_last_state(nuki)} for nuki in self.nuki_manager if nuki.config] 133 | return web.Response(text=json.dumps(resp)) 134 | 135 | async def nuki_info(self, request): 136 | if not self._check_token(request): 137 | raise web.HTTPForbidden() 138 | resp = {"bridgeType": BridgeType.SW.value, 139 | # The hardwareId and firmwareVersion should not be sent if bridgeType is BRIDGE_SW, 140 | # but the homeassistant integration expects it 141 | "ids": {"hardwareId": self._server_id, "serverId": self._server_id}, 142 | "versions": {"appVersion": "0.1.0", "firmwareVersion": "0.1.0"}, 143 | "uptime": (datetime.datetime.now() - self._start_datetime).seconds, 144 | "currentTime": datetime.datetime.now().isoformat()[:-7] + "Z", 145 | "serverConnected": False, 146 | "scanResults": [{"nukiId": nuki.config["id"], 147 | "type": nuki.device_type.value, # How to get this from bt api? 148 | "name": nuki.config["name"], 149 | "rssi": nuki.rssi, 150 | "paired": True} for nuki in self.nuki_manager if nuki.config]} 151 | return web.Response(text=json.dumps(resp)) 152 | 153 | def _clear_old_ctokens(self): 154 | for ctk in list(self._used_token.keys()): 155 | diff = (datetime.datetime.utcnow() - self._used_token[ctk]).total_seconds() 156 | if diff > 60: 157 | del self._used_token[ctk] 158 | 159 | def _check_token(self, request): 160 | if "hash" in request.query: 161 | rnr = request.query["rnr"] 162 | ts = request.query["ts"] 163 | hash_256 = hashlib.sha256(f"{ts},{rnr},{self._token}".encode("utf-8")).hexdigest() 164 | return hash_256 == request.query["hash"] 165 | elif "token" in request.query: 166 | return self._token == request.query["token"] 167 | elif "ctoken" in request.query: 168 | nonce = bytes.fromhex(request.query["nonce"]) 169 | ctoken = bytes.fromhex(request.query["ctoken"]) 170 | self._clear_old_ctokens() 171 | if ctoken not in self._used_token: 172 | ts, rnr = self._hashed_token_box.decrypt(ctoken, nonce).decode().split(",") 173 | ts = datetime.datetime.fromisoformat(ts[:-1]) 174 | diff = (datetime.datetime.utcnow() - ts).total_seconds() 175 | self._used_token[ctoken] = ts 176 | return diff <= 60 177 | return False 178 | 179 | async def nuki_lockaction(self, request): 180 | if not self._check_token(request): 181 | raise web.HTTPForbidden() 182 | action = int(request.query["action"]) 183 | n = self.nuki_manager.nuki_by_id(int(request.query["nukiId"])) 184 | await n.lock_action(action) 185 | res = json.dumps({"success": True, "batteryCritical": n.is_battery_critical}) 186 | return web.Response(text=res) 187 | 188 | async def nuki_state(self, request): 189 | if not self._check_token(request): 190 | raise web.HTTPForbidden() 191 | n = self.nuki_manager.nuki_by_id(int(request.query["nukiId"])) 192 | return web.Response(text=json.dumps(self._get_nuki_last_state(n))) 193 | 194 | async def nuki_lock(self, request): 195 | if not self._check_token(request): 196 | raise web.HTTPForbidden() 197 | n = self.nuki_manager.nuki_by_id(int(request.query["nukiId"])) 198 | await n.lock() 199 | res = json.dumps({"success": True, "batteryCritical": n.is_battery_critical}) 200 | return web.Response(text=res) 201 | 202 | async def nuki_unlock(self, request): 203 | if not self._check_token(request): 204 | raise web.HTTPForbidden() 205 | n = self.nuki_manager.nuki_by_id(int(request.query["nukiId"])) 206 | await n.unlock() 207 | res = json.dumps({"success": True, "batteryCritical": n.is_battery_critical}) 208 | return web.Response(text=res) 209 | 210 | 211 | def _add_devices_to_manager(data, nuki_manager): 212 | for ls in data["smartlock"]: 213 | address = ls["address"].lower() 214 | auth_id = bytes.fromhex(ls["auth_id"]) 215 | nuki_public_key = bytes.fromhex(ls["nuki_public_key"]) 216 | bridge_public_key = bytes.fromhex(ls["bridge_public_key"]) 217 | bridge_private_key = bytes.fromhex(ls["bridge_private_key"]) 218 | n = Nuki(address, auth_id, nuki_public_key, bridge_public_key, bridge_private_key) 219 | n.retry = ls.get("retry", 3) 220 | n.connection_timeout = ls.get("connection_timeout", 10) 221 | n.command_timeout = ls.get("command_timeout", 30) 222 | nuki_manager.add_nuki(n) 223 | 224 | 225 | if __name__ == "__main__": 226 | parser = argparse.ArgumentParser() 227 | parser.add_argument("--config", metavar=('CONFIG_FILE',), help="Specify the yaml file to use") 228 | parser.add_argument("--pair", metavar=('MAC_ADDRESS',), help="Pair to a nuki smartlock") 229 | parser.add_argument("--generate-config", action='store_true', help="Generate a new configuration file") 230 | parser.add_argument("--unlock", action='store_true', help="Unlock") 231 | parser.add_argument("--lock", action='store_true', help="Lock") 232 | parser.add_argument("--verbose", nargs='?', const=1, type=int, default=0, help="More logs") 233 | args = parser.parse_args() 234 | 235 | if not args.verbose: 236 | logger.setLevel(level=logging.INFO) 237 | logging.getLogger("aiohttp").setLevel(level=logging.ERROR) 238 | logging.getLogger("bleak").setLevel(level=logging.ERROR) 239 | elif args.verbose == 1: 240 | logger.setLevel(level=logging.DEBUG) 241 | logging.getLogger("aiohttp").setLevel(level=logging.INFO) 242 | logging.getLogger("bleak").setLevel(level=logging.INFO) 243 | elif args.verbose == 2: 244 | logger.setLevel(level=logging.DEBUG) 245 | logging.getLogger("aiohttp").setLevel(level=logging.DEBUG) 246 | logging.getLogger("bleak").setLevel(level=logging.DEBUG) 247 | 248 | if args.generate_config: 249 | app_id = random.getrandbits(32) 250 | token = random.getrandbits(256).to_bytes(32, "little").hex() 251 | server_id = uuid.getnode() 252 | print(f"server:\n" 253 | f" host: 0.0.0.0\n" 254 | f" port: 8080\n" 255 | f" name: RaspiNukiBridge\n" 256 | f" app_id: {app_id}\n" 257 | f" token: {token}\n" 258 | f" id: {server_id}\n") 259 | exit(0) 260 | 261 | config_file = args.config or "nuki.yaml" 262 | with open(config_file) as f: 263 | data = yaml.load(f, Loader=yaml.FullLoader) 264 | 265 | if "id" not in data["server"]: 266 | data["server"]["id"] = uuid.getnode() 267 | with open(config_file, "w") as f: 268 | yaml.dump(data, f) 269 | 270 | name = data["server"]["name"] 271 | app_id = data["server"]["app_id"] 272 | bt_adapter = data["server"].get("adapter", "hci0") 273 | 274 | nuki_manager = NukiManager(name, app_id, bt_adapter) 275 | 276 | if args.pair: 277 | address = args.pair 278 | logger.info(f"Generatig keys for Nuki {address}") 279 | keypair = PrivateKey.generate() 280 | bridge_public_key = keypair.public_key.__bytes__() 281 | bridge_private_key = keypair.__bytes__() 282 | logger.info(f"bridge_public_key: {bridge_public_key.hex()}") 283 | logger.info(f"bridge_private_key: {bridge_private_key.hex()}") 284 | nuki = Nuki(address, None, None, bridge_public_key, bridge_private_key) 285 | nuki_manager.add_nuki(nuki) 286 | 287 | loop = asyncio.get_event_loop() 288 | 289 | def pairing_completed(paired_nuki): 290 | logger.info(f"Pairing completed, nuki_public_key: {paired_nuki.nuki_public_key.hex()}") 291 | logger.info(f"Pairing completed, auth_id: {paired_nuki.auth_id.hex()}") 292 | loop.stop() 293 | loop.create_task(nuki.pair(pairing_completed)) 294 | loop.run_forever() 295 | else: 296 | _add_devices_to_manager(data, nuki_manager) 297 | 298 | if args.unlock: 299 | device = nuki_manager.device_list[0] 300 | asyncio.run(device.unlock()) 301 | elif args.lock: 302 | device = nuki_manager.device_list[0] 303 | asyncio.run(device.lock()) 304 | else: 305 | host = data["server"]["host"] 306 | port = data["server"]["port"] 307 | token = data["server"]["token"] 308 | server_id = data["server"]["id"] 309 | web_server = WebServer(host, port, token, server_id, nuki_manager) 310 | web_server.start() 311 | -------------------------------------------------------------------------------- /nuki.py: -------------------------------------------------------------------------------- 1 | import asyncio 2 | import datetime 3 | import hashlib 4 | import logging 5 | import struct 6 | import hmac 7 | import enum 8 | import binascii 9 | 10 | import nacl.utils 11 | import nacl.secret 12 | from nacl.bindings.crypto_box import crypto_box_beforenm 13 | from bleak import BleakScanner, BleakClient 14 | 15 | BLE_SMARTLOCK_PAIRING_SERVICE = "a92ee100-5501-11e4-916c-0800200c9a66" 16 | BLE_SMARTLOCK_CHAR = "a92ee202-5501-11e4-916c-0800200c9a66" 17 | BLE_SMARTLOCK_PAIRING_CHAR = 'a92ee101-5501-11e4-916c-0800200c9a66' 18 | 19 | BLE_OPENER_PAIRING_SERVICE = "a92ae100-5501-11e4-916c-0800200c9a66" 20 | BLE_OPENER_CHAR = "a92ae202-5501-11e4-916c-0800200c9a66" 21 | BLE_OPENER_PAIRING_CHAR = 'a92ae101-5501-11e4-916c-0800200c9a66' 22 | 23 | 24 | class BridgeType(enum.Enum): 25 | HW = 1 26 | SW = 2 27 | 28 | 29 | class DeviceType(enum.Enum): 30 | SMARTLOCK_1_2 = 0 31 | OPENER = 2 32 | SMARTDOOR = 3 33 | SMARTLOCK_3 = 4 34 | 35 | 36 | class DoorsensorState(enum.Enum): 37 | UNAVAILABLE = 0 38 | DEACTIVATED = 1 39 | DOOR_CLOSED = 2 40 | DOOR_OPENED = 3 41 | DOOR_STATE_UNKOWN = 4 42 | CALIBRATING = 5 43 | UNCALIBRATED = 16 44 | REMOVED = 240 45 | UNKOWN = 255 46 | 47 | 48 | class StatusCode(enum.Enum): 49 | COMPLETED = 0 50 | ACCEPTED = 1 51 | 52 | 53 | class NukiCommand(enum.Enum): 54 | REQUEST_DATA = 0x0001 55 | PUBLIC_KEY = 0x0003 56 | CHALLENGE = 0x0004 57 | AUTH_AUTHENTICATOR = 0x0005 58 | AUTH_DATA = 0x0006 59 | AUTH_ID = 0x0007 60 | KEYTURNER_STATES = 0x000C 61 | LOCK_ACTION = 0x000D 62 | STATUS = 0x000E 63 | ERROR_REPORT = 0x0012 64 | REQUEST_CONFIG = 0x0014 65 | CONFIG = 0x0015 66 | AUTH_ID_CONFIRM = 0x001E 67 | 68 | 69 | class NukiState(enum.Enum): 70 | UNINITIALIZED = 0x00 71 | PAIRING_MODE = 0x01 72 | DOOR_MODE = 0x02 73 | CONTINUOUS_MODE = 0x03 74 | MAINTENANCE_MODE = 0x04 75 | 76 | 77 | class LockState(enum.Enum): 78 | UNCALIBRATED = 0x00 79 | LOCKED = 0x01 80 | UNLOCKING = 0x02 81 | UNLOCKED = 0x03 82 | LOCKING = 0x04 83 | UNLATCHED = 0x05 84 | UNLOCKED_LOCK_N_GO = 0x06 85 | UNLATCHING = 0x07 86 | CALIBRATION = 0xFC 87 | BOOT_RUN = 0xFD 88 | MOTOR_BLOCKED = 0xFE 89 | UNDEFINED = 0xFF 90 | 91 | 92 | class OpenerState(enum.Enum): 93 | UNCALIBRATED = 0x00 94 | LOCKED = 0x01 95 | RTO_ACTIVE = 0x03 96 | OPEN = 0x05 97 | OPENING = 0x07 98 | UNDEFINED = 0xFF 99 | 100 | 101 | class NukiAction(enum.Enum): 102 | NONE = 0x00 103 | UNLOCK = 0x01 104 | LOCK = 0x02 105 | UNLATCH = 0x03 106 | LOCK_N_GO = 0x04 107 | LOCK_N_GO_UNLATCH = 0x05 108 | FULL_LOCK = 0x06 109 | FOB_ACTION_1 = 0x81 110 | FOB_ACTION_2 = 0x82 111 | FOB_ACTION_3 = 0x83 112 | 113 | 114 | class NukiClientType(enum.Enum): 115 | APP = 0x00 116 | BRIDGE = 0x01 117 | FOB = 0x02 118 | KEYPAD = 0x03 119 | 120 | 121 | logger = logging.getLogger("raspinukibridge") 122 | 123 | 124 | class NukiManager: 125 | 126 | def __init__(self, name, app_id, adapter="hci0"): 127 | self.name = name 128 | self.app_id = app_id 129 | self.type_id = NukiClientType.BRIDGE 130 | self._newstate_callback = None 131 | 132 | self._adapter = adapter 133 | self._devices = {} 134 | self._scanner = BleakScanner(adapter=self._adapter) 135 | self._scanner.register_detection_callback(self._detected_ibeacon) 136 | 137 | @property 138 | def newstate_callback(self): 139 | return self._newstate_callback 140 | 141 | @newstate_callback.setter 142 | def newstate_callback(self, value): 143 | self._newstate_callback = value 144 | for device in self._devices.values(): 145 | asyncio.get_event_loop().create_task(self.newstate_callback(device)) 146 | 147 | async def nuki_newstate(self, nuki): 148 | if self.newstate_callback: 149 | await self.newstate_callback(nuki) 150 | 151 | def get_client(self, address, timeout=None): 152 | return BleakClient(address, adapter=self._adapter, timeout=timeout) 153 | 154 | def __getitem__(self, index): 155 | return list(self._devices.values())[index] 156 | 157 | def nuki_by_id(self, nuki_id): 158 | return next(nuki for nuki in self._devices.values() if nuki.config.get("id") == nuki_id) 159 | 160 | def add_nuki(self, nuki: 'Nuki'): 161 | nuki.manager = self 162 | self._devices[nuki.address] = nuki 163 | 164 | @property 165 | def device_list(self): 166 | return list(self._devices.values()) 167 | 168 | async def start_scanning(self): 169 | logger.info("Start scanning") 170 | await self._scanner.start() 171 | 172 | async def stop_scanning(self): 173 | logger.info("Stop scanning") 174 | try: 175 | await self._scanner.stop() 176 | except: 177 | pass 178 | 179 | async def _detected_ibeacon(self, device, advertisement_data): 180 | device_address = device.address.lower() 181 | if device_address in self._devices: 182 | manufacturer_data = advertisement_data.manufacturer_data[76] 183 | if manufacturer_data[0] != 0x02: 184 | # Ignore HomeKit advertisement 185 | return 186 | logger.info(f"Nuki: {device_address}, RSSI: {device.rssi} {advertisement_data}") 187 | tx_p = manufacturer_data[-1] 188 | nuki = self._devices[device_address] 189 | nuki.set_ble_device(device) 190 | nuki.rssi = device.rssi 191 | if not nuki.device_type: 192 | try: 193 | await nuki.connect() # this will force the identification of the device type 194 | except: 195 | await self.start_scanning() 196 | return 197 | if not nuki.last_state or tx_p & 0x1: 198 | await nuki.update_state() 199 | elif not nuki.config: 200 | await nuki.get_config() 201 | 202 | 203 | class Nuki: 204 | 205 | def __init__(self, address, auth_id, nuki_public_key, bridge_public_key, bridge_private_key): 206 | self.address = address 207 | self.auth_id = auth_id 208 | self.nuki_public_key = nuki_public_key 209 | self.bridge_public_key = bridge_public_key 210 | self.bridge_private_key = bridge_private_key 211 | self.manager = None 212 | self.id = None 213 | self.name = None 214 | self.rssi = None 215 | self.last_state = None 216 | self.config = {} 217 | 218 | self._device_type = None 219 | self._pairing_handle = None 220 | self._client = None 221 | self._challenge_command = None 222 | self._pairing_callback = None 223 | self._command_timeout_task = None 224 | self._reset_opener_state_task = None 225 | self.retry = 3 226 | self.connection_timeout = 10 227 | self.command_timeout = 30 228 | 229 | self._BLE_CHAR = None 230 | self._BLE_PAIRING_CHAR = None 231 | 232 | if nuki_public_key and bridge_private_key: 233 | self._create_shared_key() 234 | 235 | @property 236 | def device_type(self): 237 | return self._device_type 238 | 239 | @device_type.setter 240 | def device_type(self, device_type: DeviceType): 241 | if device_type == DeviceType.OPENER: 242 | self._BLE_PAIRING_CHAR = BLE_OPENER_PAIRING_CHAR 243 | self._BLE_CHAR = BLE_OPENER_CHAR 244 | else: 245 | self._BLE_PAIRING_CHAR = BLE_SMARTLOCK_PAIRING_CHAR 246 | self._BLE_CHAR = BLE_SMARTLOCK_CHAR 247 | self._device_type = device_type 248 | logger.info(f"Device type: {self.device_type}") 249 | 250 | def _create_shared_key(self): 251 | self._shared_key = crypto_box_beforenm(self.nuki_public_key, self.bridge_private_key) 252 | self._box = nacl.secret.SecretBox(self._shared_key) 253 | 254 | @property 255 | def is_battery_critical(self): 256 | return bool(self.last_state["critical_battery_state"] & 1) 257 | 258 | @property 259 | def is_battery_charging(self): 260 | return bool(self.last_state["critical_battery_state"] & 2) 261 | 262 | @property 263 | def battery_percentage(self): 264 | return ((self.last_state["critical_battery_state"] & 252) >> 2) * 2 265 | 266 | @staticmethod 267 | def _prepare_command(cmd_code: int, payload=bytes()): 268 | message = cmd_code.to_bytes(2, "little") + payload 269 | crc = binascii.crc_hqx(message, 0xffff).to_bytes(2, "little") 270 | message += crc 271 | return message 272 | 273 | def _encrypt_command(self, cmd_code: int, payload=bytes()): 274 | unencrypted = self.auth_id + self._prepare_command(cmd_code, payload)[:-2] 275 | crc = binascii.crc_hqx(unencrypted, 0xffff).to_bytes(2, "little") 276 | unencrypted += crc 277 | nonce = nacl.utils.random(24) 278 | encrypted = self._box.encrypt(unencrypted, nonce)[24:] 279 | length = len(encrypted).to_bytes(2, "little") 280 | message = nonce + self.auth_id + length + encrypted 281 | return message 282 | 283 | def _decrypt_command(self, data): 284 | nonce = data[:24] 285 | auth_id, length = struct.unpack(" 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 | --------------------------------------------------------------------------------