├── .gitignore ├── LICENSE ├── README-development.md ├── README.md ├── setup.py ├── src └── diii │ ├── __init__.py │ ├── cli.py │ ├── exceptions.py │ ├── iii.py │ ├── repl.py │ └── server.py └── tests ├── druid.log ├── es.lua ├── metro.lua ├── slew.lua └── step.lua /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | share/python-wheels/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 27 | MANIFEST 28 | 29 | # PyInstaller 30 | # Usually these files are written by a python script from a template 31 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 32 | *.manifest 33 | *.spec 34 | 35 | # Installer logs 36 | pip-log.txt 37 | pip-delete-this-directory.txt 38 | 39 | # Unit test / coverage reports 40 | htmlcov/ 41 | .tox/ 42 | .nox/ 43 | .coverage 44 | .coverage.* 45 | .cache 46 | nosetests.xml 47 | coverage.xml 48 | *.cover 49 | *.py,cover 50 | .hypothesis/ 51 | .pytest_cache/ 52 | cover/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | .pybuilder/ 76 | target/ 77 | 78 | # Jupyter Notebook 79 | .ipynb_checkpoints 80 | 81 | # IPython 82 | profile_default/ 83 | ipython_config.py 84 | 85 | # pyenv 86 | # For a library or package, you might want to ignore these files since the code is 87 | # intended to run in multiple environments; otherwise, check them in: 88 | # .python-version 89 | 90 | # pipenv 91 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 92 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 93 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 94 | # install all needed dependencies. 95 | #Pipfile.lock 96 | 97 | # poetry 98 | # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. 99 | # This is especially recommended for binary packages to ensure reproducibility, and is more 100 | # commonly ignored for libraries. 101 | # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control 102 | #poetry.lock 103 | 104 | # pdm 105 | # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. 106 | #pdm.lock 107 | # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it 108 | # in version control. 109 | # https://pdm.fming.dev/latest/usage/project/#working-with-version-control 110 | .pdm.toml 111 | .pdm-python 112 | .pdm-build/ 113 | 114 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm 115 | __pypackages__/ 116 | 117 | # Celery stuff 118 | celerybeat-schedule 119 | celerybeat.pid 120 | 121 | # SageMath parsed files 122 | *.sage.py 123 | 124 | # Environments 125 | .env 126 | .venv 127 | env/ 128 | venv/ 129 | ENV/ 130 | env.bak/ 131 | venv.bak/ 132 | 133 | # Spyder project settings 134 | .spyderproject 135 | .spyproject 136 | 137 | # Rope project settings 138 | .ropeproject 139 | 140 | # mkdocs documentation 141 | /site 142 | 143 | # mypy 144 | .mypy_cache/ 145 | .dmypy.json 146 | dmypy.json 147 | 148 | # Pyre type checker 149 | .pyre/ 150 | 151 | # pytype static type analyzer 152 | .pytype/ 153 | 154 | # Cython debug symbols 155 | cython_debug/ 156 | 157 | # PyCharm 158 | # JetBrains specific template is maintained in a separate JetBrains.gitignore that can 159 | # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore 160 | # and can be added to the global gitignore or merged into this file. For a more nuclear 161 | # option (not recommended) you can uncomment the following to ignore the entire idea folder. 162 | #.idea/ 163 | 164 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README-development.md: -------------------------------------------------------------------------------- 1 | ## Setup 2 | First create a [virtual environment](https://docs.python.org/3/library/venv.html) and then do an [editable install](https://pip.pypa.io/en/latest/reference/pip_install/#editable-installs) of diii. 3 | ``` 4 | cd 5 | # Create virtual environment 6 | python3 -m venv .venv 7 | 8 | # Active the virtual environment 9 | # Linux / Mac OS 10 | source .venv/bin/activate 11 | # Windows 12 | source .venv/Scripts/activate 13 | 14 | # Do an editable install 15 | pip install -e . 16 | # Activate the virtual environment again to update virtual environment $PATH 17 | source .venv/bin/activate 18 | 19 | # Now execute diii, which runs directly from the code from this directory 20 | # Linux / Mac OS / Windows(PowerShell) 21 | diii 22 | # Windows (GIT Bash) 23 | winpty diii 24 | ``` 25 | 26 | Closing the terminal will also exit the virtual environment. Running `deactivate` will exit the virtual environment as well. 27 | 28 | If at a later point you want to start working again it's enough to activate the virtual environment again using 29 | ``` 30 | cd = 3.6 with `python --version`. 17 | 18 | Install and run: 19 | ```bash 20 | # Install diii 21 | pip3 install monome-diii 22 | # Run diii :) 23 | diii 24 | ``` 25 | 26 | ## diii 27 | 28 | Start by running `diii` 29 | 30 | - type q (enter) to quit. 31 | - type h (enter) for a list of special commands. 32 | 33 | - will reconnect to device after a disconnect / restart 34 | - scrollable console history 35 | 36 | Example: 37 | 38 | ``` 39 | q to quit. h for help 40 | 41 | > x=6 42 | 43 | > print(x) 44 | 6 45 | 46 | > q 47 | ``` 48 | 49 | Diagnostic logs are written to `diii.log`. 50 | 51 | ## Command Line Interface 52 | 53 | Sometimes you don't need the repl, but just want to upload/download scripts to/from device. You can do so directly from the command line with the `upload` and `download` commands. 54 | 55 | ### Upload 56 | 57 | ``` 58 | diii upload script.lua 59 | ``` 60 | 61 | Uploads the provided lua file `script.lua` to device and stores it in flash to be executed on boot. 62 | 63 | ### Download 64 | 65 | ``` 66 | diii download > feathers.lua 67 | ``` 68 | 69 | Grabs the script currently stored on device, and pastes the result into a new file `feathers.lua`. 70 | 71 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from setuptools import setup, find_packages 2 | 3 | # Read the contents of the readme to publish it to PyPI 4 | with open("README.md") as readme: 5 | long_description = readme.read() 6 | 7 | setup( 8 | name="monome-diii", 9 | description="Terminal interface for iii devices", 10 | long_description=long_description, 11 | long_description_content_type="text/markdown", 12 | url="https://github.com/monome/diii", 13 | author="monome", 14 | author_email="bcrabtree@monome.org", 15 | classifiers=[ 16 | "Programming Language :: Python :: 3", 17 | "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", 18 | "Operating System :: OS Independent", 19 | ], 20 | packages=find_packages("src"), 21 | package_dir={"": "src"}, 22 | include_package_data=True, 23 | use_scm_version=True, 24 | python_requires=">=3.6", 25 | setup_requires=[ 26 | "setuptools_scm", 27 | "setuptools_scm_git_archive", 28 | ], 29 | install_requires=[ 30 | "Click>=7.0", 31 | "packaging", 32 | "prompt-toolkit>=2.0.10,<3.0", 33 | "pyserial>=3.4", 34 | "pyusb", 35 | "requests", 36 | "websockets>=9.1", 37 | "setuptools", 38 | "setuptools_scm", 39 | "setuptools_scm_git_archive", 40 | ], 41 | extras_require={ 42 | "test": [ 43 | "pylint", 44 | ] 45 | }, 46 | entry_points={ 47 | "console_scripts": [ 48 | "diii=diii.cli:cli", 49 | ], 50 | }, 51 | ) 52 | -------------------------------------------------------------------------------- /src/diii/__init__.py: -------------------------------------------------------------------------------- 1 | import pkg_resources 2 | 3 | from setuptools_scm import get_version 4 | 5 | try: 6 | __version__ = get_version() 7 | except LookupError: 8 | from pkg_resources import get_distribution 9 | __version__ = get_distribution("monome-diii").version 10 | -------------------------------------------------------------------------------- /src/diii/cli.py: -------------------------------------------------------------------------------- 1 | """ Command-line interface for diii """ 2 | 3 | import sys 4 | import time 5 | 6 | import click 7 | 8 | import requests 9 | import os 10 | from packaging import version 11 | 12 | from diii import __version__ 13 | from diii.iii import Deviceiii 14 | from diii import repl as diii_repl 15 | 16 | @click.group(invoke_without_command=True) 17 | @click.pass_context 18 | @click.version_option(__version__) 19 | def cli(ctx): 20 | """ Terminal interface for iii devices """ 21 | if ctx.invoked_subcommand is None: 22 | ctx.invoke(repl) 23 | 24 | @cli.command(short_help="Download a file from device") 25 | def download(): 26 | """ 27 | Download a file from device and print it to screen 28 | """ 29 | with Deviceiii() as iii: 30 | iii.connect() 31 | iii.writeline('^^p') 32 | time.sleep(0.3) 33 | click.echo(iii.read(1000000)) 34 | 35 | @cli.command(short_help="Upload a file to device") 36 | @click.argument("filename", type=click.Path(exists=True)) 37 | def upload(filename): 38 | """ 39 | Upload a file to device. 40 | FILENAME is the path to the lua file to upload 41 | """ 42 | with Deviceiii() as iii: 43 | iii.connect() 44 | time.sleep(0.3) 45 | iii.upload(filename) 46 | #time.sleep(0.3) 47 | click.echo(iii.read(1000000)) 48 | #time.sleep(1.0) 49 | #iii.writeline('^^p') 50 | #time.sleep(0.3) 51 | #click.echo(iii.read(1000000)) 52 | 53 | @cli.command(short_help="Read flash index from device") 54 | @click.argument("index", type=click.INT, required=True) 55 | def flash_read(index): 56 | """ 57 | Download a flash index from device and print it to screen 58 | INDEX is the flash index 59 | """ 60 | with Deviceiii() as iii: 61 | iii.connect() 62 | cmd = 'print(flash_read('+str(index)+'))\n' 63 | iii.writeline(cmd) 64 | time.sleep(0.3) 65 | click.echo(iii.read(1000000)) 66 | 67 | @cli.command(short_help="Write file to flash index on device") 68 | @click.argument("index", type=click.INT, required=True) 69 | @click.argument("filename", type=click.Path(exists=True)) 70 | def flash_write(index,filename): 71 | """ 72 | Write file to flash index on device. 73 | INDEX is the flash index 74 | FILENAME is the path to the file to upload 75 | """ 76 | with Deviceiii() as iii: 77 | iii.connect() 78 | time.sleep(0.3) 79 | file = open(filename).read().replace('\n','') 80 | send = "flash_write("+str(index)+",'"+file+"')\n" 81 | click.echo(send) 82 | #iii.upload(filename) 83 | iii.writeline(send) 84 | #time.sleep(0.3) 85 | click.echo(iii.read(1000000)) 86 | #time.sleep(1.0) 87 | #iii.writeline('^^p') 88 | #time.sleep(0.3) 89 | #click.echo(iii.read(1000000)) 90 | 91 | @cli.command() 92 | @click.argument("filename", type=click.Path(exists=True), required=False) 93 | @click.option("--theme/--no-theme", default=True, show_default=True, 94 | help="Whether to use the internal color theme.") 95 | def repl(filename, theme): 96 | """ Start interactive terminal """ 97 | diii_repl.main(filename, theme) 98 | -------------------------------------------------------------------------------- /src/diii/exceptions.py: -------------------------------------------------------------------------------- 1 | class DeviceNotFoundError(Exception): 2 | def __init__(self, msg, inner=None): 3 | super().__init__(msg) 4 | self.inner = inner 5 | -------------------------------------------------------------------------------- /src/diii/iii.py: -------------------------------------------------------------------------------- 1 | import asyncio 2 | import logging 3 | import time 4 | import os 5 | 6 | import serial 7 | import serial.tools.list_ports 8 | 9 | from diii.exceptions import DeviceNotFoundError 10 | 11 | 12 | logger = logging.getLogger(__name__) 13 | 14 | def find_serial_port(hwid): 15 | for portinfo in serial.tools.list_ports.comports(): 16 | if hwid in portinfo.hwid: # must match VID:PID 17 | if os.name == "nt": # windows doesn't know the name of the device 18 | return portinfo 19 | if "iii" in portinfo.product: # more precise detection for linux/macos 20 | return portinfo 21 | raise DeviceNotFoundError(f"can't find iii device") 22 | 23 | class Deviceiii: 24 | def __init__(self, serial=None): 25 | self.serial = None 26 | self.is_connected = False 27 | self.event_handlers = {} 28 | 29 | def find_device(self): 30 | portinfo = find_serial_port('USB VID:PID=CAFE:1101') 31 | try: 32 | return serial.Serial( 33 | portinfo.device, 34 | baudrate=115200, 35 | timeout=0.1, 36 | ) 37 | except serial.SerialException as e: 38 | raise DeviceNotFoundError("can't open serial port", e) 39 | 40 | def __enter__(self): 41 | return self 42 | 43 | def __exit__(self, exc, exc_type, traceback): 44 | if self.is_connected: 45 | self.disconnect() 46 | 47 | def connect(self): 48 | self.serial = self.find_device() 49 | logger.info(f'connected to device on {self.serial.port}') 50 | 51 | def disconnect(self): 52 | if self.serial is not None: 53 | self.serial.close() 54 | 55 | def raise_event(self, event, *args, **kwargs): 56 | try: 57 | handlers = self.event_handlers[event] 58 | except KeyError: 59 | pass 60 | else: 61 | for handler in handlers: 62 | try: 63 | handler(*args, **kwargs) 64 | except Exception as exc: 65 | logger.error(f'error in command handler "{event}" ({handler}): {exc}') 66 | 67 | def replace_handlers(self, handlers): 68 | self.event_handlers = handlers 69 | 70 | def reconnect(self, err_event=False): 71 | try: 72 | self.connect() 73 | self.is_connected = True 74 | self.raise_event('connect') 75 | except Exception as exc: 76 | if self.is_connected or err_event: 77 | self.is_connected = False 78 | self.raise_event('connect_err', exc) 79 | 80 | def writebin(self, b): 81 | if len(b) % 64 == 0: 82 | b += b'\n' 83 | logger.debug(f'-> {b}') 84 | self.serial.write(b) 85 | 86 | def write(self, s): 87 | self.writebin(s.encode('utf-8')) 88 | 89 | def writeline(self, line): 90 | self.write(line + '\r\n') 91 | 92 | def writefile(self, fname): 93 | with open(fname) as f: 94 | logger.info(f'opened file: {f}') 95 | for line in f.readlines(): 96 | self.writeline(line.rstrip()) 97 | time.sleep(0.001) 98 | 99 | def _upload(self, fname, event, end): 100 | self.raise_event(event, fname) 101 | self.writeline('^^s') 102 | time.sleep(0.1) 103 | self.writefile(fname) 104 | time.sleep(0.1) 105 | self.writeline(end) 106 | time.sleep(0.1) 107 | self.writeline('^^z') 108 | 109 | def execute(self, fname): 110 | self._upload(fname, 'running', '^^e') 111 | 112 | def upload(self, fname): 113 | self._upload(fname, 'uploading', '^^w') 114 | 115 | def readbin(self, count): 116 | b = self.serial.read(count) 117 | if len(b) > 0: 118 | logger.debug(f'<- {b}') 119 | return b 120 | 121 | def read(self, count): 122 | return self.readbin(count).decode('utf-8') 123 | 124 | async def read_forever(self): 125 | while True: 126 | sleeptime = 0.001 127 | try: 128 | r = self.read(10000) 129 | if len(r) > 0: 130 | lines = r.split('\n\r') 131 | for line in lines: 132 | self.process_line(line) 133 | except Exception as exc: 134 | if self.is_connected: 135 | logger.error(f'lost connection: {exc}') 136 | sleeptime = 0.1 137 | self.reconnect() 138 | await asyncio.sleep(sleeptime) 139 | 140 | def process_line(self, line): 141 | if "^^" in line: 142 | cmds = line.split('^^') 143 | for cmd in cmds: 144 | t3 = cmd.rstrip().partition('(') 145 | if not any(t3): 146 | continue 147 | evt = t3[0] 148 | args = t3[2].rstrip(')').split(',') 149 | self.raise_event('iii_event', line, evt, args) 150 | elif len(line) > 0: 151 | self.raise_event('iii_output', line) 152 | -------------------------------------------------------------------------------- /src/diii/repl.py: -------------------------------------------------------------------------------- 1 | """ diii """ 2 | # pylint: disable=C0103 3 | from abc import ABC, abstractmethod 4 | import asyncio 5 | import logging 6 | import logging.config 7 | import os 8 | import sys 9 | 10 | from prompt_toolkit.completion import Completer, PathCompleter, WordCompleter 11 | from prompt_toolkit.eventloop.defaults import use_asyncio_event_loop 12 | from prompt_toolkit.patch_stdout import patch_stdout 13 | from prompt_toolkit.application import Application 14 | from prompt_toolkit.application.current import get_app 15 | from prompt_toolkit.document import Document 16 | from prompt_toolkit.filters import to_filter 17 | from prompt_toolkit.key_binding import KeyBindings 18 | from prompt_toolkit.layout.containers import ( 19 | to_container, 20 | Container, FloatContainer, Float, 21 | VSplit, HSplit, 22 | Window, WindowAlign, 23 | ) 24 | from prompt_toolkit.layout.layout import Layout 25 | from prompt_toolkit.layout.screen import Char 26 | from prompt_toolkit.styles import Style 27 | from prompt_toolkit.widgets import TextArea 28 | from prompt_toolkit.layout.controls import FormattedTextControl 29 | from prompt_toolkit.layout.menus import CompletionsMenu 30 | 31 | from diii.iii import Deviceiii 32 | from diii.server import DiiiServer 33 | 34 | 35 | logger = logging.getLogger(__name__) 36 | 37 | # monkey patch to fix https://github.com/monome/druid/issues/8 38 | Char.display_mappings['\t'] = ' ' 39 | 40 | diii_intro = " q to quit. h for help.\n\n" 41 | diii_help = """ 42 | h this menu 43 | u upload 44 | u upload previous file 45 | p print current script 46 | q quit 47 | """ 48 | 49 | last_script = '' 50 | 51 | class DiiiUi: 52 | def __init__(self, use_theme): 53 | self.statusbar = Window( 54 | height=1, 55 | char='─', 56 | style='class:line', 57 | content=FormattedTextControl(text=' diii'), 58 | align=WindowAlign.RIGHT 59 | ) 60 | 61 | self.content = HSplit([ 62 | Window(), 63 | self.statusbar, 64 | Window(height=1), 65 | ]) 66 | self.container = FloatContainer( 67 | content=self.content, 68 | floats=[ 69 | Float( 70 | xcursor=True, 71 | ycursor=True, 72 | content=CompletionsMenu(max_height=16, scroll_offset=1), 73 | ), 74 | ], 75 | ) 76 | self.key_bindings = KeyBindings() 77 | 78 | @self.key_bindings.add('c-c', eager=True) 79 | @self.key_bindings.add('c-q', eager=True) 80 | def quit_diii(event): 81 | event.app.exit() 82 | 83 | if use_theme: 84 | self.style = Style([ 85 | ('capture-field', '#747369'), 86 | ('output-field', '#d3d0c8'), 87 | ('input-field', '#f2f0ec'), 88 | ('line', '#747369'), 89 | ('scrollbar.background', 'bg:#000000'), 90 | ('scrollbar.button', 'bg:#747369'), 91 | ]) 92 | else: 93 | self.style = Style([]) 94 | 95 | self.layout = Layout(self.container) 96 | 97 | self.app = Application( 98 | layout=self.layout, 99 | key_bindings=self.key_bindings, 100 | style=self.style, 101 | mouse_support=False, 102 | full_screen=True, 103 | ) 104 | 105 | self.pages = dict() 106 | self.current_page = None 107 | 108 | def set_page(self, name): 109 | if self.current_page is not None: 110 | self.current_page.unmount() 111 | try: 112 | self.current_page = self.pages[name] 113 | except KeyError: 114 | pass 115 | else: 116 | self.current_page.mount() 117 | 118 | def add_page(self, key, page): 119 | self.pages[key] = page 120 | 121 | class UiPage(ABC): 122 | def __init__(self, ui): 123 | self.ui = ui 124 | self.build_ui() 125 | 126 | @abstractmethod 127 | def build_ui(self): 128 | pass 129 | 130 | @abstractmethod 131 | def arrange_ui(self, container): 132 | pass 133 | 134 | def output_to_field(self, field, st): 135 | s = field.text + st.replace('\r', '') 136 | field.buffer.document = Document(text=s, cursor_position=len(s)) 137 | 138 | def mount(self): 139 | self.arrange_ui(self.ui.content) 140 | 141 | def unmount(self): 142 | pass 143 | 144 | 145 | class ReplCompleter(Completer): 146 | III_COMMANDS = { 147 | "clear": "Clear the saved script", 148 | "print": "Print the current script", 149 | "reboot": "Reboot", 150 | "upload": "Send a file, store and run it", 151 | } 152 | 153 | def __init__(self): 154 | self.path_completer = PathCompleter( 155 | file_filter=lambda s: os.path.isdir(s) or s.endswith('.lua') 156 | ) 157 | 158 | self.word_completer = WordCompleter( 159 | words=self.III_COMMANDS.keys(), 160 | ignore_case=True, 161 | meta_dict=self.III_COMMANDS, 162 | ) 163 | 164 | def offset_document(self, document, offset): 165 | move_cursor = len(document.current_line) - offset 166 | return Document( 167 | document.current_line[offset:], 168 | cursor_position=document.cursor_position - offset 169 | ) 170 | 171 | def get_completions(self, document, complete_event): 172 | line = document.current_line.lstrip() 173 | offset = len(document.current_line) - len(line) 174 | 175 | if line.startswith('^^'): 176 | line = line[2:] 177 | offset += 2 178 | new_document = self.offset_document(document, offset) 179 | yield from self.word_completer.get_completions(new_document, complete_event) 180 | elif line.startswith('r ') or line.startswith('u '): 181 | line = line[2:] 182 | offset += 2 183 | rem = line.lstrip() 184 | offset += len(line) - len(rem) 185 | new_document = self.offset_document(document, offset) 186 | yield from self.path_completer.get_completions(new_document, complete_event) 187 | 188 | 189 | class DiiiRepl(UiPage): 190 | def __init__(self, ui, iii): 191 | self.iii = iii 192 | self.completer = ReplCompleter() 193 | super().__init__(ui) 194 | 195 | on_disconnect = lambda exc: self.output(' \n') 196 | self.handlers = { 197 | 'connect': [lambda: self.output(' \n')], 198 | 'connect_err': [on_disconnect], 199 | 'disconnect': [on_disconnect], 200 | 201 | 'running': [lambda fname: self.output(f'running {fname}\n')], 202 | 'uploading': [lambda fname: self.output(f'uploading {fname}\n')], 203 | 204 | 'iii_event': [self.iii_event], 205 | 'iii_output': [lambda output: self.output(output + '\n')], 206 | } 207 | 208 | def build_ui(self): 209 | self.captures = [ 210 | TextArea(style='class:capture-field', height=2), 211 | TextArea(style='class:capture-field', height=2), 212 | ] 213 | self.output_field = TextArea( 214 | style='class:output-field', 215 | text=diii_intro, 216 | scrollbar=True, 217 | ) 218 | self.output_field.window.right_margins[0].display_arrows = to_filter(False) 219 | self.input_field = TextArea( 220 | height=1, 221 | prompt='> ', 222 | multiline=False, 223 | wrap_lines=False, 224 | style='class:input-field', 225 | completer=self.completer, 226 | complete_while_typing=True, 227 | ) 228 | self.input_field.accept_handler = self.accept 229 | 230 | def arrange_ui(self, container): 231 | container.children.clear() 232 | container.children.extend([ 233 | VSplit(self.captures), 234 | to_container(self.output_field), 235 | self.ui.statusbar, 236 | to_container(self.input_field), 237 | ]) 238 | 239 | def mount(self): 240 | self.iii.replace_handlers(self.handlers) 241 | super().mount() 242 | pgup = lambda evt: self.pageup(evt, self.output_field) 243 | pgdn = lambda evt: self.pagedown(evt, self.output_field) 244 | self.ui.key_bindings.add('pageup')(pgup) 245 | self.ui.key_bindings.add('escape', 'v')(pgup) 246 | self.ui.key_bindings.add('pagedown')(pgdn) 247 | self.ui.key_bindings.add('c-v')(pgdn) 248 | self.ui.layout.focus(self.input_field) 249 | 250 | def output(self, st): 251 | self.output_field.buffer.cursor_position = len(self.output_field.buffer.text) 252 | self.output_field.buffer.insert_text(st.replace('\r', '')) 253 | 254 | def accept(self, buff): 255 | self.output(f'\n> {self.input_field.text}\n') 256 | self.parse(self.input_field.text) 257 | 258 | def parse(self, cmd): 259 | parts = cmd.split(maxsplit=1) 260 | if len(parts) == 0: 261 | return 262 | c = parts[0] 263 | if c == 'u': 264 | run_func = self.iii.upload 265 | global last_script 266 | if len(parts) == 1: 267 | if len(last_script) == 0: 268 | self.output(' u to upload script') 269 | else: 270 | run_func(last_script) 271 | elif len(parts) == 2 and os.path.isfile(parts[1]): 272 | last_script = parts[1] 273 | run_func(parts[1]) 274 | else: 275 | self.iii.writeline(cmd) 276 | elif len(parts) == 1: 277 | if c == 'q': 278 | print('bye.') 279 | get_app().exit() 280 | elif c == 'p': 281 | self.iii.writeline('^^p') 282 | elif c == 'h': 283 | self.output(diii_help) 284 | else: 285 | self.iii.writeline(cmd) 286 | else: 287 | self.iii.writeline(cmd) 288 | 289 | def iii_event(self, line, event, args): 290 | if event == 'stream' or event == 'change': 291 | ch_str, val = args 292 | ch = int(ch_str) 293 | if ch >= 1 and ch <= 2: 294 | self.output_to_field(self.captures[ch - 1], f'\ninput[{ch}] = {val}\n') 295 | else: 296 | self.output(f'^^{event}({", ".join(args)})') 297 | 298 | # these come from: 299 | # https://github.com/prompt-toolkit/python-prompt-toolkit/blob/5c3d13eb849885bc4c1a2553ea6f81e6272f84c9/prompt_toolkit/key_binding/bindings/scroll.py#L147 300 | def pageup(self, event, field): 301 | w = field.window 302 | b = field.buffer 303 | if w and w.render_info: 304 | # Put cursor at the first visible line. (But make sure that the cursor 305 | # moves at least one line up.) 306 | line_index = max( 307 | 0, 308 | min(w.render_info.first_visible_line(), b.document.cursor_position_row - 1), 309 | ) 310 | 311 | b.cursor_position = b.document.translate_row_col_to_index(line_index, 0) 312 | b.cursor_position += b.document.get_start_of_line_position( 313 | after_whitespace=True 314 | ) 315 | 316 | # Set the scroll offset. We can safely set it to zero; the Window will 317 | # make sure that it scrolls at least until the cursor becomes visible. 318 | w.vertical_scroll = 0 319 | 320 | def pagedown(self, event, field): 321 | w = field.window 322 | b = field.buffer 323 | if w and w.render_info: 324 | # Scroll down one page. 325 | line_index = max(w.render_info.last_visible_line(), w.vertical_scroll + 1) 326 | w.vertical_scroll = line_index 327 | 328 | b.cursor_position = b.document.translate_row_col_to_index(line_index, 0) 329 | b.cursor_position += b.document.get_start_of_line_position( 330 | after_whitespace=True 331 | ) 332 | 333 | 334 | class Diii: 335 | def __init__(self, iii, use_theme): 336 | self.iii = iii 337 | self.ui = DiiiUi(use_theme) 338 | self.repl = DiiiRepl(ui=self.ui, iii=iii) 339 | 340 | self.ui.add_page('repl', self.repl) 341 | self.ui.set_page('repl') 342 | 343 | async def foreground(self, script=None): 344 | if script is not None: 345 | if self.iii.is_connected == False: 346 | print('no iii device found. exiting.') 347 | return 348 | self.iii.execute(script) 349 | 350 | return await self.ui.app.run_async() 351 | 352 | async def background(self): 353 | await self.iii.read_forever() 354 | 355 | 356 | log_config = { 357 | 'version': 1, 358 | 'formatters': { 359 | 'detailed': { 360 | 'class': 'logging.Formatter', 361 | 'format': '%(asctime)s %(name)-15s %(levelname)-8s' 362 | '%(processName)-10s %(message)s' 363 | }, 364 | }, 365 | 'handlers': { 366 | 'file': { 367 | 'class': 'logging.FileHandler', 368 | 'filename': 'diii.log', 369 | 'mode': 'w', 370 | 'formatter': 'detailed', 371 | }, 372 | }, 373 | 'loggers': { 374 | 'diii.repl': { 375 | 'handlers': ['file'], 376 | }, 377 | 'diii.iii': { 378 | 'handlers': ['file'], 379 | }, 380 | }, 381 | 'root': { 382 | 'level': 'INFO', 383 | 'handlers': [], 384 | }, 385 | } 386 | 387 | def main(script=None, use_theme=True): 388 | try: 389 | logging.config.dictConfig(log_config) 390 | except ValueError: 391 | print('could not configure file logging (insufficient permissions?)') 392 | 393 | loop = asyncio.get_event_loop() 394 | use_asyncio_event_loop() 395 | with patch_stdout(): 396 | with Deviceiii() as iii: 397 | shell = Diii(iii, use_theme) 398 | 399 | server = DiiiServer(shell.repl, 'localhost', 6666) 400 | iii.reconnect(err_event=True) 401 | background_task = asyncio.gather( 402 | shell.background(), 403 | server.listen(), 404 | return_exceptions=True, 405 | ) 406 | loop.run_until_complete(shell.foreground()) 407 | background_task.cancel() 408 | -------------------------------------------------------------------------------- /src/diii/server.py: -------------------------------------------------------------------------------- 1 | import asyncio 2 | import websockets 3 | from websockets.exceptions import ConnectionClosedError 4 | 5 | 6 | class DiiiServer: 7 | 8 | def __init__(self, repl, host, port): 9 | self.repl = repl 10 | self.host = host 11 | self.port = port 12 | 13 | async def handle(self, websocket, path): 14 | (host, *args) = websocket.remote_address 15 | #self.repl.output(f'\n ') 16 | self.repl.handlers['iii_output'].append( 17 | lambda output: asyncio.ensure_future( 18 | self.handle_output(websocket, output) 19 | ) 20 | ) 21 | try: 22 | async for message in websocket: 23 | self.repl.output(f'\n> {message}\n') 24 | self.repl.iii.writeline(message) 25 | except ConnectionClosedError as e: 26 | #self.repl.output(f'\n ') 27 | pass 28 | else: 29 | #self.repl.output(f'\n ') 30 | pass 31 | 32 | async def listen(self): 33 | self.repl.output(f' \n') 34 | await websockets.serve(self.handle, self.host, self.port) 35 | 36 | async def handle_output(self, websocket, output): 37 | await websocket.send(output) 38 | -------------------------------------------------------------------------------- /tests/druid.log: -------------------------------------------------------------------------------- 1 | 2024-11-18 19:02:18,231 druid.crow INFO MainProcess connected to crow on /dev/ttyACM0 2 | 2024-11-18 19:08:14,765 druid.crow ERROR MainProcess lost connection: device reports readiness to read but returned no data (device disconnected or multiple access on port?) 3 | 2024-11-18 19:08:27,366 druid.crow INFO MainProcess connected to crow on /dev/ttyACM1 4 | 2024-11-18 19:08:34,377 druid.crow INFO MainProcess opened file: <_io.TextIOWrapper name='es.lua' mode='r' encoding='UTF-8'> 5 | 2024-11-18 19:21:42,478 druid.crow ERROR MainProcess lost connection: device reports readiness to read but returned no data (device disconnected or multiple access on port?) 6 | 2024-11-18 19:21:55,508 druid.crow INFO MainProcess connected to crow on /dev/ttyACM0 7 | 2024-11-18 19:22:55,157 druid.crow ERROR MainProcess lost connection: device reports readiness to read but returned no data (device disconnected or multiple access on port?) 8 | 2024-11-18 19:23:03,594 druid.crow INFO MainProcess connected to crow on /dev/ttyACM1 9 | 2024-11-18 20:01:28,108 druid.crow ERROR MainProcess lost connection: device reports readiness to read but returned no data (device disconnected or multiple access on port?) 10 | 2024-11-20 11:43:27,998 druid.crow INFO MainProcess connected to crow on /dev/ttyACM0 11 | 2024-11-20 11:45:52,366 druid.crow INFO MainProcess opened file: <_io.TextIOWrapper name='step.lua' mode='r' encoding='UTF-8'> 12 | 2024-11-20 11:46:43,193 druid.crow INFO MainProcess opened file: <_io.TextIOWrapper name='step.lua' mode='r' encoding='UTF-8'> 13 | 2024-11-20 11:47:38,250 druid.crow INFO MainProcess opened file: <_io.TextIOWrapper name='es.lua' mode='r' encoding='UTF-8'> 14 | 2024-11-20 11:47:52,650 druid.crow INFO MainProcess opened file: <_io.TextIOWrapper name='es.lua' mode='r' encoding='UTF-8'> 15 | 2024-11-20 11:48:02,864 druid.crow ERROR MainProcess lost connection: device reports readiness to read but returned no data (device disconnected or multiple access on port?) 16 | -------------------------------------------------------------------------------- /tests/es.lua: -------------------------------------------------------------------------------- 1 | print("earthsea?") 2 | grid_led_all(0) 3 | grid_led(0,0,15) 4 | grid_refresh() 5 | 6 | ch = 0 7 | 8 | metro = function(index, count) 9 | --print(string.format("metro %d: %d", index, count)) 10 | --grid_led(count,index,3) 11 | --grid_refresh() 12 | end 13 | 14 | grid = function(x,y,z) 15 | --print(string.format("%d %d %d",x,y,z)) 16 | if x==0 then 17 | if z then 18 | grid_led(0,ch,0) 19 | ch=y 20 | grid_led(0,ch,3) 21 | grid_refresh() 22 | end 23 | else 24 | 25 | note = x + (7-y)*5 + 50 26 | midi_tx(0, 0x90+ch, note, z*127) 27 | grid_led(x,y,z*15) 28 | grid_refresh() 29 | end 30 | end 31 | 32 | --metro_set(1, 100, 5) 33 | --metro_set(2, 50, 10) 34 | -------------------------------------------------------------------------------- /tests/metro.lua: -------------------------------------------------------------------------------- 1 | print("METRO TEST ======") 2 | grid_led_all(0) 3 | grid_led(0,0,15) 4 | grid_refresh() 5 | 6 | c = {1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1} 7 | ccval = {0, 0, 0, 0, 0, 0, 0, 0} 8 | ccnum = {10, 11, 12, 13, 14, 15, 16, 17} 9 | 10 | metro = function(index, count) 11 | print(string.format("metro %d: %d", index, count)) 12 | 13 | grid_led_rel(c[index],index%4+1,-5) 14 | c[index] = (c[index] % 16) + 1 15 | grid_led_rel(c[index],index%4+1,5) 16 | grid_refresh() 17 | --midi_tx(0, 0xb0, ccnum[index], ccval[index]) 18 | --ccval[index] = (ccval[index] + 1) % 128 19 | end 20 | 21 | i = 1 22 | 23 | grid = function(x,y,z) 24 | if(z==0) then 25 | metro_set(i,50+i*11,10) 26 | print(i) 27 | i = i+1 28 | end 29 | --print(string.format("%d %d %d",x,y,z)) 30 | note = x + (7-y)*5 + 50 31 | midi_tx(0, 0x91, note, z*127) 32 | grid_led(x,y,z*15) 33 | grid_refresh() 34 | end 35 | 36 | 37 | -------------------------------------------------------------------------------- /tests/slew.lua: -------------------------------------------------------------------------------- 1 | slew.init() 2 | 3 | test = function() 4 | slew.new(print,3,80,10000,1) 5 | end 6 | 7 | px = {1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1} 8 | 9 | skid = function(x,y) 10 | grid_led(px[y],y,0) 11 | grid_led(x,y,5) 12 | px[y] = x 13 | grid_refresh() 14 | end 15 | 16 | sl = {} 17 | 18 | grid = function(x,y,z) 19 | if z==1 then 20 | if(sl[y]) then slew.stop(sl[y]) end 21 | sl[y]=slew.new(function(a) skid(a,y) end,px[y],x,500) 22 | end 23 | end 24 | -------------------------------------------------------------------------------- /tests/step.lua: -------------------------------------------------------------------------------- 1 | print("step") 2 | 3 | ch = 0 4 | step = 1 5 | last = 0 6 | note = {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0} 7 | map = {66,68,70,72,74,76,78,80,82,84,86,88,90,92,94,96} 8 | 9 | tick = function() 10 | if last > 0 then midi_note_off(map[last]) end 11 | step = (step % 16) + 1 12 | last = note[step] 13 | if last > 0 then midi_note_on(map[last]) end 14 | redraw() 15 | end 16 | 17 | metro = function(index, count) 18 | tick() 19 | end 20 | 21 | grid = function(x,y,z) 22 | if z==0 then return end 23 | if y==0 then 24 | -- cut 25 | else 26 | x = x+1 27 | if note[x] == y then note[x] = 0 28 | else note[x] = y end 29 | redraw() 30 | end 31 | end 32 | 33 | redraw = function() 34 | grid_led_all(0) 35 | grid_led(step-1,0,5) 36 | for n=1,16 do 37 | if note[n] > 0 then 38 | grid_led(n-1,note[n],step==n and 15 or 5) 39 | end 40 | end 41 | grid_refresh() 42 | end 43 | 44 | ticks = 0 45 | 46 | midi_rx = function(d1,d2,d3,d4) 47 | if d1==8 and d2==240 then 48 | ticks = ((ticks + 1) % 12) 49 | if ticks == 0 then tick() end 50 | else 51 | ps("midi_rx %d %d %d %d",d1,d2,d3,d4) 52 | end 53 | --print("midi",d1,d2,d3,d4) 54 | end 55 | 56 | --metro_set(1, 150) 57 | 58 | redraw() 59 | --------------------------------------------------------------------------------