[ { "path": ".github/ISSUE_TEMPLATE/bug_report.md", "content": "---\nname: Bug report\nabout: Create a report to help us improve\ntitle: ''\nlabels: bug\nassignees: ''\n\n---\n\n**Describe the bug**\nA clear and concise description of what the bug is.\n\n**To reproduce**\nSteps to reproduce the behavior:\n\n**Expected behavior**\nA clear and concise description of what you expected to happen.\n\n**Screenshots/debug logs**\nIf applicable, add screenshots or debug logs to help explain your problem.\n\n**Software/hardware configuration (please complete the following information):**\n - Stenogotchi version: \n - Plugin version:\n - OS: \n - Hardware:\n\n**Additional context**\nAdd any other context about the problem here.\n" }, { "path": ".github/ISSUE_TEMPLATE/feature_request.md", "content": "---\nname: Feature request\nabout: Suggest an idea for this project\ntitle: ''\nlabels: ''\nassignees: ''\n\n---\n\n**Is your feature request related to a problem? Please describe.**\nA clear and concise description of what the problem is. Ex. I'm always frustrated when [...]\n\n**Describe the solution you'd like**\nA clear and concise description of what you want to happen.\n\n**Describe alternatives you've considered**\nA clear and concise description of any alternative solutions or features you've considered.\n\n**Additional context**\nAdd any other context or screenshots about the feature request here.\n" }, { "path": ".gitignore", "content": "# Byte-compiled / optimized / DLL files\n__pycache__/\n*.py[cod]\n*$py.class\n\n# C extensions\n*.so\n\n# Distribution / packaging\n.Python\nbuild/\ndevelop-eggs/\ndist/\ndownloads/\neggs/\n.eggs/\nlib/\nlib64/\nparts/\nsdist/\nvar/\nwheels/\npip-wheel-metadata/\nshare/python-wheels/\n*.egg-info/\n.installed.cfg\n*.egg\nMANIFEST\n\n# PyInstaller\n# Usually these files are written by a python script from a template\n# before PyInstaller builds the exe, so as to inject date/other infos into it.\n*.manifest\n*.spec\n\n# Installer logs\npip-log.txt\npip-delete-this-directory.txt\n\n# Unit test / coverage reports\nhtmlcov/\n.tox/\n.nox/\n.coverage\n.coverage.*\n.cache\nnosetests.xml\ncoverage.xml\n*.cover\n*.py,cover\n.hypothesis/\n.pytest_cache/\n\n# Translations\n*.mo\n*.pot\n\n# Django stuff:\n*.log\nlocal_settings.py\ndb.sqlite3\ndb.sqlite3-journal\n\n# Flask stuff:\ninstance/\n.webassets-cache\n\n# Scrapy stuff:\n.scrapy\n\n# Sphinx documentation\ndocs/_build/\n\n# PyBuilder\ntarget/\n\n# Jupyter Notebook\n.ipynb_checkpoints\n\n# IPython\nprofile_default/\nipython_config.py\n\n# pyenv\n.python-version\n\n# pipenv\n# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.\n# However, in case of collaboration, if having platform-specific dependencies or dependencies\n# having no cross-platform support, pipenv may install dependencies that don't work, or not\n# install all needed dependencies.\n#Pipfile.lock\n\n# PEP 582; used by e.g. github.com/David-OConnor/pyflow\n__pypackages__/\n\n# Celery stuff\ncelerybeat-schedule\ncelerybeat.pid\n\n# SageMath parsed files\n*.sage.py\n\n# Environments\n.env\n.venv\nenv/\nvenv/\nENV/\nenv.bak/\nvenv.bak/\n\n# Spyder project settings\n.spyderproject\n.spyproject\n\n# Rope project settings\n.ropeproject\n\n# mkdocs documentation\n/site\n\n# mypy\n.mypy_cache/\n.dmypy.json\ndmypy.json\n\n# Pyre type checker\n.pyre/\n" }, { "path": "BUILDNOTES.md", "content": "# Build Notes\nConnect all the parts before soldering anything in place. They will not function without properly secured connections, but checking how they fit together can save you from time-consuming mistakes. You'll need a soldering iron, solder and preferably also cutting pliers, a metal file and some flux to complete the build. Below you find some tips on how to fit the parts together as neatly as possible.\n\n## Build Process\nThe depicted device did not have pre-soldered header pins, allowing me to shorten the pins on the underside rather than the top. Leaving the ends connecting to the display unaltered. Depending on your model you may therefore need to make some changes to the below steps.\n- Push the header pins through from the underside, leaving 4.5 mm of the pins exposed on the top (pre-soldered headers extend 9 mm above the board for comparison).\n- Layer the buttonSHIM on the top directly against the RPI0w.\n- Solder the headers on the top to the buttonSHIM using plenty of flux. Leaving as much of the pins clean as possible so they still fit into the display's socket.\n- Cut and remove the black plastic separator from the headers on the underside, leaving only bare pins on this side of the board as well.\n- Solder the pins to the underside of the board, ensuring a good electrical connection to the RPI0w.\n- Cut and file down the pins on the underside to make room for the UPS-Lite. Shortening them enough so they don't poke or scratch the battery.\n- Secure the UPS-Lite using the included hexagonal nuts. The screws are just barely long enough to accommodate the thickness of both the RPI0w and buttonSHIM.\n- Carefully press down the eINK module on the male pin headers without applying excessive force to the display itself.\n\n## GPIO Header\nWhether your RPI0w comes with pre-soldered male header or not, I recommend removing the black spacer. This way you can position the buttonSHIM directly against the board on the top with only the female header of the eINK display module and the buttonSHIM itself adding to the overall height of the device. \n\n## Waveshare Display:\n- In order to fit the screen onto the device as snugly as possible, make sure to desolder or by other means detach the large white connector. The yellow kapton tape didn't end up being needed since the covered components don't make contact with the RPI0w.\n\n![waveshare_stock](https://user-images.githubusercontent.com/17461433/144749374-befd978c-a6eb-4e9a-a1fc-603ed09b6914.jpg)\n![waveshare_modified](https://user-images.githubusercontent.com/17461433/112752795-6a5dab00-8fdd-11eb-8e15-bd59c9444a42.jpeg)\n\n## ButtonSHIM:\n- Take care to orient the module correctly.\n- Soldering it into place you want to aim for small but secure solder joints. Any extra solder on the pins will limit how close to the board you can fit the screen. An X-Acto knife or small file can help with potentially needed clean-up.\n\n![buttonshim_attached](https://user-images.githubusercontent.com/17461433/112752878-cc1e1500-8fdd-11eb-98e5-62af52a660a2.jpeg)\n\n## UPS-Lite:\n- Make sure the pins on the bottom don't extend too far before screwing the module onto the board. They should not be allowed to touch the battery pack. I ended up filing the pins down quite a bit to ensure sufficient clearance. Shape and length of the pins is important for the pogo pins to make good contact.\n- In the picture you can also spot a couple of the pins on the top and just how low the solder joints need to be for connecting the display.\n\n![upslite_attached](https://user-images.githubusercontent.com/17461433/112752928-1acbaf00-8fde-11eb-8281-5b35784cc348.JPG)\n\n## Real Time Clock\n- If you want to add a RTC module to keep the device synced while powered off, I recommend the [DS3231](https://www.pishop.us/product/ds3231-real-time-clock-module-for-raspberry-pi/). A good [setup guide](https://learn.adafruit.com/adding-a-real-time-clock-to-raspberry-pi/set-rtc-time) has been published by Adafruit.\n- Removing the female headers, the module fits neatly inside the UPS-Lite. You can see the correct wiring and positioning in the below picture. Don't forget to isolate it with some tape and form neat solder joints for the pins shared by the UPS-Lite.\n\n![ds3231_attached](https://user-images.githubusercontent.com/17461433/111912767-cff8e700-8a73-11eb-9bd0-a406bd7241ef.jpg)" }, { "path": "CHANGELOG.md", "content": "# Changelog\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),\nand this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n\n## [0.1.0] - 2022-01-02\n### Added\n- Modifier, function and navigation-key support, both individually and in combination (unsupported inputs logged in plover.log).\n- Reactions to new records in WPM-tracking mode.\n- Plover dictionary lookup with eINK display and STENO input support. The plugin (dict_lookup) utilizes native Plover lookup functionality for full compatibility with supported dictionary formats.\n- Buttonshim actions, both built-in and custom, accessible through web UI.\n- Hardware build guide.\n\n### Changed\n- Plover v4.0.0.dev10 or higher required.\n- Stenogotchi_link v0.3.0 required. Plugin now logs to plover.log.\n- Character and personality adjustments.\n- Simplified installation process.\n- Added documentation for aligning text output with target device expected input language and layout.\n- Web UI default port changed from 8080 to 80.\n- Bluetooth connection established only once Plover has started.\n\n### Fixed\n- Significantly reduced input latency in STENO mode.\n- Improved Bluetooth pairing and connection management.\n- Web UI now starts only once a wifi connection has been established.\n\n## [Unreleased]\n### Added\n### Changed\n### Fixed\n### Removed\n\n## [0.0.5] - 2021-03-24\n### Added\n- DS3231 real time clock module wiring and positioning reference picture to README.\n- Four new faces, producing processing animation when combined.\n- WPM stats now track and display top result for session.\n\n### Changed\n- Led plugin and default patterns to better indicate noteworthy events.\n\n### Fixed\n- QWERTY-mode breaking bug introduced in v0.0.4.\n- Letter capitalization, symbol characters and return key in STENO-mode.\n\n## [0.0.4] - 2021-03-21\n### Added\n- This CHANGELOG file.\n- User configurable bluetooth device name using main.plugins.plover_link.bt_device_name.\n- User configurable list of bluetooth mac addresses, in order of priority, to auto-connect to using main.plugins.plover_link.bt_autoconnect_mac.\n- User configurable option to clear eINK display at shutdown using ui.display.clear_at_shutdown.\n- User configurable wpm calculation method using main.plugins.plover_link.wpm_method.\n- User configurable wpm update frequency and calculation window in seconds using main.plugins.plover_link.wpm_timeout.\n- More variety in mood indicators on common events.\n- Requirements file.\n\n### Changed\n- Improved installation guide and documentation in README.\n- All functionality in buttonshim plugin reworked into class for better integration with the project.\n- More consistent logging messages.\n- Stenogotchi_link version upgrade to v0.0.4.\n\n### Fixed\n- Reboot after initial setup or hostname change not working.\n- Wifi status not showing as [OFF] if wifi is disabled at boot.\n- Mode not changing to STENO when Plover becomes operational.\n- All button press events not producing logging messages.\n- Dependencies for stenogotchi_link Plover plugin corrected in setup.cfg.\n\n## [0.0.3] - 2021-03-18\n### Added\n- First public pre-release version on GitHub.\n- Stenogotchi, portable stenography using Plover and bluetooth keyboard emulation on a Raspberry Pi Zero W. With support for Waveshare 2.13 v2, ButtonSHIM and UPS-Lite v1.2 modules.\n- Plover plugin stenogotchi_link for communicating between Plover and Stenogotchi.\n- README now includes tested installation guide no longer requiring building PyQt5 from source.\n- README now includes basic configuration and usage documentation.\n- LICENSE file.\n\n[Unreleased]: https://github.com/Anodynous/stenogotchi/compare/v0.1.0...dev\n[0.1.0]: https://github.com/Anodynous/stenogotchi/compare/v0.0.5...v0.1.0\n[0.0.5]: https://github.com/Anodynous/stenogotchi/compare/v0.0.4...v0.0.5\n[0.0.4]: https://github.com/Anodynous/stenogotchi/compare/v0.0.3...v0.0.4\n[0.0.3]: https://github.com/Anodynous/stenogotchi/releases/tag/v0.0.3" }, { "path": "LICENSE", "content": " GNU AFFERO GENERAL PUBLIC LICENSE\n Version 3, 19 November 2007\n\n Copyright (C) 2007 Free Software Foundation, Inc. \n Everyone is permitted to copy and distribute verbatim copies\n of this license document, but changing it is not allowed.\n\n Preamble\n\n The GNU Affero General Public License is a free, copyleft license for\nsoftware and other kinds of works, specifically designed to ensure\ncooperation with the community in the case of network server software.\n\n The licenses for most software and other practical works are designed\nto take away your freedom to share and change the works. By contrast,\nour General Public Licenses are intended to guarantee your freedom to\nshare and change all versions of a program--to make sure it remains free\nsoftware for all its users.\n\n When we speak of free software, we are referring to freedom, not\nprice. Our General Public Licenses are designed to make sure that you\nhave the freedom to distribute copies of free software (and charge for\nthem if you wish), that you receive source code or can get it if you\nwant it, that you can change the software or use pieces of it in new\nfree programs, and that you know you can do these things.\n\n Developers that use our General Public Licenses protect your rights\nwith two steps: (1) assert copyright on the software, and (2) offer\nyou this License which gives you legal permission to copy, distribute\nand/or modify the software.\n\n A secondary benefit of defending all users' freedom is that\nimprovements made in alternate versions of the program, if they\nreceive widespread use, become available for other developers to\nincorporate. Many developers of free software are heartened and\nencouraged by the resulting cooperation. However, in the case of\nsoftware used on network servers, this result may fail to come about.\nThe GNU General Public License permits making a modified version and\nletting the public access it on a server without ever releasing its\nsource code to the public.\n\n The GNU Affero General Public License is designed specifically to\nensure that, in such cases, the modified source code becomes available\nto the community. It requires the operator of a network server to\nprovide the source code of the modified version running there to the\nusers of that server. Therefore, public use of a modified version, on\na publicly accessible server, gives the public access to the source\ncode of the modified version.\n\n An older license, called the Affero General Public License and\npublished by Affero, was designed to accomplish similar goals. This is\na different license, not a version of the Affero GPL, but Affero has\nreleased a new version of the Affero GPL which permits relicensing under\nthis license.\n\n The precise terms and conditions for copying, distribution and\nmodification follow.\n\n TERMS AND CONDITIONS\n\n 0. Definitions.\n\n \"This License\" refers to version 3 of the GNU Affero General Public License.\n\n \"Copyright\" also means copyright-like laws that apply to other kinds of\nworks, such as semiconductor masks.\n\n \"The Program\" refers to any copyrightable work licensed under this\nLicense. Each licensee is addressed as \"you\". \"Licensees\" and\n\"recipients\" may be individuals or organizations.\n\n To \"modify\" a work means to copy from or adapt all or part of the work\nin a fashion requiring copyright permission, other than the making of an\nexact copy. The resulting work is called a \"modified version\" of the\nearlier work or a work \"based on\" the earlier work.\n\n A \"covered work\" means either the unmodified Program or a work based\non the Program.\n\n To \"propagate\" a work means to do anything with it that, without\npermission, would make you directly or secondarily liable for\ninfringement under applicable copyright law, except executing it on a\ncomputer or modifying a private copy. Propagation includes copying,\ndistribution (with or without modification), making available to the\npublic, and in some countries other activities as well.\n\n To \"convey\" a work means any kind of propagation that enables other\nparties to make or receive copies. Mere interaction with a user through\na computer network, with no transfer of a copy, is not conveying.\n\n An interactive user interface displays \"Appropriate Legal Notices\"\nto the extent that it includes a convenient and prominently visible\nfeature that (1) displays an appropriate copyright notice, and (2)\ntells the user that there is no warranty for the work (except to the\nextent that warranties are provided), that licensees may convey the\nwork under this License, and how to view a copy of this License. If\nthe interface presents a list of user commands or options, such as a\nmenu, a prominent item in the list meets this criterion.\n\n 1. Source Code.\n\n The \"source code\" for a work means the preferred form of the work\nfor making modifications to it. \"Object code\" means any non-source\nform of a work.\n\n A \"Standard Interface\" means an interface that either is an official\nstandard defined by a recognized standards body, or, in the case of\ninterfaces specified for a particular programming language, one that\nis widely used among developers working in that language.\n\n The \"System Libraries\" of an executable work include anything, other\nthan the work as a whole, that (a) is included in the normal form of\npackaging a Major Component, but which is not part of that Major\nComponent, and (b) serves only to enable use of the work with that\nMajor Component, or to implement a Standard Interface for which an\nimplementation is available to the public in source code form. A\n\"Major Component\", in this context, means a major essential component\n(kernel, window system, and so on) of the specific operating system\n(if any) on which the executable work runs, or a compiler used to\nproduce the work, or an object code interpreter used to run it.\n\n The \"Corresponding Source\" for a work in object code form means all\nthe source code needed to generate, install, and (for an executable\nwork) run the object code and to modify the work, including scripts to\ncontrol those activities. However, it does not include the work's\nSystem Libraries, or general-purpose tools or generally available free\nprograms which are used unmodified in performing those activities but\nwhich are not part of the work. For example, Corresponding Source\nincludes interface definition files associated with source files for\nthe work, and the source code for shared libraries and dynamically\nlinked subprograms that the work is specifically designed to require,\nsuch as by intimate data communication or control flow between those\nsubprograms and other parts of the work.\n\n The Corresponding Source need not include anything that users\ncan regenerate automatically from other parts of the Corresponding\nSource.\n\n The Corresponding Source for a work in source code form is that\nsame work.\n\n 2. Basic Permissions.\n\n All rights granted under this License are granted for the term of\ncopyright on the Program, and are irrevocable provided the stated\nconditions are met. This License explicitly affirms your unlimited\npermission to run the unmodified Program. The output from running a\ncovered work is covered by this License only if the output, given its\ncontent, constitutes a covered work. This License acknowledges your\nrights of fair use or other equivalent, as provided by copyright law.\n\n You may make, run and propagate covered works that you do not\nconvey, without conditions so long as your license otherwise remains\nin force. You may convey covered works to others for the sole purpose\nof having them make modifications exclusively for you, or provide you\nwith facilities for running those works, provided that you comply with\nthe terms of this License in conveying all material for which you do\nnot control copyright. Those thus making or running the covered works\nfor you must do so exclusively on your behalf, under your direction\nand control, on terms that prohibit them from making any copies of\nyour copyrighted material outside their relationship with you.\n\n Conveying under any other circumstances is permitted solely under\nthe conditions stated below. Sublicensing is not allowed; section 10\nmakes it unnecessary.\n\n 3. Protecting Users' Legal Rights From Anti-Circumvention Law.\n\n No covered work shall be deemed part of an effective technological\nmeasure under any applicable law fulfilling obligations under article\n11 of the WIPO copyright treaty adopted on 20 December 1996, or\nsimilar laws prohibiting or restricting circumvention of such\nmeasures.\n\n When you convey a covered work, you waive any legal power to forbid\ncircumvention of technological measures to the extent such circumvention\nis effected by exercising rights under this License with respect to\nthe covered work, and you disclaim any intention to limit operation or\nmodification of the work as a means of enforcing, against the work's\nusers, your or third parties' legal rights to forbid circumvention of\ntechnological measures.\n\n 4. Conveying Verbatim Copies.\n\n You may convey verbatim copies of the Program's source code as you\nreceive it, in any medium, provided that you conspicuously and\nappropriately publish on each copy an appropriate copyright notice;\nkeep intact all notices stating that this License and any\nnon-permissive terms added in accord with section 7 apply to the code;\nkeep intact all notices of the absence of any warranty; and give all\nrecipients a copy of this License along with the Program.\n\n You may charge any price or no price for each copy that you convey,\nand you may offer support or warranty protection for a fee.\n\n 5. Conveying Modified Source Versions.\n\n You may convey a work based on the Program, or the modifications to\nproduce it from the Program, in the form of source code under the\nterms of section 4, provided that you also meet all of these conditions:\n\n a) The work must carry prominent notices stating that you modified\n it, and giving a relevant date.\n\n b) The work must carry prominent notices stating that it is\n released under this License and any conditions added under section\n 7. This requirement modifies the requirement in section 4 to\n \"keep intact all notices\".\n\n c) You must license the entire work, as a whole, under this\n License to anyone who comes into possession of a copy. This\n License will therefore apply, along with any applicable section 7\n additional terms, to the whole of the work, and all its parts,\n regardless of how they are packaged. This License gives no\n permission to license the work in any other way, but it does not\n invalidate such permission if you have separately received it.\n\n d) If the work has interactive user interfaces, each must display\n Appropriate Legal Notices; however, if the Program has interactive\n interfaces that do not display Appropriate Legal Notices, your\n work need not make them do so.\n\n A compilation of a covered work with other separate and independent\nworks, which are not by their nature extensions of the covered work,\nand which are not combined with it such as to form a larger program,\nin or on a volume of a storage or distribution medium, is called an\n\"aggregate\" if the compilation and its resulting copyright are not\nused to limit the access or legal rights of the compilation's users\nbeyond what the individual works permit. Inclusion of a covered work\nin an aggregate does not cause this License to apply to the other\nparts of the aggregate.\n\n 6. Conveying Non-Source Forms.\n\n You may convey a covered work in object code form under the terms\nof sections 4 and 5, provided that you also convey the\nmachine-readable Corresponding Source under the terms of this License,\nin one of these ways:\n\n a) Convey the object code in, or embodied in, a physical product\n (including a physical distribution medium), accompanied by the\n Corresponding Source fixed on a durable physical medium\n customarily used for software interchange.\n\n b) Convey the object code in, or embodied in, a physical product\n (including a physical distribution medium), accompanied by a\n written offer, valid for at least three years and valid for as\n long as you offer spare parts or customer support for that product\n model, to give anyone who possesses the object code either (1) a\n copy of the Corresponding Source for all the software in the\n product that is covered by this License, on a durable physical\n medium customarily used for software interchange, for a price no\n more than your reasonable cost of physically performing this\n conveying of source, or (2) access to copy the\n Corresponding Source from a network server at no charge.\n\n c) Convey individual copies of the object code with a copy of the\n written offer to provide the Corresponding Source. This\n alternative is allowed only occasionally and noncommercially, and\n only if you received the object code with such an offer, in accord\n with subsection 6b.\n\n d) Convey the object code by offering access from a designated\n place (gratis or for a charge), and offer equivalent access to the\n Corresponding Source in the same way through the same place at no\n further charge. You need not require recipients to copy the\n Corresponding Source along with the object code. If the place to\n copy the object code is a network server, the Corresponding Source\n may be on a different server (operated by you or a third party)\n that supports equivalent copying facilities, provided you maintain\n clear directions next to the object code saying where to find the\n Corresponding Source. Regardless of what server hosts the\n Corresponding Source, you remain obligated to ensure that it is\n available for as long as needed to satisfy these requirements.\n\n e) Convey the object code using peer-to-peer transmission, provided\n you inform other peers where the object code and Corresponding\n Source of the work are being offered to the general public at no\n charge under subsection 6d.\n\n A separable portion of the object code, whose source code is excluded\nfrom the Corresponding Source as a System Library, need not be\nincluded in conveying the object code work.\n\n A \"User Product\" is either (1) a \"consumer product\", which means any\ntangible personal property which is normally used for personal, family,\nor household purposes, or (2) anything designed or sold for incorporation\ninto a dwelling. In determining whether a product is a consumer product,\ndoubtful cases shall be resolved in favor of coverage. For a particular\nproduct received by a particular user, \"normally used\" refers to a\ntypical or common use of that class of product, regardless of the status\nof the particular user or of the way in which the particular user\nactually uses, or expects or is expected to use, the product. A product\nis a consumer product regardless of whether the product has substantial\ncommercial, industrial or non-consumer uses, unless such uses represent\nthe only significant mode of use of the product.\n\n \"Installation Information\" for a User Product means any methods,\nprocedures, authorization keys, or other information required to install\nand execute modified versions of a covered work in that User Product from\na modified version of its Corresponding Source. The information must\nsuffice to ensure that the continued functioning of the modified object\ncode is in no case prevented or interfered with solely because\nmodification has been made.\n\n If you convey an object code work under this section in, or with, or\nspecifically for use in, a User Product, and the conveying occurs as\npart of a transaction in which the right of possession and use of the\nUser Product is transferred to the recipient in perpetuity or for a\nfixed term (regardless of how the transaction is characterized), the\nCorresponding Source conveyed under this section must be accompanied\nby the Installation Information. But this requirement does not apply\nif neither you nor any third party retains the ability to install\nmodified object code on the User Product (for example, the work has\nbeen installed in ROM).\n\n The requirement to provide Installation Information does not include a\nrequirement to continue to provide support service, warranty, or updates\nfor a work that has been modified or installed by the recipient, or for\nthe User Product in which it has been modified or installed. Access to a\nnetwork may be denied when the modification itself materially and\nadversely affects the operation of the network or violates the rules and\nprotocols for communication across the network.\n\n Corresponding Source conveyed, and Installation Information provided,\nin accord with this section must be in a format that is publicly\ndocumented (and with an implementation available to the public in\nsource code form), and must require no special password or key for\nunpacking, reading or copying.\n\n 7. Additional Terms.\n\n \"Additional permissions\" are terms that supplement the terms of this\nLicense by making exceptions from one or more of its conditions.\nAdditional permissions that are applicable to the entire Program shall\nbe treated as though they were included in this License, to the extent\nthat they are valid under applicable law. If additional permissions\napply only to part of the Program, that part may be used separately\nunder those permissions, but the entire Program remains governed by\nthis License without regard to the additional permissions.\n\n When you convey a copy of a covered work, you may at your option\nremove any additional permissions from that copy, or from any part of\nit. (Additional permissions may be written to require their own\nremoval in certain cases when you modify the work.) You may place\nadditional permissions on material, added by you to a covered work,\nfor which you have or can give appropriate copyright permission.\n\n Notwithstanding any other provision of this License, for material you\nadd to a covered work, you may (if authorized by the copyright holders of\nthat material) supplement the terms of this License with terms:\n\n a) Disclaiming warranty or limiting liability differently from the\n terms of sections 15 and 16 of this License; or\n\n b) Requiring preservation of specified reasonable legal notices or\n author attributions in that material or in the Appropriate Legal\n Notices displayed by works containing it; or\n\n c) Prohibiting misrepresentation of the origin of that material, or\n requiring that modified versions of such material be marked in\n reasonable ways as different from the original version; or\n\n d) Limiting the use for publicity purposes of names of licensors or\n authors of the material; or\n\n e) Declining to grant rights under trademark law for use of some\n trade names, trademarks, or service marks; or\n\n f) Requiring indemnification of licensors and authors of that\n material by anyone who conveys the material (or modified versions of\n it) with contractual assumptions of liability to the recipient, for\n any liability that these contractual assumptions directly impose on\n those licensors and authors.\n\n All other non-permissive additional terms are considered \"further\nrestrictions\" within the meaning of section 10. If the Program as you\nreceived it, or any part of it, contains a notice stating that it is\ngoverned by this License along with a term that is a further\nrestriction, you may remove that term. If a license document contains\na further restriction but permits relicensing or conveying under this\nLicense, you may add to a covered work material governed by the terms\nof that license document, provided that the further restriction does\nnot survive such relicensing or conveying.\n\n If you add terms to a covered work in accord with this section, you\nmust place, in the relevant source files, a statement of the\nadditional terms that apply to those files, or a notice indicating\nwhere to find the applicable terms.\n\n Additional terms, permissive or non-permissive, may be stated in the\nform of a separately written license, or stated as exceptions;\nthe above requirements apply either way.\n\n 8. Termination.\n\n You may not propagate or modify a covered work except as expressly\nprovided under this License. Any attempt otherwise to propagate or\nmodify it is void, and will automatically terminate your rights under\nthis License (including any patent licenses granted under the third\nparagraph of section 11).\n\n However, if you cease all violation of this License, then your\nlicense from a particular copyright holder is reinstated (a)\nprovisionally, unless and until the copyright holder explicitly and\nfinally terminates your license, and (b) permanently, if the copyright\nholder fails to notify you of the violation by some reasonable means\nprior to 60 days after the cessation.\n\n Moreover, your license from a particular copyright holder is\nreinstated permanently if the copyright holder notifies you of the\nviolation by some reasonable means, this is the first time you have\nreceived notice of violation of this License (for any work) from that\ncopyright holder, and you cure the violation prior to 30 days after\nyour receipt of the notice.\n\n Termination of your rights under this section does not terminate the\nlicenses of parties who have received copies or rights from you under\nthis License. If your rights have been terminated and not permanently\nreinstated, you do not qualify to receive new licenses for the same\nmaterial under section 10.\n\n 9. Acceptance Not Required for Having Copies.\n\n You are not required to accept this License in order to receive or\nrun a copy of the Program. Ancillary propagation of a covered work\noccurring solely as a consequence of using peer-to-peer transmission\nto receive a copy likewise does not require acceptance. However,\nnothing other than this License grants you permission to propagate or\nmodify any covered work. These actions infringe copyright if you do\nnot accept this License. Therefore, by modifying or propagating a\ncovered work, you indicate your acceptance of this License to do so.\n\n 10. Automatic Licensing of Downstream Recipients.\n\n Each time you convey a covered work, the recipient automatically\nreceives a license from the original licensors, to run, modify and\npropagate that work, subject to this License. You are not responsible\nfor enforcing compliance by third parties with this License.\n\n An \"entity transaction\" is a transaction transferring control of an\norganization, or substantially all assets of one, or subdividing an\norganization, or merging organizations. If propagation of a covered\nwork results from an entity transaction, each party to that\ntransaction who receives a copy of the work also receives whatever\nlicenses to the work the party's predecessor in interest had or could\ngive under the previous paragraph, plus a right to possession of the\nCorresponding Source of the work from the predecessor in interest, if\nthe predecessor has it or can get it with reasonable efforts.\n\n You may not impose any further restrictions on the exercise of the\nrights granted or affirmed under this License. For example, you may\nnot impose a license fee, royalty, or other charge for exercise of\nrights granted under this License, and you may not initiate litigation\n(including a cross-claim or counterclaim in a lawsuit) alleging that\nany patent claim is infringed by making, using, selling, offering for\nsale, or importing the Program or any portion of it.\n\n 11. Patents.\n\n A \"contributor\" is a copyright holder who authorizes use under this\nLicense of the Program or a work on which the Program is based. The\nwork thus licensed is called the contributor's \"contributor version\".\n\n A contributor's \"essential patent claims\" are all patent claims\nowned or controlled by the contributor, whether already acquired or\nhereafter acquired, that would be infringed by some manner, permitted\nby this License, of making, using, or selling its contributor version,\nbut do not include claims that would be infringed only as a\nconsequence of further modification of the contributor version. For\npurposes of this definition, \"control\" includes the right to grant\npatent sublicenses in a manner consistent with the requirements of\nthis License.\n\n Each contributor grants you a non-exclusive, worldwide, royalty-free\npatent license under the contributor's essential patent claims, to\nmake, use, sell, offer for sale, import and otherwise run, modify and\npropagate the contents of its contributor version.\n\n In the following three paragraphs, a \"patent license\" is any express\nagreement or commitment, however denominated, not to enforce a patent\n(such as an express permission to practice a patent or covenant not to\nsue for patent infringement). To \"grant\" such a patent license to a\nparty means to make such an agreement or commitment not to enforce a\npatent against the party.\n\n If you convey a covered work, knowingly relying on a patent license,\nand the Corresponding Source of the work is not available for anyone\nto copy, free of charge and under the terms of this License, through a\npublicly available network server or other readily accessible means,\nthen you must either (1) cause the Corresponding Source to be so\navailable, or (2) arrange to deprive yourself of the benefit of the\npatent license for this particular work, or (3) arrange, in a manner\nconsistent with the requirements of this License, to extend the patent\nlicense to downstream recipients. \"Knowingly relying\" means you have\nactual knowledge that, but for the patent license, your conveying the\ncovered work in a country, or your recipient's use of the covered work\nin a country, would infringe one or more identifiable patents in that\ncountry that you have reason to believe are valid.\n\n If, pursuant to or in connection with a single transaction or\narrangement, you convey, or propagate by procuring conveyance of, a\ncovered work, and grant a patent license to some of the parties\nreceiving the covered work authorizing them to use, propagate, modify\nor convey a specific copy of the covered work, then the patent license\nyou grant is automatically extended to all recipients of the covered\nwork and works based on it.\n\n A patent license is \"discriminatory\" if it does not include within\nthe scope of its coverage, prohibits the exercise of, or is\nconditioned on the non-exercise of one or more of the rights that are\nspecifically granted under this License. You may not convey a covered\nwork if you are a party to an arrangement with a third party that is\nin the business of distributing software, under which you make payment\nto the third party based on the extent of your activity of conveying\nthe work, and under which the third party grants, to any of the\nparties who would receive the covered work from you, a discriminatory\npatent license (a) in connection with copies of the covered work\nconveyed by you (or copies made from those copies), or (b) primarily\nfor and in connection with specific products or compilations that\ncontain the covered work, unless you entered into that arrangement,\nor that patent license was granted, prior to 28 March 2007.\n\n Nothing in this License shall be construed as excluding or limiting\nany implied license or other defenses to infringement that may\notherwise be available to you under applicable patent law.\n\n 12. No Surrender of Others' Freedom.\n\n If conditions are imposed on you (whether by court order, agreement or\notherwise) that contradict the conditions of this License, they do not\nexcuse you from the conditions of this License. If you cannot convey a\ncovered work so as to satisfy simultaneously your obligations under this\nLicense and any other pertinent obligations, then as a consequence you may\nnot convey it at all. For example, if you agree to terms that obligate you\nto collect a royalty for further conveying from those to whom you convey\nthe Program, the only way you could satisfy both those terms and this\nLicense would be to refrain entirely from conveying the Program.\n\n 13. Remote Network Interaction; Use with the GNU General Public License.\n\n Notwithstanding any other provision of this License, if you modify the\nProgram, your modified version must prominently offer all users\ninteracting with it remotely through a computer network (if your version\nsupports such interaction) an opportunity to receive the Corresponding\nSource of your version by providing access to the Corresponding Source\nfrom a network server at no charge, through some standard or customary\nmeans of facilitating copying of software. This Corresponding Source\nshall include the Corresponding Source for any work covered by version 3\nof the GNU General Public License that is incorporated pursuant to the\nfollowing paragraph.\n\n Notwithstanding any other provision of this License, you have\npermission to link or combine any covered work with a work licensed\nunder version 3 of the GNU General Public License into a single\ncombined work, and to convey the resulting work. The terms of this\nLicense will continue to apply to the part which is the covered work,\nbut the work with which it is combined will remain governed by version\n3 of the GNU General Public License.\n\n 14. Revised Versions of this License.\n\n The Free Software Foundation may publish revised and/or new versions of\nthe GNU Affero General Public License from time to time. Such new versions\nwill be similar in spirit to the present version, but may differ in detail to\naddress new problems or concerns.\n\n Each version is given a distinguishing version number. If the\nProgram specifies that a certain numbered version of the GNU Affero General\nPublic License \"or any later version\" applies to it, you have the\noption of following the terms and conditions either of that numbered\nversion or of any later version published by the Free Software\nFoundation. If the Program does not specify a version number of the\nGNU Affero General Public License, you may choose any version ever published\nby the Free Software Foundation.\n\n If the Program specifies that a proxy can decide which future\nversions of the GNU Affero General Public License can be used, that proxy's\npublic statement of acceptance of a version permanently authorizes you\nto choose that version for the Program.\n\n Later license versions may give you additional or different\npermissions. However, no additional obligations are imposed on any\nauthor or copyright holder as a result of your choosing to follow a\nlater version.\n\n 15. Disclaimer of Warranty.\n\n THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY\nAPPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT\nHOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM \"AS IS\" WITHOUT WARRANTY\nOF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,\nTHE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR\nPURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM\nIS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF\nALL NECESSARY SERVICING, REPAIR OR CORRECTION.\n\n 16. Limitation of Liability.\n\n IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING\nWILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS\nTHE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY\nGENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE\nUSE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF\nDATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD\nPARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),\nEVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF\nSUCH DAMAGES.\n\n 17. Interpretation of Sections 15 and 16.\n\n If the disclaimer of warranty and limitation of liability provided\nabove cannot be given local legal effect according to their terms,\nreviewing courts shall apply local law that most closely approximates\nan absolute waiver of all civil liability in connection with the\nProgram, unless a warranty or assumption of liability accompanies a\ncopy of the Program in return for a fee.\n\n END OF TERMS AND CONDITIONS\n\n How to Apply These Terms to Your New Programs\n\n If you develop a new program, and you want it to be of the greatest\npossible use to the public, the best way to achieve this is to make it\nfree software which everyone can redistribute and change under these terms.\n\n To do so, attach the following notices to the program. It is safest\nto attach them to the start of each source file to most effectively\nstate the exclusion of warranty; and each file should have at least\nthe \"copyright\" line and a pointer to where the full notice is found.\n\n \n Copyright (C) \n\n This program is free software: you can redistribute it and/or modify\n it under the terms of the GNU Affero General Public License as published\n by the Free Software Foundation, either version 3 of the License, or\n (at your option) any later version.\n\n This program is distributed in the hope that it will be useful,\n but WITHOUT ANY WARRANTY; without even the implied warranty of\n MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n GNU Affero General Public License for more details.\n\n You should have received a copy of the GNU Affero General Public License\n along with this program. If not, see .\n\nAlso add information on how to contact you by electronic and paper mail.\n\n If your software can interact with users remotely through a computer\nnetwork, you should also make sure that it provides a way for users to\nget its source. For example, if your program is a web application, its\ninterface could display a \"Source\" link that leads users to an archive\nof the code. There are many ways you could offer source, and different\nsolutions will be better for different programs; see section 13 for the\nspecific requirements.\n\n You should also get your employer (if you work as a programmer) or school,\nif any, to sign a \"copyright disclaimer\" for the program, if necessary.\nFor more information on this, and how to apply and follow the GNU AGPL, see\n.\n" }, { "path": "README.md", "content": "# Stenogotchi\n![stenogotchi_1](https://user-images.githubusercontent.com/17461433/107876588-8e52aa80-6ecf-11eb-81ba-14731c885ff1.jpeg)\n\nAim of the project is to deliver a cheap and portable device for running [Plover](https://www.openstenoproject.org/ \"Plover: Open Steno Project\") where local installation on the host is impossible or simply not preferred. A stand-alone link enabling stenography using any input device supported by Plover on any device accepting bluetooth keyboards. \n\nLikely use-cases include: \n- Mobile devices\n- Corporate and public computers restricting software installations \n- Hassle-free switching between devices without the need to install and configure Plover\n- On-the-go stenographic recording\n\nStenogotchi is built on top of [Pwnagotchi](https://github.com/evilsocket/pwnagotchi), but instead of hungering for WPA handshakes it feeds on your steno chords. It emulates a BT HID device for connecting to a host and output can be toggled between STENO and QWERTY mode on the fly. The friendly UI optimized for low-power eINK displays is also accessible as a web UI version, making both the eINK display and buttonSHIM modules optional. If the RPI0w always will be powered over microUSB a separate battery pack is not needed. The suggested UPS-Lite 1000 mAH battery provides 3+ hours of runtime and supports pass-through charging. \n\n## Hardware\n| Module | Status |\n|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------|\n| [Raspberry Pi Zero W](https://www.raspberrypi.org/products/raspberry-pi-zero-w/) or [Raspberry Pi Zero 2 W](https://www.raspberrypi.com/products/raspberry-pi-zero-2-w/) | Required |\n| MicroSD card (min 4 GiB) | Required |\n| [Waveshare 2.13 v.2](https://www.waveshare.com/wiki/2.13inch_e-Paper_HAT) | Recommended |\n| [ButtonSHIM](https://shop.pimoroni.com/products/button-shim) | Recommended |\n| [UPS-Lite v1.2](https://hackaday.io/project/173847-ups-lite) | Recommended |\n| [DS3231 RTC Module](https://www.pishop.us/product/ds3231-real-time-clock-module-for-raspberry-pi/) | Optional |\n\nSee the [build notes](BUILDNOTES.md) for guidance on fitting the parts together.\n## Installation\nAll commands should be executed as root. The installation process can be completed headless.\n\n1. Flash and configure DietPi image, see https://dietpi.com/docs/install/\n * For headless installation, set AUTO_SETUP_NET_WIFI_ENABLED=1 in dietpi.txt and enter wifi credentials in dietpi-wifi.txt before first boot.\n * When prompted allow dietpi to update, change passwords and disable serial console. Under dietpi-config > advanced options enable:\n * Bluetooth\n * SPI state (needed by eINK screen)\n * I2C state (needed by Buttonshim module and for UPS-Lite power readings)\n * Using command 'dietpi-autostart' enable automatic login of user 'root' to local terminal (option #7)\n\n2. Install dependencies\n\n apt-get install git xorg xserver-xorg-video-fbdev python3-pip python3-rpi.gpio python3-gi libtiff5 libopenjp2-7 bluez screen rfkill -y\n pip3 install file_read_backwards flask flask-wtf flask-cors evdev python-xlib pillow spidev jsonpickle dbus-python toml\n\n3. Download and install Plover (v4.0.0.dev10)\n\n wget https://github.com/openstenoproject/plover/releases/download/v4.0.0.dev10/plover-4.0.0.dev10-py3-none-any.whl\n pip3 install plover-4.0.0.dev10-py3-none-any.whl\n\n * If you'd rather try the [continuous build of Plover](https://github.com/openstenoproject/plover/releases/tag/continuous) for the latest improvements, you will need to install both build-essential and python3-dev through apt-get first. Switch back to dev10 if you experience issues.\n4. Clone the Stenogotchi repository and install the plover plugin \"stenogotchi_link\"\n\n git clone https://github.com/Anodynous/stenogotchi.git\n pip3 install ./stenogotchi/plover_plugin/\n\n5. Configure Plover. Setup will ultimately depend on your own preferences and keyboard, but below is what I use. Make sure to include at least 'auto_start = True' and the '[Plugins]' section in your own config.\n\n mkdir -p /root/.config/plover/\n nano /root/.config/plover/plover.cfg\n \n #----------\n [Output Configuration]\n space_placement = After Output\n start_attached = True\n start_capitalize = False\n undo_levels = 30\n\n [Logging Configuration]\n enable_stroke_logging = False\n enable_translation_logging = False\n\n [Machine Configuration]\n auto_start = True\n machine_type = Gemini PR\n\n [Gemini PR]\n baudrate = 9600\n bytesize = 8\n parity = N\n port = /dev/ttyACM0\n stopbits = 1\n timeout = 2.0\n\n [Plugins]\n enabled_extensions = [\"stenogotchi_link\"]\n\n6. Run installation script to finalize setup of Stenogotchi. Optional boot time improvements offered by script described in \"Significantly reduce boot time\" section below.\n \n chmod +x ./stenogotchi/initial_setup.sh\n ./stenogotchi/initial_setup.sh\n\n7. Configure Stenogotchi settings after reboot completes\n\n nano /etc/stenogotchi/config.toml\n \n #----------modify the config as you see fit----------#\n main.plugins.buttonshim.enabled = true\n main.plugins.upslite.enabled = true\n main.plugins.evdevkb.enabled = true\n main.plugins.plover_link.bt_autoconnect_mac = '00:DE:AD:BE:EF:00,11:DE:AD:BE:EF:11'\n #----------\n\n## Updating\n cd ~/stenogotchi\n git pull\n pip3 install ~/stenogotchi/plover_plugin/\n\n## Configuration / Troubleshooting\n* Configuration files are placed in /etc/stenogotchi/. Create a separate file named config.toml containing overrides to the defaults. Don't edit default.toml directly as it will be overwritten on Stenogotchi version updates.\n* The logfile is created in /var/log, which dietpi by default mounts to RAM to preserve the SD card lifespan. To make the file persistent across reboots it needs to be written to the disk. To aid with troubleshooting, either set the location to another existing folder using 'main.log.path' in config.toml or change the global dietpi setting using dietpi-software > Log System.\n* If your target device expects a different input language or keyboard layout than US qwerty, use setxkbmap to align it. This should be added to the beginning of your .xinitrc file to run automatically at startup. For German language and dvorak layout for example the below would be used.\n\n setxkbmap -layout de -variant dvorak\n\n### Bluetooth connections\n* Define your bluetooth devices in main.plugins.plover_link.bt_autoconnect_mac to auto-connect on boot. Multiple comma-separated devices in order of priority can be given. If no connection attempts are successful at boot, the device will fall back to listening for incoming connection and pairing attempts.\n* Only one active connection at a time is supported. To switch remote devices, disable bluetooth on the remote device and wait around 10 seconds before initiating a new connection. The Stenogotchi will attempt to reconnect to the lost device for a few seconds before falling back to listening for new incoming connections.\n* Issues with pairing or connecting after changes in bluetooth configurations can normally be fixed through unpairing and re-pairing. On the Stenogotchi side this is best handled through bluetoothctl using the below process. Re-initiate pairing process from remote device after the pairing information has been cleared on both host and client side.\n \n bluetoothctl\n [bluetooth]# paired-devices\n Device 00:DE:AD:BE:EF:00 Anodynous' Ipad\n [bluetooth]# remove 00:DE:AD:BE:EF:00\n [bluetooth]# exit\n\n### Significantly reduce boot time\n* Set ARM initial turbo to the max (60s) under dietpi-config > performance options to reduce boot time. You can also play around with overclocking, throttling and cpu governor to find a suitable balance between performance and power draw. \n* Disable dietpi and apt update check at boot:\n \n nano /boot/dietpi.txt\n\n #----------\t\n CONFIG_CHECK_DIETPI_UPDATES=0\n CONFIG_CHECK_APT_UPDATES=0\n \n* Disable waiting for network and time sync at boot. Doing this you should be aware that the RPI0w does not have a hardware clock. It will lose track of real world time as soon it is powered off, making log timestamps or any time based action you may set up unreliable. None of this is important for the core functionality of the Stenogotchi and disabling time-sync at boot can shave up to a minute off the boot process. By adding a cheap I2C hardware clock you can completely remove the need for network sync. Many modules are small enough to fit in the empty space of the UPS-Lite or under the eINK screen. See the [build notes](BUILDNOTES.md) for more directions.\n \n nano /boot/dietpi.txt\n \n #----------\n CONFIG_BOOT_WAIT_FOR_NETWORK=0\n CONFIG_NTP_MODE=0 \n\n## Usage\n![stenogotchi_2](https://user-images.githubusercontent.com/17461433/107883149-d5539680-6ef5-11eb-86fe-41f0b6293eed.jpg)\n\n### Buttonshim\nBelow long-press (1s) actions are pre-defined. Short-press triggers user configurable terminal commands, e.g. rclone sync of Plover dictionaries with cloud storage.\n \n* Button A - toggle QWERTY / STENO mode\n* Button B - toggle wpm & strokes readings\n* Button C - toggle dictionary lookup mode\n* Button D - toggle wifi (reboot persistent)\n* Button E - shutdown\n\n## Project roadmap\n- [x] Proof of concept. Headless RPI0W running Plover, emulating bluetooth HID device and seamlessly piping steno output over BT to host\n- [x] Create proper plugin for integration with Plover\n- [x] Integrate bluetooth HID server as Stenogotchi plugin\n- [x] Support for eINK display and web UI\n- [x] Support for buttons for built-in and user customizable actions\n- [x] Support for external battery charge readings on UI\n- [x] Create Stenogotchi plugin to capture QWERTY input while blocking Plover\n- [x] ButtonSHIM toggle to enable/disable WIFI, persisting reboot\n- [x] ButtonSHIM toggle between STENO and QWERTY output mode\n- [x] WPM readings for STENO mode\n- [x] Full installation guide for Plover and Stenogotchi using DietPi as base image\n- [x] Dictionary lookup using eINK screen\n- [x] Decrease steno latency\n- [x] Improved web UI, including buttonSHIM functionality\n- [ ] Plover chords for triggering Stenogotchi actions\n- [ ] Dictionary additions using eINK screen\n- [ ] Document configuration options and buttonSHIM functionality\n- [ ] Clean up and optimize code, fix bugs and add test suite\n- [ ] Expand Stenogotchi statuses, reactions and mood indicators\n- [ ] On-the-fly updating and reloading of Plover dictionaries\n- [ ] Simple AI for shaping personality of the Stenogotchi\n- [ ] Proper usage and configuration documentation\n- [ ] Support for other eINK display modules\n\n## Pictures\n![stenogotchi_3](https://user-images.githubusercontent.com/17461433/107877063-cb6c6c00-6ed2-11eb-9f92-9059acd9f66d.jpeg)\n![stenogotchi_4](https://user-images.githubusercontent.com/17461433/107876793-e3db8700-6ed0-11eb-83bb-648b08d1a315.jpeg)\n![stenogotchi_5](https://user-images.githubusercontent.com/17461433/107876790-e0480000-6ed0-11eb-820d-65188cd0a031.jpeg)\n\n## License\nReleased under the GPL3 license.\n" }, { "path": "initial_setup.sh", "content": "#!/bin/bash\n# Finalize setup of Stenogotchi. Only needs to be run once.\n# Use the below steps if you prefer not executing the automated script or run into issues.\n# ------------------------------------------------------------------------------------------\n# 1) Add configuration file for D-Bus service used by Stenogotchi and the Plover plugin to communicate \n#cp ./stenogotchi/plover_plugin/stenogotchi_link/com.github.stenogotchi.conf /etc/dbus-1/system.d/\n# 2) Modify service file to remove input bluetooth plugin so it does not grab the sockets Stenogotchi requires access to. \n# Append '-P input' to existing line in '/lib/systemd/system/bluetooth.service' file to end up with:\n#ExecStart=/usr/libexec/bluetooth/bluetoothd -P input\n# 3) Ensure 'root' user autologin to local terminal is enabled using dietpi-autostart\n# 4) Create file '~/.bash_profile' with the below content (excluding #-characters)\n#if [[ -z $DISPLAY ]] && [[ $(tty) = /dev/tty1 ]]; then\n# screen -S stenogotchi -dm python3 /root/stenogotchi/stenogotchi.py --debug\n# xinit\n#fi\n# 5) Create file '~/.xinitrc' with the below content\n#screen -S plover plover -g none -l debug\n# 6) Launch Stenogotchi manually once which will complete setup and reboot device. \n# Configure settings per preference in '/etc/stenogotchi/config.toml' after reboot.\n# 7) Optional but highly recommended. Reduce boot time by disabling Dietpi and APT update check and setting initial turbo boost to 60s.\n# In /boot/dietpi.txt set below values:\n#CONFIG_CHECK_DIETPI_UPDATES=0\n#CONFIG_CHECK_APT_UPDATES=0\n# In /boot/config.txt set:\n#initial_turbo=60\n# 8) Optional but recommended. Reduce boot time further by disabling waiting for network and NTP time sync.\n# Doing this you should be aware that the RPI0w does not have a hardware clock. It will lose track of real world time as soon it is powered off, making log timestamps or any time based action you may set up unreliable. None of this is important for the core functionality of the Stenogotchi and disabling time-sync at boot can shave up to a minute off the boot process. By adding a cheap I2C hardware clock you can completely remove the need for network sync.\n# In /boot/dietpi.txt set below values:\n#CONFIG_BOOT_WAIT_FOR_NETWORK=0\n#CONFIG_NTP_MODE=0\n# 9) Launch stenogotchi manually and configure using /etc/stenogotchi/config.toml after reboot has completed\n#python3 ./stenogotchi/stenogotchi.py\n\nFLAG=\"/var/log/_stenogotchi_setup_completed.log\"\nBASEDIR=$(cd `dirname $0` && pwd)\n\n# Check and run script only if it hasn't been done already\nif [ ! -f $FLAG ]; then\n # Set flag indicating script has been run\n touch $FLAG\n\n # Configure bluetooth service\n printf \"Adding configuration file for D-Bus service used by Stenogotchi and the Plover plugin to communicate.\\n\"\n sleep 1\n cp $BASEDIR/plover_plugin/stenogotchi_link/com.github.stenogotchi.conf /etc/dbus-1/system.d/ && printf \"Success!\\n\" || printf \"Failed! \\nPlease manually copy 'com.github.stenogotchi.conf' from stenogotchi_link folder to '/etc/dbus-1/system.d/'\"\n\n printf \"\\nModifying service file to remove input bluetooth plugin so it does not grab the sockets Stenogotchi requires access to.\\n\"\n sleep 1\n # Only add in case not appended yet\n if ! grep -q \"\\-P input\" /lib/systemd/system/bluetooth.service; then\n sed '/^ExecStart=/s/$/ -P input/' /lib/systemd/system/bluetooth.service -i.bkp && printf \"Success!\\n\" || printf \"Failed! \\nPlease manually modify existing line in '/lib/systemd/system/bluetooth.service' to 'ExecStart=/usr/lib/bluetooth/bluetoothd -P input' \"\n else\n printf \"Skipped! Bluetooth input plugin already disabled\\n\"\n fi\n\n # Configure autostart of plover\n printf \"\\nConfigure Stenogotchi to auto-start at boot. Will run under screen session named 'stenogotchi'\\n\"\n sleep 1\n echo \"screen -S plover plover -g none -l debug\" > ~/.xinitrc && printf \"Success!\\n\" || printf \"Failed! \\nPlease manually create file '~/.xinitrc' with contents 'screen -S plover plover -g none -l debug'\"\n\n # Configure autostart of stenogotchi\n read -r -d '' AUTOSTART << \"EOM\"\nif [[ -z $DISPLAY ]] && [[ $(tty) = /dev/tty1 ]]; then\n screen -S stenogotchi -dm python3 /root/stenogotchi/stenogotchi.py --debug\n xinit\nfi \nEOM\n\n printf \"\\nConfigure Plover to auto-start at boot. Will run under screen session named 'plover'\\n\"\n sleep 1\n echo \"$AUTOSTART\" > ~/.bash_profile && printf \"Success!\\n\" || printf \"Failed! \\nPlease manually create '~/.bash_profile' file with contents \\n\"$AUTOSTART\" \"\n\n # Optionally: Optimize boot time\n printf \"\\nReduce boot time by disabling automatic Dietpi and APT update checks. Set initial turbo boost to 60s.\"\n printf \"\\nSettings can be changed later in '/boot/dietpi.txt' and '/boot/config.txt'\\n\"\n while true; do\n read -p \"Do you wish to enable these highly recommended optimizations? (y/n)\" yn\n case $yn in\n [Yy]* )\n sed -i 's/CONFIG_CHECK_DIETPI_UPDATES=.*/CONFIG_CHECK_DIETPI_UPDATES=0/' /boot/dietpi.txt && printf \"set CONFIG_CHECK_DIETPI_UPDATES=0 in /boot/dietpi.txt\\n\";\n sed -i 's/CONFIG_CHECK_APT_UPDATES=.*/CONFIG_CHECK_APT_UPDATES=0/' /boot/dietpi.txt && printf \"set CONFIG_CHECK_APT_UPDATES=0 in /boot/dietpi.txt\\n\";\n sed -i 's/initial_turbo=.*/initial_turbo=60/' /boot/config.txt && printf \"set initial_turbo=60 in /boot/config.txt\\n\";\n break;;\n [Nn]* ) \n printf \"Boot optimization skipped. Enable later by setting CONFIG_CHECK_DIETPI_UPDATES=0 and CONFIG_CHECK_APT_UPDATES=0 in /boot/dietpi.txt and initial_turbo=60 in /boot/config.txt\\n\";\n break;;\n * ) echo \"Please answer yes or no.\";;\n esac\n done\n\n # Optionally: Disable waiting for network and NTP-sync \n printf \"\\nDisable waiting for network and NTP-sync at boot to significantly reduce boot time when networks are unavailable.\"\n printf \"\\nSettings can be changed later in '/boot/dietpi.txt'\\n\"\n while true; do\n read -p \"Do you wish to enable these optimizations? (y/n)\" yn\n case $yn in\n [Yy]* )\n sed -i 's/CONFIG_BOOT_WAIT_FOR_NETWORK=.*/CONFIG_BOOT_WAIT_FOR_NETWORK=0/' /boot/dietpi.txt && printf \"set CONFIG_BOOT_WAIT_FOR_NETWORK=0 in /boot/dietpi.txt\\n\";\n sed -i 's/CONFIG_NTP_MODE=.*/CONFIG_NTP_MODE=0/' /boot/dietpi.txt && printf \"set CONFIG_NTP_MODE=0 in /boot/dietpi.txt\\n\";\n break;;\n [Nn]* ) \n printf \"Boot optimization skipped. Enable later by setting CONFIG_BOOT_WAIT_FOR_NETWORK=0 and CONFIG_NTP_MODE=0 in /boot/dietpi.txt\\n\";\n break;;\n * ) echo \"Please answer yes or no.\";;\n esac\n done\n \n # Initial launch of Stenogotchi which triggers reboot\n printf \"\\nFirst time launch of Stenogotchi. Configure settings in /etc/stenogotchi/config.toml after reboot\\n\"\n sleep 5\n python3 $BASEDIR/stenogotchi.py\nelse\n printf \"Setup script has already been executed and should not need to be run again. (Delete '/var/log/_stenogotchi_setup_completed.log' to bypass check)\\n\"\nfi" }, { "path": "plover_plugin/setup.cfg", "content": "[metadata]\nname = stenogotchi_link\nversion = 0.3.0\ndescription = A plugin for exposing Plover events and communicating with Stenogotchi over D-Bus\nlong_description = \nauthor = Anodynous\nauthor_email = \nlicense = GNU General Public License v3 or later (GPLv3+)\nurl = https://github.com/Anodynous/Stenogotchi\nclassifiers =\n Development Status :: 4 - Beta\n Environment :: Plugins\n Intended Audience :: End Users/Desktop\n License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)\n Operating System :: Linux\n Programming Language :: Python :: 3\n Programming Language :: Python :: 3.7\nkeywords = plover plover_plugin stenogotchi\n\n[options]\nzip_safe = True\ninstall_requires =\n plover>=4.0.0.dev10\n jsonpickle\n dbus-python\n textstat\n PyGObject\npackages =\n stenogotchi_link\n\n[options.entry_points]\nplover.extension =\n stenogotchi_link = stenogotchi_link.stenogotchi_link:EngineServer" }, { "path": "plover_plugin/setup.py", "content": "from setuptools import setup\n\n\nsetup()" }, { "path": "plover_plugin/stenogotchi_link/__init__.py", "content": "" }, { "path": "plover_plugin/stenogotchi_link/clients.py", "content": "#!/usr/bin/env python3\n\nimport plover.log\nimport dbus, dbus.exceptions\nfrom dbus.mainloop.glib import DBusGMainLoop\n\nfrom time import sleep\nfrom threading import Thread\nfrom gi.repository import GLib\n\nfrom Xlib import X, XK\nfrom plover.oslayer.xkeyboardcontrol import KeyboardEmulation, uchr_to_keysym\nfrom plover import key_combo as plover_key_combo\nfrom stenogotchi_link.keymap import plover_convert, plover_modkey\n\nSERVER_DBUS = 'com.github.stenogotchi'\nSERVER_SRVC = '/com/github/stenogotchi'\nERROR_NO_SERVER: str = 'A server is not currently running'\nERROR_SERVER_RUNNING: str = 'A server is already running'\nTIME_SLEEP = 0\n\n\nclass StenogotchiClient:\n \"\"\" \n Transmits Plover event updates to, and listens for signals from, Stenogotchi over D-Bus.\n \"\"\"\n def __init__(self, engineserver):\n self._engineserver = engineserver\n self._setup_dbus_loop()\n self._setup_object()\n \n def _setup_dbus_loop(self):\n DBusGMainLoop(set_as_default=True)\n self._mainloop = GLib.MainLoop()\n self._thread = Thread(target=self._mainloop.run)\n self._thread.start()\n\n def _setup_object(self):\n try:\n self.bus = dbus.SystemBus()\n self.stenogotchiobject = self.bus.get_object(SERVER_DBUS, SERVER_SRVC)\n self.stenogotchi_service = dbus.Interface(self.stenogotchiobject, SERVER_DBUS)\n \n # Add signal receiver for incoming messages\n self.stenogotchi_signal = self.bus.add_signal_receiver(path=SERVER_SRVC,\n handler_function=self.stenogotchi_signal_handler,\n dbus_interface=SERVER_DBUS,\n signal_name='signal_to_plover')\n except dbus.exceptions.DBusException as e:\n plover.log.error(f'[stenogotchi_link] Failed to initialize D-Bus object: {str(e)}')\n \n def _exit(self):\n self._mainloop.quit()\n\n def plover_is_running(self, b):\n self.stenogotchi_service.plover_is_running(b)\n # If plover is shutting down, quit mainloop\n if not b:\n self._exit()\n\n def plover_is_ready(self, b):\n self.stenogotchi_service.plover_is_ready(b)\n\n def plover_machine_state(self, s):\n self.stenogotchi_service.plover_machine_state(s)\n\n def plover_output_enabled(self, b):\n self.stenogotchi_service.plover_output_enabled(b)\n\n def plover_wpm_stats(self, s):\n self.stenogotchi_service.plover_wpm_stats(s)\n\n def plover_strokes_stats(self, s):\n self.stenogotchi_service.plover_strokes_stats(s)\n\n def send_backspaces(self, y):\n self.stenogotchi_service.send_backspaces_stenogotchi(y)\n\n def send_string(self, s):\n self.stenogotchi_service.send_string_stenogotchi(s)\n\n def send_key_combination(self, s):\n self.stenogotchi_service.send_key_combination_stenogotchi(s)\n\n def send_lookup_results(self, l):\n self.stenogotchi_service.plover_translation_handler(l)\n\n def stenogotchi_signal_handler(self, dict):\n # Enable and disable wpm/strokes meters\n if 'lookup_word' in dict:\n self._engineserver.lookup_word(dict['lookup_word'])\n if 'lookup_stroke' in dict:\n self._engineserver.lookup_stroke(dict['lookup_stroke'])\n if 'output_to_stenogotchi' in dict:\n self._engineserver._output_to_stenogotchi = dict['output_to_stenogotchi']\n if 'start_wpm_meter' in dict:\n wpm_method = dict['wpm_method']\n wpm_timeout = int(dict['wpm_timeout'])\n plover.log.info('[stenogotchi_link] Starting WPM meter')\n if dict['start_wpm_meter'] == 'wpm and strokes':\n self._engineserver.start_wpm_meter(enable_wpm=True, enable_strokes=True, wpm_method=wpm_method, wpm_timeout=wpm_timeout)\n elif dict['start_wpm_meter'] == 'wpm':\n self._engineserver.start_wpm_meter(enable_wpm=True, enable_strokes=False, wpm_method=wpm_method, wpm_timeout=wpm_timeout)\n elif dict['start_wpm_meter'] == 'strokes':\n self._engineserver.start_wpm_meter(enable_wpm=False, enable_strokes=True, wpm_method=wpm_method, wpm_timeout=wpm_timeout)\n if 'stop_wpm_meter' in dict:\n plover.log.info('[stenogotchi_link] Stopping WPM meter')\n if dict['stop_wpm_meter'] == 'wpm and strokes':\n self._engineserver.stop_wpm_meter(disable_wpm=True, disable_strokes=True)\n elif dict['stop_wpm_meter'] == 'wpm':\n self._engineserver.stop_wpm_meter(disable_wpm=True, disable_strokes=False)\n elif dict['stop_wpm_meter'] == 'strokes':\n self._engineserver.stop_wpm_meter(disable_wpm=False, disable_strokes=True)\n\nclass CustomKeyboardEmulation(KeyboardEmulation):\n \"\"\" \n We use the Plover implementation, but change _update_keymap()\n to prefer lower keycode rather than low modkeys combos in mapping.\n This way we avoid some issues when mapping to BT HID keycodes.\n \"\"\"\n def _update_keymap(self):\n '''Analyse keymap, build a mapping of keysym to (keycode + modifiers),\n and find unused keycodes that can be used for unmapped keysyms.\n '''\n self._keymap = {}\n self._custom_mappings_queue = []\n # Analyse X11 keymap.\n keycode = self._display.display.info.min_keycode\n keycode_count = self._display.display.info.max_keycode - keycode + 1\n for mapping in self._display.get_keyboard_mapping(keycode, keycode_count):\n mapping = tuple(mapping)\n while mapping and X.NoSymbol == mapping[-1]:\n mapping = mapping[:-1]\n if not mapping:\n # Free never used before keycode.\n custom_mapping = [self.UNUSED_KEYSYM] * self.CUSTOM_MAPPING_LENGTH\n custom_mapping[-1] = self.PLOVER_MAPPING_KEYSYM\n mapping = custom_mapping\n elif self.CUSTOM_MAPPING_LENGTH == len(mapping) and \\\n self.PLOVER_MAPPING_KEYSYM == mapping[-1]:\n # Keycode was previously used by Plover.\n custom_mapping = list(mapping)\n else:\n # Used keycode.\n custom_mapping = None\n for keysym_index, keysym in enumerate(mapping):\n if keysym == self.PLOVER_MAPPING_KEYSYM:\n continue\n if keysym_index not in (0, 1, 4, 5):\n continue\n modifiers = 0\n if 1 == (keysym_index % 2):\n # The keycode needs the Shift modifier.\n modifiers |= X.ShiftMask\n if 4 <= keysym_index <= 5:\n # 3rd (AltGr) level.\n modifiers |= X.Mod5Mask\n mapping = self.Mapping(keycode, modifiers, keysym, custom_mapping)\n if keysym != X.NoSymbol and keysym != self.UNUSED_KEYSYM:\n # Some keysym are mapped multiple times, prefer lower keycode (Plover prefers lower modifiers combos).\n previous_mapping = self._keymap.get(keysym)\n if previous_mapping is None or mapping.keycode < previous_mapping.keycode:\n self._keymap[keysym] = mapping\n if custom_mapping is not None:\n self._custom_mappings_queue.append(mapping)\n keycode += 1\n # Determine the backspace mapping.\n backspace_keysym = XK.string_to_keysym('BackSpace')\n self._backspace_mapping = self._get_mapping(backspace_keysym)\n assert self._backspace_mapping is not None\n assert self._backspace_mapping.custom_mapping is None\n # Get modifier mapping.\n self.modifier_mapping = self._display.get_modifier_mapping()\n\nclass BTClient:\n \"\"\"\n Transmits keystroke output from Plover to Stenogotchi as HID messages over D-Bus.\n \"\"\"\n def __init__(self):\n self.target_length = 6\n self.mod_keys = 0b00000000\n self.pressed_keys = []\n self.bus = dbus.SystemBus()\n self.btkobject = self.bus.get_object(SERVER_DBUS, SERVER_SRVC)\n self.btk_service = dbus.Interface(self.btkobject, SERVER_DBUS)\n self.ke = CustomKeyboardEmulation()\n self._backspace_mapping_hid = plover_convert(self.ke._backspace_mapping.keycode)\n\n\n def update_mod_keys(self, mod_key, value):\n \"\"\"\n Which modifier keys are active is stored in an 8 bit number. \n Each bit represents a different key. This method takes which bit\n and its new value as input\n :param mod_key: The value of the bit to be updated with new value\n :param value: Binary 1 or 0 depending if pressed or released\n \"\"\"\n bit_mask = 1 << (7-mod_key)\n if value: # set bit\n self.mod_keys |= bit_mask\n else: # clear bit\n self.mod_keys &= ~bit_mask\n\n def update_keys(self, norm_key, value):\n \"\"\"\n Sets the active normal keys\n \"\"\"\n if norm_key < 0: # Log for debug purposes in case keycode isn't valid\n plover.log.error(f\"[stenogotchi_link] KeyError in update_keys, unable to send keycode: {norm_key}\")\n return\n if value < 1:\n self.pressed_keys.remove(norm_key)\n elif norm_key not in self.pressed_keys:\n self.pressed_keys.insert(0, norm_key)\n len_delta = self.target_length - len(self.pressed_keys)\n if len_delta < 0:\n self.pressed_keys = self.pressed_keys[:len_delta]\n elif len_delta > 0:\n self.pressed_keys.extend([0] * len_delta)\n \n @property\n def state(self):\n \"\"\"\n property with the HID message to be sent\n :return: bytes of HID message\n \"\"\"\n return [0xA1, 0x01, self.mod_keys, 0, *self.pressed_keys]\n\n def clear_mod_keys(self):\n self.mod_keys = 0b00000000\n\n def clear_keys(self):\n self.pressed_keys = []\n\n def send_keys(self, state_list=None):\n if not state_list:\n self.btk_service.send_keys([state_list])\n else:\n flat_list = state_list\n self.btk_service.send_keys(flat_list)\n\n def send_backspaces(self, number_of_backspaces):\n self.clear_keys()\n self.clear_mod_keys()\n state_list = []\n for x in range(number_of_backspaces):\n self.update_keys(self._backspace_mapping_hid, 1)\n state_list.append(self.state)\n self.update_keys(self._backspace_mapping_hid, 0)\n state_list.append(self.state)\n self.send_keys(state_list)\n \n\n def map_hid_events(self, keycode, modifiers=None):\n \"\"\" Returns a list of HID bytearrays to produce the key combination.\n \n Arguments:\n keycode -- An integer in the inclusive range [8-255].\n modifiers -- An 8-bit bit mask indicating if the key\n pressed is modified by other keys, such as Shift, Capslock,\n Control, and Alt.\n TODO: International, accented characters and a range of symbols are not working with the US keyboard layout. \n Could be solved using Alt codes on Windows, but Mac/iOS uses different Option codes. Complicated to solve \n in a clean way as we only emulate a BT keyboard and all characters must be produced on the remote host.\n -> Look into separate WIN/MAC translation tables. Profiles which can be linked to BT MAC adresses.\n \"\"\"\n self.clear_keys()\n self.clear_mod_keys()\n state_sublist = []\n #modifiers_list = [\n # self.ke.modifier_mapping[n][0]\n # for n in range(8)\n # if (modifiers & (1 << n))\n #]\n #for mod_keycode in modifiers_list:\n # self.update_mod_keys(plover_modkey(mod_keycode), 1)\n \n normkey_hid = plover_convert(keycode)\n # Log issues with mapping any keycodes\n if normkey_hid < 0:\n plover.log.error(f\"[stenogotchi_link] Unable to map keycode: {keycode} using plover_convert in keymap.py.\")\n return\n if modifiers:\n modkey_hid = plover_modkey(modifiers)\n if modkey_hid < 0:\n plover.log.error(f\"[stenogotchi_link] Unable to map keycode: {keycode} using plover_modkey in keymap.py.\")\n\n # Apply modifiers\n if modifiers:\n # TODO: Handle combination of modifiers. 129 for example is shift (1) + AltGr (128)\n self.update_mod_keys(modkey_hid, 1)\n # Press and release the base key.\n self.update_keys(normkey_hid, 1)\n state_sublist.append(self.state)\n sleep(TIME_SLEEP)\n self.update_keys(normkey_hid, 0)\n state_sublist.append(self.state)\n # Release modifiers\n if modifiers > 0:\n self.update_mod_keys(modkey_hid, 0)\n state_sublist.append(self.state)\n \n return state_sublist\n #for mod_keycode in reversed(modifiers_list):\n # self.update_mod_keys(plover_modkey(mod_keycode), 0)\n \n \n def send_string(self, s):\n state_list = []\n for char in s:\n keysym = uchr_to_keysym(char)\n mapping = self.ke._get_mapping(keysym)\n #plover.log.debug(f\"[stenogotchi_link] mapping : '{mapping}' mapping.keycode : '{mapping.keycode}' and mapping.modifier : '{mapping.modifiers}' (for keysym : '{keysym}' given char : '{char}')\")\n if mapping is None:\n continue\n sublist = self.map_hid_events(mapping.keycode, mapping.modifiers)\n if sublist:\n state_list.extend(sublist)\n if len(state_list) > 0:\n self.send_keys(state_list)\n \n def send_key_combination(self, combo_string: str):\n \"\"\"\n Custom implementation of Plover send_key_combination function\n since we do not work with emulated key events or need to fight\n with a KeyboardCapture instance. \n \n Arguments:\n\n combo_string -- A string representing a sequence of key\n combinations. Keys are represented by their names in the\n Xlib.XK module, without the 'XK_' prefix. For example, the\n left Alt key is represented by 'Alt_L'. Keys are either\n separated by a space or a left or right parenthesis.\n Parentheses must be properly formed in pairs and may be\n nested. A key immediately followed by a parenthetical\n indicates that the key is pressed down while all keys enclosed\n in the parenthetical are pressed and released in turn. For\n example, Alt_L(Tab) means to hold the left Alt key down, press\n and release the Tab key, and then release the left Alt key.\n \"\"\"\n self.clear_keys()\n self.clear_mod_keys()\n state_list = []\n\n # Parse and validate combo.\n key_events = [\n (keycode, 1 if pressed else 0) for keycode, pressed\n in plover_key_combo.parse_key_combo(combo_string, self.ke._get_keycode_from_keystring)\n ]\n \n # Send key events to emulate combination.\n for keycode, event_type in key_events:\n # Convert to HID\n normkey_hid = plover_convert(keycode)\n if normkey_hid == -1:\n modkey_hid = plover_modkey(keycode)\n else:\n modkey_hid = -1\n\n # Update and send keycode if mapped, otherwise log\n if modkey_hid > -1:\n self.update_mod_keys(modkey_hid, event_type)\n state_list.append(self.state)\n elif normkey_hid > -1:\n self.update_keys(normkey_hid, event_type)\n state_list.append(self.state)\n else:\n plover.log.debug(f\"[stenogotchi_link]Received key_combination from Plover: {combo_string}, resulting in key_events: {key_events}\")\n plover.log.error(f\"Unable to map keycode: {keycode}, in keymap.py (event_type: {event_type})\")\n self.send_keys(state_list)\n" }, { "path": "plover_plugin/stenogotchi_link/com.github.stenogotchi.conf", "content": "\n\n \n \n \n \n\n" }, { "path": "plover_plugin/stenogotchi_link/keymap.py", "content": "# Find HID keycode mapping here: https://www.usb.org/sites/default/files/documents/hut1_12v2.pdf\n# Linux keycodes can be found in /usr/share/X11/xkb/keycodes/evdev\n\n# Linux keycode used by Plover : HID keycode used for BT\nplover_keytable = {\n # Function row.\n 67: 58, #\"F1\",\n 68: 59, #\"F2\",\n 69: 60, #\"F3\",\n 70: 61, #\"F4\",\n 71: 62, #\"F5\",\n 72: 63, #\"F6\",\n 73: 64, #\"F7\",\n 74: 65, #\"F8\",\n 75: 66, #\"F9\",\n 76: 67, #\"F10\",\n 95: 68, #\"F11\",\n 96: 69, #\"F12\",\n # Number row.\n 49: 53, #\"`\",\n 10: 30, #\"1\",\n 11: 31, #\"2\",\n 12: 32, #\"3\",\n 13: 33, #\"4\",\n 14: 34, #\"5\",\n 15: 35, #\"6\",\n 16: 36, #\"7\",\n 17: 37, #\"8\",\n 18: 38, #\"9\",\n 19: 39, #\"0\",\n 20: 45, #\"-\",\n 21: 46, #\"=\",\n 51: 50, #\"\\\\\",\n # Upper row.\n 24: 20, #\"q\",\n 25: 26, #\"w\",\n 26: 8, #\"e\",\n 27: 21, #\"r\",\n 28: 23, #\"t\",\n 29: 28, #\"y\",\n 30: 24, #\"u\",\n 31: 12, #\"i\",\n 32: 18, #\"o\",\n 33: 19, #\"p\",\n 34: 47, #\"[\",\n 35: 48, #\"]\",\n # Home row.\n 38: 4, #\"a\",\n 39: 22, #\"s\",\n 40: 7, #\"d\",\n 41: 9, #\"f\",\n 42: 10, #\"g\",\n 43: 11, #\"h\",\n 44: 13, #\"j\",\n 45: 14, #\"k\",\n 46: 15, #\"l\",\n 47: 51, #\";\",\n 48: 52, #\"'\",\n # Bottom row.\n 52: 29, #\"z\",\n 53: 27, #\"x\",\n 54: 6, #\"c\",\n 55: 25, #\"v\",\n 56: 5, #\"b\",\n 57: 17, #\"n\",\n 58: 16, #\"m\",\n 59: 54, #\",\",\n 60: 55, #\".\",\n 61: 56, #\"/\",\n # Other keys.\n 22 : 42, #\"BackSpace\",\n 119: 76, #\"Delete\",\n 116: 81, #\"Down\",\n 115: 77, #\"End\",\n 9 : 41, #\"Escape\",\n 110: 74, #\"Home\",\n 118: 73, #\"Insert\",\n 113: 80, #\"Left\",\n 117: 78, #\"Page_Down\",\n 112: 75, #\"Page_Up\",\n 36 : 40, #\"Return\",\n 114: 79, #\"Right\",\n 23 : 43, #\"Tab\",\n 111: 82, #\"Up\",\n 65 : 44, #\"Space\",\n 66 : 57, #Caps_Lock,\n #\"KEY_BACK\": 241,\n #\"KEY_FORWARD\": 242,\n #\"KEY_REFRESH\": 250,\n #\"KEY_SYSRQ\": 70,\n # Keypad keys\n #\"KEY_NUMLOCK\": 83,\n #\"KEY_SCROLLLOCK\": 71,\n 79: 95, #kp_7 - \"KEY_KP7\"\n 80: 96, #kp_8 - \"KEY_KP8\"\n 81: 97, #kp_9 - \"KEY_KP9\"\n #\"KEY_KPMINUS\": 86,\n 83: 92, #kp_4 - \"KEY_KP4\"\n 84: 93, #kp_5 - \"KEY_KP5\"\n 85: 94, #kp_6 - \"KEY_KP6\"\n #\"KEY_KPPLUS\": 87,\n 87: 89, #kp_1 - \"KEY_KP1\"\n 88: 90, #kp_2 - \"KEY_KP2\"\n 89: 91, #kp_3 - \"KEY_KP3\"\n 90: 98, #kp_0 - \"KEY_KP0\"\n 126: 215, # \"Keypad ±\"\n #\"KEY_KPDOT\": 99,\n \n # TODO: Media keys not working correctly\n # Media keys\n 172: 232, # AudioPlay - \"KEY_PLAYPAUSE\"\n 209: 232, # AudioPause - \"KEY_PLAYPAUSE\"\n 121: 239, # AudioMute - \"KEY_MUTE\"\n 122: 238, #AudioLowerVolume - \"KEY_VOLUMEDOWN\"\n 123: 237, #AudioRaiseVolume - \"KEY_VOLUMEUP\"\n 173: 234, #AudioPrev - \"KEY_PREVIOUSSONG\"\n 171: 235, #AudioNext - \"KEY_NEXTSONG\"\n 174: 233, #AudioStop - \"KEY_STOPCD\"\n 169: 236, #Eject - \"KEY_EJECTCD\"\n}\n\n# Map modifier keys to array element in the bit array\nplover_modkeys = {\n # TODO: AltGr will not on MacOS/iOs/iPadOS produce expected character.\n 134: 0, #Super_R - \"KEY_RIGHTMETA\", WIN-key\n 128: 1, #\"KEY_RIGHTALT\", AltGr used to produce some symbols\n 62: 2, #\"KEY_RIGHTSHIFT\"\n 105: 3, #\"KEY_RIGHTCTRL\"\n 133: 4, #Super_L - \"KEY_LEFTMETA\", WIN-key\n 64: 5, #\"KEY_LEFTALT\"\n 50 : 6, #\"KEY_LEFTSHIFT\"\n 1 : 6, #\"KEY_LEFTSHIFT\", mapped to both 50 and 1 as '1' is used by Plover as shift modifier to capitalize letters and '50' when sent in key-combo\n 37: 7 #\"KEY_LEFTCTRL\"\n}\n\ndef plover_convert(plover_keycode):\n if plover_keycode in plover_keytable:\n return plover_keytable[plover_keycode]\n else:\n return -1 # Return an invalid keycode\n\ndef plover_modkey(plover_keycode):\n if plover_keycode in plover_modkeys:\n return plover_modkeys[plover_keycode]\n else:\n return -1 # Return an invalid array element " }, { "path": "plover_plugin/stenogotchi_link/stenogotchi_link.py", "content": "#!/usr/bin/env python3\n# This is a Plover plugin acting as link between Plover and Stenogotchi\n# Based on: https://github.com/nsmarkop/plover_websocket_server\n\nimport plover.log\nimport json\nimport jsonpickle\nfrom typing import Optional, List\nfrom time import sleep\n\nfrom plover.engine import StenoEngine\nfrom plover.steno import Stroke\nfrom plover.config import Config\nfrom plover.formatting import _Action\nfrom plover.steno_dictionary import StenoDictionaryCollection\n\nfrom stenogotchi_link.clients import BTClient, StenogotchiClient\nfrom stenogotchi_link.wpm import PloverWpmMeter, PloverStrokesMeter\n\n\nERROR_MISSING_ENGINE = 'Plover engine not provided'\n\n\nclass EngineServer():\n \"\"\"\n Hooks into Plover events and makes them available to Stenogotchi.\n \"\"\"\n\n # Called once to initialize an instance which lives until Plover exits\n def __init__(self, engine: StenoEngine) -> None:\n self._engine: StenoEngine = engine\n self._stenogotchiclient = StenogotchiClient(self)\n self._btclient = BTClient()\n self._wpm_meter = None\n self._strokes_meter = None\n self._output_to_stenogotchi = False\n\n # Started when user enables extension\n def start(self):\n \"\"\" Starts the server. \"\"\"\n self._connect_hooks()\n plover.log.info(\"[stenogotchi_link] Plover_link started\")\n self._stenogotchiclient.plover_is_running(True)\n\n # Called when Plover exits or user disables the extension\n def stop(self):\n \"\"\" Stops the server. \"\"\"\n self._disconnect_hooks()\n self._stenogotchiclient.plover_is_running(False)\n\n def start_wpm_meter(self, enable_wpm=False, enable_strokes=False, wpm_method='ncra', wpm_timeout=60):\n \"\"\" Starts WPM and/or Strokes meters\n \"\"\"\n if enable_wpm:\n self._wpm_meter = PloverWpmMeter(stenogotchi_link=self, wpm_method=wpm_method, timeout=wpm_timeout)\n if enable_strokes:\n self._strokes_meter = PloverStrokesMeter(stenogotchi_link=self, strokes_method=wpm_method, timeout=wpm_timeout)\n\n def stop_wpm_meter(self, disable_wpm=True, disable_strokes=True):\n if disable_wpm:\n self._wpm_meter.quit()\n self._wpm_meter = None\n if disable_strokes:\n self._strokes_meter.quit()\n self._strokes_meter = None\n\n def _on_wpm_meter_update_strokes(self, stats):\n \"\"\" Sends strokes stats to stenogotchi as a string \"\"\"\n self._stenogotchiclient.plover_strokes_stats(stats['strokes_user'])\n\n def _on_wpm_meter_update_wpm(self, stats):\n \"\"\" Sends wpm stats to stenogotchi as a string \"\"\"\n self._stenogotchiclient.plover_wpm_stats(stats['wpm_user'])\n\n def _on_plover_translation(self, results, type):\n \"\"\" Sends translation results from Plover to stenogotchi as list of strings\"\"\"\n if type == 'word': # Result from Plover will be in format List[Tuple[str]], examine: {('EBGS', 'APL', '*EUPB'), ('KP*PL',), ('KPAPL', 'PHEUPB'), ('KPAPL', '-PB'), ('KP-PB',), ('EBGS', 'APL', '-PB'), ('KP',), ('EBGS', 'APL', 'PHEUPB'), ('EBGS', 'APL', 'EUPB')}\n results_list = []\n chords = None\n for touple in results:\n if chords:\n results_list.append(chords)\n chords = None\n for result in touple:\n if chords:\n chords = chords + '/' + result\n else:\n chords = result\n if chords:\n results_list.append(chords)\n chords = None\n elif type == 'stroke': # Result from Plover will be in format str\n # TODO: implement functionality for stroke-lookup\n plover.log.debug(f\"Lookup_stroke results: {results}\")\n results_list = [results]\n self._stenogotchiclient.send_lookup_results(results_list)\n \n def lookup_word(self, word):\n matches = self._engine.reverse_lookup(word)\n self._on_plover_translation(matches, 'word')\n\n def lookup_stroke(self, stroke):\n matches = self._engine.lookup(stroke)\n self._on_plover_translation(matches, 'stroke')\n\n def get_server_status(self):\n \"\"\"Gets the status of the server.\n Returns: \n The status of the server.\n \"\"\"\n pass\n\n def _connect_hooks(self):\n \"\"\"Creates hooks into all of Plover's events.\"\"\"\n\n if not self._engine:\n plover.log.error(f'[stenogotchi_link] {ERROR_MISSING_ENGINE}')\n raise AssertionError(ERROR_MISSING_ENGINE)\n \n for hook in self._engine.HOOKS:\n callback = getattr(self, f'_on_{hook}')\n self._engine.hook_connect(hook, callback)\n\n def _disconnect_hooks(self):\n \"\"\"Removes hooks from all of Plover's events.\"\"\"\n \n if not self._engine:\n raise AssertionError(ERROR_MISSING_ENGINE)\n\n for hook in self._engine.HOOKS:\n callback = getattr(self, f'_on_{hook}')\n self._engine.hook_disconnect(hook, callback)\n \n def _on_stroked(self, stroke: Stroke):\n \"\"\" Broadcasts when a new stroke is performed. \"\"\"\n \n pass\n\n def _on_translated(self, old: List[_Action], new: List[_Action]):\n \"\"\"Broadcasts when a new translation occurs.\n Args:\n old: A list of the previous actions for the current translation.\n new: A list of the new actions for the current translation.\n \"\"\"\n \n # Send to WPM meter if we have one\n if self._wpm_meter:\n self._wpm_meter.on_translation(old, new)\n # Send to Strokes meter if we have one\n if self._strokes_meter:\n self._strokes_meter.on_translation(old, new)\n\n # print(self._wpm_meter.get_stats())\n # print(self._strokes_meter.get_stats())\n\n def _on_machine_state_changed(self, machine_type: str, machine_state: str):\n \"\"\"Broadcasts when the active machine state changes.\n Args:\n machine_type: The name of the active machine.\n machine_state: The new machine state. This should be one of the\n state constants listed in plover.machine.base.\n \"\"\"\n \n self._stenogotchiclient.plover_machine_state(\"machine_type: \" + machine_type + \" machine_state: \" + machine_state)\n\n def _on_output_changed(self, enabled: bool):\n \"\"\"Broadcasts when the state of output changes.\n Args:\n enabled: If the output is now enabled or not.\n \"\"\"\n\n data = {'output_changed': enabled}\n plover.log.debug(f'[stenogotchi_link] _on_output_changed data: {data}')\n self._stenogotchiclient.plover_output_enabled(enabled)\n \n\n def _on_config_changed(self, config_update: Config):\n \"\"\"Broadcasts when the configuration changes.\n Args:\n config_update: An object containing the full configuration or a\n part of the configuration that was updated.\n \"\"\"\n\n config_json = jsonpickle.encode(config_update, unpicklable=False)\n\n data = {'config_changed': json.loads(config_json)}\n plover.log.debug(f'[stenogotchi_link] _on_config_changed data: {data}')\n\n def _on_dictionaries_loaded(self, dictionaries: StenoDictionaryCollection):\n \"\"\"Broadcasts when all of the dictionaries get loaded.\n Args:\n dictionaries: A collection of the dictionaries that loaded.\n \"\"\"\n\n self._stenogotchiclient.plover_is_ready(True)\n\n def _on_send_string(self, text: str):\n \"\"\"Broadcasts when a new string is output.\n Args:\n text: The string that was output.\n \"\"\"\n if self._output_to_stenogotchi:\n self._stenogotchiclient.send_string(text)\n else:\n self._btclient.send_string(text)\n\n def _on_send_backspaces(self, count: int):\n \"\"\"Broadcasts when backspaces are output.\n Args:\n count: The number of backspaces that were output.\n \"\"\"\n if self._output_to_stenogotchi:\n self._stenogotchiclient.send_backspaces(count)\n else:\n self._btclient.send_backspaces(count)\n\n def _on_send_key_combination(self, combination: str):\n \"\"\"Broadcasts when a key combination is output.\n Args:\n combination: A string representing a sequence of key combinations.\n Keys are represented by their names based on the OS-specific\n keyboard implementations in plover.oslayer.\n \"\"\"\n if self._output_to_stenogotchi:\n self._stenogotchiclient.send_key_combination(combination)\n else:\n self._btclient.send_key_combination(combination)\n\n def _on_add_translation(self):\n \"\"\"Broadcasts when the add translation tool is opened via a command.\"\"\"\n\n data = {'add_translation': True}\n plover.log.debug(f'[stenogotchi_link] _on_add_translation data: {data}')\n \n def _on_focus(self):\n \"\"\"Broadcasts when the main window is focused via a command.\"\"\"\n\n data = {'focus': True}\n plover.log.debug(f'[stenogotchi_link] _on_focus data: {data}')\n\n def _on_configure(self):\n \"\"\"Broadcasts when the configuration tool is opened via a command.\"\"\"\n\n data = {'configure': True}\n plover.log.debug(f'[stenogotchi_link] _on_configure data: {data}')\n\n def _on_lookup(self):\n \"\"\"Broadcasts when the lookup tool is opened via a command.\"\"\"\n\n data = {'lookup': True}\n plover.log.debug(f'[stenogotchi_link] _on_lookup data: {data}')\n\n def _on_suggestions(self):\n \"\"\"Broadcasts when the lookup tool is opened via a command.\"\"\"\n\n data = {'suggestions': True}\n plover.log.debug(f'[stenogotchi_link] _on_lookup data: {data}')\n\n def _on_quit(self):\n \"\"\"Broadcasts when the application is terminated.\n Can be either a full quit or a restart.\n \"\"\"\n\n data = {'quit': True}\n plover.log.debug(f'[stenogotchi_link] _on_quit data: {data}')\n self._stenogotchiclient.plover_is_running(False)\n\n\nif __name__ == '__main__':\n print(\"Please enable and run as Plover plugin\")\n" }, { "path": "plover_plugin/stenogotchi_link/wpm.py", "content": "#!/usr/bin/env python3\n#\n# Based on: https://github.com/arxanas/plover_wpm_meter.git, modified to remove QT dependency.\n# \n# This is a plugin for Plover to display your typing speed as you type, in either or both of words per minute or strokes per minute:\n## Words per minute: Shows the rate at which you stroked words in the last 10 and 60 seconds.\n## Strokes per minute: Shows how efficiently you stroked words in the last 10 and 60 seconds. Lower values are more efficient, e.g. a value of 1 means that on average it took you one stroke to write out a word.\n#\n# A word is defined in one of three ways:\n## NCRA: The National Court Reporters Association defines a “word” as 1.4 syllables. This is the measure used for official NCRA testing material.\n## Traditional: The traditional metric for “word” in the context of keyboarding is defined to be 5 characters per word, including spaces. This is compatible with the notion of “word” in many typing speed utilities.\n## Spaces: A word is a whitespace-separated sequence of characters. This metric of course doesn’t take into account the fact that some words are longer than others, both in length and syllables.\n\nimport time\nfrom threading import Timer\nfrom textstat.textstat import textstat\n\nfrom plover.formatting import OutputHelper\n\nclass RepeatTimer(Timer):\n \"\"\" \n Perpetually repeating timer implementation of threading.Timer\n \"\"\" \n\n def run(self):\n while not self.finished.wait(self.interval):\n self.function(*self.args, **self.kwargs)\n\nclass CaptureOutput(object):\n \n def __init__(self, chars):\n self.chars = chars\n\n def send_backspaces(self, n):\n del self.chars[-n:]\n\n def send_string(self, s):\n self.chars += _timestamp_items(s)\n\n def send_key_combination(self, c):\n pass\n\n def send_engine_command(self, c):\n pass\n\n\nclass BaseMeter():\n \n def __init__(self, timeout=60):\n # Set timer to calculate wpm/strokes stats each second\n self._timer = RepeatTimer(1, self.on_timer)\n self._timer.start()\n # Set timer to publish wpm/strokes stats each minute\n self._event_timer = RepeatTimer(timeout, self.trigger_event_update)\n self._event_timer.start()\n self.chars = []\n\n def on_translation(self, old, new):\n output = CaptureOutput(self.chars)\n output_helper = OutputHelper(output, False, False)\n output_helper.render(None, old, new)\n\n def on_timer(self):\n raise NotImplementedError()\n\n def trigger_event_update(self):\n raise NotImplementedError()\n\n def quit(self):\n self._timer.cancel()\n self._event_timer.cancel()\n\nclass PloverWpmMeter(BaseMeter):\n\n def __init__(self, stenogotchi_link, wpm_method='ncra', timeout=60):\n super().__init__(timeout)\n self._stenogotchi_link = stenogotchi_link\n self.strokes = []\n self.wpm_methods = {\n 'ncra': False, # NCRA (by syllables)\n 'traditional': False, # Traditional (by characters)\n 'spaces': False, # Spaces (by whitespace)\n }\n self._timeouts = {\n \"wpm10\": 10,\n \"wpm_user\": timeout,\n }\n self.set_wpm_method(wpm_method)\n self.wpm_stats = {}\n\n def set_wpm_method(self, method):\n self.wpm_methods = dict.fromkeys(self.wpm_methods, False)\n self.wpm_methods[method] = True\n\n def get_wpm_method(self):\n for method, enabled in self.wpm_methods.items():\n if enabled:\n return method\n\n def get_stats(self):\n return self.wpm_stats\n\n def on_timer(self):\n max_timeout = max(self._timeouts.values())\n self.chars = _filter_old_items(self.chars, max_timeout)\n for name, timeout in self._timeouts.items():\n chars = _filter_old_items(self.chars, timeout)\n wpm = _wpm_of_chars(chars, method=self.get_wpm_method())\n self.wpm_stats[name] = str(wpm)\n\n def trigger_event_update(self):\n self._stenogotchi_link._on_wpm_meter_update_wpm(stats=self.wpm_stats)\n \n\nclass PloverStrokesMeter(BaseMeter):\n\n def __init__(self, stenogotchi_link, strokes_method='ncra', timeout=60):\n super().__init__(timeout)\n self._stenogotchi_link = stenogotchi_link\n self.actions = []\n self.strokes_methods = {\n 'ncra': False, # NCRA (by syllables)\n 'traditional': False, # Traditional (by characters)\n 'spaces': False, # Spaces (by whitespace)\n }\n self._timeouts = {\n \"strokes10\": 10,\n \"strokes_user\": timeout,\n }\n self.set_strokes_method(strokes_method)\n self.strokes_stats = {}\n \n # By default, the QLCDNumbers will just display \"0\", without a decimal\n # point, on initial render. Render them ourselves so that we don't\n # switch from \"0\" to \"0.00\" after a second.\n self.on_timer()\n\n def set_strokes_method(self, method):\n self.strokes_methods = dict.fromkeys(self.strokes_methods, False)\n self.strokes_methods[method] = True\n\n def get_strokes_method(self):\n for method, enabled in self.strokes_methods.items():\n if enabled:\n return method\n\n def get_stats(self):\n return self.strokes_stats\n\n def on_translation(self, old, new):\n super().on_translation(old, new)\n if len(old) > 0:\n self.actions = self.actions[:-len(old)]\n self.actions += _timestamp_items(new)\n\n def on_timer(self):\n max_timeout = max(self._timeouts.values())\n self.chars = _filter_old_items(self.chars, max_timeout)\n self.actions = _filter_old_items(self.actions, max_timeout)\n for name, timeout in self._timeouts.items():\n chars = _filter_old_items(self.chars, timeout)\n num_strokes = len(_filter_old_items(self.actions, timeout))\n strokes_per_word = _spw_of_chars(\n num_strokes,\n chars,\n method=self.get_strokes_method()\n )\n self.strokes_stats[name] = str(\"{:0.2f}\".format(strokes_per_word))\n\n def trigger_event_update(self):\n self._stenogotchi_link._on_wpm_meter_update_strokes(stats=self.strokes_stats)\n\ndef _timestamp_items(items):\n current_time = time.time()\n return [(i, current_time) for i in items]\n\n\ndef _filter_old_items(items, timeout):\n current_time = time.time()\n return [(i, t) for i, t in items\n if (current_time - t) <= timeout]\n\n\ndef _words_in_chars(chars, method):\n text = \"\".join(c for c, _ in chars)\n if method == \"ncra\":\n # The NCRA defines a \"word\" to be 1.4 syllables, which is the average\n # number of syllables per English word.\n syllables_per_word = 1.4\n # For some reason, textstat returns syllable counts such as a\n # one-syllable word like \"the\" being 0.9 syllables.\n syllables_in_text = textstat.syllable_count(text) / 0.9\n return syllables_in_text * (1 / syllables_per_word)\n elif method == \"traditional\":\n # Formal definition; see https://en.wikipedia.org/wiki/Words_per_minute\n return len(text) / 5\n elif method == \"spaces\":\n return len([i for i in text.split() if i])\n else:\n assert False, \"bad wpm method: \" + method\n\n\ndef _time_interval_of_chars(chars):\n start_time = min(t for _, t in chars)\n current_time = time.time()\n time_interval = current_time - start_time\n time_interval = max(1, time_interval)\n return time_interval\n\n\ndef _wpm_of_chars(chars, method):\n num_words = _words_in_chars(chars, method)\n if not num_words:\n return 0\n\n time_interval = _time_interval_of_chars(chars)\n num_minutes = time_interval / 60\n num_words_per_minute = num_words / num_minutes\n return int(round(num_words_per_minute))\n\n\ndef _spw_of_chars(num_strokes, chars, method):\n num_words = _words_in_chars(chars, method)\n if not num_words:\n return 0\n\n return num_strokes / num_words\n" }, { "path": "requirements.txt", "content": "PyGObject == 3.30.4\ndbus_python == 1.2.16\nevdev == 1.4.0\nRPi.GPIO == 0.7.0\nfile_read_backwards == 2.0.0\ntoml == 0.10.2\nspidev == 3.5\nFlask == 1.1.2\nFlask_Cors == 3.0.10\nFlask_WTF == 0.14.3\nrequests == 2.25.1\nPillow >= 8.3.2\nplover >= 4.0.0.dev10" }, { "path": "stenogotchi/__init__.py", "content": "import os\nimport logging\nimport time\nimport re\nimport subprocess\n\nfrom stenogotchi._version import __version__\n\n_name = None\nconfig = None\n\n\ndef set_name(new_name):\n if new_name is None:\n return\n\n new_name = new_name.strip()\n if new_name == '':\n return\n\n if not re.match(r'^[a-zA-Z0-9\\-]{2,25}$', new_name):\n logging.warning(\"name '%s' is invalid: min length is 2, max length 25, only a-zA-Z0-9- allowed\", new_name)\n return\n\n current = name()\n if new_name != current:\n global _name\n\n logging.info(\"setting unit hostname '%s' -> '%s'\", current, new_name)\n with open('/etc/hostname', 'wt') as fp:\n fp.write(new_name)\n\n with open('/etc/hosts', 'rt') as fp:\n prev = fp.read()\n logging.debug(\"old hosts:\\n%s\\n\", prev)\n\n with open('/etc/hosts', 'wt') as fp:\n patched = prev.replace(current, new_name, -1)\n logging.debug(\"new hosts:\\n%s\\n\", patched)\n fp.write(patched)\n\n os.system(\"hostname '%s'\" % new_name)\n reboot()\n\n\ndef name():\n global _name\n if _name is None:\n with open('/etc/hostname', 'rt') as fp:\n _name = fp.read().strip()\n return _name\n\n\ndef uptime():\n with open('/proc/uptime') as fp:\n return int(fp.read().split('.')[0])\n\n\ndef mem_usage():\n with open('/proc/meminfo') as fp:\n for line in fp:\n line = line.strip()\n if line.startswith(\"MemTotal:\"):\n kb_mem_total = int(line.split()[1])\n if line.startswith(\"MemFree:\"):\n kb_mem_free = int(line.split()[1])\n if line.startswith(\"Buffers:\"):\n kb_main_buffers = int(line.split()[1])\n if line.startswith(\"Cached:\"):\n kb_main_cached = int(line.split()[1])\n kb_mem_used = kb_mem_total - kb_mem_free - kb_main_cached - kb_main_buffers\n return round(kb_mem_used / kb_mem_total, 1)\n\n return 0\n\n\ndef _cpu_stat():\n \"\"\"\n Returns the splitted first line of the /proc/stat file\n \"\"\"\n with open('/proc/stat', 'rt') as fp:\n return list(map(int,fp.readline().split()[1:]))\n\ndef cpu_load(s=0.1):\n \"\"\"\n Returns the average cpuload over a 's'-seconds period\n \"\"\"\n parts0 = _cpu_stat()\n time.sleep(s)\n parts1 = _cpu_stat()\n parts_diff = [p1 - p0 for (p0, p1) in zip(parts0, parts1)]\n user, nice, sys, idle, iowait, irq, softirq, steal, _guest, _guest_nice = parts_diff\n idle_sum = idle + iowait\n non_idle_sum = user + nice + sys + irq + softirq + steal\n total = idle_sum + non_idle_sum\n return non_idle_sum / total\n\n\ndef temperature(celsius=True):\n with open('/sys/class/thermal/thermal_zone0/temp', 'rt') as fp:\n temp = int(fp.read().strip())\n c = int(temp / 1000)\n return c if celsius else ((c * (9 / 5)) + 32)\n\ndef get_wifi_status():\n try:\n parts = os.popen(\"sudo ip -br addr show wlan0\").read().split()\n state = parts[1]\n ip = parts[2].split('/')[0]\n return state, ip\n except:\n return None, None\n \n\ndef get_wifi_ssid():\n try:\n ssid = os.popen(\"sudo iwgetid -r\").read().split('\\n')[0]\n return ssid\n except:\n return \"\"\n\ndef set_wifi_onoff():\n wifi_updown = get_wifi_status()[0]\n if wifi_updown == 'UP':\n # switch wifi off\n subprocess.call(['sudo', 'ip', 'link', 'set', 'dev', 'wlan0', 'down'])\n subprocess.call(['sudo', 'dhclient', '-r', 'wlan0'])\n subprocess.call(['sudo', 'rfkill', 'block', '0'])\n return False\n else:\n # switch wifi on\n subprocess.call(['sudo', 'rfkill', 'unblock', '0'])\n subprocess.call(['sudo', 'dhclient', 'wlan0'])\n subprocess.call(['sudo', 'ip', 'link', 'set', 'dev', 'wlan0', 'up'])\n return True\n\ndef shutdown():\n logging.warning(\"shutting down ...\")\n\n from stenogotchi.ui import view\n \n if view.ROOT:\n view.ROOT.on_shutdown()\n # give it some time to refresh the ui\n time.sleep(5)\n \n if view.ROOT._config['ui']['display']['enabled']:\n if view.ROOT._config['ui']['display']['clear_at_shutdown']:\n view.ROOT._agent._view.init_display()\n view.ROOT._agent._view.clear()\n # give it some time to clear the ui\n time.sleep(5)\n\n logging.warning(\"syncing...\")\n\n from stenogotchi import fs\n for m in fs.mounts:\n m.sync()\n \n os.system(\"sync\")\n os.system(\"halt\")\n\n\ndef restart(mode):\n logging.warning(\"restarting in %s mode ...\", mode)\n\n if mode == 'AUTO':\n os.system(\"touch /root/.stenogotchi-auto\")\n else:\n os.system(\"touch /root/.stenogotchi-manual\")\n\n #os.system(\"service stenogotchi restart\")\n\n\ndef reboot(mode=None):\n if mode is not None:\n mode = mode.upper()\n logging.warning(\"rebooting in %s mode ...\", mode)\n else:\n logging.warning(\"rebooting ...\")\n\n from stenogotchi.ui import view\n if view.ROOT:\n view.ROOT.on_rebooting()\n # give it some time to refresh the ui\n time.sleep(10)\n\n if mode == 'AUTO':\n os.system(\"touch /root/.stenogotchi-auto\")\n elif mode == 'MANU':\n os.system(\"touch /root/.stenogotchi-manual\")\n\n logging.warning(\"syncing...\")\n\n from stenogotchi import fs\n for m in fs.mounts:\n m.sync()\n\n os.system(\"sync\")\n os.system(\"shutdown -r now\")\n" }, { "path": "stenogotchi/_version.py", "content": "__version__ = '0.1.0'" }, { "path": "stenogotchi/agent.py", "content": "import time\nimport json\nimport os\nimport re\nimport logging\nimport asyncio\nimport _thread\n\nimport stenogotchi\nimport stenogotchi.utils as utils\nimport stenogotchi.plugins as plugins\nfrom stenogotchi.ui.web.server import Server\nfrom stenogotchi.automata import Automata\n#from stenogotchi.log import LastSession\n\nRECOVERY_DATA_FILE = '/root/.stenogotchi-recovery'\n\n\nclass Agent(Automata):\n def __init__(self, view, config):\n Automata.__init__(self, config, view)\n self._started_at = time.time()\n self._view = view\n self._view.set_agent(self)\n self._web_ui = None\n self._wifi_connected = None\n\n self._history = {}\n #self.last_session = LastSession(self._config)\n self.mode = 'auto'\n\n logging.info(\"%s (v%s)\", stenogotchi.name(), stenogotchi.__version__)\n for _, plugin in plugins.loaded.items():\n logging.debug(\"plugin '%s' v%s\", plugin.__class__.__name__, plugin.__version__)\n\n def config(self):\n return self._config\n\n def view(self):\n return self._view\n\n def start(self):\n self.set_starting()\n # self.start_event_polling()\n # print initial stats\n self.start_session_fetcher()\n self.set_ready()\n\n def _update_uptime(self):\n secs = stenogotchi.uptime()\n self._view.set('uptime', utils.secs_to_hhmmss(secs))\n\n def _update_wifi(self):\n status, ip = stenogotchi.get_wifi_status()\n \n if status == 'UP':\n if self._wifi_connected:\n return\n ssid = stenogotchi.get_wifi_ssid()\n if ssid and ip:\n self._wifi_connected = True\n # Create web-ui only once a wifi connection is established\n if not self._web_ui:\n self._web_ui = Server(self, self._config['ui'])\n else:\n if not ssid:\n ssid = \"[Searching]\"\n ip = \"the ghost\"\n if not ip:\n ip = \"the ghost\"\n self._wifi_connected = False\n self.set_wifi_connected(ssid, ip)\n elif status == 'DOWN' or not status:\n if self._wifi_connected == False:\n return\n self._wifi_connected = False\n self.set_wifi_disconnected('[OFF]')\n\n def _reboot(self):\n self.set_rebooting()\n self._save_recovery_data()\n stenogotchi.reboot()\n\n def _save_recovery_data(self):\n logging.warning(\"writing recovery data to %s ...\", RECOVERY_DATA_FILE)\n with open(RECOVERY_DATA_FILE, 'w') as fp:\n data = {\n 'started_at': self._started_at,\n 'history': self._history,\n }\n json.dump(data, fp)\n\n def _load_recovery_data(self, delete=True, no_exceptions=True):\n try:\n with open(RECOVERY_DATA_FILE, 'rt') as fp:\n data = json.load(fp)\n logging.info(\"found recovery data: %s\", data)\n self._started_at = data['started_at']\n self._history = data['history']\n\n if delete:\n logging.info(\"deleting %s\", RECOVERY_DATA_FILE)\n os.unlink(RECOVERY_DATA_FILE)\n except:\n if not no_exceptions:\n raise\n\n\n def start_session_fetcher(self):\n _thread.start_new_thread(self._fetch_stats, ())\n\n async def plover_status_update(self, msg):\n pass\n\n def _fetch_stats(self):\n while True:\n #s = self.session() # this is just the request object for connection to bettercap -> to be used for fetching plover stats instead\n self._update_uptime()\n self._update_wifi()\n time.sleep(30)\n\n async def _on_event(self, msg): # no bettercap to produce events for us, to be used for plover events\n pass\n\n def _event_poller(self, loop):\n self._load_recovery_data()\n #while True:\n\n\n def start_event_polling(self):\n # start a thread and pass in the mainloop\n _thread.start_new_thread(self._event_poller, (asyncio.get_event_loop(),))\n" }, { "path": "stenogotchi/automata.py", "content": "import logging\n\nimport stenogotchi.plugins as plugins\n\n\n# basic mood system\nclass Automata(object):\n def __init__(self, config, view):\n self._config = config\n self._view = view\n\n def set_starting(self):\n self._view.on_starting()\n\n def set_ready(self):\n plugins.on('ready', self)\n\n def in_good_mood(self):\n pass\n\n # triggered when it's a sad/bad day but you have good friends around ^_^\n def set_grateful(self):\n self._view.on_grateful()\n plugins.on('grateful', self)\n\n def set_lonely(self):\n self._view.on_lonely()\n plugins.on('lonely', self)\n\n def set_bored(self):\n self._view.on_bored()\n plugins.on('bored', self)\n\n def set_sad(self):\n self._view.on_sad()\n plugins.on('sad', self)\n\n def set_angry(self):\n self._view.on_angry()\n plugins.on('angry', self)\n\n def set_excited(self):\n self._view.on_excited()\n plugins.on('excited', self)\n\n def set_processing(self):\n self._view.on_processing()\n plugins.on('processing', self)\n\n def set_rebooting(self):\n self._view.on_rebooting()\n plugins.on('rebooting', self)\n\n def wait_for(self, t, sleeping=True):\n self._view.wait(t, sleeping)\n\n def set_plover_boot(self):\n self._view.on_plover_boot()\n plugins.on('plover_boot', self)\n\n def set_plover_ready(self):\n self._view.on_plover_ready()\n plugins.on('plover_ready', self)\n\n def set_plover_quit(self):\n self._view.on_plover_quit()\n plugins.on('plover_quit', self)\n \n def set_bt_connected(self, bthost_name):\n self._view.set('bthost', bthost_name)\n self._view.on_bt_connected(bthost_name)\n plugins.on('bt_connected', self, bthost_name)\n\n def set_bt_disconnected(self):\n self._view.set('bthost', \"\")\n self._view.on_bt_disconnected()\n plugins.on('bt_disconnected', self)\n \n def set_wifi_connected(self, ssid, ip):\n self._view.set('wifi', ssid)\n self._view.on_wifi_connected(ssid, ip)\n plugins.on('wifi_connected', self, ssid, ip)\n\n def set_wifi_disconnected(self, ssid=''):\n self._view.set('wifi', ssid)\n self._view.on_wifi_disconnected()\n plugins.on('wifi_disconnected', self)\n\n def set_wpm(self, wpm, wpm_top):\n stats = '{:3s} {:5s}'.format(str(wpm), f'({wpm_top})')\n self._view.on_wpm(stats)\n plugins.on('wpm_set', self)\n\n def set_strokes(self, stats):\n self._view.on_strokes(stats)\n plugins.on('strokes_set', self)\n\n def set_wpm_record(self, wpm_top):\n self._view.on_wpm_record(wpm_top)\n plugins.on('wpm_record', self)\n self.set_wpm(wpm_top, wpm_top) # Since we set a new record wpm and wpm_top will be equal\n\n def set_on_dict_lookup_done(self):\n self._view.on_dict_lookup_done()\n plugins.on('dict_lookup_done', self)\n" }, { "path": "stenogotchi/defaults.toml", "content": "# This is a TOML document\n# This is the default config template. To change the default values, please save your modifications to /etc/stenogotchi/config.toml\n\n# Main\nmain.name = \"Stenogotchi\"\nmain.lang = \"en\"\nmain.confd = \"/etc/stenogotchi/conf.d/\"\nmain.custom_plugins = \"\"\n\n# Filesystem\nfs.memory.enabled = false\nfs.memory.mounts.log.enabled = false\nfs.memory.mounts.log.mount = \"/var/log\"\nfs.memory.mounts.log.size = \"50M\"\nfs.memory.mounts.log.sync = 60\nfs.memory.mounts.log.zram = true\nfs.memory.mounts.log.rsync = true\n\nfs.memory.mounts.data.enabled = false\nfs.memory.mounts.data.mount = \"/var/tmp/stenogotchi\"\nfs.memory.mounts.data.size = \"10M\"\nfs.memory.mounts.data.sync = 3600\nfs.memory.mounts.data.zram = false\nfs.memory.mounts.data.rsync = true\n\n# UI\n# The lifespan of an eINK display depends on the cumulative number of refreshes. To preserve your display\n# over time it is recommended to keep ui.fps value 0.0 so that refreshes only take place upon major updates.\n# Uptime, battery status, the blinking cursor and similar will not trigger a refresh\n\nui.fps = 0.0\nui.font.name = \"DejaVuSansMono\"\nui.font.size_offset = 0 # added to the font size\n\nui.faces.look_r = \"( ⚆_⚆)\"\nui.faces.look_l = \"(☉_☉ )\"\nui.faces.look_r_happy = \"( ◕‿◕)\"\nui.faces.look_l_happy = \"(◕‿◕ )\"\nui.faces.sleep = \"(⇀‿‿↼)\"\nui.faces.sleep2 = \"(≖‿‿≖)\"\nui.faces.awake = \"(◕‿‿◕)\"\nui.faces.bored = \"(-__-)\"\nui.faces.intense = \"(°▃▃°)\"\nui.faces.cool = \"(⌐■_■)\"\nui.faces.happy = \"(•‿‿•)\"\nui.faces.excited = \"(ᵔ◡◡ᵔ)\"\nui.faces.grateful = \"(^‿‿^)\"\nui.faces.motivated = \"(☼‿‿☼)\"\nui.faces.demotivated = \"(≖__≖)\"\nui.faces.smart = \"(✜‿‿✜)\"\nui.faces.lonely = \"(ب__ب)\"\nui.faces.sad = \"(╥☁╥ )\"\nui.faces.angry = \"(-_-')\"\nui.faces.friend = \"(♥‿‿♥)\"\nui.faces.broken = \"(☓‿‿☓)\"\nui.faces.debug = \"(#__#)\"\nui.faces.process_1 = \"(1__0)\"\nui.faces.process_2 = \"(1__1)\"\nui.faces.process_3 = \"(0__1)\"\nui.faces.process_4 = \"(0__0)\"\n\nui.display.enabled = true\nui.display.rotation = 0\nui.display.type = \"waveshare_2\"\nui.display.color = \"black\"\nui.display.clear_at_shutdown = true\n\n# The web UI provides an alternative way of interacting with the device to an eINK display and ButtonSHIM module. Enabling the web UI will also load the buttonshim plugin.\nui.web.enabled = false\nui.web.address = \"192.168.1.100\"\nui.web.username = \"changeme\"\nui.web.password = \"changeme\"\nui.web.origin = \"\"\nui.web.port = 80\nui.web.on_frame = \"\"\n\n# Plugins\n\n# Populate bt_autoconnect_mac with the MAC addresses of devices to attempt auto connecting to at boot. Multiple comma-separated devices in order of priority can be given.\n# After exhausting the options, the device will fall back to listening for incoming connection and pairing attempts.\n## Example:\n## main.plugins.plover_link.bt_autoconnect_mac = \"00:DE:AD:BE:EF:00, 11:DE:AD:BE:EF:11\"\nmain.plugins.plover_link.enabled = true\nmain.plugins.plover_link.bt_autoconnect_mac = \"\"\nmain.plugins.plover_link.bt_device_name = \"Stenogotchi\"\n\n# For WPM readings a word is defined in one of three ways:\n## NCRA: The National Court Reporters Association defines a “word” as 1.4 syllables. This is the measure used for official NCRA testing material.\n## Traditional: The traditional metric for “word” in the context of keyboarding is defined to be 5 characters per word, including spaces. This is compatible with the notion of “word” in many typing speed utilities.\n## Spaces: A word is a whitespace-separated sequence of characters. This metric of course doesn’t take into account the fact that some words are longer than others, both in length and syllables.\n# Specify either \"ncra\", \"traditional\" or \"spaces\" as preferred method using main.plugins.plover_link.wpm_method\n# Specify in seconds moving time window for which wpm is calculated and updated using main.plugins.plover_link.wpm_timeout\nmain.plugins.plover_link.wpm_method = \"traditional\"\nmain.plugins.plover_link.wpm_timeout = \"60\"\n\n# Plugin evdevkb is responsible for direct keyboard capturing, bypassing Plover. Input mode toggleable when enabled.\nmain.plugins.evdevkb.enabled = true\n\n# Plugin dict_lookup handles dictionary lookup from all enabled Plover dictionaries.\nmain.plugins.dict_lookup.enabled = true\n\n# Plugin upslite provides battery level, charging indicator (+) and auto-shutdown at specified battery level when a UPS-Lite v1.2 module is connected. \nmain.plugins.upslite.enabled = false\nmain.plugins.upslite.shutdown_level = 5\n\n# Plugin buttonshim enables a way to interact with the device using the five physical buttons on the ButtonSHIM hardware module or through the web UI. Enabling the web UI will automatically load the buttonshim plugin.\n# Each button has a predefined long-press (1s) action. The short-press action can be freely configured to any terminal command.\nmain.plugins.buttonshim.enabled = false\nmain.plugins.buttonshim.buttons.A.command = \"\"\nmain.plugins.buttonshim.buttons.A.blink.enabled = false\nmain.plugins.buttonshim.buttons.A.blink.red = 0\nmain.plugins.buttonshim.buttons.A.blink.green = 0\nmain.plugins.buttonshim.buttons.A.blink.blue = 0\nmain.plugins.buttonshim.buttons.A.blink.on_time = 0\nmain.plugins.buttonshim.buttons.A.blink.off_time = 0\nmain.plugins.buttonshim.buttons.A.blink.blink_times = 0\nmain.plugins.buttonshim.buttons.B.command = \"\"\nmain.plugins.buttonshim.buttons.B.blink.enabled = false\nmain.plugins.buttonshim.buttons.B.blink.red = 0\nmain.plugins.buttonshim.buttons.B.blink.green = 0\nmain.plugins.buttonshim.buttons.B.blink.blue = 0\nmain.plugins.buttonshim.buttons.B.blink.on_time = 0\nmain.plugins.buttonshim.buttons.B.blink.off_time = 0\nmain.plugins.buttonshim.buttons.B.blink.blink_times = 0\nmain.plugins.buttonshim.buttons.C.command = \"\"\nmain.plugins.buttonshim.buttons.C.blink.enabled = false\nmain.plugins.buttonshim.buttons.C.blink.red = 0\nmain.plugins.buttonshim.buttons.C.blink.green = 0\nmain.plugins.buttonshim.buttons.C.blink.blue = 0\nmain.plugins.buttonshim.buttons.C.blink.on_time = 0\nmain.plugins.buttonshim.buttons.C.blink.off_time = 0\nmain.plugins.buttonshim.buttons.C.blink.blink_times = 0\nmain.plugins.buttonshim.buttons.D.command = \"\"\nmain.plugins.buttonshim.buttons.D.blink.enabled = false\nmain.plugins.buttonshim.buttons.D.blink.red = 0\nmain.plugins.buttonshim.buttons.D.blink.green = 0\nmain.plugins.buttonshim.buttons.D.blink.blue = 0\nmain.plugins.buttonshim.buttons.D.blink.on_time = 0\nmain.plugins.buttonshim.buttons.D.blink.off_time = 0\nmain.plugins.buttonshim.buttons.D.blink.blink_times = 0\nmain.plugins.buttonshim.buttons.E.command = \"\"\nmain.plugins.buttonshim.buttons.E.blink.enabled = false\nmain.plugins.buttonshim.buttons.E.blink.red = 0\nmain.plugins.buttonshim.buttons.E.blink.green = 0\nmain.plugins.buttonshim.buttons.E.blink.blue = 0\nmain.plugins.buttonshim.buttons.E.blink.on_time = 0\nmain.plugins.buttonshim.buttons.E.blink.off_time = 0\nmain.plugins.buttonshim.buttons.E.blink.blink_times = 0\n\n# Plugin led provides an alternative way to be alerted to events through the built-in LED on the rpi0w without the need of a display.\nmain.plugins.led.enabled = false\nmain.plugins.led.led = 0\nmain.plugins.led.delay = 200\nmain.plugins.led.patterns.loaded = \"\"\nmain.plugins.led.patterns.updating = \"\"\nmain.plugins.led.patterns.ready = \"\"\nmain.plugins.led.patterns.grateful = \"\"\nmain.plugins.led.patterns.lonely = \"\"\nmain.plugins.led.patterns.bored = \"\"\nmain.plugins.led.patterns.sad = \"\"\nmain.plugins.led.patterns.angry = \"\"\nmain.plugins.led.patterns.excited = \"\"\nmain.plugins.led.patterns.rebooting = \"oo oo oo oo oo\"\nmain.plugins.led.patterns.wait = \"\"\nmain.plugins.led.patterns.sleep = \"\"\nmain.plugins.led.patterns.epoch = \"\"\nmain.plugins.led.patterns.bt_connected = \"oo oo oo oo oo\"\nmain.plugins.led.patterns.bt_disconnected = \"oo oo oo oo oo\"\nmain.plugins.led.patterns.plover_boot = \"\"\nmain.plugins.led.patterns.plover_ready = \"oo oo oo oo oo\"\nmain.plugins.led.patterns.plover_quit = \"oo oo oo oo oo\"\nmain.plugins.led.patterns.wifi_connected = \"oo oo oo oo oo\"\nmain.plugins.led.patterns.wifi_disconnected = \"oo oo oo oo oo\"\nmain.plugins.led.patterns.wpm_set = \"\"\nmain.plugins.led.patterns.strokes_set = \"\"\n\n# Plugin memtemp displays CPU temperature and RAM/CPU usage.\nmain.plugins.memtemp.enabled = false\nmain.plugins.memtemp.scale = \"celsius\"\nmain.plugins.memtemp.orientation = \"horizontal\"\n\n# Plugin logtail gives access to the Stenogotchi log through the web UI.\nmain.plugins.logtail.enabled = false\nmain.plugins.logtail.max-lines = 10000\n\nmain.plugins.session-stats.enabled = false\nmain.plugins.session-stats.save_directory = \"/var/tmp/stenogotchi/sessions/\"\n\n# Log\nmain.log.path = \"/var/log/stenogotchi.log\"\nmain.log.rotation.enabled = true\nmain.log.rotation.size = \"10M\"" }, { "path": "stenogotchi/fs/__init__.py", "content": "import os\nimport re\nimport tempfile\nimport contextlib\nimport shutil\nimport _thread\nimport logging\n\nfrom time import sleep\nfrom distutils.dir_util import copy_tree\n\nmounts = list()\n\n\n@contextlib.contextmanager\ndef ensure_write(filename, mode='w'):\n path = os.path.dirname(filename)\n fd, tmp = tempfile.mkstemp(dir=path)\n\n with os.fdopen(fd, mode) as f:\n yield f\n f.flush()\n os.fsync(f.fileno())\n\n os.replace(tmp, filename)\n\n\ndef size_of(path):\n \"\"\"\n Calculate the sum of all the files in path\n \"\"\"\n total = 0\n for root, _, files in os.walk(path):\n for f in files:\n total += os.path.getsize(os.path.join(root, f))\n return total\n\n\ndef is_mountpoint(path):\n \"\"\"\n Checks if path is mountpoint\n \"\"\"\n return os.system(f\"mountpoint -q {path}\") == 0\n\n\ndef setup_mounts(config):\n \"\"\"\n Sets up all the configured mountpoints\n \"\"\"\n global mounts\n fs_cfg = config['fs']['memory']\n if not fs_cfg['enabled']:\n return\n\n for name, options in fs_cfg['mounts'].items():\n if not options['enabled']:\n continue\n logging.debug(\"[FS] Trying to setup mount %s (%s)\", name, options['mount'])\n size,unit = re.match(r\"(\\d+)([a-zA-Z]+)\", options['size']).groups()\n target = os.path.join('/run/stenogotchi/disk/', os.path.basename(options['mount']))\n\n is_mounted = is_mountpoint(target)\n logging.debug(\"[FS] %s is %s mounted\", options['mount'],\n \"already\" if is_mounted else \"not yet\")\n\n m = MemoryFS(\n options['mount'],\n target,\n size=options['size'],\n zram=options['zram'],\n zram_disk_size=f\"{int(size)*2}{unit}\",\n rsync=options['rsync'])\n\n if not is_mounted:\n if not m.mount():\n logging.error(f\"Error while mounting {m.mountpoint}\")\n continue\n\n if not m.sync(to_ram=True):\n logging.error(f\"Error while syncing to {m.mountpoint}\")\n m.umount()\n continue\n\n interval = int(options['sync'])\n if interval:\n logging.debug(\"[FS] Starting thread to sync %s (interval: %d)\",\n options['mount'], interval)\n _thread.start_new_thread(m.daemonize, (interval,))\n else:\n logging.debug(\"[FS] Not syncing %s, because interval is 0\",\n options['mount'])\n\n mounts.append(m)\n\n\nclass MemoryFS:\n @staticmethod\n def zram_install():\n if not os.path.exists(\"/sys/class/zram-control\"):\n logging.debug(\"[FS] Installing zram\")\n return os.system(\"modprobe zram\") == 0\n return True\n\n\n @staticmethod\n def zram_dev():\n logging.debug(\"[FS] Adding zram device\")\n return open(\"/sys/class/zram-control/hot_add\", \"rt\").read().strip(\"\\n\")\n\n\n def __init__(self, mount, disk, size=\"40M\",\n zram=True, zram_alg=\"lz4\", zram_disk_size=\"100M\",\n zram_fs_type=\"ext4\", rsync=True):\n self.mountpoint = mount\n self.disk = disk\n self.size = size\n self.zram = zram\n self.zram_alg = zram_alg\n self.zram_disk_size = zram_disk_size\n self.zram_fs_type = zram_fs_type\n self.zdev = None\n self.rsync = True\n self._setup()\n\n\n def _setup(self):\n if self.zram and MemoryFS.zram_install():\n # setup zram\n self.zdev = MemoryFS.zram_dev()\n open(f\"/sys/block/zram{self.zdev}/comp_algorithm\", \"wt\").write(self.zram_alg)\n open(f\"/sys/block/zram{self.zdev}/disksize\", \"wt\").write(self.zram_disk_size)\n open(f\"/sys/block/zram{self.zdev}/mem_limit\", \"wt\").write(self.size)\n logging.debug(\"[FS] Creating fs (type: %s)\", self.zram_fs_type)\n os.system(f\"mke2fs -t {self.zram_fs_type} /dev/zram{self.zdev} >/dev/null 2>&1\")\n\n # ensure mountpoints exist\n if not os.path.exists(self.disk):\n logging.debug(\"[FS] Creating %s\", self.disk)\n os.makedirs(self.disk)\n\n if not os.path.exists(self.mountpoint):\n logging.debug(\"[FS] Creating %s\", self.mountpoint)\n os.makedirs(self.mountpoint)\n\n\n def daemonize(self, interval=60):\n logging.debug(\"[FS] Daemonized...\")\n while True:\n self.sync()\n sleep(interval)\n\n\n def sync(self, to_ram=False):\n source, dest = (self.disk, self.mountpoint) if to_ram else (self.mountpoint, self.disk)\n needed, actually_free = size_of(source), shutil.disk_usage(dest)[2]\n if actually_free >= needed:\n logging.debug(\"[FS] Syncing %s -> %s\", source,dest)\n if self.rsync:\n os.system(f\"rsync -aXv --inplace --no-whole-file --delete-after {source}/ {dest}/ >/dev/null 2>&1\")\n else:\n copy_tree(source, dest, preserve_symlinks=True)\n os.system(\"sync\")\n return True\n return False\n\n\n def mount(self):\n if os.system(f\"mount --bind {self.mountpoint} {self.disk}\"):\n return False\n\n if os.system(f\"mount --make-private {self.disk}\"):\n return False\n\n if self.zram and self.zdev is not None:\n if os.system(f\"mount -t {self.zram_fs_type} -o nosuid,noexec,nodev,user=stenogotchi /dev/zram{self.zdev} {self.mountpoint}/\"):\n return False\n else:\n if os.system(f\"mount -t tmpfs -o nosuid,noexec,nodev,mode=0755,size={self.size} stenogotchi {self.mountpoint}/\"):\n return False\n\n return True\n\n\n def umount(self):\n if os.system(f\"umount -l {self.mountpoint}\"):\n return False\n\n if os.system(f\"umount -l {self.disk}\"):\n return False\n return True" }, { "path": "stenogotchi/log.py", "content": "import hashlib\nimport time\nimport re\nimport os\nimport logging\nimport shutil\nimport gzip\nimport warnings\nfrom datetime import datetime\n\nfrom stenogotchi.voice import Voice\nfrom file_read_backwards import FileReadBackwards\n\nLAST_SESSION_FILE = '/root/.stenogotchi-last-session'\n\n\nclass LastSession(object):\n START_TOKEN = 'connecting to http'\n\n\n def __init__(self, config):\n self.config = config\n self.voice = Voice(lang=config['main']['lang'])\n self.path = config['main']['log']['path']\n self.last_session = []\n self.last_session_id = ''\n self.last_saved_session_id = ''\n self.duration = ''\n self.duration_human = ''\n\n def _get_last_saved_session_id(self):\n saved = ''\n try:\n with open(LAST_SESSION_FILE, 'rt') as fp:\n saved = fp.read().strip()\n except:\n saved = ''\n return saved\n\n def save_session_id(self):\n with open(LAST_SESSION_FILE, 'w+t') as fp:\n fp.write(self.last_session_id)\n self.last_saved_session_id = self.last_session_id\n\n def _parse_datetime(self, dt):\n dt = dt.split('.')[0]\n dt = dt.split(',')[0]\n dt = datetime.strptime(dt.split('.')[0], '%Y-%m-%d %H:%M:%S')\n return time.mktime(dt.timetuple())\n\n def _parse_stats(self):\n self.duration = ''\n self.duration_human = ''\n\n started_at = None\n stopped_at = None\n cache = {}\n\n for line in self.last_session:\n parts = line.split(']')\n if len(parts) < 2:\n continue\n\n try:\n line_timestamp = parts[0].strip('[')\n line = ']'.join(parts[1:])\n stopped_at = self._parse_datetime(line_timestamp)\n if started_at is None:\n started_at = stopped_at\n except Exception as e:\n logging.error(\"error parsing line '%s': %s\" % (line, e))\n\n if started_at is not None:\n self.duration = stopped_at - started_at\n mins, secs = divmod(self.duration, 60)\n hours, mins = divmod(mins, 60)\n else:\n hours = mins = secs = 0\n\n self.duration = '%02d:%02d:%02d' % (hours, mins, secs)\n self.duration_human = []\n if hours > 0:\n self.duration_human.append('%d %s' % (hours, self.voice.hhmmss(hours, 'h')))\n if mins > 0:\n self.duration_human.append('%d %s' % (mins, self.voice.hhmmss(mins, 'm')))\n if secs > 0:\n self.duration_human.append('%d %s' % (secs, self.voice.hhmmss(secs, 's')))\n\n self.duration_human = ', '.join(self.duration_human)\n\n def parse(self, ui, skip=False):\n if skip:\n logging.debug(\"skipping parsing of the last session logs ...\")\n else:\n logging.debug(\"reading last session logs ...\")\n\n ui.on_reading_logs()\n\n lines = []\n\n if os.path.exists(self.path):\n with FileReadBackwards(self.path, encoding=\"utf-8\") as fp:\n for line in fp:\n line = line.strip()\n if line != \"\" and line[0] != '[':\n continue\n lines.append(line)\n if LastSession.START_TOKEN in line:\n break\n\n lines_so_far = len(lines)\n if lines_so_far % 100 == 0:\n ui.on_reading_logs(lines_so_far)\n\n lines.reverse()\n\n if len(lines) == 0:\n lines.append(\"Initial Session\");\n\n ui.on_reading_logs()\n\n self.last_session = lines\n self.last_session_id = hashlib.md5(lines[0].encode()).hexdigest()\n self.last_saved_session_id = self._get_last_saved_session_id()\n\n logging.debug(\"parsing last session logs (%d lines) ...\" % len(lines))\n\n self._parse_stats()\n self.parsed = True\n\n def is_new(self):\n return self.last_session_id != self.last_saved_session_id\n\n\ndef setup_logging(args, config):\n cfg = config['main']['log']\n filename = cfg['path']\n\n formatter = logging.Formatter(\"[%(asctime)s] [%(levelname)s] %(message)s\")\n root = logging.getLogger()\n\n root.setLevel(logging.DEBUG if args.debug else logging.INFO)\n\n if filename:\n # since python default log rotation might break session data in different files,\n # we need to do log rotation ourselves\n log_rotation(filename, cfg)\n\n file_handler = logging.FileHandler(filename)\n file_handler.setFormatter(formatter)\n root.addHandler(file_handler)\n\n console_handler = logging.StreamHandler()\n console_handler.setFormatter(formatter)\n root.addHandler(console_handler)\n\n\ndef log_rotation(filename, cfg):\n rotation = cfg['rotation']\n if not rotation['enabled']:\n return\n elif not os.path.isfile(filename):\n return\n\n stats = os.stat(filename)\n # specify a maximum size to rotate ( format is 10/10B, 10K, 10M 10G )\n if rotation['size']:\n max_size = parse_max_size(rotation['size'])\n if stats.st_size >= max_size:\n do_rotate(filename, stats, cfg)\n else:\n raise Exception(\"log rotation is enabled but log.rotation.size was not specified\")\n\n\ndef parse_max_size(s):\n parts = re.findall(r'(^\\d+)([bBkKmMgG]?)', s)\n if len(parts) != 1 or len(parts[0]) != 2:\n raise Exception(\"can't parse %s as a max size\" % s)\n\n num, unit = parts[0]\n num = int(num)\n unit = unit.lower()\n\n if unit == 'k':\n return num * 1024\n elif unit == 'm':\n return num * 1024 * 1024\n elif unit == 'g':\n return num * 1024 * 1024 * 1024\n else:\n return num\n\n\ndef do_rotate(filename, stats, cfg):\n base_path = os.path.dirname(filename)\n name = os.path.splitext(os.path.basename(filename))[0]\n archive_filename = os.path.join(base_path, \"%s.gz\" % name)\n counter = 2\n\n while os.path.exists(archive_filename):\n archive_filename = os.path.join(base_path, \"%s-%d.gz\" % (name, counter))\n counter += 1\n\n log_filename = archive_filename.replace('gz', 'log')\n\n print(\"%s is %d bytes big, rotating to %s ...\" % (filename, stats.st_size, log_filename))\n\n shutil.move(filename, log_filename)\n\n print(\"compressing to %s ...\" % archive_filename)\n\n with open(log_filename, 'rb') as src:\n with gzip.open(archive_filename, 'wb') as dst:\n dst.writelines(src)\n" }, { "path": "stenogotchi/plugins/__init__.py", "content": "import os\nimport glob\nimport _thread\nimport threading\nimport importlib, importlib.util\nimport logging\n\n\n\ndefault_path = os.path.join(os.path.dirname(os.path.realpath(__file__)), \"default\")\nloaded = {}\ndatabase = {}\nlocks = {}\n\n\nclass Plugin:\n @classmethod\n def __init_subclass__(cls, **kwargs):\n super().__init_subclass__(**kwargs)\n global loaded, locks\n\n plugin_name = cls.__module__.split('.')[0]\n plugin_instance = cls()\n logging.debug(\"loaded plugin %s as %s\" % (plugin_name, plugin_instance))\n loaded[plugin_name] = plugin_instance\n\n for attr_name in plugin_instance.__dir__():\n if attr_name.startswith('on_'):\n cb = getattr(plugin_instance, attr_name, None)\n if cb is not None and callable(cb):\n locks[\"%s::%s\" % (plugin_name, attr_name)] = threading.Lock()\n\n\ndef toggle_plugin(name, enable=True):\n \"\"\"\n Load or unload a plugin\n returns True if changed, otherwise False\n \"\"\"\n import stenogotchi\n from stenogotchi.ui import view\n from stenogotchi.utils import save_config\n \n global loaded, database\n\n # log event\n if enable:\n logging.debug(f\"enabled plugin '{name}' in config\")\n else:\n logging.debug(f\"disabled plugin '{name}' in config\")\n\n if stenogotchi.config:\n if not name in stenogotchi.config['main']['plugins']:\n stenogotchi.config['main']['plugins'][name] = dict()\n stenogotchi.config['main']['plugins'][name]['enabled'] = enable\n save_config(stenogotchi.config, '/etc/stenogotchi/config.toml')\n\n if not enable and name in loaded:\n if getattr(loaded[name], 'on_unload', None):\n loaded[name].on_unload(view.ROOT)\n del loaded[name]\n\n return True\n\n if enable and name in database and name not in loaded:\n load_from_file(database[name])\n if name in loaded and stenogotchi.config and name in stenogotchi.config['main']['plugins']:\n loaded[name].options = stenogotchi.config['main']['plugins'][name]\n one(name, 'loaded')\n if stenogotchi.config:\n one(name, 'config_changed', stenogotchi.config)\n one(name, 'ui_setup', view.ROOT)\n one(name, 'ready', view.ROOT._agent)\n return True\n\n return False\n\n\ndef on(event_name, *args, **kwargs):\n for plugin_name in loaded.keys():\n one(plugin_name, event_name, *args, **kwargs)\n\n\ndef locked_cb(lock_name, cb, *args, **kwargs):\n global locks\n\n if lock_name not in locks:\n locks[lock_name] = threading.Lock()\n\n with locks[lock_name]:\n cb(*args, *kwargs)\n\n\ndef one(plugin_name, event_name, *args, **kwargs):\n global loaded\n\n if plugin_name in loaded:\n plugin = loaded[plugin_name]\n cb_name = 'on_%s' % event_name\n callback = getattr(plugin, cb_name, None)\n if callback is not None and callable(callback):\n try:\n lock_name = \"%s::%s\" % (plugin_name, cb_name)\n locked_cb_args = (lock_name, callback, *args, *kwargs)\n _thread.start_new_thread(locked_cb, locked_cb_args)\n except Exception as e:\n logging.error(\"error while running %s.%s : %s\" % (plugin_name, cb_name, e))\n logging.error(e, exc_info=True)\n\n\ndef load_from_file(filename):\n logging.debug(\"loading %s\" % filename)\n plugin_name = os.path.basename(filename.replace(\".py\", \"\"))\n spec = importlib.util.spec_from_file_location(plugin_name, filename)\n instance = importlib.util.module_from_spec(spec)\n spec.loader.exec_module(instance)\n return plugin_name, instance\n\n\ndef load_from_path(path, enabled=()):\n global loaded, database\n logging.debug(\"loading plugins from %s - enabled: %s\" % (path, enabled))\n for filename in glob.glob(os.path.join(path, \"*.py\")):\n plugin_name = os.path.basename(filename.replace(\".py\", \"\"))\n database[plugin_name] = filename\n if plugin_name in enabled:\n try:\n load_from_file(filename)\n except Exception as e:\n logging.warning(\"error while loading %s: %s\" % (filename, e))\n logging.debug(e, exc_info=True)\n\n return loaded\n\n\ndef load(config):\n enabled = [name for name, options in config['main']['plugins'].items() if\n 'enabled' in options and options['enabled']]\n \n # force enable buttonshim plugin when web ui is enabled\n logging.debug(f\"REMOVEME pre status : '{enabled}'\")\n if config['ui']['web']['enabled'] and 'buttonshim' not in enabled:\n enabled.append('buttonshim')\n logging.debug(f\"REMOVEME post status : '{enabled}'\")\n\n # load default plugins\n load_from_path(default_path, enabled=enabled)\n\n # load custom ones\n custom_path = config['main']['custom_plugins'] if 'custom_plugins' in config['main'] else None\n if custom_path is not None:\n load_from_path(custom_path, enabled=enabled)\n\n # propagate options\n for name, plugin in loaded.items():\n plugin.options = config['main']['plugins'][name]\n print(\"loaded plugin:\", name, plugin)\n\n on('loaded')\n on('config_changed', config)" }, { "path": "stenogotchi/plugins/cmd.py", "content": "# Handles the commandline stuff\n\nimport os\nimport logging\nimport glob\nimport re\nimport shutil\nfrom fnmatch import fnmatch\nfrom stenogotchi.plugins import default_path\n\n\nSAVE_DIR = '/usr/local/share/stenogotchi/availaible-plugins/'\nDEFAULT_INSTALL_PATH = '/usr/local/share/stenogotchi/installed-plugins/'\n\n\ndef add_parsers(parser):\n \"\"\"\n Adds the plugins subcommand to a given argparse.ArgumentParser\n \"\"\"\n subparsers = parser.add_subparsers()\n ## pwnagotchi plugins\n parser_plugins = subparsers.add_parser('plugins')\n plugin_subparsers = parser_plugins.add_subparsers(dest='plugincmd')\n\n ## pwnagotchi plugins search\n parser_plugins_search = plugin_subparsers.add_parser('search', help='Search for stenogotchi plugins')\n parser_plugins_search.add_argument('pattern', type=str, help=\"Search expression (wildcards allowed)\")\n\n ## pwnagotchi plugins list\n parser_plugins_list = plugin_subparsers.add_parser('list', help='List available stenogotchi plugins')\n parser_plugins_list.add_argument('-i', '--installed', action='store_true', required=False, help='List also installed plugins')\n\n ## pwnagotchi plugins update\n parser_plugins_update = plugin_subparsers.add_parser('update', help='Updates the database')\n\n ## pwnagotchi plugins upgrade\n parser_plugins_upgrade = plugin_subparsers.add_parser('upgrade', help='Upgrades plugins')\n parser_plugins_upgrade.add_argument('pattern', type=str, nargs='?', default='*', help=\"Filter expression (wildcards allowed)\")\n\n ## pwnagotchi plugins enable\n parser_plugins_enable = plugin_subparsers.add_parser('enable', help='Enables a plugin')\n parser_plugins_enable.add_argument('name', type=str, help='Name of the plugin')\n\n ## pwnagotchi plugins disable\n parser_plugins_disable = plugin_subparsers.add_parser('disable', help='Disables a plugin')\n parser_plugins_disable.add_argument('name', type=str, help='Name of the plugin')\n\n ## pwnagotchi plugins install\n parser_plugins_install = plugin_subparsers.add_parser('install', help='Installs a plugin')\n parser_plugins_install.add_argument('name', type=str, help='Name of the plugin')\n\n ## pwnagotchi plugins uninstall\n parser_plugins_uninstall = plugin_subparsers.add_parser('uninstall', help='Uninstalls a plugin')\n parser_plugins_uninstall.add_argument('name', type=str, help='Name of the plugin')\n\n ## pwnagotchi plugins edit\n parser_plugins_edit = plugin_subparsers.add_parser('edit', help='Edit the options')\n parser_plugins_edit.add_argument('name', type=str, help='Name of the plugin')\n\n return parser\n\n\ndef used_plugin_cmd(args):\n \"\"\"\n Checks if the plugins subcommand was used\n \"\"\"\n return hasattr(args, 'plugincmd')\n\n\ndef handle_cmd(args, config):\n \"\"\"\n Parses the arguments and does the thing the user wants\n \"\"\"\n if args.plugincmd == 'update':\n return update(config)\n elif args.plugincmd == 'search':\n args.installed = True # also search in installed plugins\n return list_plugins(args, config, args.pattern)\n elif args.plugincmd == 'install':\n return install(args, config)\n elif args.plugincmd == 'uninstall':\n return uninstall(args, config)\n elif args.plugincmd == 'list':\n return list_plugins(args, config)\n elif args.plugincmd == 'enable':\n return enable(args, config)\n elif args.plugincmd == 'disable':\n return disable(args, config)\n elif args.plugincmd == 'upgrade':\n return upgrade(args, config, args.pattern)\n elif args.plugincmd == 'edit':\n return edit(args, config)\n\n raise NotImplementedError()\n\n\ndef edit(args, config):\n pass\n\n\ndef enable(args, config):\n pass\n\n\ndef disable(args, config):\n pass\n\n\ndef upgrade(args, config, pattern='*'):\n pass\n\ndef list_plugins(args, config, pattern='*'):\n \"\"\"\n Lists the available and installed plugins\n \"\"\"\n installed = _get_installed(config)\n print(installed)\n return 0\n\n\ndef _extract_version(filename):\n \"\"\"\n Extracts the version from a python file\n \"\"\"\n return None\n\n\ndef _get_available():\n \"\"\"\n Get all availaible plugins\n \"\"\"\n return None\n\n\ndef _get_installed(config):\n \"\"\"\n Get all installed plugins\n \"\"\"\n installed = dict()\n search_dirs = [ default_path, config['main']['custom_plugins'] ]\n for search_dir in search_dirs:\n if search_dir:\n for filename in glob.glob(os.path.join(search_dir, \"*.py\")):\n plugin_name = os.path.basename(filename.replace(\".py\", \"\"))\n installed[plugin_name] = filename\n return installed\n\n\ndef uninstall(args, config):\n \"\"\"\n Uninstalls a plugin\n \"\"\"\n return 0\n\n\ndef install(args, config):\n \"\"\"\n Installs the given plugin\n \"\"\"\n return 0\n\n\ndef _analyse_dir(path):\n return None\n\n\ndef update(config):\n \"\"\"\n Updates the database\n \"\"\"\n return 0" }, { "path": "stenogotchi/plugins/default/buttonshim.py", "content": "# ###############################################################\n# Updated 20-03-2021 by Anodynous\n# - Moved all functionality into class to remove dependency on global variables and improve integration with other plugins and core Stenogotchi functionality.\n#\n# Updated 13-01-2021 by Anodynous\n# - Added support for hold action in addition to press.\n# Based on: https://github.com/evilsocket/pwnagotchi-plugins-contrib/blob/master/buttonshim.py\n# which in turn is based on https://github.com/pimoroni/button-shim/commit/143f35b4b56626bd7062bdff3245658af19822b4\n#\n################################################################\n\n\nimport logging\nimport RPi.GPIO as GPIO\nimport subprocess\nimport signal\nimport smbus\nimport time\nfrom threading import Thread\nimport atexit\nfrom colorsys import hsv_to_rgb\n\nimport stenogotchi\nimport stenogotchi.plugins as plugins\n\ntry:\n import queue\nexcept ImportError:\n import Queue as queue\n\nADDR = 0x3f\nLED_DATA = 7\nLED_CLOCK = 6\nREG_INPUT = 0x00\nREG_OUTPUT = 0x01\nREG_POLARITY = 0x02\nREG_CONFIG = 0x03\n\nNUM_BUTTONS = 5\nBUTTON_A = 0\n\"\"\"Button A\"\"\"\nBUTTON_B = 1\n\"\"\"Button B\"\"\"\nBUTTON_C = 2\n\"\"\"Button C\"\"\"\nBUTTON_D = 3\n\"\"\"Button D\"\"\"\nBUTTON_E = 4\n\"\"\"Button E\"\"\"\nNAMES = ['A', 'B', 'C', 'D', 'E']\n\"\"\"Sometimes you want to print the plain text name of the button that's triggered.\nYou can use::\n buttonshim.NAMES[button_index]\nTo accomplish this.\n\"\"\"\n\nERROR_LIMIT = 10\nFPS = 60\nLED_GAMMA = [\n 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,\n 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 2, 2, 2,\n 2, 2, 2, 3, 3, 3, 3, 3, 4, 4, 4, 4, 5, 5, 5, 5,\n 6, 6, 6, 7, 7, 7, 8, 8, 8, 9, 9, 9, 10, 10, 11, 11,\n 11, 12, 12, 13, 13, 13, 14, 14, 15, 15, 16, 16, 17, 17, 18, 18,\n 19, 19, 20, 21, 21, 22, 22, 23, 23, 24, 25, 25, 26, 27, 27, 28,\n 29, 29, 30, 31, 31, 32, 33, 34, 34, 35, 36, 37, 37, 38, 39, 40,\n 40, 41, 42, 43, 44, 45, 46, 46, 47, 48, 49, 50, 51, 52, 53, 54,\n 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70,\n 71, 72, 73, 74, 76, 77, 78, 79, 80, 81, 83, 84, 85, 86, 88, 89,\n 90, 91, 93, 94, 95, 96, 98, 99, 100, 102, 103, 104, 106, 107, 109, 110,\n 111, 113, 114, 116, 117, 119, 120, 121, 123, 124, 126, 128, 129, 131, 132, 134,\n 135, 137, 138, 140, 142, 143, 145, 146, 148, 150, 151, 153, 155, 157, 158, 160,\n 162, 163, 165, 167, 169, 170, 172, 174, 176, 178, 179, 181, 183, 185, 187, 189,\n 191, 193, 194, 196, 198, 200, 202, 204, 206, 208, 210, 212, 214, 216, 218, 220,\n 222, 224, 227, 229, 231, 233, 235, 237, 239, 241, 244, 246, 248, 250, 252, 255]\n\n# The LED is an APA102 driven via the i2c IO expander.\n# We must set and clear the Clock and Data pins\n# Each byte in self._reg_queue represents a snapshot of the pin state\n\n\nclass Handler():\n plugin = None\n def __init__(self, plugin):\n self.press = None\n self.release = None\n\n self.hold = None\n self.hold_time = 0\n\n self.repeat = False\n self.repeat_time = 0\n\n self.t_pressed = 0\n self.t_repeat = 0\n self.hold_fired = False\n self.plugin = plugin\n\n\nclass Buttonshim(plugins.Plugin):\n __author__ = 'gon@o2online.de, Anodynous'\n __version__ = '0.0.2'\n __license__ = 'GPL3'\n __description__ = 'Pimoroni Button Shim GPIO Button and RGB LED support plugin based on the pimoroni-buttonshim-lib and the pwnagotchi-gpio-buttons-plugin'\n\n def __init__(self):\n self._agent = None\n self.running = False\n self.options = dict()\n self._running = False\n self._plover_wpm_meters_enabled = False\n \n self._states = None\n self._bus = None\n self._reg_queue = []\n self._update_queue = []\n self._brightness = 0.5\n self._led_queue = queue.Queue()\n self._t_poll = None\n self._running = False\n self._states = 0b00011111\n self._handlers = [None,None,None,None,None]\n self._button_was_held = False\n\n def on_loaded(self):\n logging.info(\"[buttonshim] GPIO Button plugin loaded.\")\n self.running = True\n self._handlers = [Handler(self) for x in range(NUM_BUTTONS)]\n self.on_press([BUTTON_A, BUTTON_B, BUTTON_C, BUTTON_D, BUTTON_E], self.press_handler)\n self.on_hold([BUTTON_A, BUTTON_B, BUTTON_C, BUTTON_D, BUTTON_E], self.hold_handler)\n self.on_release([BUTTON_A, BUTTON_B, BUTTON_C, BUTTON_D, BUTTON_E], self.release_handler)\n\n def on_config_changed(self, config):\n self.config = config\n\n def on_ready(self, agent):\n self._agent = agent\n\n def set_ui_update(self, key, value):\n self._agent.view().set(key, value)\n\n def trigger_ui_update(self):\n self._agent.view().update()\n\n def _run(self):\n self._running = True\n _last_states = 0b00011111\n _errors = 0\n\n while self._running:\n led_data = None\n\n try:\n led_data = self._led_queue.get(False)\n self._led_queue.task_done()\n\n except queue.Empty:\n pass\n\n try:\n if led_data:\n for chunk in self._chunk(led_data, 32):\n self._bus.write_i2c_block_data(ADDR, REG_OUTPUT, chunk)\n\n self._states = self._bus.read_byte_data(ADDR, REG_INPUT)\n\n except IOError:\n _errors += 1\n if _errors > ERROR_LIMIT:\n self._running = False\n raise IOError(\"More than {} IO errors have occurred!\".format(ERROR_LIMIT))\n\n for x in range(NUM_BUTTONS):\n last = (_last_states >> x) & 1\n curr = (self._states >> x) & 1\n handler = self._handlers[x]\n\n # If last > curr then it's a transition from 1 to 0\n # since the buttons are active low, that's a press event\n if last > curr:\n handler.t_pressed = time.time()\n handler.hold_fired = False\n\n if callable(handler.press):\n handler.t_repeat = time.time()\n Thread(target=handler.press, args=(x, True, handler.plugin)).start()\n\n continue\n\n if last < curr and callable(handler.release):\n Thread(target=handler.release, args=(x, False, handler.plugin)).start()\n continue\n\n if curr == 0:\n if callable(handler.hold) and not handler.hold_fired and (time.time() - handler.t_pressed) > handler.hold_time:\n Thread(target=handler.hold, args=(x,)).start()\n handler.hold_fired = True\n\n if handler.repeat and callable(handler.press) and (time.time() - handler.t_repeat) > handler.repeat_time:\n self._handlers[x].t_repeat = time.time()\n Thread(target=self._handlers[x].press, args=(x, True, handler.plugin)).start()\n\n _last_states = self._states\n\n time.sleep(1.0 / FPS)\n\n\n def _quit(self):\n\n if self._running:\n self._led_queue.join()\n self.set_pixel(0, 0, 0)\n self._led_queue.join()\n\n self._running = False\n self._t_poll.join()\n\n\n def setup(self):\n if self._bus is not None:\n return\n\n try:\n self._bus = smbus.SMBus(1)\n\n self._bus.write_byte_data(ADDR, REG_CONFIG, 0b00011111)\n self._bus.write_byte_data(ADDR, REG_POLARITY, 0b00000000)\n self._bus.write_byte_data(ADDR, REG_OUTPUT, 0b00000000)\n\n self._t_poll = Thread(target=self._run)\n self._t_poll.daemon = True\n self._t_poll.start()\n\n self.set_pixel(0, 0, 0)\n\n atexit.register(self._quit)\n except OSError as ex:\n logging.error(f\"[buttonshim] Ignore if no ButtonSHIM hw module present and web UI enabled: OSError encountered during setup: {ex}\")\n\n\n def _set_bit(self, pin, value):\n if value:\n self._reg_queue[-1] |= (1 << pin)\n else:\n self._reg_queue[-1] &= ~(1 << pin)\n\n\n def _next(self):\n if len(self._reg_queue) == 0:\n self._reg_queue = [0b00000000]\n else:\n self._reg_queue.append(self._reg_queue[-1])\n\n\n def _enqueue(self):\n self._led_queue.put(self._reg_queue)\n\n self._reg_queue = []\n\n\n def _chunk(self, l, n):\n for i in range(0, len(l)+1, n):\n yield l[i:i + n]\n\n\n def _write_byte(self, byte):\n for i in range(8):\n self._next()\n self._set_bit(LED_CLOCK, 0)\n self._set_bit(LED_DATA, byte & 0b10000000)\n self._next()\n self._set_bit(LED_CLOCK, 1)\n byte <<= 1\n\n\n def on_hold(self, buttons, handler=None, hold_time=1):\n \"\"\"Attach a hold handler to one or more buttons.\n\n This handler is fired when you hold a button for hold_time seconds.\n\n When fired it will run in its own Thread.\n\n It will be passed one argument, the button index::\n\n @buttonshim.on_hold(buttonshim.BUTTON_A)\n def handler(button):\n # Your code here\n\n :param buttons: A single button, or a list of buttons\n :param handler: Optional: a function to bind as the handler\n :param hold_time: Optional: the hold time in seconds (default 2)\n\n \"\"\"\n self.setup()\n\n if buttons is None:\n buttons = [BUTTON_A, BUTTON_B, BUTTON_C, BUTTON_D, BUTTON_E]\n\n if isinstance(buttons, int):\n buttons = [buttons]\n\n def attach_handler(handler):\n for button in buttons:\n self._handlers[button].hold = handler\n self._handlers[button].hold_time = hold_time\n\n if handler is not None:\n attach_handler(handler)\n else:\n return attach_handler\n\n\n def on_press(self, buttons, handler=None, repeat=False, repeat_time=0.5):\n \"\"\"Attach a press handler to one or more buttons.\n\n This handler is fired when you press a button.\n\n When fired it will be run in its own Thread.\n\n It will be passed two arguments, the button index and a\n boolean indicating whether the button has been pressed/released::\n\n @buttonshim.on_press(buttonshim.BUTTON_A)\n def handler(button, pressed):\n # Your code here\n\n :param buttons: A single button, or a list of buttons\n :param handler: Optional: a function to bind as the handler\n :param repeat: Optional: Repeat the handler if the button is held\n :param repeat_time: Optional: Time, in seconds, after which to repeat\n\n \"\"\"\n self.setup()\n\n if buttons is None:\n buttons = [BUTTON_A, BUTTON_B, BUTTON_C, BUTTON_D, BUTTON_E]\n\n if isinstance(buttons, int):\n buttons = [buttons]\n\n def attach_handler(handler):\n for button in buttons:\n self._handlers[button].press = handler\n self._handlers[button].repeat = repeat\n self._handlers[button].repeat_time = repeat_time\n\n if handler is not None:\n attach_handler(handler)\n else:\n return attach_handler\n\n\n def on_release(self, buttons=None, handler=None):\n \"\"\"Attach a release handler to one or more buttons.\n\n This handler is fired when you let go of a button.\n\n When fired it will be run in its own Thread.\n\n It will be passed two arguments, the button index and a\n boolean indicating whether the button has been pressed/released::\n\n @buttonshim.on_release(buttonshim.BUTTON_A)\n def handler(button, pressed):\n # Your code here\n\n :param buttons: A single button, or a list of buttons\n :param handler: Optional: a function to bind as the handler\n\n \"\"\"\n self.setup()\n\n if buttons is None:\n buttons = [BUTTON_A, BUTTON_B, BUTTON_C, BUTTON_D, BUTTON_E]\n\n if isinstance(buttons, int):\n buttons = [buttons]\n\n def attach_handler(handler):\n for button in buttons:\n self._handlers[button].release = handler\n\n if handler is not None:\n attach_handler(handler)\n else:\n return attach_handler\n\n\n def set_brightness(self, brightness):\n self.setup()\n\n if not isinstance(brightness, int) and not isinstance(brightness, float):\n raise ValueError(\"Brightness should be an int or float\")\n\n if brightness < 0.0 or brightness > 1.0:\n raise ValueError(\"Brightness should be between 0.0 and 1.0\")\n\n self._brightness = brightness\n\n\n def set_pixel(self, r, g, b):\n \"\"\"Set the Button SHIM RGB pixel\n\n Display an RGB colour on the Button SHIM pixel.\n\n :param r: Amount of red, from 0 to 255\n :param g: Amount of green, from 0 to 255\n :param b: Amount of blue, from 0 to 255\n\n You can use HTML colours directly with hexadecimal notation in Python. EG::\n\n buttonshim.self.set_pixel(0xFF, 0x00, 0xFF)\n\n \"\"\"\n self.setup()\n\n if not isinstance(r, int) or r < 0 or r > 255:\n raise ValueError(\"Argument r should be an int from 0 to 255\")\n\n if not isinstance(g, int) or g < 0 or g > 255:\n raise ValueError(\"Argument g should be an int from 0 to 255\")\n\n if not isinstance(b, int) or b < 0 or b > 255:\n raise ValueError(\"Argument b should be an int from 0 to 255\")\n\n r, g, b = [int(x * self._brightness) for x in (r, g, b)]\n\n self._write_byte(0)\n self._write_byte(0)\n self._write_byte(0b11101111)\n self._write_byte(LED_GAMMA[b & 0xff])\n self._write_byte(LED_GAMMA[g & 0xff])\n self._write_byte(LED_GAMMA[r & 0xff])\n self._write_byte(0)\n self._write_byte(0)\n self._enqueue()\n\n def blink(self, r, g, b, ontime, offtime, blinktimes):\n logging.debug(\"[buttonshim] Blink\")\n for i in range(0, blinktimes):\n self.set_pixel(r, g, b)\n time.sleep(ontime)\n self.set_pixel(0, 0, 0)\n time.sleep(offtime)\n\n def press_handler(self, button, pressed, plugin):\n \"\"\" On press reset button held status \"\"\"\n self._button_was_held = False\n\n def toggle_qwerty_steno(self):\n try:\n cap_state = plugins.loaded['evdevkb'].get_capture_state()\n if not cap_state:\n plugins.loaded['evdevkb'].start_capture()\n logging.info(f\"[buttonshim] Switched to QWERTY mode\")\n else:\n plugins.loaded['evdevkb'].stop_capture()\n logging.info(f\"[buttonshim] Switched to STENO mode\")\n except Exception as ex:\n logging.exception(f\"[buttonshim] Check if evdevkb is loaded, exception: {str(ex)}\")\n \n def toggle_wpm_meters(self):\n command = {}\n try:\n wpm_method = plugins.loaded['plover_link'].options['wpm_method']\n wpm_timeout = plugins.loaded['plover_link'].options['wpm_timeout']\n except Exception as ex:\n logging.exception(f\"[buttonshim] Check that wpm_method and wpm_timeout is configured. Falling back to defaults. Exception: {str(ex)}\")\n wpm_method = 'ncra'\n wpm_timeout = '60'\n\n if self._plover_wpm_meters_enabled:\n command = {'stop_wpm_meter': 'wpm and strokes'}\n self.set_ui_update('wpm', '')\n self.set_ui_update('strokes', '')\n self.trigger_ui_update()\n logging.info(f\"[buttonshim] Disabled WPM readings\")\n\n elif not self._plover_wpm_meters_enabled:\n command = {'start_wpm_meter': 'wpm and strokes',\n 'wpm_method' : wpm_method,\n 'wpm_timeout' : wpm_timeout}\n\n self.set_ui_update('wpm', wpm_method)\n self.set_ui_update('strokes', f\"{wpm_timeout}s\")\n self.trigger_ui_update()\n\n logging.info(f\"[buttonshim] Enabled WPM readings using method {wpm_method} and timeout {wpm_timeout}\")\n\n self._plover_wpm_meters_enabled = not self._plover_wpm_meters_enabled\n plugins.loaded['plover_link'].send_signal_to_plover(command)\n \n def toggle_dictionary_lookup(self):\n if plugins.loaded['dict_lookup'].get_running():\n if not plugins.loaded['dict_lookup'].get_input_mode(): # If not currently enabled, enable input mode\n plugins.loaded['dict_lookup'].enable_input_mode()\n else: # If currently enabled, revert to normal view\n plugins.loaded['dict_lookup'].disable_input_mode()\n else: \n logging.debug(f\"[buttonshim] dict_lookup is not ready yet. Check that Plover is running.\")\n\n def hold_handler(self, button):\n \"\"\" On long press run built in internal Stenogotchi commands \"\"\"\n # Set button held status to prevent release_handler from triggering on release\n self._button_was_held = True\n\n # Blink in response to long hold event\n red = 0\n green = 70\n blue = 70\n on_time = 1\n off_time = 0\n blink_times = 1\n thread = Thread(target=self.blink, args=(red, green, blue, on_time, off_time, blink_times))\n thread.start()\n \n if NAMES[button] == 'A':\n # Toggle QWERTY/STENO mode\n self.toggle_qwerty_steno() \n \n elif NAMES[button] == 'B':\n # Toggle WPM & strokes meters for Plover\n self.toggle_wpm_meters()\n\n elif NAMES[button] == 'C':\n # Toggle dictionary lookup mode\n self.toggle_dictionary_lookup()\n\n elif NAMES[button] == 'D':\n # Toggle wifi on/off\n stenogotchi.set_wifi_onoff()\n # Check for changes in wifi status over a short while\n for i in range(5):\n self._agent._update_wifi()\n time.sleep(2)\n logging.info(f\"[buttonshim] Toggled wifi state\")\n \n elif NAMES[button] == 'E':\n # Initiate clean shutdown process\n logging.info(f\"[buttonshim] Initiated clean shutdown\")\n stenogotchi.shutdown()\n \n def release_handler(self, button, pressed, plugin):\n \"\"\" On short press run command from config \"\"\"\n if not self._button_was_held:\n logging.info(f\"[buttonshim] Button Pressed! Loading command from slot '{button}' for button '{NAMES[button]}'\")\n bCfg = plugin.options['buttons'][NAMES[button]]\n blinkCfg = bCfg['blink']\n logging.debug(f'[buttonshim] {self.blink}')\n if blinkCfg['enabled'] == True:\n logging.debug(f\"[buttonshim] Blinking led\")\n red = int(blinkCfg['red'])\n green = int(blinkCfg['green'])\n blue = int(blinkCfg['blue'])\n on_time = float(blinkCfg['on_time'])\n off_time = float(blinkCfg['off_time'])\n blink_times = int(blinkCfg['blink_times'])\n logging.debug(f\"[buttonshim] red {red} green {green} blue {blue} on_time {on_time} off_time {off_time} blink_times {blink_times}\")\n thread = Thread(target=self.blink, args=(red, green, blue, on_time, off_time, blink_times))\n thread.start()\n logging.debug(f\"[buttonshim] Blink thread started\")\n command = bCfg['command']\n if command == '':\n logging.debug(f\"[buttonshim] Command empty\")\n else:\n logging.debug(f\"[buttonshim] Process create: {command}\")\n process = subprocess.Popen(command, shell=True, stdin=None, stdout=open(\"/dev/null\", \"w\"), stderr=None, executable=\"/bin/bash\")\n process.wait()\n process = None\n logging.debug(f\"[buttonshim] Process end\")\n" }, { "path": "stenogotchi/plugins/default/dict_lookup.py", "content": "#!/usr/bin/env python3\n\nimport logging\nimport time\nimport random\n\nimport stenogotchi.plugins as plugins\nfrom stenogotchi.ui.components import LabeledValue, Text, Line\nfrom stenogotchi.ui.view import BLACK\nfrom stenogotchi.ui import view, state, faces\nimport stenogotchi.ui.fonts as fonts\n\nclass UiHandler():\n def __init__(self, agent):\n self.clear_elements = ('name', 'ups', 'wpm', 'status', 'strokes', 'uptime', 'line1')\n self.input_mode = False\n self._agent = agent\n self._view = view.ROOT\n self._stored_state = state.State()\n self.minion_font = fonts.ImageFont.truetype(\"%s-Bold\" % fonts.FONT_NAME, 18)\n self.minion_offset = 65\n \n def store_state(self):\n for key, element in self._view._state.items():\n if key in self.clear_elements or key == 'face':\n self._stored_state.add_element(key, element)\n \n def restore_state(self):\n # Add all removed items back\n for key, element in self._stored_state.items():\n if key in self.clear_elements:\n self.add_element(key, element)\n\n def surprise_exit(self):\n if not self._view.get('face') == faces.LOOK_L:\n self._view.set('face', faces.LOOK_L)\n self.update_view()\n time.sleep(1)\n self._view.set('face', faces.LOOK_R)\n self.update_view()\n time.sleep(1)\n \n def relocate_face(self, minion):\n self.remove_element('face')\n if minion:\n # Shrink and relocate\n face = random.choices((faces.LOOK_L_HAPPY, faces.LOOK_L), weights=(0.9, 0.10), k=1)\n self.add_element('face', Text(value=face[0], position=((self._view._width - self.minion_offset + 2), 0), color=BLACK, font=self.minion_font))\n else:\n # Grow and relocate, state doesn't matter as we will update it before view refresh\n self.add_element('face', self._stored_state._state['face'])\n\n def check_element(self, key):\n return self._view.has_element(key)\n\n def remove_element(self, key):\n try:\n self._view.remove_element(key)\n except KeyError:\n # TODO: fix self._view.has_element to replace this. Always seems to return None right now.\n logging.error(f\"[dict_lookup] No element '{key}' available for removal\")\n\n def add_element(self, key, element):\n self._view.add_element(key, element)\n\n def update_view(self):\n self._view.update()\n\n def enable_input_mode(self):\n # Storing current state\n self.store_state()\n # Removing elements we will be overlapping and block them from triggering ui updates \n for element in self.clear_elements:\n self.remove_element(element)\n # Block update of ui elements we removed\n self._view._ignore_changes = self.clear_elements\n # Shrink stenogotchi face\n self.relocate_face(minion=True)\n # Add new ui elements for input and output \n line1_offset = self._view._layout['line1'].copy()\n line1_offset[2] = self._view._width - self.minion_offset\n self.add_element('input', LabeledValue(color=BLACK, label='', value='', position=(0, 0) , label_font=fonts.Bold, text_font=fonts.Medium, max_length=29))\n self.add_element('line1_offset', Line(line1_offset, color=BLACK))\n self.add_element('out1', Text(value='', position=self._agent._view._layout['name'], color=BLACK, font=fonts.Bold, wrap=True, max_length=self._agent._view._layout['status']['max']-1))\n self.add_element('out2', Text(value='', position=self._agent._view._layout['status']['pos'], color=BLACK, font=self._agent._view._layout['status']['font'], wrap=True, max_length=self._agent._view._layout['status']['max']))\n self.input_mode = True\n # Used instead of self.update_view() to indicate input position from the start\n self.display_input(\"\")\n logging.info(\"[dict_lookup] Enabled dictionary lookup mode\")\n\n def disable_input_mode(self):\n # Add some variety to the exit\n if random.randint(0, 9) > 7:\n self.surprise_exit()\n self._view.remove_element('line1_offset')\n self._view.remove_element('input')\n self._view.remove_element('out1')\n self._view.remove_element('out2')\n # Restore removed elements\n self.restore_state()\n # Grow stenogotchi face\n self.relocate_face(minion=False)\n # revert default update-ignore state\n if self._view._config['ui']['fps'] > 0.0:\n self._view._ignore_changes = ()\n else:\n self._view._ignore_changes = ('uptime', 'name')\n # Prepare new empty state object\n self._stored_state = state.State()\n # Refresh uptime, set return message which will trigger ui update\n self._agent._update_uptime()\n self._agent.set_on_dict_lookup_done()\n \n self.input_mode = False\n logging.info(\"[dict_lookup] Disabled dictionary lookup mode\")\n\n def get_input_mode(self):\n return self.input_mode\n\n def display_output(self, list):\n if self.get_input_mode():\n out1_str = \"\"\n out2_str = \"\"\n \n #TODO: handle list items longer than max supported length for column\n cnt = 0\n for item in list:\n if cnt < 6: # lines 0-5 fit in first column\n out1_str += f\"{item}\\n\"\n elif cnt < 13: # lines 6-11 fit in second column\n out2_str += f\"{item}\\n\"\n else:\n break # no more room\n cnt += 1\n\n self._view.set('out1', out1_str)\n self._view.set('out2', out2_str)\n self.update_view()\n\n def display_input(self, string, position_indicator=\"_\"):\n if self.get_input_mode():\n string += position_indicator # Character added to highlight input position\n self._agent._view.set('input', string)\n self.update_view()\n\n\nclass InputHandler():\n # TODO: Add support for evdevkb as input device\n def __init__(self, agent):\n self._agent = agent\n self.input_mode = False\n self._input = \"\"\n \n def _on_send_string(self, text: str):\n # If enter key received\n if text in ('\\n', '\\r', '\\r\\n'):\n if plugins.loaded['dict_lookup'].get_input_mode():\n self._input += \" \"\n self.push_input(position_indicator=\"\")\n plugins.loaded['dict_lookup'].lookup_word(self._input)\n else:\n self._input += text\n self.push_input()\n\n def _on_send_backspaces(self, count: int):\n if count >= len(self._input):\n self.clear_input()\n else:\n self._input = self._input[:-count]\n self.push_input()\n\n def _on_send_key_combination(self, combination: str):\n if combination == 'Control_L(BackSpace)':\n self.clear_input()\n else:\n logging.warning(f\"[dict_lookup] Key-combinations not supported. Input '{combination}' ignored\")\n \n def _on_lookup_results(self, results_list):\n # logging.debug(f\"[dict_lookup] Lookup result from Plover '{results_list}'\")\n plugins.loaded['dict_lookup'].display_lookup_result(results_list)\n\n def enable_input_mode(self):\n # TODO: trigger routing from evdevkb to here\n command = {'output_to_stenogotchi': True}\n plugins.loaded['plover_link'].send_signal_to_plover(command)\n self.input_mode = True\n\n def disable_input_mode(self):\n # TODO: revert routing from evdevkb to btclient\n command = {'output_to_stenogotchi': False}\n plugins.loaded['plover_link'].send_signal_to_plover(command)\n self.input_mode = False\n\n def push_input(self, position_indicator=\"_\"):\n plugins.loaded['dict_lookup'].push_input(self._input, position_indicator)\n\n def clear_input(self):\n self._input = \"\"\n self.push_input()\n\n\nclass DictLookup(plugins.Plugin):\n __autohor__ = 'Anodynous'\n __version__ = '0.3'\n __license__ = 'GPL3'\n __description__ = 'This plugin enables looking up words and strokes in enabled plover dictionaries'\n\n def __init__(self):\n self._agent = None\n self.config = None\n self.running = False\n self.input_mode = False\n self.input_handler = None \n self.ui_handler = None\n\n def on_plover_ready(self, agent):\n self._agent = agent\n self.ui_handler = UiHandler(agent)\n self.input_handler = InputHandler(agent)\n self.running = True\n\n def on_config_changed(self, config):\n self.config = config\n \n def on_unload(self, ui):\n self.lookup = None\n self.ui_handler = None\n\n def get_running(self):\n return self.running\n\n def get_input_mode(self):\n return self.input_mode\n\n def enable_input_mode(self):\n self.ui_handler.enable_input_mode()\n self.input_handler.enable_input_mode()\n self.input_mode = True\n\n def disable_input_mode(self):\n self.ui_handler.disable_input_mode()\n self.input_handler.disable_input_mode()\n self.input_handler.clear_input()\n self.input_mode = False\n\n def lookup_word(self, word):\n # Remove leading/trailing whitespaces and send word to plover for dictionary lookup\n word = word.strip()\n command = {'lookup_word': word}\n plugins.loaded['plover_link'].send_signal_to_plover(command)\n\n def lookup_stroke(self, stroke):\n # Remove leading/trailing whitespaces and send stroke to plover for dictionary lookup\n # TODO: implement functionality to use stroke-lookup\n stroke = stroke.strip()\n logging.debug(f\"[dict_lookup] Looking up stroke '{stroke}'\")\n command = {'lookup_word': stroke}\n plugins.loaded['plover_link'].send_signal_to_plover(command)\n \n def display_lookup_result(self, results_list):\n self.push_output(results_list)\n\n def sort_list(self, rlist):\n # Sorts the results in ascending order.\n # Primary sorting key: number of chords\n # Secondary sorting key: length of chord(combination)\n sort_key = lambda k : (k.count('/'), len(k))\n rlist_sorted = []\n if len(rlist) < 2:\n return rlist\n else:\n rlist_sorted = sorted(rlist, key=sort_key)\n return rlist_sorted\n\n def push_input(self, string=\"\", position_indicator=\"_\"):\n if self.input_mode:\n self.ui_handler.display_input(string, position_indicator)\n \n def push_output(self, rlist):\n if self.input_mode:\n if rlist:\n rlist_sorted = self.sort_list(rlist)\n else:\n rlist_sorted = []\n self.ui_handler.display_output(rlist_sorted) \n \nif __name__ == '__main__':\n print(\"Please enable and run as Stenogotchi plugin\")" }, { "path": "stenogotchi/plugins/default/evdevkb.py", "content": "\"\"\"\nEvdev based keyboard client for capturing input and relays the keypress to a Bluetooth HID keyboard emulator D-BUS Service\n\nBased on: https://gist.github.com/ukBaz/a47e71e7b87fbc851b27cde7d1c0fcf0#file-readme-md\nWhich in turn takes the original idea from: http://yetanotherpointlesstechblog.blogspot.com/2016/04/emulating-bluetooth-keyboard-with.html\n\nTested on:\n Python 3.7 (needs 3.4+)\n Evdev 1.3.0\n\"\"\"\n\nimport logging\nimport evdev\nfrom select import select\nfrom time import sleep\n\nif not __name__ == '__main__':\n import stenogotchi.plugins as plugins\n ObjectClass = plugins.Plugin\nelse:\n import dbus\n ObjectClass = object\n\nHID_DBUS = 'com.github.stenogotchi'\nHID_SRVC = '/com/github/stenogotchi'\n\nKEYTABLE = {\n \"KEY_RESERVED\": 0,\n \"KEY_ESC\": 41,\n \"KEY_1\": 30,\n \"KEY_2\": 31,\n \"KEY_3\": 32,\n \"KEY_4\": 33,\n \"KEY_5\": 34,\n \"KEY_6\": 35,\n \"KEY_7\": 36,\n \"KEY_8\": 37,\n \"KEY_9\": 38,\n \"KEY_0\": 39,\n \"KEY_MINUS\": 45,\n \"KEY_EQUAL\": 46,\n \"KEY_BACKSPACE\": 42,\n \"KEY_TAB\": 43,\n \"KEY_Q\": 20,\n \"KEY_W\": 26,\n \"KEY_E\": 8,\n \"KEY_R\": 21,\n \"KEY_T\": 23,\n \"KEY_Y\": 28,\n \"KEY_U\": 24,\n \"KEY_I\": 12,\n \"KEY_O\": 18,\n \"KEY_P\": 19,\n \"KEY_LEFTBRACE\": 47,\n \"KEY_RIGHTBRACE\": 48,\n \"KEY_ENTER\": 40,\n \"KEY_LEFTCTRL\": 224,\n \"KEY_A\": 4,\n \"KEY_S\": 22,\n \"KEY_D\": 7,\n \"KEY_F\": 9,\n \"KEY_G\": 10,\n \"KEY_H\": 11,\n \"KEY_J\": 13,\n \"KEY_K\": 14,\n \"KEY_L\": 15,\n \"KEY_SEMICOLON\": 51,\n \"KEY_APOSTROPHE\": 52,\n \"KEY_GRAVE\": 53,\n \"KEY_LEFTSHIFT\": 225,\n \"KEY_BACKSLASH\": 50,\n \"KEY_Z\": 29,\n \"KEY_X\": 27,\n \"KEY_C\": 6,\n \"KEY_V\": 25,\n \"KEY_B\": 5,\n \"KEY_N\": 17,\n \"KEY_M\": 16,\n \"KEY_COMMA\": 54,\n \"KEY_DOT\": 55,\n \"KEY_SLASH\": 56,\n \"KEY_RIGHTSHIFT\": 229,\n \"KEY_KPASTERISK\": 85,\n \"KEY_LEFTALT\": 226,\n \"KEY_SPACE\": 44,\n \"KEY_CAPSLOCK\": 57,\n \"KEY_F1\": 58,\n \"KEY_F2\": 59,\n \"KEY_F3\": 60,\n \"KEY_F4\": 61,\n \"KEY_F5\": 62,\n \"KEY_F6\": 63,\n \"KEY_F7\": 64,\n \"KEY_F8\": 65,\n \"KEY_F9\": 66,\n \"KEY_F10\": 67,\n \"KEY_NUMLOCK\": 83,\n \"KEY_SCROLLLOCK\": 71,\n \"KEY_KP7\": 95,\n \"KEY_KP8\": 96,\n \"KEY_KP9\": 97,\n \"KEY_KPMINUS\": 86,\n \"KEY_KP4\": 92,\n \"KEY_KP5\": 93,\n \"KEY_KP6\": 94,\n \"KEY_KPPLUS\": 87,\n \"KEY_KP1\": 89,\n \"KEY_KP2\": 90,\n \"KEY_KP3\": 91,\n \"KEY_KP0\": 98,\n \"KEY_KPDOT\": 99,\n \"KEY_ZENKAKUHANKAKU\": 148,\n \"KEY_102ND\": 100,\n \"KEY_F11\": 68,\n \"KEY_F12\": 69,\n \"KEY_RO\": 135,\n \"KEY_KATAKANA\": 146,\n \"KEY_HIRAGANA\": 147,\n \"KEY_HENKAN\": 138,\n \"KEY_KATAKANAHIRAGANA\": 136,\n \"KEY_MUHENKAN\": 139,\n \"KEY_KPJPCOMMA\": 140,\n \"KEY_KPENTER\": 88,\n \"KEY_RIGHTCTRL\": 228,\n \"KEY_KPSLASH\": 84,\n \"KEY_SYSRQ\": 70,\n \"KEY_RIGHTALT\": 230,\n \"KEY_HOME\": 74,\n \"KEY_UP\": 82,\n \"KEY_PAGEUP\": 75,\n \"KEY_LEFT\": 80,\n \"KEY_RIGHT\": 79,\n \"KEY_END\": 77,\n \"KEY_DOWN\": 81,\n \"KEY_PAGEDOWN\": 78,\n \"KEY_INSERT\": 73,\n \"KEY_DELETE\": 76,\n \"KEY_MUTE\": 239,\n \"KEY_VOLUMEDOWN\": 238,\n \"KEY_VOLUMEUP\": 237,\n \"KEY_POWER\": 102,\n \"KEY_KPEQUAL\": 103,\n \"KEY_PAUSE\": 72,\n \"KEY_KPCOMMA\": 133,\n \"KEY_HANGEUL\": 144,\n \"KEY_HANJA\": 145,\n \"KEY_YEN\": 137,\n \"KEY_LEFTMETA\": 227,\n \"KEY_RIGHTMETA\": 231,\n \"KEY_COMPOSE\": 101,\n \"KEY_STOP\": 243,\n \"KEY_AGAIN\": 121,\n \"KEY_PROPS\": 118,\n \"KEY_UNDO\": 122,\n \"KEY_FRONT\": 119,\n \"KEY_COPY\": 124,\n \"KEY_OPEN\": 116,\n \"KEY_PASTE\": 125,\n \"KEY_FIND\": 244,\n \"KEY_CUT\": 123,\n \"KEY_HELP\": 117,\n \"KEY_CALC\": 251,\n \"KEY_SLEEP\": 248,\n \"KEY_WWW\": 240,\n \"KEY_COFFEE\": 249,\n \"KEY_BACK\": 241,\n \"KEY_FORWARD\": 242,\n \"KEY_EJECTCD\": 236,\n \"KEY_NEXTSONG\": 235,\n \"KEY_PLAYPAUSE\": 232,\n \"KEY_PREVIOUSSONG\": 234,\n \"KEY_STOPCD\": 233,\n \"KEY_REFRESH\": 250,\n \"KEY_EDIT\": 247,\n \"KEY_SCROLLUP\": 245,\n \"KEY_SCROLLDOWN\": 246,\n \"KEY_F13\": 104,\n \"KEY_F14\": 105,\n \"KEY_F15\": 106,\n \"KEY_F16\": 107,\n \"KEY_F17\": 108,\n \"KEY_F18\": 109,\n \"KEY_F19\": 110,\n \"KEY_F20\": 111,\n \"KEY_F21\": 112,\n \"KEY_F22\": 113,\n \"KEY_F23\": 114,\n \"KEY_F24\": 115\n}\n\n# Map modifier keys to array element in the bit array\nMODKEYS = {\n \"KEY_RIGHTMETA\": 0,\n \"KEY_RIGHTALT\": 1,\n \"KEY_RIGHTSHIFT\": 2,\n \"KEY_RIGHTCTRL\": 3,\n \"KEY_LEFTMETA\": 4,\n \"KEY_LEFTALT\": 5,\n \"KEY_LEFTSHIFT\": 6,\n \"KEY_LEFTCTRL\": 7\n}\n\nclass EvdevKbrd:\n \"\"\"\n Take the events from a physically attached keyboard and send the\n HID messages to the keyboard D-Bus server.\n \"\"\"\n def __init__(self, skip_dbus = False):\n self._skip_dbus = skip_dbus\n self.do_capture = False\n self.keytable = KEYTABLE\n self.modkeys = MODKEYS\n self.target_length = 6\n self.mod_keys = 0b00000000\n self.pressed_keys = []\n self.have_kb = False\n self.devs = None\n if self._skip_dbus:\n self.bus = None\n self.btkobject = None\n self.btk_service = None\n else:\n self.bus = dbus.SystemBus()\n self.btkobject = self.bus.get_object(HID_DBUS, HID_SRVC)\n self.btk_service = dbus.Interface(self.btkobject, HID_DBUS)\n \n def convert(self, evdev_keycode):\n return self.keytable[evdev_keycode]\n\n def modkey(self, evdev_keycode):\n if evdev_keycode in self.modkeys:\n return self.modkeys[evdev_keycode]\n else:\n return -1 # Return an invalid array element\n \n def set_do_capture(self, toggle):\n self.do_capture = toggle\n\n def grab(self):\n # Make input device unavailable for other applications\n for dev in self.devs:\n dev.grab()\n\n def ungrab(self):\n # Release input device for other applications\n for dev in self.devs:\n dev.ungrab()\n \n def get_input_devices(self):\n # Returns all input devices connected to device\n input_devices = [evdev.InputDevice(path) for path in evdev.list_devices()]\n return input_devices\n\n def get_keyboards(self):\n # Returns all input devices that look like keyboards that are connected to device\n input_devices = self.get_input_devices()\n keyboards = []\n for device in input_devices:\n # Check if the input device has a KEY_A\n has_key_a = evdev.ecodes.KEY_A in device.capabilities().get(evdev.ecodes.EV_KEY, [])\n if has_key_a:\n keyboards.append(device)\n logging.debug(f\"[evdevkb] Found keyboard '{device.name}' at path '{device.path}'\")\n return keyboards\n \n def set_keyboards(self):\n # Sets all keyboards as device to listen for key-inputs from\n while not self.have_kb:\n if not self.do_capture:\n break\n keyboards = self.get_keyboards()\n if keyboards:\n self.devs = keyboards\n self.have_kb = True\n else:\n logging.debug('[evdevkb] Keyboard not found, waiting 3 seconds and retrying')\n sleep(3)\n\n def update_mod_keys(self, mod_key, value):\n \"\"\"\n Which modifier keys are active is stored in an 8 bit number.\n Each bit represents a different key. This method takes which bit\n and its new value as input\n :param mod_key: The value of the bit to be updated with new value\n :param value: Binary 1 or 0 depending if pressed or released\n \"\"\"\n bit_mask = 1 << (7-mod_key)\n if value: # set bit\n self.mod_keys |= bit_mask\n else: # clear bit\n self.mod_keys &= ~bit_mask\n\n def update_keys(self, norm_key, value):\n if value < 1:\n self.pressed_keys.remove(norm_key)\n elif norm_key not in self.pressed_keys:\n self.pressed_keys.insert(0, norm_key)\n len_delta = self.target_length - len(self.pressed_keys)\n if len_delta < 0:\n self.pressed_keys = self.pressed_keys[:len_delta]\n elif len_delta > 0:\n self.pressed_keys.extend([0] * len_delta)\n\n @property\n def state(self):\n \"\"\"\n property with the HID message to send for the current keys pressed\n on the keyboards\n :return: bytes of HID message\n \"\"\"\n return [0xA1, 0x01, self.mod_keys, 0, *self.pressed_keys]\n\n def send_keys(self):\n # If ran as part of Stenogotchi, communicate directly with plugin\n if self._skip_dbus:\n plugins.loaded['plover_link']._stenogotchiservice.send_keys([self.state])\n # If ran as stand-alone, assume dbus is needed to access send_keys() function\n else:\n self.btk_service.send_keys(self.state)\n\n def event_loop(self):\n \"\"\"\n Reads keypresses from all identified keyboards and sends them to emulated \n bluetooth HID as long as do_capture is True.\n \"\"\"\n self.do_capture = True\n self.grab()\n \n while self.do_capture:\n r, w, x = select(self.devs, [], [], 0.01) # 0.1 is default\n for fd in r:\n for event in fd.read():\n # We only want up/down key-events\n if event.type == evdev.ecodes.EV_KEY and event.value < 2:\n key_str = evdev.ecodes.KEY[event.code]\n mod_key = self.modkey(key_str)\n if mod_key > -1:\n self.update_mod_keys(mod_key, event.value)\n else:\n self.update_keys(self.convert(key_str), event.value)\n self.send_keys()\n self.ungrab()\n for dev in self.devs:\n dev.close()\n\n\nclass EvdevKeyboard(ObjectClass):\n __autohor__ = 'Anodynous'\n __version__ = '0.2'\n __license__ = 'MIT'\n __description__ = 'This plugin captures and blocks keypress events using evdev and sends to module emulating bluetooth HID device.'\n\n def __init__(self):\n self._agent = None\n self.evdevkb = None\n self.do_capture = False\n \n def on_ready(self, agent):\n self._agent = agent\n\n def on_config_changed(self, config):\n self.config = config\n\n def trigger_ui_update(self, input_mode):\n self._agent.view().set('mode', input_mode)\n self._agent.view().update()\n\n def start_capture(self):\n logging.info('[evdevkb] Capturing evdev keypress events...')\n self.trigger_ui_update('QWERTY')\n self.evdevkb = EvdevKbrd(skip_dbus=True)\n self.evdevkb.set_do_capture(True)\n self.do_capture = True\n self.evdevkb.set_keyboards()\n self.evdevkb.event_loop()\n\n def stop_capture(self):\n logging.info('[evdevkb] Ignoring evdev keypress events...')\n self.evdevkb.set_do_capture(False)\n self.do_capture = False\n self.evdevkb = None\n self.trigger_ui_update('STENO')\n \n def get_capture_state(self):\n return self.do_capture\n\nif __name__ == '__main__':\n try:\n print('Setting up keyboard')\n kb = EvdevKbrd()\n\n print('starting event loop')\n kb.set_keyboards()\n kb.event_loop()\n except RuntimeError: pass # Handling for bug in evdev 1.3.0, see https://github.com/gvalkov/python-evdev/issues/120\n\n" }, { "path": "stenogotchi/plugins/default/example.py", "content": "# ###############################################################\n# Based on: https://github.com/evilsocket/pwnagotchi/blob/master/pwnagotchi/plugins/default/example.py\n#\n# Changed 22-03-2021 by Anodynous\n# - Changed to fit Stenogotchi events\n#\n################################################################\n\nimport logging\n\nimport stenogotchi.plugins as plugins\nfrom stenogotchi.ui.components import LabeledValue\nfrom stenogotchi.ui.view import BLACK\nimport stenogotchi.ui.fonts as fonts\n\n\nclass Example(plugins.Plugin):\n __author__ = 'evilsocket@gmail.com, Anodynous'\n __version__ = '1.0.0'\n __license__ = 'GPL3'\n __description__ = 'An example plugin for pwnagotchi that implements all the available callbacks.'\n\n def __init__(self):\n logging.debug(\"[example] example plugin created\")\n\n # called when http://:/plugins// is called\n # must return a html page\n # IMPORTANT: If you use \"POST\"s, add a csrf-token (via csrf_token() and render_template_string)\n def on_webhook(self, path, request):\n logging.info(\"[example] webhook established\")\n\n # called when the plugin is loaded\n def on_loaded(self):\n logging.warning(\"[example] WARNING: this plugin should be disabled! options = \" % self.options)\n\n # called before the plugin is unloaded\n def on_unload(self, ui):\n logging.info(\"[example] is unloaded\")\n\n # called hen there's internet connectivity\n def on_internet_available(self, agent):\n logging.info(\"[example] unit has internet connection\")\n\n # called to setup the ui elements\n def on_ui_setup(self, ui):\n # add custom UI elements\n ui.add_element('ups', LabeledValue(color=BLACK, label='UPS', value='0%/0V', position=(ui.width() / 2 - 25, 0),\n label_font=fonts.Bold, text_font=fonts.Medium))\n\n # called when the ui is updated\n def on_ui_update(self, ui):\n # update those elements\n some_voltage = 0.1\n some_capacity = 100.0\n ui.set('ups', \"%4.2fV/%2i%%\" % (some_voltage, some_capacity))\n\n # called when the hardware display setup is done, display is an hardware specific object\n def on_display_setup(self, display):\n logging.info(\"[example] unit has set up display\")\n\n # called when everything is ready and the main loop is about to start\n def on_ready(self, agent):\n logging.info(\"[example] unit is ready\")\n # you can run custom bettercap commands if you want\n # agent.run('ble.recon on')\n # or set a custom state\n # agent.set_bored()\n\n # called when the status is set to grateful\n def on_grateful(self, agent):\n logging.info(\"[example] unit is grateful\")\n\n # called when the status is set to lonely\n def on_lonely(self, agent):\n logging.info(\"[example] unit is lonely\")\n\n # called when the status is set to bored\n def on_bored(self, agent):\n logging.info(\"[example] unit is bored\")\n\n # called when the status is set to sad\n def on_sad(self, agent):\n logging.info(\"[example] unit is sad\")\n\n # called when the status is set to angry\n def on_angry(self, agent):\n logging.info(\"[example] unit is angry\")\n\n # called when the status is set to excited\n def on_excited(self, agent):\n logging.info(\"[example] unit is excited\")\n\n # called when the agent is rebooting the board\n def on_rebooting(self, agent):\n logging.info(\"[example] unit is rebooting\")\n\n # called when the agent is waiting for t seconds\n def on_wait(self, agent, t):\n logging.info(f\"[example] unit is waiting {t} seconds\")\n\n # called when the agent is sleeping for t seconds\n def on_sleep(self, agent, t):\n logging.info(f\"[example] unit is sleeping {t} seconds\")\n\n # called when an epoch is over (where an epoch is a single loop of the main algorithm)\n def on_epoch(self, agent, epoch, epoch_data):\n logging.info(f\"[example] epoch is over\")\n\n # called when successfully connected to a bluetooth host\n def on_bt_connected(self, agent, bthost_name):\n logging.info(f\"[example] unit connected to bluetooth host '{bthost_name}'\")\n\n # called when disconnected from bluetooth host\n def on_bt_disconnected(self, agent):\n logging.info(\"[example] unit disconnected from bluetooth host\")\n\n # called when plover boots\n def on_plover_boot(self, agent):\n logging.info(\"[example] Plover is starting up\")\n\n # called when plover is ready\n def on_plover_ready(self, agent):\n logging.info(\"[example] Plover is ready\")\n\n # called when plover quits\n def on_plover_quit(self, agent):\n logging.info(\"[example] Plover has quit\")\n\n # called when wifi is connected\n def on_wifi_connected(self, agent, ssid, ip):\n logging.info(f\"[example] unit is connected to wifi '{ssid}' using ip '{ip}'\")\n\n # called when wifi is disconnected\n def on_wifi_disconnected(self, agent):\n logging.info(\"[example] unit is disconnected from wifi\")\n\n # called when wpm stats are updated\n def on_wpm_stats(self, agent):\n logging.info(\"[example] unit received new WPM stats\")\n\n # called when wpm-strokes stats are updated\n def on_strokes_stats(self, agent):\n logging.info(\"[example] unit received new WPM-strokes stats\")" }, { "path": "stenogotchi/plugins/default/led.py", "content": "# ###############################################################\n# Based on: https://github.com/evilsocket/pwnagotchi/blob/master/pwnagotchi/plugins/default/led.py\n#\n# Changed 22-03-2021 by Anodynous\n# - Changed to fit Stenogotchi events\n#\n################################################################\n\nfrom threading import Event\nimport _thread\nimport logging\nimport time\n\nimport stenogotchi.plugins as plugins\n\n\nclass Led(plugins.Plugin):\n __author__ = 'evilsocket@gmail.com, Anodynous'\n __version__ = '1.0.0'\n __license__ = 'GPL3'\n __description__ = 'This plugin blinks the PWR led with different patterns depending on the event.'\n\n def __init__(self):\n self._is_busy = False\n self._event = Event()\n self._event_name = None\n self._led_file = \"/sys/class/leds/led0/brightness\"\n self._delay = 200\n\n # called when the plugin is loaded\n def on_loaded(self):\n self._led_file = \"/sys/class/leds/led%d/brightness\" % self.options['led']\n self._delay = int(self.options['delay'])\n\n logging.info(\"[led] plugin loaded for %s\" % self._led_file)\n self._on_event('loaded')\n _thread.start_new_thread(self._worker, ())\n\n def on_config_changed(self, config):\n self.config = config\n\n def _on_event(self, event):\n if not self._is_busy:\n self._event_name = event\n self._event.set()\n logging.debug(\"[led] event '%s' set\", event)\n else:\n logging.debug(\"[led] skipping event '%s' because the worker is busy\", event)\n\n def _led(self, on):\n with open(self._led_file, 'wt') as fp:\n fp.write(str(on))\n\n def _blink(self, pattern):\n logging.debug(\"[led] using pattern '%s' ...\" % pattern)\n for c in pattern:\n if c == ' ':\n self._led(1)\n else:\n self._led(0)\n time.sleep(self._delay / 1000.0)\n # reset\n self._led(0)\n\n def _worker(self):\n while True:\n self._event.wait()\n self._event.clear()\n self._is_busy = True\n\n try:\n if self._event_name in self.options['patterns']:\n pattern = self.options['patterns'][self._event_name]\n self._blink(pattern)\n else:\n logging.debug(\"[led] no pattern defined for %s\" % self._event_name)\n except Exception as e:\n logging.exception(\"[led] error while blinking\")\n\n finally:\n self._is_busy = False\n\n # called when the unit is updating its software\n def on_updating(self):\n self._on_event('updating')\n\n # called when there's internet connectivity\n def on_internet_available(self, agent):\n self._on_event('internet_available')\n\n # called when everything is ready and the main loop is about to start\n def on_ready(self, agent):\n self._on_event('ready')\n\n # called when the status is set to grateful\n def on_grateful(self, agent):\n self._on_event('grateful')\n\n # called when the status is set to lonely\n def on_lonely(self, agent):\n self._on_event('lonely')\n\n # called when the status is set to bored\n def on_bored(self, agent):\n self._on_event('bored')\n\n # called when the status is set to sad\n def on_sad(self, agent):\n self._on_event('sad')\n\n # called when the status is set to angry\n def on_angry(self, agent):\n self._on_event('angry')\n\n # called when the status is set to excited\n def on_excited(self, agent):\n self._on_event('excited')\n\n # called when the agent is rebooting the board\n def on_rebooting(self, agent):\n self._on_event('rebooting')\n\n # called when the agent is waiting for t seconds\n def on_wait(self, agent, t):\n self._on_event('wait')\n\n # called when the agent is sleeping for t seconds\n def on_sleep(self, agent, t):\n self._on_event('sleep')\n\n # called when an epoch is over (where an epoch is a single loop of the main algorithm)\n def on_epoch(self, agent, epoch, epoch_data):\n self._on_event('epoch')\n\n # called when successfully connected to a bluetooth host\n def on_bt_connected(self, agent, bthost_name):\n self._on_event('bt_connected')\n\n # called when disconnected from bluetooth host\n def on_bt_disconnected(self, agent):\n self._on_event('bt_disconnected')\n\n # called when plover boots\n def on_plover_boot(self, agent):\n self._on_event('plover_boot')\n\n # called when plover is ready\n def on_plover_ready(self, agent):\n self._on_event('plover_ready')\n\n # called when plover quits\n def on_plover_quit(self, agent):\n self._on_event('plover_quit')\n\n # called when wifi is connected\n def on_wifi_connected(self, agent, ssid, ip):\n self._on_event('wifi_connected')\n\n # called when wifi is disconnected\n def on_wifi_disconnected(self, agent):\n self._on_event('wifi_disconnected')\n\n # called when wpm stats are updated\n def on_wpm_stats(self, agent):\n self._on_event('wpm_set')\n\n # called when wpm-strokes stats are updated\n def on_strokes_stats(self, agent):\n self._on_event('strokes_set')" }, { "path": "stenogotchi/plugins/default/logtail.py", "content": "import os\nimport logging\nimport threading\nfrom itertools import islice\nfrom time import sleep\nfrom datetime import datetime,timedelta\nfrom stenogotchi import plugins\nfrom stenogotchi.utils import StatusFile\nfrom flask import render_template_string\nfrom flask import jsonify\nfrom flask import abort\nfrom flask import Response\n\n\nTEMPLATE = \"\"\"\n{% extends \"base.html\" %}\n{% set active_page = \"plugins\" %}\n{% block title %}\n Logtail\n{% endblock %}\n\n{% block styles %}\n {{ super() }}\n \n{% endblock %}\n\n{% block script %}\n var table = document.getElementById('table');\n var filter = document.getElementById('filter');\n var filterVal = filter.value.toUpperCase();\n\n var xhr = new XMLHttpRequest();\n xhr.open('GET', '{{ url_for('plugins') }}/logtail/stream');\n xhr.send();\n var position = 0;\n var data;\n var time;\n var level;\n var msg;\n var colorClass;\n\n function handleNewData() {\n var messages = xhr.responseText.split('\\\\n');\n filterVal = filter.value.toUpperCase();\n messages.slice(position, -1).forEach(function(value) {\n\n if (value.charAt(0) != '[') {\n msg = value;\n time = '';\n level = '';\n } else {\n data = value.split(']');\n time = data.shift() + ']';\n level = data.shift() + ']';\n msg = data.join(']');\n\n switch(level) {\n case ' [INFO]':\n colorClass = 'info';\n break;\n case ' [WARNING]':\n colorClass = 'warning';\n break;\n case ' [ERROR]':\n colorClass = 'error';\n break;\n case ' [DEBUG]':\n colorClass = 'debug';\n break;\n default:\n colorClass = 'default';\n break;\n }\n }\n\n var tr = document.createElement('tr');\n var td1 = document.createElement('td');\n var td2 = document.createElement('td');\n var td3 = document.createElement('td');\n\n td1.textContent = time;\n td2.textContent = level;\n td3.textContent = msg;\n\n tr.appendChild(td1);\n tr.appendChild(td2);\n tr.appendChild(td3);\n\n tr.className = colorClass;\n\n if (filterVal.length > 0 && value.toUpperCase().indexOf(filterVal) == -1) {\n tr.style.display = \"none\";\n }\n\n table.appendChild(tr);\n });\n position = messages.length - 1;\n }\n\n var scrollingElement = (document.scrollingElement || document.body)\n function scrollToBottom () {\n scrollingElement.scrollTop = scrollingElement.scrollHeight;\n }\n\n var timer;\n var scrollElm = document.getElementById('autoscroll');\n timer = setInterval(function() {\n handleNewData();\n if (scrollElm.checked) {\n scrollToBottom();\n }\n if (xhr.readyState == XMLHttpRequest.DONE) {\n clearInterval(timer);\n }\n }, 1000);\n\n var typingTimer;\n var doneTypingInterval = 1000;\n\n filter.onkeyup = function() {\n clearTimeout(typingTimer);\n typingTimer = setTimeout(doneTyping, doneTypingInterval);\n }\n\n filter.onkeydown = function() {\n clearTimeout(typingTimer);\n }\n\n function doneTyping() {\n document.body.style.cursor = 'progress';\n var tr, tds, td, i, txtValue;\n filterVal = filter.value.toUpperCase();\n tr = table.getElementsByTagName(\"tr\");\n for (i = 1; i < tr.length; i++) {\n txtValue = tr[i].textContent || tr[i].innerText;\n if (txtValue.toUpperCase().indexOf(filterVal) > -1) {\n tr[i].style.display = \"table-row\";\n } else {\n tr[i].style.display = \"none\";\n }\n }\n document.body.style.cursor = 'default';\n }\n{% endblock %}\n\n{% block content %}\n
\n \n \n
\n
\n \n \n \n \n \n \n
\n Time\n \n Level\n \n Message\n
\n{% endblock %}\n\"\"\"\n\n\nclass Logtail(plugins.Plugin):\n __author__ = '33197631+dadav@users.noreply.github.com'\n __version__ = '0.1.0'\n __license__ = 'GPL3'\n __description__ = 'This plugin tails the logfile.'\n\n def __init__(self):\n self.lock = threading.Lock()\n self.options = dict()\n self.ready = False\n\n def on_config_changed(self, config):\n self.config = config\n self.ready = True\n\n def on_loaded(self):\n \"\"\"\n Gets called when the plugin gets loaded\n \"\"\"\n logging.info(\"[logtail] Logtail plugin loaded.\")\n\n\n def on_webhook(self, path, request):\n if not self.ready:\n return \"Plugin not ready\"\n\n if not path or path == \"/\":\n return render_template_string(TEMPLATE)\n\n if path == 'stream':\n def generate():\n with open(self.config['main']['log']['path']) as f:\n yield ''.join(f.readlines()[-self.options.get('max-lines', 4096):])\n while True:\n yield f.readline()\n\n return Response(generate(), mimetype='text/plain')\n\n abort(404)\n" }, { "path": "stenogotchi/plugins/default/memtemp.py", "content": "# memtemp shows memory infos and cpu temperature\n#\n# mem usage, cpu load, cpu temp\n#\n###############################################################\n#\n# Updated 13-01-2021 by Anodynous\n# - Changed CPU reading from using default method to having a \n# continuously updating 60s average to draw upon. Default \n# method returns 90-100% on RPI0 when triggered alongside \n# an on_ui_update event \n#\n# Updated 18-10-2019 by spees \n# - Changed the place where the data was displayed on screen\n# - Made the data a bit more compact and easier to read\n# - removed the label so we wont waste screen space\n# - Updated version to 1.0.1\n#\n# 20-10-2019 by spees \n# - Refactored to use the already existing functions\n# - Now only shows memory usage in percentage\n# - Added CPU load\n# - Added horizontal and vertical orientation\n#\n###############################################################\nfrom stenogotchi.ui.components import LabeledValue\nfrom stenogotchi.ui.view import BLACK\nimport stenogotchi.ui.fonts as fonts\nimport stenogotchi.plugins as plugins\nimport stenogotchi\nimport logging\nimport _thread\n\n\nclass MemTemp(plugins.Plugin):\n __author__ = 'https://github.com/xenDE'\n __version__ = '1.0.1'\n __license__ = 'GPL3'\n __description__ = 'A plugin that will display memory/cpu usage and temperature'\n\n def __init__(self):\n self.cpu_load_avg = 0\n\n def on_loaded(self):\n logging.info(\"[memtemp] memtemp plugin loaded.\")\n _thread.start_new_thread(self._cpu_poller(), ())\n\n def on_config_changed(self, config):\n self.config = config\n\n def mem_usage(self):\n return int(stenogotchi.mem_usage() * 100)\n\n def cpu_load(self):\n #return int(stenogotchi.cpu_load() * 100)\n return int(self.cpu_load_avg * 100)\n\n\n def _cpu_poller(self, s=60):\n \"\"\"\n Runs in own thread and continually recalculates the CPU load over a (s)-second long window\n \"\"\"\n while True:\n self.cpu_load_avg = stenogotchi.cpu_load(s)\n\n def on_ui_setup(self, ui):\n if ui.is_waveshare_v2():\n h_pos = (180, 80)\n v_pos = (180, 61)\n elif ui.is_waveshare_v1():\n h_pos = (170, 80)\n v_pos = (170, 61)\n elif ui.is_waveshare144lcd():\n h_pos = (53, 77)\n v_pos = (78, 67)\n elif ui.is_inky():\n h_pos = (140, 68)\n v_pos = (165, 54)\n elif ui.is_waveshare27inch():\n h_pos = (192, 138)\n v_pos = (216, 122)\n else:\n h_pos = (155, 76)\n v_pos = (180, 61)\n\n if self.options['orientation'] == \"vertical\":\n ui.add_element('memtemp', LabeledValue(color=BLACK, label='', value=' mem:-\\n cpu:-\\ntemp:-',\n position=v_pos,\n label_font=fonts.Small, text_font=fonts.Small))\n else:\n # default to horizontal\n ui.add_element('memtemp', LabeledValue(color=BLACK, label='', value='mem cpu temp\\n - - -',\n position=h_pos,\n label_font=fonts.Small, text_font=fonts.Small))\n\n def on_unload(self, ui):\n with ui._lock:\n ui.remove_element('memtemp')\n\n def on_ui_update(self, ui):\n if self.options['scale'] == \"fahrenheit\":\n temp = (stenogotchi.temperature() * 9 / 5) + 32\n symbol = \"f\"\n elif self.options['scale'] == \"kelvin\":\n temp = stenogotchi.temperature() + 273.15\n symbol = \"k\"\n else:\n # default to celsius\n temp = stenogotchi.temperature()\n symbol = \"c\"\n\n if self.options['orientation'] == \"vertical\":\n ui.set('memtemp',\n \" mem:%s%%\\n cpu:%s%%\\ntemp:%s%s\" % (self.mem_usage(), self.cpu_load(), temp, symbol))\n else:\n # default to horizontal\n ui.set('memtemp',\n \" mem cpu temp\\n %s%% %s%% %s%s\" % (self.mem_usage(), self.cpu_load(), temp, symbol))\n" }, { "path": "stenogotchi/plugins/default/plover_link.py", "content": "\n\"\"\"\nStenogotchi and Bluetooth HID keyboard emulator D-BUS Service\n\nBased on: https://gist.github.com/ukBaz/a47e71e7b87fbc851b27cde7d1c0fcf0#file-readme-md\nWhich in turn takes the original idea from: http://yetanotherpointlesstechblog.blogspot.com/2016/04/emulating-bluetooth-keyboard-with.html\n\nTested on:\n Python 3.7-3.9\n BlueZ 5.5\n\"\"\"\nimport os\nimport sys\nimport logging\nfrom types import MethodDescriptorType\nimport dbus\nimport dbus.service\nimport socket\n\nfrom time import sleep\nfrom gi.repository import GLib\nfrom dbus.mainloop.glib import DBusGMainLoop\n\nif not __name__ == '__main__':\n import stenogotchi.plugins as plugins\n ObjectClass = plugins.Plugin\nelse:\n ObjectClass = object\n\nclass BluezErrorRejected(dbus.DBusException):\n _dbus_error_name = \"org.bluez.Error.Rejected\"\n\n\nclass BluezErrorCanceled(dbus.DBusException):\n _dbus_error_name = \"org.bluez.Error.Canceled\"\n\n\nclass Agent(dbus.service.Object):\n \"\"\" \n BT Pairing agent\n API: https://git.kernel.org/pub/scm/bluetooth/bluez.git/plain/doc/agent-api.txt \n examples: https://github.com/elsampsa/btdemo/blob/master/bt_studio.py \n \"\"\"\n\n @dbus.service.method('org.bluez.Agent1',\n in_signature='os', out_signature='')\n def AuthorizeService(self, device, uuid):\n logging.info(f\"[plover_link] Successfully paired device: {device} using Secure Simple Pairing (SSP)\")\n return\n\n @dbus.service.method('org.bluez.Agent1',\n in_signature='o', out_signature='')\n def RequestAuthorization(self, device):\n logging.info(f\"[plover_link] Accepted RequestAuthorization from {device}\")\n return\n\n @dbus.service.method('org.bluez.Agent1',\n in_signature='', out_signature='')\n def Cancel(self):\n logging.info(\"[plover_link] Cancel request received from BT client\")\n raise(BluezErrorCanceled)\n \n @dbus.service.method('org.bluez.Agent1',\n in_signature='', out_signature='')\n def Release(self):\n self.logging(\"[plover_link] Connection released due to BT client request\")\n mainloop.quit()\n\n\nclass HumanInterfaceDeviceProfile(dbus.service.Object):\n \"\"\"\n BlueZ D-Bus Profile for HID\n \"\"\"\n fd = -1\n\n @dbus.service.method('org.bluez.Profile1',\n in_signature='', out_signature='')\n def Release(self):\n logging.info('[plover_link] PloverLink: Release')\n mainloop.quit()\n\n @dbus.service.method('org.bluez.Profile1',\n in_signature='oha{sv}', out_signature='')\n def NewConnection(self, path, fd, properties):\n self.fd = fd.take()\n logging.info('[plover_link] NewConnection({}, {})'.format(path, self.fd))\n for key in properties.keys():\n if key == 'Version' or key == 'Features':\n logging.info('[plover_link] {} = 0x{:04x}'.format(key,\n properties[key]))\n else:\n logging.info('[plover_link] {} = {}'.format(key, properties[key]))\n\n @dbus.service.method('org.bluez.Profile1',\n in_signature='o', out_signature='')\n def RequestDisconnection(self, path):\n logging.info('[plover_link] RequestDisconnection {}'.format(path))\n\n if self.fd > 0:\n os.close(self.fd)\n self.fd = -1\n \n\nclass BTKbDevice:\n \"\"\"\n Create a bluetooth device to emulate a HID keyboard\n \"\"\"\n # Service control port - must match port configured in SDP record\n P_CTRL = 17\n # Service interrupt port - must match port configured in SDP record\n P_INTR = 19\n # BlueZ dbus\n PROFILE_DBUS_PATH = '/bluez/yaptb/btkb_profile'\n AGENT_DBUS_PATH = '/org/bluez'\n ADAPTER_IFACE = 'org.bluez.Adapter1'\n DEVICE_INTERFACE = 'org.bluez.Device1'\n DBUS_PROP_IFACE = 'org.freedesktop.DBus.Properties'\n DBUS_OM_IFACE = 'org.freedesktop.DBus.ObjectManager'\n\n # file path of the sdp record to laod\n install_dir = os.path.dirname(os.path.realpath(__file__))\n SDP_RECORD_PATH = os.path.join(install_dir,\n 'plover_link_btserver_sdp_record.xml')\n # UUID for HID service (1124)\n # https://www.bluetooth.com/specifications/assigned-numbers/service-discovery\n UUID = '00001124-0000-1000-8000-00805f9b34fb'\n\n def __init__(self, hci=0):\n self._agent = plugins.loaded['plover_link']._agent\n self.bt_autoconnect_list = None\n self.bt_last_conn = None\n self.autoconnect_in_progress = False\n self.bt_agent_running = False\n self.scontrol = None\n self.ccontrol = None # Socket object for control\n self.sinterrupt = None\n self.cinterrupt = None # Socket object for interrupt\n self.dev_path = '/org/bluez/hci{}'.format(hci)\n logging.info('[plover_link] Setting up BT device')\n self.bus = dbus.SystemBus()\n \n self.adapter_methods = dbus.Interface(self.bus.get_object('org.bluez', \n self.dev_path), self.ADAPTER_IFACE)\n self.adapter_property = dbus.Interface(self.bus.get_object('org.bluez',\n self.dev_path), self.DBUS_PROP_IFACE)\n\n self.bus.add_signal_receiver(self.interfaces_added,\n dbus_interface=self.DBUS_OM_IFACE,\n signal_name='InterfacesAdded')\n\n self.bus.add_signal_receiver(self._properties_changed,\n dbus_interface=self.DBUS_PROP_IFACE,\n signal_name='PropertiesChanged',\n arg0=self.DEVICE_INTERFACE,\n path_keyword='path')\n\n self.register_hid_profile()\n\n # Set the Bluetooth device configuration\n try: \n self.alias = plugins.loaded['plover_link'].options['bt_device_name']\n except:\n self.alias = 'Stenogotchi'\n self.discoverabletimeout = 0\n self.discoverable = True\n self.bthost_mac = None\n self.bthost_name = \"\"\n\n # Get list of Bluetooth devices to auto connect to\n bt_autoconnect_str = plugins.loaded['plover_link'].options['bt_autoconnect_mac']\n if bt_autoconnect_str:\n self.bt_autoconnect_list = list(map(str.strip, bt_autoconnect_str.split(',')))\n else:\n self.bt_autoconnect_list = None\n\n logging.info('[plover_link] Configured BT device with name {}'.format(self.alias))\n \n def interfaces_added(self, path, device_info):\n pass\n\n def _properties_changed(self, interface, changed, invalidated, path):\n if self.on_disconnect is not None:\n if 'Connected' in changed:\n if not changed['Connected']:\n self.on_disconnect()\n\n def on_disconnect(self):\n if self.autoconnect_in_progress:\n return\n\n logging.info('[plover_link] The client has been disconnected')\n self.bthost_mac = None\n self.bthost_name = \"\"\n self._agent.set_bt_disconnected()\n # Attempt to auto_connect once, then go back to listening mode\n connected = self.auto_connect()\n if not connected:\n if not self.bt_agent_running:\n self.register_bt_pairing_agent()\n if not self.scontrol:\n self.listen()\n\n\n @property\n def address(self):\n \"\"\" Return the adapter MAC address. \"\"\"\n return self.adapter_property.Get(self.ADAPTER_IFACE,\n 'Address')\n\n @property\n def powered(self):\n \"\"\" Power state of the Adapter. \"\"\"\n return self.adapter_property.Get(self.ADAPTER_IFACE, 'Powered')\n\n @powered.setter\n def powered(self, new_state):\n self.adapter_property.Set(self.ADAPTER_IFACE, 'Powered', new_state)\n\n @property\n def alias(self):\n return self.adapter_property.Get(self.ADAPTER_IFACE,\n 'Alias')\n\n @alias.setter\n def alias(self, new_alias):\n self.adapter_property.Set(self.ADAPTER_IFACE,\n 'Alias',\n new_alias)\n\n @property\n def discoverabletimeout(self):\n \"\"\" Discoverable timeout of the Adapter. \"\"\"\n return self.adapter_props.Get(self.ADAPTER_IFACE,\n 'DiscoverableTimeout')\n\n @discoverabletimeout.setter\n def discoverabletimeout(self, new_timeout):\n self.adapter_property.Set(self.ADAPTER_IFACE,\n 'DiscoverableTimeout',\n dbus.UInt32(new_timeout))\n\n @property\n def discoverable(self):\n \"\"\" Discoverable state of the Adapter. \"\"\"\n return self.adapter_props.Get(\n self.ADAPTER_INTERFACE, 'Discoverable')\n\n @discoverable.setter\n def discoverable(self, new_state):\n self.adapter_property.Set(self.ADAPTER_IFACE,\n 'Discoverable',\n new_state)\n\n def register_hid_profile(self):\n \"\"\"\n Setup and register HID Profile\n \"\"\"\n\n logging.debug('[plover_link] Configuring Bluez Profile')\n service_record = self.read_sdp_service_record()\n\n opts = {\n 'Role': 'server',\n 'RequireAuthentication': True,\n 'RequireAuthorization': True,\n 'AutoConnect': True,\n 'ServiceRecord': service_record,\n }\n\n manager = dbus.Interface(self.bus.get_object('org.bluez',\n '/org/bluez'),\n 'org.bluez.ProfileManager1')\n\n HumanInterfaceDeviceProfile(self.bus,\n BTKbDevice.PROFILE_DBUS_PATH)\n\n manager.RegisterProfile(BTKbDevice.PROFILE_DBUS_PATH,\n BTKbDevice.UUID,\n opts)\n\n logging.debug('[plover_link] Profile registered ')\n\n def register_bt_pairing_agent(self):\n \"\"\"\n Setup and register BT paring agent\n \"\"\"\n capability = 'NoInputNoOutput'\n manager = dbus.Interface(self.bus.get_object('org.bluez',\n '/org/bluez'),\n 'org.bluez.AgentManager1')\n Agent(self.bus, BTKbDevice.AGENT_DBUS_PATH)\n\n manager.RegisterAgent(BTKbDevice.AGENT_DBUS_PATH, capability)\n #manager.UnregisterAgent(BTKbDevice.AGENT_DBUS_PATH, capability)\n manager.RequestDefaultAgent(BTKbDevice.AGENT_DBUS_PATH)\n self.bt_agent_running = True\n logging.debug(f'[plover_link] Registered secure Bluez pairing agent with capability: {capability}')\n\n @staticmethod\n def read_sdp_service_record():\n \"\"\"\n Read and return SDP record from a file\n :return: (string) SDP record\n \"\"\"\n logging.debug('[plover_link] Reading service record')\n try:\n fh = open(BTKbDevice.SDP_RECORD_PATH, 'r')\n except OSError:\n sys.exit('Could not open the sdp record. Exiting...')\n\n return fh.read() \n\n def create_ssockets(self):\n \"\"\" Create passive listening sockets and close possibly exising ones \"\"\"\n logging.debug(\"[plover_link] Creating BT listening ssockets\")\n\n if self.scontrol:\n self.scontrol.close()\n if self.sinterrupt:\n self.sinterrupt.close()\n\n self.scontrol = socket.socket(socket.AF_BLUETOOTH,\n socket.SOCK_SEQPACKET,\n socket.BTPROTO_L2CAP)\n self.scontrol.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)\n self.sinterrupt = socket.socket(socket.AF_BLUETOOTH,\n socket.SOCK_SEQPACKET,\n socket.BTPROTO_L2CAP)\n self.sinterrupt.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)\n\n def listen(self):\n \"\"\"\n Listen for connections coming from HID client\n \"\"\"\n if not self.scontrol or not self.sinterrupt:\n self.create_ssockets()\n\n try:\n # Bind address/port to existing sockets\n self.scontrol.bind((self.address, self.P_CTRL))\n self.sinterrupt.bind((self.address, self.P_INTR))\n\n # Start listening on the server sockets with limit of 1 connection per socket\n self.scontrol.listen(1)\n self.sinterrupt.listen(1)\n\n logging.info('[plover_link] Waiting for connections')\n\n self.ccontrol, cinfo = self.scontrol.accept()\n logging.debug('[plover_link] {} connected on the ccontrol socket'.format(cinfo[0]))\n\n self.cinterrupt, cinfo = self.sinterrupt.accept()\n logging.debug('[plover_link] {} connected on the cinterrupt channel'.format(cinfo[0]))\n \n self.bthost_mac = cinfo[0]\n self.bthost_name = self.get_connected_device_name()\n\n self._agent.set_bt_connected(self.bthost_name)\n self.bt_last_conn = self.bthost_mac\n\n except OSError as ex:\n logging.error(f\"[plover_link] Failed to enter listening mode: {ex}\")\n logging.info(f\"[plover_link] If issue persists, check that your '/lib/systemd/system/bluetooth.service' file still contains 'ExecStart=/usr/lib/bluetooth/bluetoothd -P input'\")\n\n\n # def reconnect(self):\n # print(\"Trying reconnect...\") \n # if not self.bt_last_conn:\n # return\n # logging.info('[plover_link] Waiting 5 seconds before attempting to reconnect to lost BT device...')\n # sleep(5)\n # for i in range(3):\n # try:\n # hidHost = self.bt_last_conn\n # self.ccontrol = socket.socket(socket.AF_BLUETOOTH,\n # socket.SOCK_SEQPACKET,\n # socket.BTPROTO_L2CAP)\n # self.cinterrupt = socket.socket(socket.AF_BLUETOOTH,\n # socket.SOCK_SEQPACKET,\n # socket.BTPROTO_L2CAP)\n # self.ccontrol.connect((hidHost, self.P_CTRL))\n # self.cinterrupt.connect((hidHost, self.P_INTR))\n # print(\"Connected!\")\n # break\n # except Exception as ex:\n # logging.info(f\"[plover_link] Failed to reconnect, will retry in 5s... Reason: '{ex}'\")\n # sleep(5)\n\n def auto_connect(self):\n \"\"\" Automatically connects to preferred BT devices in listed order. Also handles reconnect attempts at lost connection. \"\"\"\n \n # Check if we should make a reconnect attempt to previous BT device\n if self.bt_last_conn:\n reconnect = True\n else:\n reconnect = False\n\n if not self.bt_autoconnect_list and not reconnect:\n logging.info('[plover_link] No bt_autoconnect_mac set in config. Listening for incoming connections instead...') \n return False\n else:\n self.autoconnect_in_progress = True\n \n if reconnect:\n if not self.bt_last_conn:\n return False\n logging.info('[plover_link] Waiting 5 seconds before attempting to reconnect to lost BT device...') \n sleep(5) # Sleep 5 seconds before attempting a reconnect to lost BT device\n autoconnect_list = [self.bt_last_conn]\n else:\n logging.info('[plover_link] Trying to auto connect to preferred BT host(s)...')\n autoconnect_list = self.bt_autoconnect_list.copy()\n\n for i in autoconnect_list:\n logging.info(f'[plover_link] Trying to auto connect to {i}')\n try:\n self.ccontrol = socket.socket(socket.AF_BLUETOOTH,\n socket.SOCK_SEQPACKET,\n socket.BTPROTO_L2CAP)\n \n self.cinterrupt = socket.socket(socket.AF_BLUETOOTH,\n socket.SOCK_SEQPACKET,\n socket.BTPROTO_L2CAP)\n\n self.ccontrol.connect((i, self.P_CTRL))\n self.cinterrupt.connect((i, self.P_INTR))\n\n # On successful connection\n self.autoconnect_in_progress = False\n self.bthost_mac = i\n self.bt_last_conn = i\n self.bthost_name = self.get_connected_device_name()\n self._agent.set_bt_connected(self.bthost_name)\n return True # stop trying to auto connect upon success\n\n \n except Exception as e:\n if e.__class__.__name__ == \"OSError\" and str(e) == \"[Errno 52] Invalid exchange\":\n self.unpair_device(i)\n logging.info(f'[plover_link] Invalid handshake exchange with {i}. Unpaired device. Please re-initiate pairing from remote device.')\n self._agent._view.on_custom(f\"Had to purge {i} due to invalid handshake. Please re-pair us.\")\n elif (e.__class__.__name__ == \"PermissionError\" and str(e) == \"[Errno 13] Permission denied\"):\n logging.info(f'[plover_link] Permission to connect to {i} denied. Ensure device has been paired.')\n self._agent._view.on_custom(f\"Hey... {i} refused my connection! Please re-pair us.\")\n elif (e.__class__.__name__ == \"ConnectionRefusedError\" and str(e) == \"[Errno 111] Connection refused\"):\n logging.info(f'[plover_link] Connection to {i} refused. Ensure device has been paired and is available.')\n self._agent._view.on_custom(f\"Hmpf... {i} refused my connection. Ensure device has been paired and is available.\")\n elif e.__class__.__name__ == \"OSError\" and str(e) == \"[Errno 112] Host is down\":\n logging.info(f'[plover_link] Host {i} is down.')\n else:\n logging.info(f'[plover_link] Failed to connect to {i} due to \"{e.__class__.__name__}\" : \"{e}\"')\n if self.bt_autoconnect_list and not reconnect:\n if i in self.bt_autoconnect_list:\n self.bt_autoconnect_list.remove(i)\n\n # If all addresses attempted without success\n if not self.bt_autoconnect_list or reconnect:\n logging.info('[plover_link] Unsuccessful auto connect attempt. Listening for incoming connections instead...')\n # self.ccontrol.close()\n # self.cinterrupt.close()\n self.autoconnect_in_progress = False\n self.bt_last_conn = None\n return False\n \n sleep(2)\n\n def unpair_device(self, address):\n \"\"\" Removes remote device including pairing information \"\"\"\n \n proxy_object = self.bus.get_object(\"org.bluez\",\"/\")\n manager = dbus.Interface(proxy_object, \"org.freedesktop.DBus.ObjectManager\")\n managed_objects = manager.GetManagedObjects()\n for path in managed_objects:\n adr = managed_objects[path].get('org.bluez.Device1', {}).get('Address', False)\n if adr == address:\n self.adapter_methods.RemoveDevice(path)\n\n\n \n def get_connected_device_name(self):\n \"\"\" Returns name (Alias) of connected BT device \"\"\"\n \n proxy_object = self.bus.get_object(\"org.bluez\",\"/\")\n manager = dbus.Interface(proxy_object, \"org.freedesktop.DBus.ObjectManager\")\n managed_objects = manager.GetManagedObjects()\n for path in managed_objects:\n con_state = managed_objects[path].get('org.bluez.Device1', {}).get('Connected', False)\n if con_state:\n addr = managed_objects[path].get('org.bluez.Device1', {}).get('Address')\n alias = managed_objects[path].get('org.bluez.Device1', {}).get('Alias')\n logging.info(f'[plover_link] Device {alias} [{addr}] is connected')\n \n return alias\n\n def send(self, msg):\n \"\"\"\n Send HID message\n :param msg: (bytes) HID packet to send\n \"\"\"\n self.cinterrupt.send(bytes(bytearray(msg)))\n\n\nclass StenogotchiService(dbus.service.Object):\n \"\"\"\n Setup of a D-Bus service to receive:\n Status updates and HID messages from Plover plugin.\n HID messages from Stenogotchi evdevkb plugin\n \"\"\"\n def __init__(self):\n logging.info('[plover_link] Setting up Stenogotchi D-Bus service')\n bus_name = dbus.service.BusName('com.github.stenogotchi', bus=dbus.SystemBus())\n dbus.service.Object.__init__(self, bus_name, '/com/github/stenogotchi')\n \n self._agent = plugins.loaded['plover_link']._agent\n self.device = BTKbDevice() # create and setup our BTKbDevice\n self.wpm_top = None\n \n def auto_connect(self):\n \"\"\" Connect to preferred bt_mac(s). If unspecified or unavailable fall back to await new and trusted incoming connections \"\"\"\n connected = self.device.auto_connect() \n if not connected:\n self.device.register_bt_pairing_agent() # Handler for new pairing attempts\n self.device.listen() # Handler for incoming trusted connections\n\n\n @dbus.service.method('com.github.stenogotchi', in_signature='aay') # array of bytearrays\n def send_keys(self, key_list):\n for key in key_list:\n self.device.send(key)\n\n @dbus.service.method('com.github.stenogotchi', in_signature='b') # boolean\n def plover_is_running(self, b):\n logging.debug('[plover_link] plover_is_running = ' + str(b))\n if b:\n self._agent.set_plover_boot()\n else:\n self._agent.set_plover_quit()\n\n @dbus.service.method('com.github.stenogotchi', in_signature='b') # boolean\n def plover_is_ready(self, b):\n logging.debug('[plover_link] plover_is_ready = ' + str(b))\n self._agent.set_plover_ready()\n\n @dbus.service.method('com.github.stenogotchi', in_signature='s') # string\n def plover_machine_state(self, s):\n logging.debug('[plover_link] plover_machine_state = ' + s)\n\n @dbus.service.method('com.github.stenogotchi', in_signature='b') # boolean\n def plover_output_enabled(self, b):\n logging.debug('[plover_link] plover_output_enabled = ' + str(b))\n\n @dbus.service.method('com.github.stenogotchi', in_signature='s') # string\n def plover_wpm_stats(self, s):\n logging.debug('[plover_link] plover_wpm_stats = ' + s)\n wpm = int(s)\n if not self.wpm_top: \n self.wpm_top = wpm\n self._agent.set_wpm(wpm, self.wpm_top)\n else:\n if wpm > self.wpm_top:\n self.wpm_top = wpm\n logging.debug(f'[plover_link] new wpm record: {self.wpm_top}')\n self._agent.set_wpm_record(self.wpm_top)\n else:\n self._agent.set_wpm(wpm, self.wpm_top)\n\n @dbus.service.method('com.github.stenogotchi', in_signature='s') # string\n def plover_strokes_stats(self, s):\n # logging.debug(f\"[plover_link] plover_strokes_stats = '{s}'\")\n self._agent.set_strokes(s)\n\n @dbus.service.method('com.github.stenogotchi', in_signature='s') # string\n def send_string_stenogotchi(self, s):\n plugins.loaded['dict_lookup'].input_handler._on_send_string(s)\n # logging.debug(f\"[plover_link] send_string_stenogotchi = '{s}'\")\n\n @dbus.service.method('com.github.stenogotchi', in_signature='n') # 16-bit signed int\n def send_backspaces_stenogotchi(self, n):\n plugins.loaded['dict_lookup'].input_handler._on_send_backspaces(n)\n # logging.debug(f\"[plover_link] send_backspaces_stenogotchi = '{n}'\")\n\n @dbus.service.method('com.github.stenogotchi', in_signature='s') # string\n def send_key_combination_stenogotchi(self, s):\n plugins.loaded['dict_lookup'].input_handler._on_send_key_combination(s)\n # logging.debug(f\"[plover_link] send_key_combination_stenogotchi = '{s}'\")\n \n @dbus.service.method('com.github.stenogotchi', in_signature='as') # list of strings\n def plover_translation_handler(self, l):\n plugins.loaded['dict_lookup'].input_handler._on_lookup_results(l)\n # logging.debug(f\"[plover_link] plover_translation_handler = '{l}'\")\n \n @dbus.service.signal('com.github.stenogotchi', signature='a{sv}') # dictionary of strings to variants\n def signal_to_plover(self, message):\n # The signal is emitted when this method exits\n pass\n\nclass PloverLink(ObjectClass):\n __autohor__ = 'Anodynous'\n __version__ = '0.3'\n __license__ = 'MIT'\n __description__ = 'This plugin enables connectivity to Plover through D-Bus. Note that it needs root permissions due to using sockets'\n\n def __init__(self):\n self._agent = None\n self.running = False\n self._stenogotchiservice = None\n self.mainloop = None\n\n # called when everything is ready and the main loop is about to start\n def on_ready(self, agent):\n self._agent = agent # used for agent/automata functionsadded to be able to do callbacks to agent events\n\n DBusGMainLoop(set_as_default=True)\n self._stenogotchiservice = StenogotchiService()\n self.mainloop = GLib.MainLoop()\n \n try:\n self.mainloop.run()\n self.running = True\n logging.info(\"[plover_link] PloverLink is up\")\n except:\n logging.error(\"[plover_link] Could not start PloverLink\")\n\n def on_plover_ready(self, agent):\n self._stenogotchiservice.auto_connect()\n \n def on_config_changed(self, config):\n self.config = config\n \n def on_unload(self, ui):\n self.mainloop.quit()\n\n def send_signal_to_plover(self, message):\n self._stenogotchiservice.signal_to_plover(message)\n\nif __name__ == '__main__':\n # The sockets require root permission\n if not os.geteuid() == 0:\n sys.exit('Only root can run this script')\n\n DBusGMainLoop(set_as_default=True)\n stenogotchiservice = StenogotchiService()\n mainloop = GLib.MainLoop()\n mainloop.run()\n" }, { "path": "stenogotchi/plugins/default/plover_link_btserver_sdp_record.xml", "content": "\n\n\n\t\n\t\t\n\t\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\n\t\n\t\n\t\t\n\t\n\t\n\t\t BT Keyboard\" />\n\t\n\t\n\t\t\n\t\n\t\n\t\t\n\t\n\t\n\t\t\n\t\n\t\n\t\t\n\t\n\t\n\t\t\n\t\n\t\n\t\t\n\t\n\t\n\t\t\n\t\n\t\n\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\n\t\n\t\n\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\n\t\n\t\n\t\t\n\t\n\t\n\t\t\n\t\n\t\n\t\t\n\t\n\t\n\t\t\n\t\n\t\n\t\t\n\t\n\t\n\t\t\n\t\n\n" }, { "path": "stenogotchi/plugins/default/upslite.py", "content": "#!/usr/bin/env python3\n\"\"\"\nBased on: https://github.com/linshuqin329/UPS-Lite\nRequires i2c to be enabled in dietpi-config (or raspi-config)\n\nSupports readings from the https://hackaday.io/project/173847-ups-lite platform for Raspberry Pi Zero W\n\"\"\"\n\nimport logging\nimport struct\nimport smbus\nimport sys\nimport time\nimport RPi.GPIO as GPIO\nimport stenogotchi\n\nif not __name__ == '__main__':\n import stenogotchi.plugins as plugins\n ObjectClass = plugins.Plugin\nelse:\n ObjectClass = object\n\nI2CBUS = 1 # Run \"sudo i2cdetect -l\" to see which bus is being used (bcm2835 is what you are looking for). 0 = /dev/i2c-0 (port I2C0), 1 = /dev/i2c-1 (port I2C1)\nI2CADDRESS = 0x36 # Run \"sudo i2cdetect -y 1\" to see address 36 mounted on the i2c bus. This is MAXI17040G which we want to interact with\n\n\nclass Upslite(ObjectClass):\n __autohor__ = 'Anodynous'\n __version__ = '0.1'\n __license__ = 'GPL3'\n __description__ = 'This plugin enables battery readings for the UPS-Lite V1.2 RPI0 module using integrated MAX17040'\n\n def __init__(self):\n self.GPIO = GPIO\n self.bus = None\n self.address = I2CADDRESS\n self.is_plugged = False\n self.voltage = 0\n self.charge = 0\n\n # Called when plugin is loaded\n def on_loaded(self):\n try:\n self.GPIO.setmode(self.GPIO.BCM)\n self.GPIO.setwarnings(False)\n self.GPIO.setup(4,self.GPIO.IN)\n\n self.bus = smbus.SMBus(I2CBUS)\n\n self._power_on_reset()\n self._quickstart()\n except:\n logging.error(\"[upslite] Could not start UPS-Lite plugin\")\n \n def on_config_changed(self, config):\n self.config = config\n\n # Called when the ui is updated\n def on_ui_update(self, ui):\n # update those elements\n self._read_charge()\n self._check_plugged()\n\n # Set battery reading\n ui_string = str(self.charge)\n if self.is_plugged:\n ui_string += \"+\"\n ui.set('ups', ui_string)\n\n # Check for critical level. Initiate shutdown if too low\n if not self.is_plugged:\n if self.charge <= self.options['shutdown_level']:\n logging.info(f'[upslite] Battery charge critical: {self.charge}')\n ui.update(force=True, new_data={'status': 'Battery level critical. Shutting down in 1m unless connected to charger...'})\n time.sleep(60)\n self._check_plugged()\n if not self.is_plugged:\n logging.info('[upslite] Shutting down')\n stenogotchi.shutdown()\n else:\n logging.info('[upslite] Battery charging. Aborting shutdown process')\n ui.update(force=True, new_data={'status': 'Pheew... That was a close one! Feeling better already.'})\n\n def _read_voltage(self):\n \"\"\" Reads and sets as a float the voltage from the Raspi UPS Hat via the provided SMBus object\"\"\"\n read = self.bus.read_word_data(self.address, 0X02)\n swapped = struct.unpack(\"H\", read))[0]\n voltage = swapped * 1.25 /1000/16\n if voltage > 0: # if we get a non-zero value\n self.voltage = round(5.2 % voltage, 2)\n\n def _read_charge(self):\n \"\"\" Reads and sets as an int the remaining charge of the battery connected to the Raspi UPS Hat via the provided SMBus object. \"\"\"\n self.is_full = False\n self.is_low = False\n self.is_critical = False\n\n read = self.bus.read_word_data(self.address, 0X04)\n swapped = struct.unpack(\"H\", read))[0]\n charge = swapped/256\n if charge > 100:\n charge = 100\n self.charge = round(charge)\n\n def _check_plugged(self):\n if (self.GPIO.input(4) == self.GPIO.HIGH):\n self.is_plugged = True\n elif (self.GPIO.input(4) == self.GPIO.LOW):\n self.is_plugged = False\n\n def _quickstart(self):\n self.bus.write_word_data(self.address, 0x06,0x4000)\n\n def _power_on_reset(self):\n self.bus.write_word_data(self.address, 0xfe,0x0054)\n\n def get_charge(self):\n self._read_charge()\n return self.charge\n\n def get_voltage(self):\n self._read_voltage()\n return self.voltage\n\n def get_is_plugged(self):\n self._check_plugged()\n return self.is_plugged\n\n\nif __name__ == '__main__':\n ups = Upslite()\n ups.on_loaded()\n time.sleep(1) # needs a second to ensure non-zero values are returned on initial read\n print(\"++++++++++++++++++++\")\n \n while True:\n voltage = ups.get_voltage()\n charge = ups.get_charge()\n is_plugged = ups.get_is_plugged()\n \n print(\"Voltage:%5.2fV\" % voltage)\n print(\"Battery:%5i%%\" % charge)\n\n if charge > 99:\n print(\"Battery FULL\")\n else:\n if charge < 2:\n print(\"Battery CRITICAL\")\n elif charge < 6:\n print(\"Battery LOW\")\n if is_plugged:\n print(\"Power Adapter Plugged In \")\n else:\n print(\"Power Adapter Unplugged\")\n print(\"++++++++++++++++++++\")\n\n time.sleep(5)\n" }, { "path": "stenogotchi/ui/__init__.py", "content": "" }, { "path": "stenogotchi/ui/components.py", "content": "from PIL import Image\nfrom textwrap import TextWrapper\n\n\nclass Widget(object):\n def __init__(self, xy, color=0):\n self.xy = xy\n self.color = color\n\n def draw(self, canvas, drawer):\n raise Exception(\"not implemented\")\n\n\nclass Bitmap(Widget):\n def __init__(self, path, xy, color=0):\n super().__init__(xy, color)\n self.image = Image.open(path)\n\n def draw(self, canvas, drawer):\n canvas.paste(self.image, self.xy)\n\n\nclass Line(Widget):\n def __init__(self, xy, color=0, width=1):\n super().__init__(xy, color)\n self.width = width\n\n def draw(self, canvas, drawer):\n drawer.line(self.xy, fill=self.color, width=self.width)\n\n\nclass Rect(Widget):\n def draw(self, canvas, drawer):\n drawer.rectangle(self.xy, outline=self.color)\n\n\nclass FilledRect(Widget):\n def draw(self, canvas, drawer):\n drawer.rectangle(self.xy, fill=self.color)\n\n\nclass Text(Widget):\n def __init__(self, value=\"\", position=(0, 0), font=None, color=0, wrap=False, max_length=0):\n super().__init__(position, color)\n self.value = value\n self.font = font\n self.wrap = wrap\n self.max_length = max_length\n self.wrapper = TextWrapper(width=self.max_length, replace_whitespace=False) if wrap else None\n\n def draw(self, canvas, drawer):\n if self.value is not None:\n if self.wrap:\n text = '\\n'.join(self.wrapper.wrap(self.value))\n else:\n text = self.value\n drawer.text(self.xy, text, font=self.font, fill=self.color)\n\n\nclass LabeledValue(Widget):\n def __init__(self, label, value=\"\", position=(0, 0), label_font=None, text_font=None, color=0, label_spacing=5, max_length=0):\n super().__init__(position, color)\n self.label = label\n self.label_font = label_font\n self.max_length = max_length\n self.value = value\n self.text_font = text_font\n self.label_spacing = label_spacing\n\n def draw(self, canvas, drawer):\n if self.max_length > 0:\n value = self.value[:self.max_length]\n else:\n value = self.value\n\n if self.label is None:\n drawer.text(self.xy, value, font=self.label_font, fill=self.color)\n else:\n pos = self.xy\n drawer.text(pos, self.label, font=self.label_font, fill=self.color)\n drawer.text((pos[0] + self.label_spacing + 5 * len(self.label), pos[1]), value, font=self.text_font, fill=self.color)\n" }, { "path": "stenogotchi/ui/display.py", "content": "import os\nimport logging\nimport threading\n\nimport stenogotchi.plugins as plugins\nimport stenogotchi.ui.hw as hw\nfrom stenogotchi.ui.view import View\n\n\nclass Display(View):\n def __init__(self, config, state={}):\n super(Display, self).__init__(config, hw.display_for(config), state)\n config = config['ui']['display']\n\n self._enabled = config['enabled']\n self._rotation = config['rotation']\n\n self.init_display()\n\n self._canvas_next_event = threading.Event()\n self._canvas_next = None\n self._render_thread_instance = threading.Thread(\n target=self._render_thread,\n daemon=True\n )\n self._render_thread_instance.start()\n\n def is_waveshare_v2(self):\n return self._implementation.name == 'waveshare_2'\n\n def init_display(self):\n if self._enabled:\n self._implementation.initialize()\n plugins.on('display_setup', self._implementation)\n else:\n logging.warning(\"display module is disabled\")\n self.on_render(self._on_view_rendered)\n\n def clear(self):\n self._implementation.clear()\n\n def image(self):\n img = None\n if self._canvas is not None:\n img = self._canvas if self._rotation == 0 else self._canvas.rotate(-self._rotation)\n return img\n\n def _render_thread(self):\n \"\"\"Used for non-blocking screen updating.\"\"\"\n\n while True:\n self._canvas_next_event.wait()\n self._canvas_next_event.clear()\n self._implementation.render(self._canvas_next)\n\n def _on_view_rendered(self, img):\n try:\n if self._config['ui']['web']['on_frame'] != '':\n os.system(self._config['ui']['web']['on_frame'])\n except Exception as e:\n logging.error(\"%s\" % e)\n\n if self._enabled:\n self._canvas = (img if self._rotation == 0 else img.rotate(self._rotation))\n if self._implementation is not None:\n self._canvas_next = self._canvas\n self._canvas_next_event.set()" }, { "path": "stenogotchi/ui/faces.py", "content": "LOOK_R = '( ⚆_⚆)'\nLOOK_L = '(☉_☉ )'\nLOOK_R_HAPPY = '( ◕‿◕)'\nLOOK_L_HAPPY = '(◕‿◕ )'\nSLEEP = '(⇀‿‿↼)'\nSLEEP2 = '(≖‿‿≖)'\nAWAKE = '(◕‿‿◕)'\nBORED = '(-__-)'\nINTENSE = '(°▃▃°)'\nCOOL = '(⌐■_■)'\nHAPPY = '(•‿‿•)'\nGRATEFUL = '(^‿‿^)'\nEXCITED = '(ᵔ◡◡ᵔ)'\nMOTIVATED = '(☼‿‿☼)'\nDEMOTIVATED = '(≖__≖)'\nSMART = '(✜‿‿✜)'\nLONELY = '(ب__ب)'\nSAD = '(╥☁╥ )'\nANGRY = \"(-_-')\"\nFRIEND = '(♥‿‿♥)'\nBROKEN = '(☓‿‿☓)'\nDEBUG = '(#__#)'\nPROCESS_1 = '(1__0)'\nPROCESS_2 = '(1__1)'\nPROCESS_3 = '(0__1)'\nPROCESS_4 = '(0__0)'\n\n\ndef load_from_config(config):\n for face_name, face_value in config.items():\n globals()[face_name.upper()] = face_value" }, { "path": "stenogotchi/ui/fonts.py", "content": "from PIL import ImageFont\n\n# should not be changed\nFONT_NAME = 'DejaVuSansMono'\n\n# can be changed\nSTATUS_FONT_NAME = None\nSIZE_OFFSET = 0\n\nBold = None\nBoldSmall = None\nBoldBig = None\nMedium = None\nSmall = None\nHuge = None\n\n\ndef init(config):\n global STATUS_FONT_NAME, SIZE_OFFSET\n STATUS_FONT_NAME = config['ui']['font']['name']\n SIZE_OFFSET = config['ui']['font']['size_offset']\n setup(10, 9, 10, 35, 25, 9)\n\n\ndef status_font(old_font):\n global STATUS_FONT_NAME, SIZE_OFFSET\n return ImageFont.truetype(STATUS_FONT_NAME, size=old_font.size + SIZE_OFFSET)\n\n\ndef setup(bold, bold_small, medium, huge, bold_big, small):\n global Bold, BoldSmall, Medium, Huge, BoldBig, Small, FONT_NAME\n\n Small = ImageFont.truetype(FONT_NAME, small)\n Medium = ImageFont.truetype(FONT_NAME, medium)\n BoldSmall = ImageFont.truetype(\"%s-Bold\" % FONT_NAME, bold_small)\n Bold = ImageFont.truetype(\"%s-Bold\" % FONT_NAME, bold)\n BoldBig = ImageFont.truetype(\"%s-Bold\" % FONT_NAME, bold_big)\n Huge = ImageFont.truetype(\"%s-Bold\" % FONT_NAME, huge)" }, { "path": "stenogotchi/ui/hw/__init__.py", "content": "from stenogotchi.ui.hw.waveshare2 import WaveshareV2\n\ndef display_for(config):\n # config has been normalized already in utils.load_config\n if config['ui']['display']['type'] == 'waveshare_2':\n return WaveshareV2(config)\n else:\n print(\"no display specified\")" }, { "path": "stenogotchi/ui/hw/base.py", "content": "import stenogotchi.ui.fonts as fonts\n\n\nclass DisplayImpl(object):\n def __init__(self, config, name):\n self.name = name\n self.config = config['ui']['display']\n self._layout = {\n 'width': 0,\n 'height': 0,\n 'face': (0, 0),\n 'name': (0, 0),\n 'ups': (0, 0),\n 'wpm': (0, 0),\n 'strokes': (0, 0),\n 'uptime': (0, 0),\n 'line1': (0, 0),\n 'line2': (0, 0),\n 'friend_face': (0, 0),\n 'friend_name': (0, 0),\n 'bthost': {\n 'pos': (0, 0),\n 'max': 20\n },\n 'wifi': {\n 'pos': (0, 0),\n 'max': 20\n },\n 'mode': (0, 0),\n # status is special :D\n 'status': {\n 'pos': (0, 0),\n 'font': fonts.status_font(fonts.Medium),\n 'max': 20\n }\n }\n\n def layout(self):\n raise NotImplementedError\n\n def initialize(self):\n raise NotImplementedError\n\n def render(self, canvas):\n raise NotImplementedError\n\n def clear(self):\n raise NotImplementedError" }, { "path": "stenogotchi/ui/hw/libs/__init__.py", "content": "" }, { "path": "stenogotchi/ui/hw/libs/waveshare/__init__.py", "content": "" }, { "path": "stenogotchi/ui/hw/libs/waveshare/v2/__init__.py", "content": "" }, { "path": "stenogotchi/ui/hw/libs/waveshare/v2/epd2in13_V2.py", "content": "# //*****************************************************************************\n# * | File :\t epd2in13.py\n# * | Author : Waveshare team\n# * | Function : Electronic paper driver\n# * | Info :\n# *----------------\n# * |\tThis version: V3.0\n# * | Date : 2018-11-01\n# * | Info : python2 demo\n# * 1.Remove:\n# digital_write(self, pin, value)\n# digital_read(self, pin)\n# delay_ms(self, delaytime)\n# set_lut(self, lut)\n# self.lut = self.lut_full_update\n# * 2.Change:\n# display_frame -> TurnOnDisplay\n# set_memory_area -> SetWindow\n# set_memory_pointer -> SetCursor\n# * 3.How to use\n# epd = epd2in13.EPD()\n# epd.init(epd.lut_full_update)\n# image = Image.new('1', (epd2in13.EPD_WIDTH, epd2in13.EPD_HEIGHT), 255)\n# ...\n# drawing ......\n# ...\n# epd.display(getbuffer(image))\n# ******************************************************************************//\n# Permission is hereby granted, free of charge, to any person obtaining a copy\n# of this software and associated documentation files (the \"Software\"), to deal\n# in the Software without restriction, including without limitation the rights\n# to use, copy, modify, merge, publish, distribute, sublicense, and//or sell\n# copies of the Software, and to permit persons to whom the Software is\n# furnished to do so, subject to the following conditions:\n#\n# The above copyright notice and this permission notice shall be included in\n# all copies or substantial portions of the Software.\n#\n# THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n# FITNESS OR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n# LIABILITY WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\n# THE SOFTWARE.\n#\n\nimport time\nimport spidev\nimport RPi.GPIO as GPIO\nfrom PIL import Image\n\n# Pin definition\nRST_PIN = 17\nDC_PIN = 25\nCS_PIN = 8\nBUSY_PIN = 24\n\n# SPI device, bus = 0, device = 0\nSPI = spidev.SpiDev(0, 0)\n\n\ndef digital_write(pin, value):\n GPIO.output(pin, value)\n\n\ndef digital_read(pin):\n return GPIO.input(BUSY_PIN)\n\n\ndef delay_ms(delaytime):\n time.sleep(delaytime / 1000.0)\n\n\ndef spi_writebyte(data):\n SPI.writebytes(data)\n\n\ndef module_init():\n GPIO.setmode(GPIO.BCM)\n GPIO.setwarnings(False)\n GPIO.setup(RST_PIN, GPIO.OUT)\n GPIO.setup(DC_PIN, GPIO.OUT)\n GPIO.setup(CS_PIN, GPIO.OUT)\n GPIO.setup(BUSY_PIN, GPIO.IN)\n SPI.max_speed_hz = 2000000\n SPI.mode = 0b00\n return 0;\n\n\n# Display resolution\nEPD_WIDTH = 122\nEPD_HEIGHT = 250\n\n\nclass EPD:\n def __init__(self):\n self.reset_pin = RST_PIN\n self.dc_pin = DC_PIN\n self.busy_pin = BUSY_PIN\n self.width = EPD_WIDTH\n self.height = EPD_HEIGHT\n\n FULL_UPDATE = 0\n PART_UPDATE = 1\n lut_full_update = [\n 0x80, 0x60, 0x40, 0x00, 0x00, 0x00, 0x00, # LUT0: BB: VS 0 ~7\n 0x10, 0x60, 0x20, 0x00, 0x00, 0x00, 0x00, # LUT1: BW: VS 0 ~7\n 0x80, 0x60, 0x40, 0x00, 0x00, 0x00, 0x00, # LUT2: WB: VS 0 ~7\n 0x10, 0x60, 0x20, 0x00, 0x00, 0x00, 0x00, # LUT3: WW: VS 0 ~7\n 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, # LUT4: VCOM: VS 0 ~7\n\n 0x03, 0x03, 0x00, 0x00, 0x02, # TP0 A~D RP0\n 0x09, 0x09, 0x00, 0x00, 0x02, # TP1 A~D RP1\n 0x03, 0x03, 0x00, 0x00, 0x02, # TP2 A~D RP2\n 0x00, 0x00, 0x00, 0x00, 0x00, # TP3 A~D RP3\n 0x00, 0x00, 0x00, 0x00, 0x00, # TP4 A~D RP4\n 0x00, 0x00, 0x00, 0x00, 0x00, # TP5 A~D RP5\n 0x00, 0x00, 0x00, 0x00, 0x00, # TP6 A~D RP6\n\n 0x15, 0x41, 0xA8, 0x32, 0x30, 0x0A,\n ]\n\n lut_partial_update = [ # 20 bytes\n 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, # LUT0: BB: VS 0 ~7\n 0x80, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, # LUT1: BW: VS 0 ~7\n 0x40, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, # LUT2: WB: VS 0 ~7\n 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, # LUT3: WW: VS 0 ~7\n 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, # LUT4: VCOM: VS 0 ~7\n\n 0x0A, 0x00, 0x00, 0x00, 0x00, # TP0 A~D RP0\n 0x00, 0x00, 0x00, 0x00, 0x00, # TP1 A~D RP1\n 0x00, 0x00, 0x00, 0x00, 0x00, # TP2 A~D RP2\n 0x00, 0x00, 0x00, 0x00, 0x00, # TP3 A~D RP3\n 0x00, 0x00, 0x00, 0x00, 0x00, # TP4 A~D RP4\n 0x00, 0x00, 0x00, 0x00, 0x00, # TP5 A~D RP5\n 0x00, 0x00, 0x00, 0x00, 0x00, # TP6 A~D RP6\n\n 0x15, 0x41, 0xA8, 0x32, 0x30, 0x0A,\n ]\n\n # Hardware reset\n def reset(self):\n digital_write(self.reset_pin, GPIO.HIGH)\n delay_ms(200)\n digital_write(self.reset_pin, GPIO.LOW) # module reset\n delay_ms(200)\n digital_write(self.reset_pin, GPIO.HIGH)\n delay_ms(200)\n\n def send_command(self, command):\n digital_write(self.dc_pin, GPIO.LOW)\n spi_writebyte([command])\n\n def send_data(self, data):\n digital_write(self.dc_pin, GPIO.HIGH)\n spi_writebyte([data])\n\n def wait_until_idle(self):\n while (digital_read(self.busy_pin) == 1): # 0: idle, 1: busy\n delay_ms(100)\n\n def TurnOnDisplay(self):\n self.send_command(0x22)\n self.send_data(0xC7)\n self.send_command(0x20)\n self.wait_until_idle()\n\n def init(self, update):\n if (module_init() != 0):\n return -1\n # EPD hardware init start\n self.reset()\n if (update == self.FULL_UPDATE):\n self.wait_until_idle()\n self.send_command(0x12) # soft reset\n self.wait_until_idle()\n\n self.send_command(0x74) # set analog block control\n self.send_data(0x54)\n self.send_command(0x7E) # set digital block control\n self.send_data(0x3B)\n\n self.send_command(0x01) # Driver output control\n self.send_data(0xF9)\n self.send_data(0x00)\n self.send_data(0x00)\n\n self.send_command(0x11) # data entry mode\n self.send_data(0x01)\n\n self.send_command(0x44) # set Ram-X address start//end position\n self.send_data(0x00)\n self.send_data(0x0F) # 0x0C-->(15+1)*8=128\n\n self.send_command(0x45) # set Ram-Y address start//end position\n self.send_data(0xF9) # 0xF9-->(249+1)=250\n self.send_data(0x00)\n self.send_data(0x00)\n self.send_data(0x00)\n\n self.send_command(0x3C) # BorderWavefrom\n self.send_data(0x03)\n\n self.send_command(0x2C) # VCOM Voltage\n self.send_data(0x55) #\n\n self.send_command(0x03)\n self.send_data(self.lut_full_update[70])\n\n self.send_command(0x04) #\n self.send_data(self.lut_full_update[71])\n self.send_data(self.lut_full_update[72])\n self.send_data(self.lut_full_update[73])\n\n self.send_command(0x3A) # Dummy Line\n self.send_data(self.lut_full_update[74])\n self.send_command(0x3B) # Gate time\n self.send_data(self.lut_full_update[75])\n\n self.send_command(0x32)\n for count in range(70):\n self.send_data(self.lut_full_update[count])\n\n self.send_command(0x4E) # set RAM x address count to 0\n self.send_data(0x00)\n self.send_command(0x4F) # set RAM y address count to 0X127\n self.send_data(0xF9)\n self.send_data(0x00)\n self.wait_until_idle()\n else:\n self.send_command(0x2C) # VCOM Voltage\n self.send_data(0x26)\n\n self.wait_until_idle()\n\n self.send_command(0x32)\n for count in range(70):\n self.send_data(self.lut_partial_update[count])\n\n self.send_command(0x37)\n self.send_data(0x00)\n self.send_data(0x00)\n self.send_data(0x00)\n self.send_data(0x00)\n self.send_data(0x40)\n self.send_data(0x00)\n self.send_data(0x00)\n\n self.send_command(0x22)\n self.send_data(0xC0)\n self.send_command(0x20)\n self.wait_until_idle()\n\n self.send_command(0x3C) # BorderWavefrom\n self.send_data(0x01)\n return 0\n\n def getbuffer(self, image):\n if self.width % 8 == 0:\n linewidth = self.width // 8\n else:\n linewidth = self.width // 8 + 1\n\n buf = [0xFF] * (linewidth * self.height)\n image_monocolor = image.convert('1')\n imwidth, imheight = image_monocolor.size\n pixels = image_monocolor.load()\n\n if (imwidth == self.width and imheight == self.height):\n # print(\"Vertical\")\n for y in range(imheight):\n for x in range(imwidth):\n if pixels[x, y] == 0:\n x = imwidth - x\n buf[x // 8 + y * linewidth] &= ~(0x80 >> (x % 8))\n elif (imwidth == self.height and imheight == self.width):\n # print(\"Horizontal\")\n for y in range(imheight):\n for x in range(imwidth):\n newx = y\n newy = self.height - x - 1\n if pixels[x, y] == 0:\n newy = imwidth - newy - 1\n buf[newx // 8 + newy * linewidth] &= ~(0x80 >> (y % 8))\n return buf\n\n def display(self, image):\n if self.width % 8 == 0:\n linewidth = self.width // 8\n else:\n linewidth = self.width // 8 + 1\n\n self.send_command(0x24)\n for j in range(0, self.height):\n for i in range(0, linewidth):\n self.send_data(image[i + j * linewidth])\n self.TurnOnDisplay()\n\n def displayPartial(self, image):\n if self.width % 8 == 0:\n linewidth = self.width // 8\n else:\n linewidth = self.width // 8 + 1\n\n self.send_command(0x24)\n for j in range(0, self.height):\n for i in range(0, linewidth):\n self.send_data(image[i + j * linewidth])\n self.send_command(0x26)\n for j in range(0, self.height):\n for i in range(0, linewidth):\n self.send_data(~image[i + j * linewidth])\n self.TurnOnDisplay()\n\n def Clear(self, color):\n if self.width % 8 == 0:\n linewidth = self.width // 8\n else:\n linewidth = self.width // 8 + 1\n # print(linewidth)\n\n self.send_command(0x24)\n for j in range(0, self.height):\n for i in range(0, linewidth):\n self.send_data(color)\n self.TurnOnDisplay()\n\n def sleep(self):\n self.send_command(0x22) # POWER OFF\n self.send_data(0xC3)\n self.send_command(0x20)\n\n self.send_command(0x10) # enter deep sleep\n self.send_data(0x01)\n delay_ms(100)\n\n ### END OF FILE ###" }, { "path": "stenogotchi/ui/hw/waveshare2.py", "content": "import logging\n\nimport stenogotchi.ui.fonts as fonts\nfrom stenogotchi.ui.hw.base import DisplayImpl\n\n\nclass WaveshareV2(DisplayImpl):\n def __init__(self, config):\n super(WaveshareV2, self).__init__(config, 'waveshare_2')\n self._display = None\n\n def layout(self):\n if self.config['color'] == 'black':\n fonts.setup(10, 9, 10, 35, 25, 9)\n self._layout['width'] = 250\n self._layout['height'] = 122\n self._layout['face'] = (0, 40)\n self._layout['name'] = (5, 20)\n self._layout['ups'] = (0, 0)\n self._layout['wpm'] = {\n 'pos': (50, 0),\n 'max': 9\n }\n self._layout['strokes'] = {\n 'pos': (128, 0),\n 'max': 5\n }\n self._layout['uptime'] = (185, 0)\n self._layout['line1'] = [0, 14, 250, 14]\n self._layout['line2'] = [0, 108, 250, 108]\n self._layout['friend_face'] = (0, 92)\n self._layout['friend_name'] = (40, 94)\n self._layout['bthost'] = {\n 'pos': (0, 109),\n 'max': 15\n }\n self._layout['wifi'] = {\n 'pos': (113, 109),\n 'max': 12\n }\n self._layout['mode'] = (210, 109)\n self._layout['status'] = {\n 'pos': (125, 20),\n 'font': fonts.status_font(fonts.Medium),\n 'max': 20\n }\n else: # these are not correctly configured based on different width and height of color display\n fonts.setup(10, 9, 10, 35, 25, 9)\n self._layout['width'] = 212\n self._layout['height'] = 104\n self._layout['face'] = (0, 26)\n self._layout['name'] = (5, 15)\n self._layout['ups'] = (0, 0)\n self._layout['wpm'] = {\n 'pos': (50, 0),\n 'max': 9\n }\n self._layout['strokes'] = {\n 'pos': (128, 0),\n 'max': 5\n }\n self._layout['status'] = (91, 15)\n self._layout['uptime'] = (147, 0)\n self._layout['line1'] = [0, 12, 212, 12]\n self._layout['line2'] = [0, 92, 212, 92]\n self._layout['friend_face'] = (0, 76)\n self._layout['friend_name'] = (40, 78)\n self._layout['bthost'] = {\n 'pos': (0, 93),\n 'max': 15\n }\n self._layout['wifi'] = {\n 'pos': (113, 109),\n 'max': 12\n }\n self._layout['mode'] = (187, 93)\n self._layout['status'] = {\n 'pos': (125, 20),\n 'font': fonts.status_font(fonts.Medium),\n 'max': 14\n }\n return self._layout\n\n def initialize(self):\n logging.info(\"initializing waveshare v2 display\")\n from stenogotchi.ui.hw.libs.waveshare.v2.epd2in13_V2 import EPD\n self._display = EPD()\n self._display.init(self._display.FULL_UPDATE)\n self._display.Clear(0xff)\n self._display.init(self._display.PART_UPDATE)\n\n def render(self, canvas):\n buf = self._display.getbuffer(canvas)\n self._display.displayPartial(buf)\n\n def clear(self):\n self._display.Clear(0xff)\n" }, { "path": "stenogotchi/ui/state.py", "content": "from threading import Lock\n\n\nclass State(object):\n def __init__(self, state={}):\n self._state = state\n self._lock = Lock()\n self._listeners = {}\n self._changes = {}\n\n def add_element(self, key, elem):\n self._state[key] = elem\n self._changes[key] = True\n\n def has_element(self, key):\n return key in self._state\n\n def remove_element(self, key):\n del self._state[key]\n self._changes[key] = True\n\n def add_listener(self, key, cb):\n with self._lock:\n self._listeners[key] = cb\n\n def items(self):\n with self._lock:\n return self._state.items()\n\n def get(self, key):\n with self._lock:\n return self._state[key].value if key in self._state else None\n\n def reset(self):\n with self._lock:\n self._changes = {}\n\n def changes(self, ignore=()):\n with self._lock:\n changes = []\n for change in self._changes.keys():\n if change not in ignore:\n changes.append(change)\n return changes\n\n def has_changes(self):\n with self._lock:\n return len(self._changes) > 0\n\n def set(self, key, value):\n with self._lock:\n if key in self._state:\n prev = self._state[key].value\n self._state[key].value = value\n\n if prev != value:\n self._changes[key] = True\n if key in self._listeners and self._listeners[key] is not None:\n self._listeners[key](prev, value)\n" }, { "path": "stenogotchi/ui/view.py", "content": "import _thread\nfrom threading import Lock\nimport time\nimport logging\nimport random\nfrom PIL import ImageDraw\n\nimport stenogotchi\nimport stenogotchi.utils as utils\nimport stenogotchi.plugins as plugins\nfrom stenogotchi.voice import Voice\n\nimport stenogotchi.ui.web as web\nimport stenogotchi.ui.fonts as fonts\nimport stenogotchi.ui.faces as faces\nfrom stenogotchi.ui.components import *\nfrom stenogotchi.ui.state import State\n\nWHITE = 0xff\nBLACK = 0x00\nROOT = None\n\n\nclass View(object):\n def __init__(self, config, impl, state=None):\n global ROOT\n\n # setup faces from the configuration in case the user customized them\n faces.load_from_config(config['ui']['faces'])\n\n self._agent = None\n self._render_cbs = []\n self._config = config\n self._canvas = None\n self._frozen = False\n self._lock = Lock()\n self._voice = Voice(lang=config['main']['lang'])\n self._implementation = impl\n self._layout = impl.layout()\n self._width = self._layout['width']\n self._height = self._layout['height']\n self._state = State(state={\n 'ups': LabeledValue(color=BLACK, label='BAT', value='', position=self._layout['ups'],\n label_font=fonts.Bold,text_font=fonts.Medium),\n\n 'wpm': LabeledValue(color=BLACK, label='WPM', value='', position=self._layout['wpm']['pos'],\n label_font=fonts.Bold, text_font=fonts.Medium, max_length=self._layout['wpm']['max']),\n\n 'strokes': LabeledValue(color=BLACK, label='STR', value='', position=self._layout['strokes']['pos'],\n label_font=fonts.Bold, text_font=fonts.Medium, max_length=self._layout['strokes']['max']),\n\n 'uptime': LabeledValue(color=BLACK, label='UP', value='', position=self._layout['uptime'],\n label_font=fonts.Bold, text_font=fonts.Medium),\n\n 'line1': Line(self._layout['line1'], color=BLACK),\n \n 'line2': Line(self._layout['line2'], color=BLACK),\n \n 'face': Text(value=faces.SLEEP, position=self._layout['face'], color=BLACK, font=fonts.Huge),\n \n 'friend_face': Text(value=None, position=self._layout['friend_face'], font=fonts.Bold, color=BLACK),\n \n 'friend_name': Text(value=None, position=self._layout['friend_name'], font=fonts.BoldSmall, color=BLACK),\n \n 'name': Text(value='%s>' % 'stenogotchi', position=self._layout['name'], color=BLACK, font=fonts.Bold),\n \n 'status': Text(value=self._voice.default(),\n position=self._layout['status']['pos'],\n color=BLACK,\n font=self._layout['status']['font'],\n wrap=True,\n # the current maximum number of characters per line, assuming each character is 6 pixels wide\n max_length=self._layout['status']['max']),\n\n 'bthost': LabeledValue(label='BT', value='', color=BLACK,\n position=self._layout['bthost']['pos'], label_font=fonts.Bold,\n text_font=fonts.Medium, max_length=self._layout['bthost']['max']),\n \n 'wifi': LabeledValue(label='WIFI', value='', color=BLACK,\n position=self._layout['wifi']['pos'], label_font=fonts.Bold,\n text_font=fonts.Medium, max_length=self._layout['wifi']['max']),\n \n 'mode': Text(value='NONE', position=self._layout['mode'],\n font=fonts.Bold, color=BLACK),\n })\n\n if state:\n for key, value in state.items():\n self._state.set(key, value)\n\n plugins.on('ui_setup', self)\n\n if config['ui']['fps'] > 0.0:\n _thread.start_new_thread(self._refresh_handler, ())\n self._ignore_changes = ()\n else:\n logging.warning(\"ui.fps is 0, the display will only update for major changes\")\n self._ignore_changes = ('uptime', 'name')\n\n ROOT = self\n\n def set_agent(self, agent):\n self._agent = agent\n\n def has_element(self, key):\n self._state.has_element(key)\n\n def add_element(self, key, elem):\n self._state.add_element(key, elem)\n\n def remove_element(self, key):\n self._state.remove_element(key)\n\n def width(self):\n return self._width\n\n def height(self):\n return self._height\n\n def on_state_change(self, key, cb):\n self._state.add_listener(key, cb)\n\n def on_render(self, cb):\n if cb not in self._render_cbs:\n self._render_cbs.append(cb)\n\n def _refresh_handler(self):\n delay = 1.0 / self._config['ui']['fps']\n while True:\n try:\n name = self._state.get('name')\n self.set('name', name.rstrip('█').strip() if '█' in name else (name + ' █'))\n self.update()\n except Exception as e:\n logging.warning(\"non fatal error while updating view: %s\" % e)\n\n time.sleep(delay)\n\n def set(self, key, value):\n self._state.set(key, value)\n\n def get(self, key):\n return self._state.get(key)\n\n def on_starting(self):\n self.set('status', self._voice.on_starting() + (\"\\n(v%s)\" % stenogotchi.__version__))\n self.set('face', faces.AWAKE)\n self.update()\n\n def on_manual_mode(self, last_session):\n self.set('mode', 'MANU')\n self.set('face', faces.HAPPY)\n self.set('status', self._voice.on_last_session_data(last_session))\n self.set('uptime', last_session.duration)\n self.update()\n\n def is_normal(self):\n return self._state.get('face') not in (\n faces.INTENSE,\n faces.COOL,\n faces.BORED,\n faces.HAPPY,\n faces.EXCITED,\n faces.MOTIVATED,\n faces.DEMOTIVATED,\n faces.SMART,\n faces.SAD,\n faces.LONELY)\n\n def on_keys_generation(self):\n self.set('face', faces.AWAKE)\n self.set('status', self._voice.on_keys_generation())\n self.update()\n\n def on_normal(self):\n self.set('face', faces.AWAKE)\n self.set('status', self._voice.on_normal())\n self.update()\n\n def on_reading_logs(self, lines_so_far=0):\n self.set('face', faces.SMART)\n self.set('status', self._voice.on_reading_logs(lines_so_far))\n self.update()\n\n def wait(self, secs, sleeping=True):\n was_normal = self.is_normal()\n part = secs / 10.0\n \n for step in range(0, 10):\n # if we weren't in a normal state before going\n # to sleep, keep that face and status on for\n # a while, otherwise the sleep animation will\n # always override any minor state change before it\n if was_normal or step > 5:\n if sleeping:\n if secs > 1:\n self.set('face', faces.SLEEP)\n self.set('status', self._voice.on_napping(int(secs)))\n else:\n self.set('face', faces.SLEEP2)\n self.set('status', self._voice.on_awakening())\n else:\n self.set('status', self._voice.on_waiting(int(secs)))\n good_mood = self._agent.in_good_mood()\n if step % 2 == 0:\n self.set('face', faces.LOOK_R_HAPPY if good_mood else faces.LOOK_R)\n else:\n self.set('face', faces.LOOK_L_HAPPY if good_mood else faces.LOOK_L)\n\n time.sleep(part)\n secs -= part\n\n self.on_normal()\n\n def on_shutdown(self):\n face = random.choices((faces.SLEEP, faces.SLEEP2), weights=[0.7, 0.3], k=1)\n self.set('face', face[0])\n self.set('status', self._voice.on_shutdown())\n self.update(force=True)\n self._frozen = True\n\n def on_bored(self):\n self.set('face', faces.BORED)\n self.set('status', self._voice.on_bored())\n self.update()\n\n def on_sad(self):\n self.set('face', faces.SAD)\n self.set('status', self._voice.on_sad())\n self.update()\n\n def on_angry(self):\n self.set('face', faces.ANGRY)\n self.set('status', self._voice.on_angry())\n self.update()\n\n def on_motivated(self, reward):\n self.set('face', faces.MOTIVATED)\n self.set('status', self._voice.on_motivated(reward))\n self.update()\n\n def on_demotivated(self, reward):\n self.set('face', faces.DEMOTIVATED)\n self.set('status', self._voice.on_demotivated(reward))\n self.update()\n\n def on_excited(self):\n self.set('face', faces.EXCITED)\n self.set('status', self._voice.on_excited())\n self.update()\n\n def on_miss(self, who):\n self.set('face', faces.SAD)\n self.set('status', self._voice.on_miss(who))\n self.update()\n\n def on_grateful(self):\n self.set('face', faces.GRATEFUL)\n self.set('status', self._voice.on_grateful())\n self.update()\n\n def on_lonely(self):\n self.set('face', faces.LONELY)\n self.set('status', self._voice.on_lonely())\n self.update()\n\n def on_processing(self):\n start_face = self._state.get('face')\n processing_faces = [faces.PROCESS_1, faces.PROCESS_2, faces.PROCESS_3, faces.PROCESS_4]\n for face in processing_faces:\n self.set('face', face)\n self.update()\n time.sleep(2)\n self.set('face', start_face)\n self.update()\n\n def on_rebooting(self):\n self.set('face', faces.BROKEN)\n self.set('status', self._voice.on_rebooting())\n self.update()\n\n def on_custom(self, text):\n self.set('face', faces.DEBUG)\n self.set('status', self._voice.custom(text))\n self.update()\n \n def on_plover_boot(self):\n face = random.choices([faces.SLEEP, faces.SLEEP2, faces.BORED], weights=[0.6, 0.3, 0.1], k=1)\n self.set('face', face[0])\n self.set('status', self._voice.on_plover_boot())\n self.update()\n\n def on_plover_ready(self):\n face = random.choices([faces.AWAKE, faces.LOOK_R_HAPPY, faces.LOOK_L_HAPPY, faces.EXCITED, faces.GRATEFUL], weights=[0.5, 0.2, 0.2, 0.05, 0.05], k=1)\n self.set('face', face[0])\n self.set('status', self._voice.on_plover_ready())\n if self._state.get('mode') == 'NONE':\n self.set('mode', 'STENO')\n self.update()\n\n def on_plover_quit(self):\n face = random.choice((faces.BROKEN, faces.DEBUG))\n self.set('face', face)\n self.set('status', 'Uh-oh... I think Plover just quit on us')\n if self._state.get('mode') == 'STENO':\n self.set('mode', 'NONE')\n self.update()\n\n def on_wpm(self, wpm):\n self.set('wpm', wpm)\n self.update()\n\n def on_strokes(self, strokes):\n self.set('strokes', strokes)\n self.update()\n\n def on_wpm_record(self, wpm_top):\n if wpm_top < 100:\n self.set('face', faces.LOOK_R_HAPPY)\n elif wpm_top < 200:\n self.set('face', faces.EXCITED)\n else:\n self.set('face', faces.INTENSE)\n self.set('status', self._voice.on_wpm_record(wpm_top))\n # Don't trigger self.update as we always will call set_wpm() afterwards.\n\n def on_bt_connected(self, bthost_name):\n self.set('face', faces.LOOK_L_HAPPY)\n self.set('status', self._voice.on_bt_connected(bthost_name))\n self.update()\n\n def on_bt_disconnected(self):\n self.set('face', faces.INTENSE)\n self.set('status', self._voice.on_bt_disconnected())\n self.update()\n\n def on_wifi_connected(self, ssid, ip):\n self.set('face', faces.COOL)\n self.set('status', self._voice.on_wifi_connected(ssid, ip))\n self.update()\n\n def on_wifi_disconnected(self):\n self.set('face', faces.LONELY)\n self.set('status', self._voice.on_wifi_disconnected())\n self.update()\n \n def on_dict_lookup_done(self):\n face = random.choices([faces.AWAKE, faces.LOOK_R_HAPPY, faces.LOOK_L_HAPPY, faces.EXCITED, faces.GRATEFUL], weights=[0.5, 0.2, 0.2, 0.05, 0.05], k=1)\n self.set('face', face[0])\n self.set('status', self._voice.on_dict_lookup_done())\n self.update()\n\n def update(self, force=False, new_data={}):\n for key, val in new_data.items():\n self.set(key, val)\n\n with self._lock:\n if self._frozen:\n return\n\n state = self._state\n changes = state.changes(ignore=self._ignore_changes)\n if force or len(changes):\n self._canvas = Image.new('1', (self._width, self._height), WHITE)\n drawer = ImageDraw.Draw(self._canvas)\n\n plugins.on('ui_update', self)\n\n for key, lv in state.items():\n lv.draw(self._canvas, drawer)\n\n web.update_frame(self._canvas)\n\n for cb in self._render_cbs:\n cb(self._canvas)\n\n self._state.reset()\n" }, { "path": "stenogotchi/ui/web/__init__.py", "content": "import os\nfrom threading import Lock\n\nframe_path = '/var/tmp/stenogotchi/stenogotchi.png'\nframe_format = 'PNG'\nframe_ctype = 'image/png'\nframe_lock = Lock()\n\n\ndef update_frame(img):\n global frame_lock, frame_path, frame_format\n if not os.path.exists(os.path.dirname(frame_path)):\n os.makedirs(os.path.dirname(frame_path))\n with frame_lock:\n img.save(frame_path, format=frame_format)\n" }, { "path": "stenogotchi/ui/web/handler.py", "content": "import logging\nimport os\nimport _thread\nimport secrets\nimport subprocess\nfrom functools import wraps\n\n# https://stackoverflow.com/questions/14888799/disable-console-messages-in-flask-server\nlogging.getLogger('werkzeug').setLevel(logging.ERROR)\nos.environ['WERKZEUG_RUN_MAIN'] = 'true'\n\nimport stenogotchi\nimport stenogotchi.ui.web as web\nfrom stenogotchi import plugins\n\nfrom flask import send_file\nfrom flask import Response\nfrom flask import request\nfrom flask import abort\nfrom flask import redirect\nfrom flask import render_template, render_template_string\n\n\nclass Handler:\n def __init__(self, config, agent, app):\n self._config = config\n self._agent = agent\n self._app = app\n\n self._app.add_url_rule('/', 'index', self.with_auth(self.index))\n self._app.add_url_rule('/ui', 'ui', self.with_auth(self.ui))\n\n self._app.add_url_rule('/shutdown', 'shutdown', self.with_auth(self.shutdown), methods=['POST'])\n \n self._app.add_url_rule('/toggle_input', 'toggle_input', self.with_auth(self.toggle_input), methods=['POST'])\n self._app.add_url_rule('/toggle_wpm', 'toggle_wpm', self.with_auth(self.toggle_wpm), methods=['POST'])\n self._app.add_url_rule('/toggle_lookup', 'toggle_lookup', self.with_auth(self.toggle_lookup), methods=['POST'])\n self._app.add_url_rule('/buttonshim/