├── requirements.txt ├── custom_components └── prana │ ├── manifest.json │ ├── utils.py │ ├── const.py │ ├── light.py │ ├── translations │ └── en.json │ ├── switch.py │ ├── __init__.py │ ├── entity.py │ ├── fan.py │ └── config_flow.py ├── pyproject.toml ├── tmp.py ├── Makefile ├── setup.cfg ├── .gitignore ├── README.md └── LICENSE /requirements.txt: -------------------------------------------------------------------------------- 1 | # Development dependencies 2 | copyright==1.0.1.0 3 | twine==1.13.0 4 | m2r==0.2.1 5 | flake8==3.8.4 6 | black==20.8b1 7 | mypy>=0.7 8 | -------------------------------------------------------------------------------- /custom_components/prana/manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "domain": "prana", 3 | "name": "Prana Recuperators", 4 | "documentation": "", 5 | "version": "0.2.0", 6 | "dependencies": [], 7 | "codeowners": [ 8 | "@corvis" 9 | ], 10 | "requirements": [ 11 | "prana-rc.client>=0.3.11" 12 | ], 13 | "config_flow": true 14 | } 15 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [tool.black] 2 | line-length = 120 3 | target-version = ['py37'] 4 | exclude = ''' 5 | ( 6 | /( 7 | \.eggs # exclude a few common directories in the 8 | | \.git # root of the project 9 | | \.mypy_cache 10 | | \.tox 11 | | \.venv 12 | | _build 13 | | buck-out 14 | | build 15 | | dist 16 | )/ 17 | ) 18 | ''' 19 | -------------------------------------------------------------------------------- /tmp.py: -------------------------------------------------------------------------------- 1 | from os import listdir 2 | from os.path import isfile, isdir, getsize, join 3 | 4 | 5 | def get_dir_size(path: str) -> int: 6 | if isfile(path): 7 | return getsize(path) 8 | else: 9 | size = 0 10 | for file_name in listdir(path): 11 | p = join(path, file_name) 12 | if isfile(p): 13 | size += getsize(p) 14 | elif isdir(p): 15 | size += get_dir_size(p) 16 | else: 17 | pass # Skip everything else 18 | return size 19 | 20 | getsize('/tmp/.X11-unix') 21 | print(get_dir_size('/home/corvis/Documents')) 22 | 23 | # Questions -> Exceptions what are the cases? 24 | # IsFile -> What if it's not a file and not dir (links, block devices, sockets)? 25 | # Recursion depth -------------------------------------------------------------------------------- /custom_components/prana/utils.py: -------------------------------------------------------------------------------- 1 | import hashlib 2 | import logging 3 | from typing import Dict 4 | 5 | from prana_rc.contrib.client.aiohttp import PranaRCAioHttpClient 6 | from prana_rc.contrib.client.common import PranaRCAsyncClient 7 | 8 | from . import const 9 | 10 | PRANA_SPEEDS = ["Off", "Low", "2", "3", "4", "5", "6", "7", "8", "High"] 11 | PRANA_DEFAULT_SPEED = "2" 12 | 13 | 14 | def api_client_from_config(config: Dict) -> PranaRCAsyncClient: 15 | return PranaRCAioHttpClient(config.get(const.CONF_BASE_URL)) 16 | 17 | 18 | def handle_prana_error(e: Exception, errors: Dict, logger: logging.Logger): 19 | errors["base"] = "unable_to_connect_to_server" 20 | logger.exception("Unable to connect to prana rc server") 21 | 22 | 23 | def generate_unique_id(config: Dict): 24 | hash_alg = hashlib.sha1() 25 | hash_alg.update(config[const.CONF_CONNECTION_TYPE].encode("utf-8")) 26 | hash_alg.update(config[const.CONF_BASE_URL].encode("utf-8")) 27 | return hash_alg.hexdigest() 28 | 29 | 30 | def speed_int_to_str(speed: int) -> str: 31 | return PRANA_SPEEDS[speed] 32 | 33 | 34 | def percentage_to_speed(percentage: int) -> str: 35 | if percentage == 0: 36 | return PRANA_SPEEDS[0] 37 | return PRANA_SPEEDS[int(percentage / len(PRANA_SPEEDS))] 38 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | VIRTUAL_ENV_PATH=venv 2 | SKIP_VENV="${NO_VENV}" 3 | PYPI_API_KEY := 4 | PYPI_REPOSITORY_URL := 5 | ALPHA_VERSION := 6 | 7 | SHELL := /bin/bash 8 | .DEFAULT_GOAL := pre_commit 9 | 10 | pre_commit: format lint 11 | 12 | flake8: 13 | @( \ 14 | set -e; \ 15 | if [ -z $(SKIP_VENV) ]; then source $(VIRTUAL_ENV_PATH)/bin/activate; fi; \ 16 | echo "Runing Flake8 checks..."; \ 17 | flake8 ./custom_components/prana --count --statistics; \ 18 | echo "DONE: Flake8"; \ 19 | ) 20 | 21 | mypy: 22 | @( \ 23 | set -e; \ 24 | if [ -z $(SKIP_VENV) ]; then source $(VIRTUAL_ENV_PATH)/bin/activate; fi; \ 25 | echo "Runing MyPy checks..."; \ 26 | mypy --show-error-codes ./custom_components/prana; \ 27 | echo "DONE: MyPy"; \ 28 | ) 29 | 30 | lint: flake8 mypy 31 | 32 | clean: 33 | @(rm -rf custom_components/build dist/* *.egg-info custom_components/*.egg-info .pytest_cache) 34 | 35 | format: 36 | @( \ 37 | if [ -z $(SKIP_VENV) ]; then source $(VIRTUAL_ENV_PATH)/bin/activate; fi; \ 38 | echo "Runing Black code formater..."; \ 39 | black ./custom_components/prana; \ 40 | echo "DONE: Black"; \ 41 | ) 42 | 43 | venv: 44 | @( \ 45 | virtualenv $(VIRTUAL_ENV_PATH); \ 46 | source ./venv/bin/activate; \ 47 | pip install -r ./requirements.txt; \ 48 | ) -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [flake8] 2 | max-complexity = 12 3 | max-line-length=127 4 | 5 | exclude = 6 | # No need to traverse our git directory 7 | .git, 8 | # There's no value in checking cache directories 9 | __pycache__, 10 | # This contains our built documentation 11 | build, 12 | # This contains builds of flake8 that we don't want to check 13 | dist, 14 | *.egg-info, 15 | # Test / internal files 16 | _client_test.py 17 | 18 | ignore = 19 | # W291 trailing whitespace 20 | W291, 21 | # W391 blank line at end of file 22 | W391, 23 | # E501: line too long 24 | E501, 25 | # W503: Line break occurred before a binary operator 26 | W503, 27 | # E203: Whitespace before ':' 28 | E203, 29 | # D202 No blank lines allowed after function docstring 30 | D202, 31 | # W504 line break after binary operator 32 | W504 33 | 34 | per-file-ignores = 35 | # imported but unused 36 | __init__.py: F401 37 | 38 | [codespell] 39 | skip = *.po,*.ts,.pyc 40 | ignore-words-list = hass 41 | 42 | [mypy] 43 | python_version = 3.7 44 | show_error_codes = true 45 | ignore_errors = false 46 | warn_return_any = false 47 | ignore_missing_imports = True 48 | disallow_any_generics = false 49 | pretty = true 50 | 51 | [mypy-examples] 52 | ignore_errors = true 53 | follow_imports = silent 54 | ignore_missing_imports = true 55 | -------------------------------------------------------------------------------- /custom_components/prana/const.py: -------------------------------------------------------------------------------- 1 | from enum import Enum 2 | 3 | # Common consts 4 | DOMAIN = "prana" 5 | PLATFORMS = ("fan", "switch", "light") # MUST BE THE FIRST IN THE LIST 6 | 7 | SIGNAL_PRANA_MAIN_INITIALIZED = "prana_main_initialized" 8 | 9 | PRANA_DISCOVERY_TIMEOUT = 10 10 | 11 | 12 | class ConnectionType(Enum): 13 | LOCAL_BLE = "local_ble" 14 | REMOTE_HTTP_SERVER = "remote_http" 15 | REMOTE_WEBSOCKET = "remore_ws" 16 | 17 | 18 | # Config properties 19 | CONF_CONNECTION_TYPE = "connection_type" 20 | CONF_BASE_URL = "base_url" 21 | 22 | CONNECTION_TYPE_MAP = {ConnectionType.REMOTE_HTTP_SERVER: "HTTP"} 23 | 24 | # Options 25 | OPT_LAST_UPDATE = "_timestamp" 26 | OPT_DEVICES = "devices" 27 | OPT_DEVICE_NAME = "name" 28 | OPT_DEVICE_ADDRESS = "addr" 29 | 30 | # Config flow user input keys 31 | INP_DEVICE = "device" 32 | INP_DISCOVERED_DEVICES = "discovered_device" 33 | INP_DEVICE_ADD_DEVICE = "add_new" 34 | INP_DEVICE_DISCOVER_DEVICE = "discover_new" 35 | 36 | # Runtime data fields 37 | DATA_API_CLIENT = "prana_rc_client" 38 | DATA_MAIN_ENTITIES = "main_entities" 39 | DATA_ENTITIES = "entities" 40 | DATA_DISPATCHER_DISPOSERS = "dispatcher_disposers" 41 | DATA_UNDO_UPDATE_CONF_UPDATE_LISTENER = "undo_config_update_listener" 42 | 43 | # Entity attributes 44 | ATTR_LAST_UPDATED = "last_updated" 45 | ATTR_FLOWS_LOCKED = "flows_locked" 46 | ATTR_IN_SPEED = "input_speed" 47 | ATTR_OUT_SPEED = "output_speed" 48 | ATTR_WINTER_MODE_ON = "winter_mode" 49 | ATTR_HEATING = "heating" 50 | ATTR_BRIGHTNESS = "brightness" 51 | 52 | # Device attributes 53 | ATTR_DEVICE_ADDRESS = "ble_address" 54 | ATTR_DEVICE_NAME = "name" 55 | 56 | # Other 57 | DIRECTION_IN = "in" 58 | DIRECTION_OUT = "out" 59 | DIRECTION_BOTH = "both" 60 | -------------------------------------------------------------------------------- /custom_components/prana/light.py: -------------------------------------------------------------------------------- 1 | from typing import List, Optional, Any 2 | 3 | from homeassistant.components.light import LightEntity, SUPPORT_BRIGHTNESS 4 | from homeassistant.config_entries import ConfigEntry 5 | from homeassistant.core import HomeAssistant 6 | 7 | from custom_components.prana import const 8 | from custom_components.prana.entity import PranaDependantEntity 9 | 10 | PRANA_BRIGHTNESS_MAX = 6 11 | PRANA_BRIGHTNESS_MIN = 0 12 | 13 | 14 | async def async_setup_entry(hass: HomeAssistant, config_entry: ConfigEntry, async_add_entities, discovery_info=None): 15 | entities: List[PranaDependantEntity] = [] 16 | 17 | for prana_fan in hass.data[const.DOMAIN][config_entry.entry_id][const.DATA_MAIN_ENTITIES]: 18 | entities.append(PranaBrightness(prana_fan)) 19 | 20 | if len(entities) > 0: 21 | async_add_entities(entities) 22 | hass.data[const.DOMAIN][config_entry.entry_id][const.DATA_ENTITIES] += entities 23 | 24 | 25 | class PranaBrightness(PranaDependantEntity, LightEntity): 26 | @property 27 | def unique_id(self) -> Optional[str]: 28 | return self.main_entity.unique_id + "_brightness" 29 | 30 | @property 31 | def name(self) -> Optional[str]: 32 | return self.main_entity.name + " Brightness" 33 | 34 | @property 35 | def is_on(self) -> bool: 36 | return self.main_entity.is_on and self.main_entity.state_attributes.get(const.ATTR_BRIGHTNESS, 0) > 0 37 | 38 | @property 39 | def supported_features(self): 40 | """Flag supported features.""" 41 | return SUPPORT_BRIGHTNESS 42 | 43 | @property 44 | def brightness(self): 45 | """Return the brightness of this light between 0..255.""" 46 | prana_value = self.main_entity._prana_state.brightness 47 | return int(prana_value * (255 / PRANA_BRIGHTNESS_MAX)) 48 | 49 | async def async_turn_on(self, brightness: int) -> None: 50 | pass # Not supported yet 51 | 52 | async def async_turn_off(self, **kwargs: Any) -> None: 53 | pass # Not supported yet 54 | -------------------------------------------------------------------------------- /custom_components/prana/translations/en.json: -------------------------------------------------------------------------------- 1 | { 2 | "config": { 3 | "abort": {}, 4 | "error": { 5 | "unable_to_connect_to_server": "Unable to connect to Prana RC server" 6 | }, 7 | "create_entry": { 8 | "default": "Successfully connected to PranaRC server" 9 | }, 10 | "step": { 11 | "user": { 12 | "data": { 13 | "connection_type": "Connection Type" 14 | }, 15 | "description": "Choose one of the supported connection option. You will be presented with the other parameters specific to the chosen connection method on the next step.", 16 | "title": "Setup Prana Recuperator connection" 17 | }, 18 | "remote_connection": { 19 | "data": { 20 | "connection_type": "Connection Type", 21 | "base_url": "Base URL" 22 | }, 23 | "title": "Connection parameters" 24 | } 25 | } 26 | }, 27 | "options": { 28 | "error": { 29 | "unable_to_connect": "Unable to connect to the remote device. See logs for details", 30 | "discovery_error": "Discovery failed. See logs for more details" 31 | }, 32 | "step": { 33 | "init": { 34 | "data": { 35 | "edit_key": "Page" 36 | }, 37 | "description": "Choose existing device to edit or add a new one. \nNOTE: The discovery process might take some time (up to 10 seconds)", 38 | "title": "Prana Hub Options" 39 | }, 40 | "edit_device": { 41 | "data": { 42 | "addr": "BLE MAC Address", 43 | "name": "Name" 44 | }, 45 | "title": "Device Settings", 46 | "description": "" 47 | }, 48 | "discover": { 49 | "data": { 50 | "discovered_device": "Discovered devices" 51 | }, 52 | "title": "Devices discovery", 53 | "description": "Below are the the lis of discovered devices available for pairing. \nIf you don't see your device make sure it is turned on, located nearby and is not connected to any other device already. \nIf you still can't find yur device you can return back and add it manually by mac address." 54 | } 55 | } 56 | } 57 | } -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | pip-wheel-metadata/ 24 | share/python-wheels/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | MANIFEST 29 | 30 | # PyInstaller 31 | # Usually these files are written by a python script from a template 32 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 33 | *.manifest 34 | *.spec 35 | 36 | # Installer logs 37 | pip-log.txt 38 | pip-delete-this-directory.txt 39 | 40 | # Unit test / coverage reports 41 | htmlcov/ 42 | .tox/ 43 | .nox/ 44 | .coverage 45 | .coverage.* 46 | .cache 47 | nosetests.xml 48 | coverage.xml 49 | *.cover 50 | *.py,cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | target/ 76 | 77 | # Jupyter Notebook 78 | .ipynb_checkpoints 79 | 80 | # IPython 81 | profile_default/ 82 | ipython_config.py 83 | 84 | # pyenv 85 | .python-version 86 | 87 | # pipenv 88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 91 | # install all needed dependencies. 92 | #Pipfile.lock 93 | 94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 95 | __pypackages__/ 96 | 97 | # Celery stuff 98 | celerybeat-schedule 99 | celerybeat.pid 100 | 101 | # SageMath parsed files 102 | *.sage.py 103 | 104 | # Environments 105 | .env 106 | .venv 107 | env/ 108 | venv/ 109 | ENV/ 110 | env.bak/ 111 | venv.bak/ 112 | 113 | # Spyder project settings 114 | .spyderproject 115 | .spyproject 116 | 117 | # Rope project settings 118 | .ropeproject 119 | 120 | # mkdocs documentation 121 | /site 122 | 123 | # mypy 124 | .mypy_cache/ 125 | .dmypy.json 126 | dmypy.json 127 | 128 | # Pyre type checker 129 | .pyre/ 130 | 131 | .idea/ -------------------------------------------------------------------------------- /custom_components/prana/switch.py: -------------------------------------------------------------------------------- 1 | from typing import Optional, Any, List 2 | 3 | from homeassistant.components.switch import SwitchEntity 4 | from homeassistant.config_entries import ConfigEntry 5 | from homeassistant.core import HomeAssistant 6 | from prana_rc.contrib.api import SetStateDTO 7 | 8 | from custom_components.prana import const 9 | from custom_components.prana.entity import PranaDependantEntity 10 | 11 | 12 | async def async_setup_entry(hass: HomeAssistant, config_entry: ConfigEntry, async_add_entities, discovery_info=None): 13 | entities: List[PranaDependantEntity] = [] 14 | 15 | for prana_fan in hass.data[const.DOMAIN][config_entry.entry_id][const.DATA_MAIN_ENTITIES]: 16 | entities.append(PranaHeating(prana_fan)) 17 | entities.append(PranaWinterMode(prana_fan)) 18 | 19 | if len(entities) > 0: 20 | async_add_entities(entities) 21 | hass.data[const.DOMAIN][config_entry.entry_id][const.DATA_ENTITIES] += entities 22 | 23 | 24 | class PranaHeating(PranaDependantEntity, SwitchEntity): 25 | @property 26 | def unique_id(self) -> Optional[str]: 27 | return self.main_entity.unique_id + "_heating" 28 | 29 | @property 30 | def name(self) -> Optional[str]: 31 | return self.main_entity.name + " Heating" 32 | 33 | @property 34 | def is_on(self) -> bool: 35 | return self.main_entity.is_on and self.main_entity.state_attributes.get(const.ATTR_HEATING, False) 36 | 37 | async def async_turn_off(self, **kwargs: Any) -> None: 38 | await self.main_entity.api_client.set_state(self.main_entity.device_address, SetStateDTO(heating=False)) 39 | await self.main_entity.coordinator.async_refresh() 40 | 41 | async def async_turn_on(self, **kwargs: Any) -> None: 42 | await self.main_entity.api_client.set_state(self.main_entity.device_address, SetStateDTO(heating=True)) 43 | await self.main_entity.coordinator.async_refresh() 44 | 45 | 46 | class PranaWinterMode(PranaDependantEntity, SwitchEntity): 47 | @property 48 | def unique_id(self) -> Optional[str]: 49 | return self.main_entity.unique_id + "_winter_mode" 50 | 51 | @property 52 | def name(self) -> Optional[str]: 53 | return self.main_entity.name + " Winter Mode" 54 | 55 | @property 56 | def is_on(self) -> bool: 57 | return self.main_entity.is_on and self.main_entity.state_attributes.get(const.ATTR_WINTER_MODE_ON, False) 58 | 59 | async def async_turn_off(self, **kwargs: Any) -> None: 60 | await self.main_entity.api_client.set_state(self.main_entity.device_address, SetStateDTO(winter_mode=False)) 61 | await self.main_entity.coordinator.async_refresh() 62 | 63 | async def async_turn_on(self, **kwargs: Any) -> None: 64 | await self.main_entity.api_client.set_state(self.main_entity.device_address, SetStateDTO(winter_mode=True)) 65 | await self.main_entity.coordinator.async_refresh() 66 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

Home Assistant Integration with Prana Recuperators

2 | 3 | Home Assistant integration with Prana Recuperators. It utilizes [prana_rc](https://github.com/corvis/prana_rc) underneath which could be installed either on the same machine with Home Assistant or at some other location closer to Prana device. 4 | 5 | ## Features 6 | 7 | - No need to keep Home Assistant close to the Prana device. 8 | - Apart from the simple ON\OF speed control allows managing extra features like: 9 | - Heating mode 10 | - Winter mode 11 | - Brightness (read-only at the moment) 12 | - Allows controlling input and output flows independently 13 | - Automatic discovery of the prana devices 14 | 15 | ## How does it work 16 | 17 | The configuration is done via Config Flow. You have to establish a connection with running [prana_rc](https://github.com/corvis/prana_rc) instance and then use Options dialog to connect to the particular device (auto-discovery is available as well as an ability to type in the mac address of the device). 18 | 19 | Once the device is configured the integration will register a bunch of entities: 20 | 21 | - Your __main FAN entity__ which represents prana recuperator. This is what you most likely will be using regularly. It allows turning on and off the device in locked flows mode and set a particular speed. It also publishes a bunch of attributes that represent the current device state e.g. display brightness, heater status, winter mode, etc. 22 | - The light entity which represents __display brightness__. So far it is read-only so you won't be able to adjust brightens. 23 | - Switches for __heating__ and __winter__ modes. Allows controlling heating and winter modes correspondingly. 24 | - Fan entities for __input__ and __output__ flows could be used to put Prana into unlocked flows mode and control flows independently. 25 | 26 | ## Installation 27 | 28 | 1. Download release from the [releases section](https://github.com/corvis/homeassistant_prana/releases). 29 | 2. Unpack the archive and put the content of the `custom_components` directory under `custom_components` directory of your home assistant installation. 30 | 3. Restart home assistant 31 | 4. Install Prana RC and run it in http server mode: 32 | - The easiest way with docker would be to use docker: ` CODE SAMPLE TBD ` 33 | - Also consult with Prana RC [installation instructions](https://github.com/corvis/prana_rc#installation--usage) 34 | 5. In Home Assistant go to the `Configuration` -> `Integrations` -> `Add integration` 35 | 6. Find and select `Prana Recuperators` in the integrations list 36 | 7. Follow the instructions to connect to Prana RC server. You will be asked for IP address and port. Keep it as it is if you run Prana RC locally. 37 | 8. Once configured hub open `Options` for newly added integration and follow either Discovery flow (default) or choose "Add device manually" if discovery doesn't detect your device for some reason. 38 | 9. Make sure to set a meaningful name for the device as it will be used for both the entity id and user-facing name of your entities. 39 | 40 | ## Limitations 41 | 42 | - Brightness control is not implemented now (read-only) 43 | - Separate flows management is not yet implemented (read-only) 44 | 45 | ## Credits 46 | * Dmitry Berezovsky, author 47 | * Prana RC, interfacing library to communicate with Prana hardware via BLE. 48 | 49 | ## Disclaimer 50 | This module is licensed under GPL v3. This means you are free to use in non-commercial projects. 51 | 52 | The GPL license clearly explains that there is no warranty for this free software. Please see the included LICENSE file for details. 53 | -------------------------------------------------------------------------------- /custom_components/prana/__init__.py: -------------------------------------------------------------------------------- 1 | import asyncio 2 | import logging 3 | 4 | from homeassistant.config_entries import ConfigEntry 5 | from homeassistant.core import HomeAssistant, Config 6 | from homeassistant.helpers.dispatcher import async_dispatcher_connect 7 | 8 | from custom_components.prana.entity import BaseMainPranaFan 9 | from . import const, utils 10 | 11 | _LOGGER = logging.getLogger(__name__) 12 | 13 | 14 | async def async_setup(hass: HomeAssistant, config: Config) -> bool: 15 | """Set up configured Prana integration based on the yaml config""" 16 | # TODO: transform yaml into config entry 17 | hass.data.setdefault(const.DOMAIN, {}) 18 | return True 19 | 20 | 21 | async def async_setup_entry(hass: HomeAssistant, config_entry: ConfigEntry): 22 | """Set up Prana from a config entry.""" 23 | _LOGGER.debug("Loading config entry {} (id: {})".format(config_entry.title, config_entry.entry_id)) 24 | api_client = utils.api_client_from_config(config_entry.data) 25 | await api_client.init() 26 | 27 | # Subscribe for changes to config entry 28 | undo_config_update_listener = config_entry.add_update_listener(update_config_listener) 29 | 30 | # Bootstrap data structure for config entry 31 | hass.data[const.DOMAIN][config_entry.entry_id] = { 32 | const.DATA_API_CLIENT: api_client, 33 | const.DATA_UNDO_UPDATE_CONF_UPDATE_LISTENER: undo_config_update_listener, 34 | const.DATA_ENTITIES: [], 35 | const.DATA_MAIN_ENTITIES: [], 36 | const.DATA_DISPATCHER_DISPOSERS: [], 37 | } 38 | 39 | entry_data = hass.data[const.DOMAIN][config_entry.entry_id] 40 | 41 | async def handle_main_entities_initialized(): # Initialize the rest of the platforms (supplementary entities) 42 | for component in const.PLATFORMS[1:]: 43 | hass.async_create_task(hass.config_entries.async_forward_entry_setup(config_entry, component)) 44 | 45 | entry_data[const.DATA_DISPATCHER_DISPOSERS].append( 46 | async_dispatcher_connect(hass, const.SIGNAL_PRANA_MAIN_INITIALIZED, handle_main_entities_initialized) 47 | ) 48 | 49 | # Run fan platform initialization 50 | hass.async_create_task(hass.config_entries.async_forward_entry_setup(config_entry, const.PLATFORMS[0])) 51 | 52 | return True 53 | 54 | 55 | async def async_unload_entry(hass: HomeAssistant, config_entry: ConfigEntry): 56 | """Destroy resources related to config entry""" 57 | _LOGGER.debug("Unloading config entry {} (id: {})".format(config_entry.title, config_entry.entry_id)) 58 | unload_ok = all( 59 | await asyncio.gather( 60 | *[hass.config_entries.async_forward_entry_unload(config_entry, component) for component in const.PLATFORMS] 61 | ) 62 | ) 63 | entry_data = hass.data[const.DOMAIN][config_entry.entry_id] 64 | 65 | # Disposing client 66 | try: 67 | await entry_data[const.DATA_API_CLIENT].close() 68 | except Exception as e: 69 | _LOGGER.warning("Unable to gracefully close prana_rc client session: " + str(e)) 70 | finally: 71 | entry_data[const.DATA_API_CLIENT] = None 72 | 73 | # Remove entities from hass 74 | # await asyncio.gather(*[entity.async_remove() for entity in entry_data[const.DATA_ENTITIES]]) 75 | entry_data[const.DATA_ENTITIES] = [] 76 | 77 | entry_data[const.DATA_UNDO_UPDATE_CONF_UPDATE_LISTENER]() 78 | 79 | # Cancel dispatchers 80 | for dispose in entry_data[const.DATA_DISPATCHER_DISPOSERS]: 81 | dispose() 82 | 83 | if unload_ok: 84 | hass.data[const.DOMAIN].pop(config_entry.entry_id) 85 | 86 | return unload_ok 87 | 88 | 89 | async def update_config_listener(hass: HomeAssistant, config_entry: ConfigEntry): 90 | """Will be invoked after once entry updated.""" 91 | _LOGGER.debug( 92 | "Config entry {}(id: {}) updated. Platform reload will be triggered".format( 93 | config_entry.title, config_entry.entry_id 94 | ) 95 | ) 96 | await hass.config_entries.async_reload(config_entry.entry_id) 97 | -------------------------------------------------------------------------------- /custom_components/prana/entity.py: -------------------------------------------------------------------------------- 1 | from abc import ABCMeta 2 | from typing import Optional, Dict, Any, Union 3 | 4 | from homeassistant.components.fan import FanEntity, SUPPORT_SET_SPEED 5 | from homeassistant.core import callback 6 | from homeassistant.helpers.entity import DeviceInfo 7 | from homeassistant.helpers.entity import Entity 8 | from homeassistant.helpers.update_coordinator import DataUpdateCoordinator 9 | from prana_rc.contrib.api import PranaStateDTO 10 | from prana_rc.contrib.client.common import PranaRCAsyncClient 11 | from prana_rc.entity import Speed 12 | 13 | from . import const, utils 14 | 15 | PranaEntity = Union["BasePranaEntity", "PranaDependantEntity"] 16 | 17 | 18 | class CoordinatorEntity(Entity): 19 | """A class for entities using DataUpdateCoordinator.""" 20 | 21 | def __init__(self, coordinator: DataUpdateCoordinator) -> None: 22 | """Create the entity with a DataUpdateCoordinator.""" 23 | self.coordinator = coordinator 24 | 25 | @property 26 | def should_poll(self) -> bool: 27 | """No need to poll. Coordinator notifies entity of updates.""" 28 | return False 29 | 30 | @property 31 | def available(self) -> bool: 32 | """Return if entity is available.""" 33 | return self.coordinator.last_update_success 34 | 35 | async def async_added_to_hass(self) -> None: 36 | """When entity is added to hass.""" 37 | await super().async_added_to_hass() 38 | self.async_on_remove(self.coordinator.async_add_listener(self._handle_coordinator_update)) 39 | 40 | @callback 41 | def _handle_coordinator_update(self) -> None: 42 | """Handle updated data from the coordinator.""" 43 | self.async_write_ha_state() 44 | 45 | async def async_update(self) -> None: 46 | """Update the entity. 47 | 48 | Only used by the generic entity update service. 49 | """ 50 | 51 | # Ignore manual update requests if the entity is disabled 52 | if not self.enabled: 53 | return 54 | 55 | await self.coordinator.async_request_refresh() 56 | 57 | 58 | class BasePranaEntity(CoordinatorEntity): 59 | """Parent class for Prana entities""" 60 | 61 | def __init__( 62 | self, 63 | coordinator: DataUpdateCoordinator, 64 | api_client: PranaRCAsyncClient, 65 | device_config: dict, 66 | base_entity_id: str, 67 | base_entity_name: str, 68 | ): 69 | super().__init__(coordinator) 70 | self.coordinator = coordinator 71 | self._base_entity_id = base_entity_id 72 | self._base_entity_name = base_entity_name 73 | self._device_config = device_config 74 | self.api_client = api_client 75 | 76 | @property 77 | def _prana_state(self) -> PranaStateDTO: 78 | return self.coordinator.data 79 | 80 | @property 81 | def device_address(self): 82 | return self._device_config[const.OPT_DEVICE_ADDRESS] 83 | 84 | @property 85 | def device_info(self) -> DeviceInfo: 86 | return DeviceInfo({ 87 | 'identifiers': {(const.DOMAIN, self.unique_id)}, 88 | const.ATTR_DEVICE_ADDRESS: self._device_config.get(const.OPT_DEVICE_ADDRESS), 89 | const.ATTR_DEVICE_NAME: self._device_config.get(const.OPT_DEVICE_NAME), 90 | }) 91 | 92 | @property 93 | def assumed_state(self) -> bool: 94 | return False 95 | 96 | 97 | class PranaFanEntity(FanEntity, metaclass=ABCMeta): 98 | @property 99 | def preset_modes(self) -> Optional[list]: 100 | return utils.PRANA_SPEEDS + [None] # type:ignore 101 | 102 | def percentage_to_speed(self, percentage: int) -> str: 103 | return utils.percentage_to_speed(percentage) 104 | 105 | @property 106 | def supported_features(self) -> int: 107 | """Flag supported features.""" 108 | if not hasattr(self, "_supported_features"): 109 | features = SUPPORT_SET_SPEED 110 | try: 111 | from homeassistant.components.fan import SUPPORT_PRESET_MODE 112 | 113 | features = SUPPORT_PRESET_MODE 114 | except ImportError: 115 | pass 116 | setattr(self, "_supported_features", features) 117 | return getattr(self, "_supported_features") 118 | 119 | @property 120 | def speed_list(self) -> Optional[list]: 121 | """Get the list of available speeds.""" 122 | return self.preset_modes 123 | 124 | def speed_to_percentage(self, speed: str) -> int: 125 | speed_int = Speed.from_str(speed).value 126 | return speed_int * 10 127 | 128 | 129 | class BaseMainPranaFan(BasePranaEntity, PranaFanEntity, metaclass=ABCMeta): 130 | pass 131 | 132 | 133 | class PranaDependantEntity(CoordinatorEntity): 134 | def __init__(self, prana_main_entity: BaseMainPranaFan) -> None: 135 | super().__init__(prana_main_entity.coordinator) 136 | self.main_entity: BaseMainPranaFan = prana_main_entity 137 | 138 | @property 139 | def device_info(self) -> Optional[Dict[str, Any]]: 140 | return self.main_entity.device_info 141 | 142 | @property 143 | def should_poll(self) -> bool: 144 | return True 145 | 146 | 147 | class PranaSupplementaryFan(PranaDependantEntity, PranaFanEntity): 148 | pass 149 | -------------------------------------------------------------------------------- /custom_components/prana/fan.py: -------------------------------------------------------------------------------- 1 | import datetime 2 | import logging 3 | from typing import List, Tuple, Optional, Any 4 | 5 | from homeassistant.config_entries import ConfigEntry 6 | from homeassistant.core import HomeAssistant 7 | from homeassistant.helpers.dispatcher import async_dispatcher_send 8 | from homeassistant.helpers.update_coordinator import DataUpdateCoordinator 9 | from prana_rc.contrib.api import SetStateDTO 10 | from prana_rc.contrib.client.common import PranaRCAsyncClient 11 | from prana_rc.entity import Speed 12 | 13 | from . import const, utils 14 | from .entity import PranaEntity, BaseMainPranaFan, PranaSupplementaryFan 15 | 16 | _LOGGER = logging.getLogger(__name__) 17 | UPDATE_INTERVAL = datetime.timedelta(seconds=30) 18 | PRANA_API_ATTEMPTS = 5 19 | PRANA_API_TIMEOUT = 5 20 | 21 | 22 | async def async_setup_entry(hass: HomeAssistant, config_entry: ConfigEntry, async_add_entities, discovery_info=None): 23 | prana_client: PranaRCAsyncClient = hass.data[const.DOMAIN][config_entry.entry_id][const.DATA_API_CLIENT] 24 | entities: List[PranaEntity] = [] 25 | 26 | if config_entry.data.get(const.CONF_CONNECTION_TYPE) == const.ConnectionType.REMOTE_HTTP_SERVER.value: 27 | for device_config in config_entry.options.get(const.OPT_DEVICES, {}).values(): 28 | device_coordinator, device_entities = await setup_prana_device( 29 | hass, prana_client, device_config, config_entry.data 30 | ) 31 | entities += device_entities 32 | else: 33 | _LOGGER.warning( 34 | "Connection type {} is not yet supported. This config entry will be ignored.".format( 35 | config_entry.get(const.CONF_CONNECTION_TYPE) 36 | ) 37 | ) 38 | 39 | if len(entities) > 0: 40 | hass.data[const.DOMAIN][config_entry.entry_id][const.DATA_MAIN_ENTITIES] += entities 41 | # At the moment we registered just main entities. Let's build supplementary fans 42 | for main_entity in entities.copy(): 43 | entities.append(PranaInputFan(main_entity)) 44 | entities.append(PranaOutputFan(main_entity)) 45 | hass.data[const.DOMAIN][config_entry.entry_id][const.DATA_ENTITIES] += entities 46 | async_add_entities(entities) 47 | 48 | async_dispatcher_send(hass, const.SIGNAL_PRANA_MAIN_INITIALIZED) 49 | 50 | return True 51 | 52 | 53 | async def setup_prana_device( 54 | hass: HomeAssistant, prana_client: PranaRCAsyncClient, device_config: dict, hub_config: dict 55 | ) -> Tuple[DataUpdateCoordinator, List[PranaEntity]]: 56 | device_entities = [] 57 | entity_id = "prana_" + device_config[const.OPT_DEVICE_ADDRESS].replace(":", "_") 58 | entity_name = device_config[const.OPT_DEVICE_NAME] 59 | 60 | async def async_get_state(): 61 | try: 62 | return await prana_client.get_state( 63 | device_config[const.OPT_DEVICE_ADDRESS], timeout=PRANA_API_TIMEOUT, attempts=PRANA_API_ATTEMPTS 64 | ) 65 | except Exception as e: 66 | _LOGGER.warning("Can't read data from prana recuperator {} ({}): ".format(entity_name, entity_id) + str(e)) 67 | raise e 68 | 69 | # Configure update coordinator 70 | coordinator = DataUpdateCoordinator( 71 | hass, _LOGGER, name=entity_id, update_method=async_get_state, update_interval=UPDATE_INTERVAL 72 | ) 73 | 74 | main_entity = PranaMainFan(coordinator, prana_client, device_config, entity_id, entity_name) 75 | device_entities.append(main_entity) 76 | 77 | # Fetch initial data so we have data when entities subscribe 78 | await coordinator.async_refresh() 79 | 80 | return coordinator, device_entities 81 | 82 | 83 | class PranaMainFan(BaseMainPranaFan): 84 | def __init__( 85 | self, 86 | coordinator: DataUpdateCoordinator, 87 | api_client: PranaRCAsyncClient, 88 | device_config: dict, 89 | base_entity_id: str, 90 | base_entity_name, 91 | ): 92 | super().__init__(coordinator, api_client, device_config, base_entity_id, base_entity_name) 93 | _LOGGER.debug("Configured Prana main fan entity {}".format(self.name)) 94 | 95 | @property 96 | def unique_id(self) -> str: 97 | return self._base_entity_id 98 | 99 | @property 100 | def name(self) -> str: 101 | return self._base_entity_name 102 | 103 | @property 104 | def is_on(self) -> Optional[bool]: 105 | if self._prana_state is not None: 106 | return self._prana_state.is_on 107 | else: 108 | return None 109 | 110 | @property 111 | def speed(self) -> Optional[str]: 112 | if self._prana_state is not None: 113 | return utils.speed_int_to_str(self._prana_state.speed_locked) 114 | else: 115 | return None 116 | 117 | async def async_set_preset_mode(self, preset_mode: str) -> None: 118 | if preset_mode == utils.PRANA_SPEEDS[0]: 119 | await self.async_turn_off() 120 | prana_speed = Speed.from_str(preset_mode if preset_mode is not None else utils.PRANA_DEFAULT_SPEED) 121 | await self.api_client.set_state(self.device_address, SetStateDTO(speed=prana_speed)) 122 | await self.coordinator.async_refresh() 123 | 124 | @property 125 | def current_direction(self) -> Optional[str]: 126 | state = self._prana_state 127 | if state is None or not state.is_on: 128 | return None 129 | if state.flows_locked: 130 | return const.DIRECTION_BOTH 131 | else: 132 | return const.DIRECTION_IN if state.is_input_fan_on else const.DIRECTION_OUT 133 | 134 | @property 135 | def state_attributes(self) -> dict: 136 | state = self._prana_state 137 | if state is None or not state.is_on: 138 | return {} 139 | attributes = super().state_attributes 140 | in_speed, out_speed = state.speed_locked, state.speed_locked if state.is_on else (0, 0) 141 | if not state.flows_locked: 142 | in_speed = state.speed_in if state.is_input_fan_on else 0 143 | out_speed = state.speed_out if state.is_output_fan_on else 0 144 | attributes.update( 145 | { 146 | # const.ATTR_LAST_UPDATED: state.timestamp.isoformat() 147 | const.ATTR_BRIGHTNESS: state.brightness, 148 | const.ATTR_FLOWS_LOCKED: state.flows_locked, 149 | const.ATTR_HEATING: state.mini_heating_enabled, 150 | const.ATTR_WINTER_MODE_ON: state.winter_mode_enabled, 151 | const.ATTR_IN_SPEED: in_speed, 152 | const.ATTR_OUT_SPEED: out_speed, 153 | } 154 | ) 155 | return attributes 156 | 157 | async def async_turn_on(self, speed: Optional[str] = "2", **kwargs): 158 | """Turn on the fan.""" 159 | await self.async_set_preset_mode(speed or utils.PRANA_DEFAULT_SPEED) 160 | return self.is_on 161 | 162 | async def async_turn_off(self, **kwargs: Any) -> None: 163 | """Turn onn the fan.""" 164 | await self.api_client.set_state(self.device_address, SetStateDTO(speed=Speed.OFF)) 165 | await self.coordinator.async_refresh() 166 | 167 | 168 | class PranaInputFan(PranaSupplementaryFan): 169 | @property 170 | def unique_id(self) -> Optional[str]: 171 | return self.main_entity.unique_id + "_input" 172 | 173 | @property 174 | def name(self) -> Optional[str]: 175 | return self.main_entity.name + " Input" 176 | 177 | @property 178 | def is_on(self) -> bool: 179 | return self.main_entity.state_attributes.get(const.ATTR_IN_SPEED, 0) != 0 180 | 181 | @property 182 | def speed(self) -> Optional[str]: 183 | return utils.speed_int_to_str(self.main_entity.state_attributes.get(const.ATTR_IN_SPEED, 0)) 184 | 185 | async def async_turn_on(self, speed: Optional[str] = "2", **kwargs) -> None: 186 | pass # Not supported yet 187 | 188 | async def async_turn_off(self, **kwargs: Any) -> None: 189 | pass # Not supported yet 190 | 191 | 192 | class PranaOutputFan(PranaSupplementaryFan): 193 | @property 194 | def unique_id(self) -> Optional[str]: 195 | return self.main_entity.unique_id + "_output" 196 | 197 | @property 198 | def name(self) -> Optional[str]: 199 | return self.main_entity.name + " Output" 200 | 201 | @property 202 | def is_on(self) -> bool: 203 | return self.main_entity.state_attributes.get(const.ATTR_OUT_SPEED, 0) != 0 204 | 205 | @property 206 | def speed(self) -> Optional[str]: 207 | return utils.speed_int_to_str(self.main_entity.state_attributes.get(const.ATTR_OUT_SPEED, 0)) 208 | 209 | async def async_turn_on(self, speed: Optional[str] = "2", **kwargs) -> None: 210 | pass # Not supported yet 211 | 212 | async def async_turn_off(self, **kwargs: Any) -> None: 213 | pass # Not supported yet 214 | -------------------------------------------------------------------------------- /custom_components/prana/config_flow.py: -------------------------------------------------------------------------------- 1 | import datetime 2 | import logging 3 | import urllib.parse 4 | from typing import Dict 5 | 6 | import voluptuous as vol 7 | from homeassistant import config_entries 8 | from homeassistant.core import callback 9 | from prana_rc.contrib.client.common import PranaRCAsyncClient 10 | 11 | from . import const, utils 12 | 13 | _LOGGER = logging.getLogger(__name__) 14 | 15 | 16 | class PranaFlowHandler(config_entries.ConfigFlow, domain=const.DOMAIN): # type: ignore[call-arg] # noqa 17 | VERSION = 1 18 | CONNECTION_CLASS = config_entries.CONN_CLASS_LOCAL_POLL 19 | 20 | async def async_step_user(self, user_input: dict = None): 21 | if user_input is not None: 22 | if user_input[const.CONF_CONNECTION_TYPE] == const.ConnectionType.REMOTE_HTTP_SERVER.value: 23 | return await self.async_step_remote_connection( 24 | connection_type=const.ConnectionType(user_input[const.CONF_CONNECTION_TYPE]) 25 | ) 26 | else: 27 | return self.async_show_form( 28 | step_id="user", 29 | data_schema=vol.Schema( 30 | { 31 | vol.Required( 32 | const.CONF_CONNECTION_TYPE, default=const.ConnectionType.REMOTE_HTTP_SERVER.value 33 | ): vol.In({k.value: v for k, v in const.CONNECTION_TYPE_MAP.items()}), 34 | } 35 | ), 36 | ) 37 | 38 | async def async_step_remote_connection(self, user_input: dict = None, connection_type: const.ConnectionType = None): 39 | errors: Dict[str, str] = {} 40 | if user_input is not None: 41 | prana_client = utils.api_client_from_config(user_input) 42 | try: 43 | await prana_client.init() 44 | await prana_client.healthcheck() 45 | config = dict(user_input) 46 | parsed_url = urllib.parse.urlparse(user_input[const.CONF_BASE_URL]) 47 | unique_id = utils.generate_unique_id(config) 48 | await self.async_set_unique_id(unique_id, raise_on_progress=False) 49 | self._abort_if_unique_id_configured() 50 | return self.async_create_entry(title="Prana Hub @ " + parsed_url.netloc, data=config) 51 | except Exception as e: 52 | utils.handle_prana_error(e, errors, _LOGGER) 53 | finally: 54 | await prana_client.close() 55 | 56 | if user_input is None: 57 | assert connection_type is not None, "connection_type must be passed as an argument from the prev. step" 58 | 59 | user_input = { 60 | const.CONF_BASE_URL: "http://localhost:8881", 61 | const.CONF_CONNECTION_TYPE: connection_type.value, 62 | } 63 | connection_type_name = const.CONNECTION_TYPE_MAP.get( 64 | const.ConnectionType(user_input.get(const.CONF_CONNECTION_TYPE)) 65 | ) 66 | return self.async_show_form( 67 | step_id="remote_connection", 68 | data_schema=vol.Schema( 69 | { 70 | vol.Required(const.CONF_BASE_URL, default=user_input.get(const.CONF_BASE_URL)): str, 71 | vol.Required( 72 | const.CONF_CONNECTION_TYPE, default=user_input.get(const.CONF_CONNECTION_TYPE) 73 | ): vol.In({user_input.get(const.CONF_CONNECTION_TYPE): connection_type_name}), 74 | } 75 | ), 76 | errors=errors, 77 | ) 78 | 79 | @staticmethod 80 | @callback 81 | def async_get_options_flow(config_entry: config_entries.ConfigEntry): 82 | return PranaOptionsFlowHandler(config_entry) 83 | 84 | 85 | class PranaOptionsFlowHandler(config_entries.OptionsFlow): 86 | def __init__(self, config_entry: config_entries.ConfigEntry): 87 | self.config_entry = config_entry 88 | self.current_options = config_entry.options or {const.OPT_DEVICES: {}} 89 | 90 | def preserve_options_section(self, value: dict): 91 | result = dict(self.current_options) 92 | addr = value[const.OPT_DEVICE_ADDRESS] = value[const.OPT_DEVICE_ADDRESS].strip() 93 | result[const.OPT_DEVICES][addr] = value 94 | result[const.OPT_LAST_UPDATE] = int(datetime.datetime.now().timestamp()) 95 | return self.async_create_entry( 96 | title="", 97 | data=result, 98 | ) 99 | 100 | async def async_step_init(self, user_input=None): 101 | errors = {} 102 | 103 | if user_input is not None: 104 | if user_input[const.INP_DEVICE] == const.INP_DEVICE_ADD_DEVICE: 105 | return await self.async_step_edit_device() 106 | elif user_input[const.INP_DEVICE] == const.INP_DEVICE_DISCOVER_DEVICE: 107 | return await self.async_step_discover() 108 | elif user_input[const.INP_DEVICE] in self.current_options[const.OPT_DEVICES].keys(): 109 | return await self.async_step_edit_device(addr=user_input[const.INP_DEVICE]) 110 | 111 | devices_options = { 112 | x.get(const.OPT_DEVICE_ADDRESS): "{} [{}]".format( 113 | x.get(const.OPT_DEVICE_NAME), x.get(const.OPT_DEVICE_ADDRESS) 114 | ) 115 | for x in self.current_options.get(const.OPT_DEVICES).values() 116 | } 117 | 118 | devices_options[const.INP_DEVICE_ADD_DEVICE] = "Add new device..." 119 | devices_options[const.INP_DEVICE_DISCOVER_DEVICE] = "Discover new device..." 120 | 121 | return self.async_show_form( 122 | step_id="init", 123 | data_schema=vol.Schema( 124 | {vol.Required(const.INP_DEVICE, default=const.INP_DEVICE_DISCOVER_DEVICE): vol.In(devices_options)} 125 | ), 126 | errors=errors, 127 | ) 128 | 129 | async def async_step_edit_device(self, user_input: Dict = None, addr: str = None): 130 | errors = {} 131 | current = {} 132 | if addr is not None: 133 | current = self.current_options[const.OPT_DEVICES].get(addr) 134 | 135 | if user_input is not None and addr is None: 136 | if current is None: 137 | current = self.current_options[const.OPT_DEVICES].get(user_input.get(const.OPT_DEVICE_ADDRESS)) 138 | 139 | # Todo: validate input? 140 | prana_client: PranaRCAsyncClient = utils.api_client_from_config(self.config_entry.data) 141 | async with prana_client as c: 142 | try: 143 | await c.get_state(user_input.get(const.OPT_DEVICE_ADDRESS)) 144 | except Exception: 145 | errors["base"] = "unable_to_connect" 146 | _LOGGER.exception( 147 | "Unable to conenct to ble device " + str(user_input.get(const.OPT_DEVICE_ADDRESS)) 148 | ) 149 | 150 | if len(errors.keys()) == 0: 151 | return self.preserve_options_section(user_input) 152 | else: 153 | # We came here from the discover dialog 154 | if user_input is not None: 155 | current = user_input # type: ignore 156 | 157 | schema_dict = { 158 | vol.Required( 159 | const.OPT_DEVICE_ADDRESS, 160 | default=current.get(const.OPT_DEVICE_ADDRESS, ""), 161 | ): str, 162 | vol.Required( 163 | const.OPT_DEVICE_NAME, 164 | default=current.get(const.OPT_DEVICE_NAME, ""), 165 | ): str, 166 | } 167 | 168 | return self.async_show_form( 169 | step_id="edit_device", data_schema=vol.Schema(schema_dict), description_placeholders={}, errors=errors 170 | ) 171 | 172 | async def async_step_discover(self, user_input: Dict = None): 173 | errors = {} 174 | devs_options = {} 175 | 176 | if user_input is not None: 177 | address, name = user_input[const.INP_DISCOVERED_DEVICES].split("/", 1) 178 | return await self.async_step_edit_device( 179 | {const.OPT_DEVICE_NAME: name, const.OPT_DEVICE_ADDRESS: address}, addr=address 180 | ) 181 | 182 | prana_client: PranaRCAsyncClient = utils.api_client_from_config(self.config_entry.data) 183 | async with prana_client as c: 184 | try: 185 | discovered_devs = (await c.discover(timeout=const.PRANA_DISCOVERY_TIMEOUT)) or [] 186 | devs_options = { 187 | "{}/{}".format(x["address"], x["name"]): "{} [{}]".format(x["name"], x["address"]) 188 | for x in discovered_devs 189 | } 190 | except Exception: 191 | errors["base"] = "discovery_error" 192 | _LOGGER.exception("Unable to complete BLE discovery") 193 | 194 | return self.async_show_form( 195 | step_id="discover", 196 | data_schema=vol.Schema( 197 | { 198 | vol.Required( 199 | const.INP_DISCOVERED_DEVICES, 200 | default=next(iter(devs_options)) if len(devs_options.keys()) > 0 else None, 201 | ): vol.In(devs_options) 202 | } 203 | ), 204 | errors=errors, 205 | ) 206 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------