├── .github ├── dependabot.yml ├── release-drafter.yml └── workflows │ ├── publish-to-pypi.yml │ └── release-drafter.yml ├── .gitignore ├── LICENSE ├── README.md ├── fullykiosk ├── __init__.py └── exceptions.py ├── requirements.txt └── setup.py /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | # To get started with Dependabot version updates, you'll need to specify which 2 | # package ecosystems to update and where the package manifests are located. 3 | # Please see the documentation for all configuration options: 4 | # https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates 5 | 6 | version: 2 7 | updates: 8 | - package-ecosystem: "pip" 9 | directory: "/" 10 | schedule: 11 | interval: "weekly" 12 | -------------------------------------------------------------------------------- /.github/release-drafter.yml: -------------------------------------------------------------------------------- 1 | change-template: "- #$NUMBER - $TITLE (@$AUTHOR)" 2 | categories: 3 | - title: "⚠ Breaking Changes" 4 | labels: 5 | - "breaking change" 6 | template: | 7 | ## What’s Changed 8 | 9 | $CHANGES 10 | -------------------------------------------------------------------------------- /.github/workflows/publish-to-pypi.yml: -------------------------------------------------------------------------------- 1 | name: Publish releases to PyPI 2 | 3 | on: 4 | release: 5 | types: [published, prereleased] 6 | 7 | jobs: 8 | build-and-publish: 9 | name: Builds and publishes releases to PyPI 10 | runs-on: ubuntu-latest 11 | steps: 12 | - uses: actions/checkout@master 13 | - name: Set up Python 3.7 14 | uses: actions/setup-python@v1 15 | with: 16 | python-version: 3.7 17 | - name: Install wheel 18 | run: >- 19 | pip install wheel 20 | - name: Build 21 | run: >- 22 | python3 setup.py sdist bdist_wheel 23 | - name: Publish release to PyPI 24 | uses: pypa/gh-action-pypi-publish@master 25 | with: 26 | user: __token__ 27 | password: ${{ secrets.PYPI_TOKEN }} 28 | -------------------------------------------------------------------------------- /.github/workflows/release-drafter.yml: -------------------------------------------------------------------------------- 1 | name: Release Drafter 2 | 3 | on: 4 | push: 5 | branches: 6 | - master 7 | 8 | jobs: 9 | update_release_draft: 10 | runs-on: ubuntu-latest 11 | steps: 12 | # Drafts your next Release notes as Pull Requests are merged into "master" 13 | - uses: release-drafter/release-drafter@v5 14 | env: 15 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 16 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Hide sublime text stuff 2 | *.sublime-project 3 | *.sublime-workspace 4 | 5 | # Hide some OS X stuff 6 | .DS_Store 7 | .AppleDouble 8 | .LSOverride 9 | Icon 10 | 11 | # Thumbnails 12 | ._* 13 | 14 | # IntelliJ IDEA 15 | .idea 16 | *.iml 17 | 18 | # pytest 19 | .pytest_cache 20 | .cache 21 | 22 | # GITHUB Proposed Python stuff: 23 | *.py[cod] 24 | 25 | # C extensions 26 | *.so 27 | 28 | # Packages 29 | *.egg 30 | *.egg-info 31 | dist 32 | build 33 | eggs 34 | .eggs 35 | parts 36 | bin 37 | var 38 | sdist 39 | develop-eggs 40 | .installed.cfg 41 | lib 42 | lib64 43 | pip-wheel-metadata 44 | 45 | # Logs 46 | *.log 47 | pip-log.txt 48 | 49 | # Unit test / coverage reports 50 | .coverage 51 | .tox 52 | coverage.xml 53 | nosetests.xml 54 | htmlcov/ 55 | test-reports/ 56 | test-results.xml 57 | test-output.xml 58 | 59 | # Translations 60 | *.mo 61 | 62 | # Mr Developer 63 | .mr.developer.cfg 64 | .project 65 | .pydevproject 66 | 67 | .python-version 68 | 69 | # emacs auto backups 70 | *~ 71 | *# 72 | *.orig 73 | 74 | # venv stuff 75 | pyvenv.cfg 76 | pip-selfcheck.json 77 | venv 78 | .venv 79 | Pipfile* 80 | share/* 81 | Scripts/ 82 | 83 | # vimmy stuff 84 | *.swp 85 | *.swo 86 | tags 87 | ctags.tmp 88 | 89 | # vagrant stuff 90 | virtualization/vagrant/setup_done 91 | virtualization/vagrant/.vagrant 92 | virtualization/vagrant/config 93 | 94 | # Visual Studio Code 95 | .vscode/* 96 | !.vscode/cSpell.json 97 | !.vscode/extensions.json 98 | !.vscode/tasks.json 99 | 100 | # Typing 101 | .mypy_cache 102 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # python-fullykiosk 2 | Python wrapper for Fully Kiosk Browser REST interface 3 | -------------------------------------------------------------------------------- /fullykiosk/__init__.py: -------------------------------------------------------------------------------- 1 | import aiohttp 2 | import json 3 | import logging 4 | 5 | from .exceptions import FullyKioskError 6 | 7 | _LOGGER = logging.getLogger(__name__) 8 | 9 | RESPONSE_STATUS = "status" 10 | RESPONSE_STATUSTEXT = "statustext" 11 | RESPONSE_ERRORSTATUS = "Error" 12 | 13 | 14 | class FullyKiosk: 15 | def __init__(self, session, host, port, password, use_ssl=False, verify_ssl=False): 16 | if not use_ssl: 17 | verify_ssl = False 18 | self._rh = _RequestsHandler(session, host, port, use_ssl=use_ssl, 19 | verify_ssl=verify_ssl) 20 | self._password = password 21 | self._deviceInfo = None 22 | self._settings = None 23 | 24 | async def sendCommand(self, cmd, **kwargs): 25 | data = await self._rh.get( 26 | cmd=cmd, password=self._password, type="json", **kwargs 27 | ) 28 | 29 | if ( 30 | isinstance(data, dict) 31 | and RESPONSE_STATUS in data 32 | and data[RESPONSE_STATUS] == RESPONSE_ERRORSTATUS 33 | ): 34 | raise FullyKioskError(RESPONSE_ERRORSTATUS, data[RESPONSE_STATUSTEXT]) 35 | return data 36 | 37 | # REST API Documentation: https://www.fully-kiosk.com/en/#rest 38 | 39 | async def getDeviceInfo(self): 40 | result = await self.sendCommand("deviceInfo") 41 | self._deviceInfo = result 42 | return self._deviceInfo 43 | 44 | async def getSettings(self): 45 | result = await self.sendCommand("listSettings") 46 | self._settings = result 47 | return self._settings 48 | 49 | @property 50 | def deviceInfo(self): 51 | return self._deviceInfo 52 | 53 | @property 54 | def settings(self): 55 | return self._settings 56 | 57 | # Configurations 58 | 59 | async def setConfigurationString(self, setting, stringValue): 60 | await self.sendCommand("setStringSetting", key=setting, value=stringValue) 61 | 62 | async def setConfigurationBool(self, setting, boolValue): 63 | await self.sendCommand("setBooleanSetting", key=setting, value=boolValue) 64 | 65 | # Screen, screensaver 66 | 67 | async def screenOn(self): 68 | await self.sendCommand("screenOn") 69 | 70 | async def screenOff(self): 71 | await self.sendCommand("screenOff") 72 | 73 | async def forceSleep(self): 74 | await self.sendCommand("forceSleep") 75 | 76 | async def startScreensaver(self): 77 | await self.sendCommand("startScreensaver") 78 | 79 | async def stopScreensaver(self): 80 | await self.sendCommand("stopScreensaver") 81 | 82 | # Daydream: max Android 12 83 | 84 | async def startDaydream(self): 85 | await self.sendCommand("startDaydream") 86 | 87 | async def stopDaydream(self): 88 | await self.sendCommand("stopDaydream") 89 | 90 | async def setScreenBrightness(self, brightness): 91 | await self.setConfigurationString("screenBrightness", brightness) 92 | 93 | # Audio 94 | 95 | async def setAudioVolume(self, volume, stream=None): 96 | await self.sendCommand("setAudioVolume", level=volume, stream=stream) 97 | 98 | async def playSound(self, url, stream=None): 99 | await self.sendCommand("playSound", url=url, stream=stream) 100 | 101 | async def stopSound(self): 102 | await self.sendCommand("stopSound") 103 | 104 | async def textToSpeech(self, text, locale=None, engine=None, queue=None): 105 | if queue is not None: 106 | queue = "1" if queue else "0" 107 | await self.sendCommand("textToSpeech", text=text, locale=locale, engine=engine, queue=queue) 108 | 109 | async def stopTextToSpeech(self): 110 | await self.sendCommand("stopTextToSpeech") 111 | 112 | # Lock, maintenance 113 | 114 | async def lockKiosk(self): 115 | await self.sendCommand("lockKiosk") 116 | 117 | async def unlockKiosk(self): 118 | await self.sendCommand("unlockKiosk") 119 | 120 | async def enableLockedMode(self): 121 | await self.sendCommand("enableLockedMode") 122 | 123 | async def disableLockedMode(self): 124 | await self.sendCommand("disableLockedMode") 125 | 126 | # Root only: 127 | 128 | async def rebootDevice(self): 129 | await self.sendCommand("rebootDevice") 130 | 131 | # App management 132 | 133 | async def restartApp(self): 134 | await self.sendCommand("restartApp") 135 | 136 | async def exitApp(self): 137 | await self.sendCommand("exitApp") 138 | 139 | async def killMyProcess(self): 140 | await self.sendCommand("killMyProcess") 141 | 142 | async def toForeground(self): 143 | await self.sendCommand("toForeground") 144 | 145 | async def toBackground(self): 146 | await self.sendCommand("toBackground") 147 | 148 | async def startApplication(self, application): 149 | await self.sendCommand("startApplication", package=application) 150 | 151 | # Web browsing 152 | 153 | async def loadStartUrl(self): 154 | await self.sendCommand("loadStartUrl") 155 | 156 | async def loadUrl(self, url): 157 | await self.sendCommand("loadUrl", url=url) 158 | 159 | async def clearCache(self): 160 | await self.sendCommand("clearCache") 161 | 162 | async def clearWebstorage(self): 163 | await self.sendCommand("clearWebstorage") 164 | 165 | async def clearCookies(self): 166 | await self.sendCommand("clearCookies") 167 | 168 | async def resetWebview(self): 169 | await self.sendCommand("resetWebview") 170 | 171 | # Motion detection 172 | 173 | async def triggerMotion(self): 174 | await self.sendCommand("triggerMotion") 175 | 176 | async def enableMotionDetection(self): 177 | await self.setConfigurationBool("motionDetection", True) 178 | 179 | async def disableMotionDetection(self): 180 | await self.setConfigurationBool("motionDetection", False) 181 | 182 | # Camera, screenshot: 183 | 184 | async def getCamshot(self): 185 | return await self.sendCommand("getCamshot") 186 | 187 | async def getScreenshot(self): 188 | return await self.sendCommand("getScreenshot") 189 | 190 | 191 | class _RequestsHandler: 192 | """Internal class to create FullyKiosk requests""" 193 | 194 | def __init__(self, session: aiohttp.ClientSession, host, port, use_ssl=False, 195 | verify_ssl=False): 196 | self.headers = {"Accept": "application/json"} 197 | 198 | self.session = session 199 | self.host = host 200 | self.port = port 201 | self.use_ssl = use_ssl 202 | self.verify_ssl = verify_ssl 203 | 204 | async def get(self, **kwargs): 205 | url = f"http{'s' if self.use_ssl else ''}://{self.host}:{self.port}" 206 | params = [] 207 | 208 | for key, value in kwargs.items(): 209 | if value is not None: 210 | params.append((key, str(value))) 211 | req_params = {"url": url, "headers": self.headers, "params": params} 212 | if not self.verify_ssl: 213 | req_params["ssl"] = False 214 | 215 | _LOGGER.debug("Sending request to: %s", url) 216 | _LOGGER.debug("Parameters: %s", params) 217 | async with self.session.get(**req_params) as response: 218 | if response.status != 200: 219 | _LOGGER.warning( 220 | "Invalid response from Fully Kiosk Browser API: %s", response.status 221 | ) 222 | raise FullyKioskError(response.status, await response.text()) 223 | 224 | content_type = response.headers['Content-Type'] 225 | if content_type.startswith("image/") or content_type == "application/octet-stream": 226 | return await response.content.read() 227 | data = await response.json(content_type=content_type) 228 | 229 | _LOGGER.debug(json.dumps(data)) 230 | return data 231 | -------------------------------------------------------------------------------- /fullykiosk/exceptions.py: -------------------------------------------------------------------------------- 1 | class FullyKioskError(Exception): 2 | """Raised when Fully Kiosk Browser API request ended in error. 3 | Attributes: 4 | status_code - error code returned by Fully Kiosk Browser 5 | status - more detailed description 6 | """ 7 | 8 | def __init__(self, status_code, status): 9 | self.status_code = status_code 10 | self.status = status 11 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | aiohttp>=3.6.3 2 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | """Setup module for python-fullykiosk.""" 2 | from pathlib import Path 3 | 4 | from setuptools import find_packages, setup 5 | 6 | PROJECT_DIR = Path(__file__).parent.resolve() 7 | README_FILE = PROJECT_DIR / "README.md" 8 | VERSION = "0.0.14" 9 | 10 | 11 | setup( 12 | name="python-fullykiosk", 13 | version=VERSION, 14 | url="https://github.com/cgarwood/python-fullykiosk", 15 | download_url="https://github.com/cgarwood/python-fullykiosk", 16 | author="Charles Garwood", 17 | author_email="cgarwood@gmail.com", 18 | description="Python wrapper for Fully Kiosk Browser REST API", 19 | long_description=README_FILE.read_text(encoding="utf-8"), 20 | long_description_content_type="text/markdown", 21 | packages=find_packages(exclude=["test.*", "test"]), 22 | python_requires=">=3.6", 23 | include_package_data=True, 24 | zip_safe=False, 25 | classifiers=[ 26 | "Development Status :: 4 - Beta", 27 | "Intended Audience :: Developers", 28 | "Natural Language :: English", 29 | "Programming Language :: Python :: 3", 30 | "Programming Language :: Python :: 3.6", 31 | "Programming Language :: Python :: 3.7", 32 | "Programming Language :: Python :: 3.8", 33 | "Topic :: Home Automation", 34 | "License :: OSI Approved :: Apache Software License", 35 | ], 36 | ) 37 | --------------------------------------------------------------------------------