├── .gitignore ├── LICENSE ├── ProPresenterStageDisplayClientComms.py ├── README.md ├── StageDisplay.py ├── config-sample.json └── start.sh /.gitignore: -------------------------------------------------------------------------------- 1 | config.json 2 | 3 | # Byte-compiled / optimized / DLL files 4 | __pycache__/ 5 | *.py[cod] 6 | *$py.class 7 | 8 | # C extensions 9 | *.so 10 | 11 | # Distribution / packaging 12 | .Python 13 | env/ 14 | build/ 15 | develop-eggs/ 16 | dist/ 17 | downloads/ 18 | eggs/ 19 | .eggs/ 20 | lib/ 21 | lib64/ 22 | parts/ 23 | sdist/ 24 | var/ 25 | wheels/ 26 | *.egg-info/ 27 | .installed.cfg 28 | *.egg 29 | 30 | # PyInstaller 31 | # Usually these files are written by a python script from a template 32 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 33 | *.manifest 34 | *.spec 35 | 36 | # Installer logs 37 | pip-log.txt 38 | pip-delete-this-directory.txt 39 | 40 | # Unit test / coverage reports 41 | htmlcov/ 42 | .tox/ 43 | .coverage 44 | .coverage.* 45 | .cache 46 | nosetests.xml 47 | coverage.xml 48 | *.cover 49 | .hypothesis/ 50 | 51 | # Translations 52 | *.mo 53 | *.pot 54 | 55 | # Django stuff: 56 | *.log 57 | local_settings.py 58 | 59 | # Flask stuff: 60 | instance/ 61 | .webassets-cache 62 | 63 | # Scrapy stuff: 64 | .scrapy 65 | 66 | # Sphinx documentation 67 | docs/_build/ 68 | 69 | # PyBuilder 70 | target/ 71 | 72 | # Jupyter Notebook 73 | .ipynb_checkpoints 74 | 75 | # pyenv 76 | .python-version 77 | 78 | # celery beat schedule file 79 | celerybeat-schedule 80 | 81 | # SageMath parsed files 82 | *.sage.py 83 | 84 | # dotenv 85 | .env 86 | 87 | # virtualenv 88 | .venv 89 | venv/ 90 | ENV/ 91 | 92 | # Spyder project settings 93 | .spyderproject 94 | .spyproject 95 | 96 | # Rope project settings 97 | .ropeproject 98 | 99 | # mkdocs documentation 100 | /site 101 | 102 | # mypy 103 | .mypy_cache/ 104 | -------------------------------------------------------------------------------- /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 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 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 | {project} Copyright (C) {year} {fullname} 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 | -------------------------------------------------------------------------------- /ProPresenterStageDisplayClientComms.py: -------------------------------------------------------------------------------- 1 | """ProPresenter Stage Display Client (Communication Class). An Open-Source Python Client for the ProPresenter6 Stage Display XML Feed.""" 2 | 3 | import socket 4 | import errno 5 | import time 6 | import threading 7 | import xml.etree.ElementTree as ET 8 | 9 | __author__ = "Anthony Eden" 10 | __copyright__ = "Copyright 2017, Anthony Eden / Media Realm" 11 | __credits__ = ["Anthony Eden"] 12 | __license__ = "GPL" 13 | __version__ = "0.1" 14 | 15 | 16 | class ProPresenterStageDisplayClientComms(threading.Thread): 17 | """This class handles all the communications with the ProPresenter Stage Display server.""" 18 | 19 | # The handle for the socket connection to ProPresenter 20 | sock = None 21 | 22 | # A list of data types to subscribe to (with callbacks) 23 | dataSubscriptions = [] 24 | 25 | # Should we be shutting down this thread? Set via self.stop() 26 | _stop = False 27 | 28 | # Store the password used to connect to the ProPresenter Stage Display socket 29 | password = "" 30 | 31 | def __init__(self, host, port, password): 32 | """Setup the class""" 33 | 34 | self.sock = None 35 | self.host = host 36 | self.port = port 37 | self.password = password 38 | self.dataSubscriptions = [] 39 | 40 | # Start the thread 41 | threading.Thread.__init__(self) 42 | 43 | def stop(self): 44 | """Attempt to close this thread.""" 45 | self._stop = True 46 | 47 | def run(self): 48 | """Create a socket connection to the ProPresenter server""" 49 | 50 | self.sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM) 51 | 52 | try: 53 | self.sock.connect((self.host, self.port)) 54 | except: 55 | # End the thread and call a callback 56 | self.doCallback("ConnectionFailed", "") 57 | self.stop() 58 | else: 59 | self.doCallback("Connected", "") 60 | self.sock.setblocking(0) 61 | self.loop() 62 | 63 | def loop(self): 64 | """A method that keeps going forever, and handles all the communication with the open ProPresenter socket.""" 65 | 66 | # Login to ProPresenter 67 | self.sendCommand(""+self.password+"\r\n") 68 | 69 | while True: 70 | if self._stop is True: 71 | # End the thread 72 | self.sock.close() 73 | break 74 | 75 | # Try and receive data from ProPresenter 76 | recvData = self.recvUntilNewline() 77 | 78 | if recvData is False: 79 | self.sock.close() 80 | break 81 | 82 | if recvData is not None: 83 | self.processReceivedData(recvData) 84 | 85 | # Lower this number to receive data quicker 86 | time.sleep(0.1) 87 | 88 | def recvUntilNewline(self): 89 | """Receive data until we get to the end of a message.""" 90 | totalData = "" 91 | inBlock = False 92 | 93 | while True: 94 | try: 95 | thisData = self.sock.recv(1024) 96 | 97 | if thisData == "": 98 | # Connection closed 99 | self.sock.close() 100 | self.doCallback("Disconnected", "") 101 | return False 102 | 103 | else: 104 | totalData += thisData 105 | 106 | except socket.error, e: 107 | if e.args[0] != errno.EWOULDBLOCK: 108 | self.sock.close() 109 | self.doCallback("Disconnected", e) 110 | return False 111 | 112 | else: 113 | # Check if we're in a data block 114 | if totalData[:80] == '': 115 | inBlock = True 116 | 117 | # Check if the datablock is over 118 | if "" in totalData[-25:]: 119 | return totalData 120 | 121 | if self._stop is True: 122 | # End the thread 123 | self.sock.close() 124 | break 125 | 126 | def processReceivedData(self, recvData): 127 | """Process the received data from ProPresenter. Attempts to parse it and trigger the subscribed callback.""" 128 | 129 | try: 130 | tree = ET.fromstring(recvData) 131 | except: 132 | # This is an unexpected data type. Ignore it for now... 133 | pass 134 | else: 135 | 136 | for fields in tree.findall('Fields'): 137 | for slideElement in fields.findall('Field'): 138 | if 'identifier' in slideElement.attrib: 139 | dataType = slideElement.attrib['identifier'] 140 | 141 | # This dict will have all the data to return to our callbacks 142 | returnData = {} 143 | 144 | # Send the actual text 145 | returnData['text'] = slideElement.text 146 | 147 | # Send all the attributes 148 | for i, key in enumerate(slideElement.attrib): 149 | returnData[key] = slideElement.attrib[key] 150 | 151 | # Trigger a callback 152 | self.doCallback(dataType, returnData) 153 | 154 | def sendCommand(self, msg): 155 | """Buffer a command to send.""" 156 | self.sock.send(msg + "\r\n") 157 | 158 | def addSubscription(self, subType, callbackObj, limit=False, filters={}): 159 | """Add a subscription to the list of data subscriptions.""" 160 | self.dataSubscriptions.append({ 161 | "commandType": subType, 162 | "callback": callbackObj, 163 | "limit": limit 164 | }) 165 | 166 | def doCallback(self, dataType, returnData): 167 | # Loop over every subscription 168 | for subI, subX in enumerate(self.dataSubscriptions): 169 | 170 | # If the subscribed command type matches the message's command type 171 | if dataType == subX['commandType'] or (subX['commandType'][-1:] == "*" and dataType[:len(subX['commandType'][:-1])] == subX['commandType'][:-1]): 172 | 173 | # Execute the callback! 174 | subX['callback'](returnData) 175 | 176 | # Check if we need to decrement the limit 177 | if self.dataSubscriptions[subI]['limit'] is not False: 178 | self.dataSubscriptions[subI]['limit'] = self.dataSubscriptions[subI]['limit'] - 1 179 | 180 | # Check if we need to remove this subscription 181 | if self.dataSubscriptions[subI]['limit'] <= 0 and self.dataSubscriptions[subI]['limit'] is not False: 182 | self.dataSubscriptions.pop(subI) 183 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ![ProPresenter Stage Display for Python](https://mediarealm.com.au/wp-content/uploads/2017/07/ProPresenter-Stage-Display-Python.png) 2 | 3 | # ProPresenter Stage Display for Python 4 | An unofficial Python implementation of the [ProPresenter Stage Display](https://www.renewedvision.com/store.php?item=prostagedisplay). 5 | 6 | ## THIS VERSION HAS BEEN DISCONTINUED. IT WILL NOT WORK IN ANY MAJOR FUTURE RELEASES OF PROPRESENTER (PAST VERSION 6). PLEASE UPGRADE TO THIS NEW VERSION: https://github.com/anthonyeden/ProPresenter-Lyrics-HTML 7 | 8 | Currently, this implementation is very basic and designed to implement only three basic features: 9 | 10 | * Clock 11 | * Current slide text 12 | * Next slide text 13 | 14 | This program has been designed to run on small devices such as the Raspberry Pi. 15 | 16 | # Installation - General Instructions (non-Raspberry Pi) 17 | 18 | 1. Download the [software](https://github.com/anthonyeden/ProPresenter-Stage-Display-Python/archive/master.zip) 19 | 2. Install Python2 20 | 3. Copy _config-sample.json_ to _config.json_ 21 | 4. Edit _config.json_ in a text editor and set the IP Address, Port Number, and Password for your ProPresenter Stage Display computer (found in _Preferences > Network_ of your ProPresenter PC). 22 | 5. Run _python StageDisplay.py_ 23 | 24 | # Installation - Raspberry Pi 25 | 26 | 1. [Download and install Raspbian Desktop](https://www.raspberrypi.org/downloads/raspbian/) on your Raspberry Pi 27 | 2. Connect your WiFi or Ethernet 28 | 3. Open Terminal and run the following commands: 29 | 30 | ``` 31 | sudo apt-get install python2 git 32 | git clone https://github.com/anthonyeden/ProPresenter-Stage-Display-Python/ 33 | echo "@/home/pi/ProPresenter-Stage-Display-Python/start.sh" >> .config/lxsession/LXDE-pi/autostart 34 | cp ProPresenter-Stage-Display-Python/config-sample.json ProPresenter-Stage-Display-Python/config.json 35 | ``` 36 | 37 | 4. To edit the configuration, run this command: 38 | 39 | ``` 40 | nano ProPresenter-Stage-Display-Python/config.json 41 | ``` 42 | 43 | Ensure you update the IP Address, Port Number & Password for your ProPresenter computer. On your ProPresenter computer, this can be setup in _Preferences > Network_ of your ProPresenter PC. 44 | 45 | Press Ctrl + X to close the Nano text editor. 46 | 47 | 6. The stage display should now load automatically whenever you login to your Raspberry Pi (there is a 10 second delay to give the Pi a chance to connect to the network). To start it manually, run the following commands from the terminal: 48 | 49 | ``` 50 | cd /home/pi/ProPresenter-Stage-Display-Python/ 51 | python2 StageDisplay.py 52 | ``` 53 | 54 | # Upgrading - Raspberry Pi 55 | 56 | 1. Open Terminal and run the following commands: 57 | 58 | ``` 59 | cd ~/ProPresenter-Stage-Display-Python 60 | git pull 61 | ``` 62 | 63 | # Lower Third Mode (Lyric Subtitles) 64 | 65 | You can also use this software to generate Lower Third (or subtitle-style) lyrics from ProPresenter. Now you can have one ProPresenter operator effortelssly generate lyrics for both the main screen and a broadcast/internet feed. 66 | 67 | To enable this mode, set 'LowerThirdMode' to true in config.json and restart the application. 68 | 69 | After you've enabled this change, the following options may be useful: 70 | 71 | "FontSizeCurrent": 35, 72 | "FontName": "Arial", 73 | "FontUppercase": false, 74 | "MergeLines": false, 75 | "MergeLinesMin": 4, 76 | "MergeLinesJoinChar": ",", 77 | "BackgroundColour": "#000000", 78 | "TextColour": "#FFFFFF" 79 | 80 | Here's a summary of these options and how you might be able to use them: 81 | 82 | * FontSizeCurrent: This is fairly self-explanatory 83 | * FontName: Set this to the name of a font installed on your system 84 | * FontUppercase: This will force all text to be converted to uppercase 85 | * MergeLines: Enable this to force every 2nd line to join with the previous line. This is useful if you have lots of lines on-screen, but don't want to display them all as separate lines in Lower Third Mode 86 | * MergeLinesMin: Slides with fewer than this number of lines won't be collapsed 87 | * MergeLinesJoinChar: This character will be inserted between the two lines that are joined. Best to use a semi-colon or comma. 88 | * BackgroundColour & TextColour: Specify any six-digit [hex string](http://www.color-hex.com) (starting with a # symbol) to change the colour of the text and background 89 | 90 | # Disabling the Screensaver on a Raspberry Pi 91 | 92 | If you run this application on a Raspberry Pi, you're going to need to disable the screensaver. There's a couple of ways to do this, depending on your version of Raspbian: 93 | 94 | ## Method 1 95 | 96 | 1. Install XScreensaver, by using the following terminal command: 97 | 98 | ``` 99 | sudo apt-get install xscreensaver 100 | ``` 101 | 102 | 2. Open the menu in the top-left corner of your desktop. 103 | 3. Go to Preference > Screensaver. 104 | 4. Select "Disable Screensaver" 105 | 5. Reboot your Pi for the changes to work 106 | 107 | 108 | ## Method 2 109 | 110 | ``` 111 | sudo nano /etc/lightdm/lightdm.conf 112 | ``` 113 | 114 | Find (Ctrl + W): 115 | 116 | ``` 117 | #xserver-command=X 118 | ``` 119 | 120 | Change it to: 121 | 122 | ``` 123 | xserver-command=X -s 0 dpms 124 | ``` 125 | 126 | ## Method 3 127 | 128 | Add these lines to /etc/xdg/lxsession/LXDE-pi/autostart: 129 | 130 | ``` 131 | @xset s noblank 132 | @xset s off 133 | @xset -dpms 134 | ``` 135 | 136 | # Known Issues 137 | 138 | There are some known issues, although this application is being used reliably week-in, week-out on a Raspberry Pi so it should be good for common usage scenarios. Please see the [Issues](https://github.com/anthonyeden/ProPresenter-Stage-Display-Python/issues) page for an up to date list of these. Feel free to add your own as you come across them. 139 | 140 | # Contributing 141 | 142 | If you wish to contribute to the development of this little script, please feel free to create a [Pull Request](https://github.com/anthonyeden/ProPresenter-Stage-Display-Python/pulls). 143 | 144 | If you run into any trouble, please create an [Issue](https://github.com/anthonyeden/ProPresenter-Stage-Display-Python/issues). 145 | -------------------------------------------------------------------------------- /StageDisplay.py: -------------------------------------------------------------------------------- 1 | "ProPresenter Stage Display App - Implements Clock, Current & Next Text" 2 | 3 | import os 4 | import json 5 | from ProPresenterStageDisplayClientComms import ProPresenterStageDisplayClientComms 6 | import Tkinter as tk 7 | import time 8 | 9 | __author__ = "Anthony Eden" 10 | __copyright__ = "Copyright 2017-2018, Anthony Eden / Media Realm" 11 | __credits__ = ["Anthony Eden"] 12 | __license__ = "GPL" 13 | __version__ = "1.0" 14 | 15 | class Application(tk.Frame): 16 | 17 | # Store the Tk root class 18 | root = None 19 | 20 | # Store the threaded class for ProPresenter 21 | ProPresenter = None 22 | 23 | # Config data for ProPresenter 24 | ProP_IPAddress = None 25 | ProP_IPPort = None 26 | ProP_Password = None 27 | 28 | # Store the labels on the screen 29 | labelCurrent = None 30 | labelNext = None 31 | labelClock = None 32 | labelTimer = None 33 | 34 | # Store the last time string 35 | time_last = "" 36 | 37 | # The maximum length of each line on the screen - set in config file 38 | wordWrapLength = 1500 39 | 40 | # Font sizes 41 | fontSizeClock = 52 42 | fontSizeCurrent = 52 43 | fontSizeNext = 36 44 | 45 | # Font name 46 | fontName = "Arial" 47 | fontStyle = "bold" 48 | fontUppercase = False 49 | fontAlign = tk.S + tk.W + tk.E 50 | fontJustify = tk.CENTER 51 | 52 | # Lower Third Mode? 53 | modeLowerThird = False 54 | 55 | # Merge every 2nd line (for lower thirds) 56 | mergeLines = False 57 | mergeLinesMin = 4 58 | mergeLinesJoinChar = "," 59 | mergeLinesStripTrailing = [".", ";", ",", " "] 60 | 61 | # Allow splitting the text at a certain delimiter 62 | splitLinesChar = None 63 | 64 | # Specify the padding for the screen 65 | padX = 50 66 | padY = 50 67 | 68 | # Allow user-configurable background and text colours 69 | backgroundColour = "black" 70 | textColour = "white" 71 | 72 | # Store the next that needs to be rendered 73 | currentText = "" 74 | nextText = "" 75 | 76 | # Store a dict of all currently running timers, so we can work out which ones to show 77 | runningTimers = {} 78 | timerRank = [] 79 | 80 | # Lower third padding 81 | lowerThirdHeight = 0 82 | lowerThirdContainer = None 83 | 84 | # Do we need to attempt a reconnection? 85 | tryReconnect = False 86 | disconnectTime = 0 87 | 88 | def __init__(self, master = None): 89 | # Setup the application and display window 90 | 91 | self.root = tk.Tk() 92 | self.root.protocol("WM_DELETE_WINDOW", self.close) 93 | self.root.focus_set() 94 | self.root.attributes('-fullscreen', True) 95 | self.root.bind('', self.close) 96 | self.root.config(cursor = 'none') 97 | 98 | # Get the config from JSON 99 | try: 100 | ConfigData_Filename = os.path.join(os.path.dirname(os.path.realpath(__file__)), "config.json") 101 | ConfigData_JSON = open(ConfigData_Filename).read() 102 | ConfigData = json.loads(ConfigData_JSON) 103 | 104 | except Exception, e: 105 | print 106 | print "##############################################" 107 | print "EXCEPTION: Cannot load and parse Config.JSON File: " 108 | print e 109 | print "##############################################" 110 | print 111 | 112 | exit() 113 | 114 | try: 115 | self.ProP_IPAddress = ConfigData['IPAddress'] 116 | self.ProP_IPPort = int(ConfigData['IPPort']) 117 | self.ProP_Password = ConfigData['Password'] 118 | self.wordWrapLength = int(ConfigData['WordWrapLength']) 119 | self.fontSizeClock = int(ConfigData['FontSizeClock']) 120 | self.fontSizeCurrent = int(ConfigData['FontSizeCurrent']) 121 | self.fontSizeNext = int(ConfigData['FontSizeNext']) 122 | 123 | if "LowerThirdMode" in ConfigData and ConfigData['LowerThirdMode'] is True: 124 | self.modeLowerThird = True 125 | 126 | if "FontName" in ConfigData: 127 | self.fontName = ConfigData['FontName'] 128 | 129 | if "FontStyle" in ConfigData: 130 | self.fontStyle = ConfigData['FontStyle'] 131 | 132 | if "FontUppercase" in ConfigData and ConfigData['FontUppercase'] is True: 133 | self.fontUppercase = True 134 | 135 | if "FontAlign" in ConfigData and ConfigData['FontAlign'] == "center": 136 | self.fontAlign = tk.S + tk.W + tk.E 137 | self.fontJustify = tk.CENTER 138 | 139 | if "FontAlign" in ConfigData and ConfigData['FontAlign'] == "left": 140 | self.fontAlign = tk.S + tk.W 141 | self.fontJustify = tk.LEFT 142 | 143 | if "FontAlign" in ConfigData and ConfigData['FontAlign'] == "right": 144 | self.fontAlign = tk.S + tk.E 145 | self.fontJustify = tk.RIGHT 146 | 147 | if "MergeLines" in ConfigData and ConfigData['MergeLines'] is True: 148 | self.mergeLines = True 149 | 150 | if "MergeLinesMin" in ConfigData: 151 | self.mergeLinesMin = int(ConfigData['MergeLinesMin']) 152 | 153 | if "MergeLinesJoinChar" in ConfigData: 154 | self.mergeLinesJoinChar = ConfigData['MergeLinesJoinChar'] 155 | 156 | if "PadX" in ConfigData: 157 | self.padX = int(ConfigData['PadX']) 158 | 159 | if "PadY" in ConfigData: 160 | self.padY = int(ConfigData['PadY']) 161 | 162 | if "LowerThirdHeight" in ConfigData: 163 | self.lowerThirdHeight = int(ConfigData['LowerThirdHeight']) 164 | else: 165 | self.lowerThirdHeight = self.root.winfo_screenheight() - (self.padY * 2) 166 | 167 | if "BackgroundColour" in ConfigData: 168 | self.backgroundColour = ConfigData['BackgroundColour'] 169 | 170 | if "TextColour" in ConfigData: 171 | self.textColour = ConfigData['TextColour'] 172 | 173 | if "SplitLines" in ConfigData: 174 | self.splitLinesChar = ConfigData['SplitLines'] 175 | 176 | if "TimerLabels" in ConfigData: 177 | self.timerRank = ConfigData['TimerLabels'] 178 | 179 | except Exception, e: 180 | print 181 | print "##############################################" 182 | print "EXCEPTION: Config file is missing a setting" 183 | print e 184 | print "##############################################" 185 | print 186 | 187 | exit() 188 | 189 | if self.modeLowerThird: 190 | self.setupMainInterface_LowerThird() 191 | else: 192 | self.setupMainInterface() 193 | 194 | self.connect() 195 | self.reconnect_tick() 196 | 197 | def connect(self): 198 | # Connect to ProPresenter and setup the necessary callbacks 199 | self.tryReconnect = False 200 | self.disconnectTime = 0 201 | 202 | self.ProPresenter = ProPresenterStageDisplayClientComms(self.ProP_IPAddress, self.ProP_IPPort, self.ProP_Password) 203 | self.ProPresenter.addSubscription("CurrentSlide", self.updateSlideTextCurrent) 204 | self.ProPresenter.addSubscription("NextSlide", self.updateSlideTextNext) 205 | self.ProPresenter.addSubscription("Connected", self.connected) 206 | self.ProPresenter.addSubscription("ConnectionFailed", self.connectFailed) 207 | self.ProPresenter.addSubscription("Disconnected", self.disconnected) 208 | self.ProPresenter.addSubscription("Timer*", self.updateTimer) 209 | self.ProPresenter.addSubscription("VideoCounter", self.updateTimerVideo) 210 | self.ProPresenter.start() 211 | 212 | def connected(self, data): 213 | print "ProPresenter Connected" 214 | 215 | def connectFailed(self, error): 216 | self.tryReconnect = True 217 | 218 | if self.disconnectTime == 0: 219 | self.disconnectTime = time.time() 220 | 221 | print "ProPresenter Connect Failed", error 222 | 223 | def disconnected(self, error): 224 | self.tryReconnect = True 225 | 226 | if self.disconnectTime == 0: 227 | self.disconnectTime = time.time() 228 | 229 | print "ProPresenter Disconnected", error 230 | 231 | def reconnect_tick(self): 232 | if self.tryReconnect and self.disconnectTime < time.time() - 5: 233 | print "Attempting to reconnect to ProPresenter" 234 | self.connect() 235 | 236 | self.labelCurrent.after(2000, self.reconnect_tick) 237 | 238 | def setupMainInterface(self): 239 | # Setup the interface widgets 240 | 241 | # Setup the main window for the application 242 | tk.Frame.__init__( 243 | self, 244 | None, 245 | background = self.backgroundColour 246 | ) 247 | self.grid(sticky = tk.N + tk.S + tk.E + tk.W) 248 | 249 | self.top = self.winfo_toplevel() 250 | 251 | self.rowconfigure(0, weight = 1) 252 | self.rowconfigure(1, weight = 40) 253 | self.rowconfigure(2, weight = 20) 254 | self.columnconfigure(0, weight = 1) 255 | self.columnconfigure(1, weight = 1) 256 | 257 | self.top.grid() 258 | self.top.rowconfigure(0, weight = 1) 259 | self.top.columnconfigure(0, weight = 1) 260 | 261 | self.grid_propagate(False) 262 | self.top.grid_propagate(False) 263 | 264 | # Clock Text Label 265 | self.labelClock = tk.Label( 266 | self, 267 | text = str("Clock"), 268 | font = (self.fontName, self.fontSizeClock, self.fontStyle), 269 | background = self.backgroundColour, 270 | foreground = self.textColour, 271 | wraplength = self.wordWrapLength, 272 | anchor = tk.NW, 273 | justify = tk.LEFT 274 | ) 275 | self.labelClock.grid( 276 | column = 0, 277 | row = 0, 278 | sticky = tk.W+tk.N+tk.S, 279 | padx = self.padX, 280 | pady = self.padY 281 | ) 282 | 283 | # Timer Text Label 284 | self.labelTimer = tk.Label( 285 | self, 286 | text = "", 287 | font = (self.fontName, self.fontSizeClock, self.fontStyle), 288 | background = self.backgroundColour, 289 | foreground = self.textColour, 290 | wraplength = self.wordWrapLength, 291 | anchor = tk.NE, 292 | justify = tk.RIGHT 293 | ) 294 | self.labelTimer.grid( 295 | column = 1, 296 | row = 0, 297 | sticky = tk.E+tk.N+tk.S, 298 | padx = self.padX, 299 | pady = self.padY 300 | ) 301 | 302 | # Current Slide Text Label 303 | self.labelCurrent = tk.Label( 304 | self, 305 | text = "Waiting for data...", 306 | font = (self.fontName, self.fontSizeCurrent, self.fontStyle), 307 | background = self.backgroundColour, 308 | foreground = self.textColour, 309 | wraplength = self.wordWrapLength, 310 | anchor = tk.NW, 311 | justify = tk.LEFT, 312 | ) 313 | self.labelCurrent.grid( 314 | column = 0, 315 | row = 1, 316 | sticky = tk.W+tk.E+tk.N+tk.S, 317 | padx = self.padX, 318 | pady = self.padY, 319 | columnspan = 2, 320 | ) 321 | 322 | 323 | # Next Slide Text Label 324 | self.labelNext = tk.Label( 325 | self, 326 | text = "", 327 | font = (self.fontName, self.fontSizeNext, self.fontStyle), 328 | background = self.backgroundColour, 329 | foreground = self.textColour, 330 | wraplength = self.wordWrapLength, 331 | anchor = tk.NW, 332 | justify = tk.LEFT, 333 | ) 334 | self.labelNext.grid( 335 | column = 0, 336 | row = 2, 337 | sticky = tk.W+tk.E+tk.N+tk.S, 338 | padx = self.padX, 339 | pady = self.padY, 340 | columnspan = 2, 341 | ) 342 | 343 | def setupMainInterface_LowerThird(self): 344 | # Setup the interface widgets - for lower third mode 345 | 346 | # Setup the main window for the application 347 | tk.Frame.__init__( 348 | self, 349 | None, 350 | background = self.backgroundColour, 351 | cursor = "none" 352 | ) 353 | self.grid(sticky = tk.N + tk.S + tk.E + tk.W) 354 | 355 | self.top = self.winfo_toplevel() 356 | 357 | self.rowconfigure(0, weight = 1) 358 | self.columnconfigure(0, weight = 1) 359 | 360 | self.top.grid() 361 | self.top.rowconfigure(0, weight = 1) 362 | self.top.columnconfigure(0, weight = 1) 363 | 364 | self.lowerThirdContainer = tk.Frame( 365 | self, 366 | height = self.lowerThirdHeight, 367 | width = self.root.winfo_screenwidth() - (self.padX * 2), 368 | background = self.backgroundColour, 369 | ) 370 | self.lowerThirdContainer.pack_propagate(0) 371 | self.lowerThirdContainer.place(x = self.padX, y = self.root.winfo_screenheight() - self.padY - self.lowerThirdHeight) 372 | 373 | self.labelCurrent = tk.Label( 374 | self.lowerThirdContainer, 375 | text = "Waiting for data...", 376 | font = (self.fontName, self.fontSizeCurrent, self.fontStyle), 377 | foreground = self.textColour, 378 | background = self.backgroundColour, 379 | wraplength = self.wordWrapLength, 380 | justify = self.fontJustify, 381 | ) 382 | 383 | if self.fontJustify == tk.RIGHT: 384 | anchor = tk.E 385 | elif self.fontJustify == tk.LEFT: 386 | anchor = tk.W 387 | else: 388 | anchor = tk.CENTER 389 | 390 | if self.lowerThirdHeight == self.root.winfo_screenheight() - (self.padY * 2): 391 | # Anchor to bottom of screen - old behaviour is now the default 392 | expand = 0 393 | side = tk.BOTTOM 394 | else: 395 | # Centre align 396 | expand = 1 397 | side = tk.TOP 398 | 399 | self.labelCurrent.pack(fill = tk.Y, expand = expand, anchor = anchor, side = side) 400 | 401 | def updateSlideTextCurrent(self, data): 402 | # Update the text label for the current slide 403 | if self.labelCurrent is None: 404 | return False 405 | 406 | if data['text'] is None: 407 | self.currentText = "" 408 | return None 409 | 410 | if self.splitLinesChar is not None and data['text'] is not None and self.splitLinesChar in data['text']: 411 | data['text'] = data['text'].split(self.splitLinesChar) 412 | data['text'] = data['text'][0] 413 | 414 | if self.mergeLines: 415 | # Prepare to remove every 2nd line break 416 | lines = data['text'].encode('utf-8').split("\n") 417 | textOutput = "" 418 | 419 | if len(lines) < self.mergeLinesMin: 420 | # No need to merge these lines 421 | textOutput = "\n".join(lines) 422 | else: 423 | # Join every 2nd line to the previous 424 | for i, line in enumerate(lines): 425 | 426 | # Strip trailing or leading whitespace from each line 427 | line = line.strip() 428 | 429 | # Get rid of some trailing punctuation before the merge 430 | if line[-1:] in self.mergeLinesStripTrailing: 431 | line = line[:-1] 432 | 433 | if i == 0: 434 | textOutput = line 435 | elif i % 2 == 0: 436 | textOutput += "\n" + line 437 | else: 438 | textOutput += self.mergeLinesJoinChar.encode('utf-8') + " " + line 439 | else: 440 | textOutput = data['text'].encode('utf-8') 441 | 442 | # We want the text to be updated by the main thread, not the ProPresenter thread 443 | if self.fontUppercase: 444 | self.currentText = textOutput.upper() 445 | elif not self.fontUppercase: 446 | self.currentText = textOutput 447 | 448 | def updateSlideTextNext(self, data): 449 | # Update the text label for the next slide 450 | if self.labelNext is None: 451 | return False 452 | 453 | if self.splitLinesChar is not None and data['text'] is not None and self.splitLinesChar in data['text']: 454 | data['text'] = data['text'].split(self.splitLinesChar) 455 | data['text'] = data['text'][0] 456 | 457 | # We want the text to be updated by the main thread, not the ProPresenter thread 458 | if data['text'] is not None and self.fontUppercase: 459 | self.nextText = data['text'].encode('utf-8').upper() 460 | elif data['text'] is not None and not self.fontUppercase: 461 | self.nextText = data['text'].encode('utf-8') 462 | else: 463 | self.nextText = "" 464 | 465 | def updateTimer(self, data): 466 | # Update the various timers 467 | if self.labelTimer is None: 468 | return False 469 | 470 | if data['text'] is None or 'label' not in data: 471 | return None 472 | 473 | if data['text'] == "--:--:--": 474 | data['running'] = "0" 475 | 476 | if ('running' not in data or data['running'] == "0") and data['label'] in self.runningTimers: 477 | del self.runningTimers[data['label']] 478 | 479 | if 'overrun' not in data: 480 | data['overrun'] = '0' 481 | 482 | if 'running' in data and data['running'] == "1": 483 | self.runningTimers[data['label']] = { 484 | "current": data['text'], 485 | "overrun": data['overrun'], 486 | "type": data['type'], 487 | } 488 | 489 | if len(self.runningTimers) == 0: 490 | self.labelTimer.config(text = "") 491 | return None 492 | 493 | # Loop over all configured timers, and show the highest priority one 494 | for timerName in self.timerRank: 495 | if timerName in self.runningTimers: 496 | self.labelTimer.config(text = self.runningTimers[timerName]['current']) 497 | 498 | if self.runningTimers[timerName]['overrun'] == "1" and self.runningTimers[timerName]['current'][:1] == "-": 499 | self.labelTimer.config(foreground = "red") 500 | else: 501 | self.labelTimer.config(foreground = self.textColour) 502 | 503 | return True 504 | 505 | # Nothing to display - empty out the field 506 | self.labelTimer.config(text = "") 507 | 508 | def updateTimerVideo(self, data): 509 | # Update the video countdown timer 510 | if self.labelTimer is None: 511 | return False 512 | 513 | if data['text'] != '--:--:--': 514 | data['running'] = '1' 515 | 516 | self.updateTimer(data) 517 | 518 | def close(self, extra = None): 519 | # Terminate the application 520 | if self.ProPresenter is not None: 521 | self.ProPresenter.stop() 522 | 523 | self.root.destroy() 524 | 525 | def clock_tick(self): 526 | # Sets the clock time 527 | if self.labelClock is None: 528 | return False 529 | 530 | time_now = time.strftime('%I:%M:%S %p') 531 | 532 | # Update the timer on screen when the timer has incremented 533 | if time_now != self.time_last: 534 | self.time_last = time_now 535 | self.labelClock.config(text = time_now) 536 | 537 | self.labelClock.after(200, self.clock_tick) 538 | 539 | def updatetext_tick(self): 540 | # Update text from the main thread (to try and avoid redraw issues) 541 | 542 | if self.labelCurrent is not None: 543 | self.labelCurrent.configure(text = self.currentText) 544 | self.update_idletasks() 545 | 546 | if self.labelNext is not None: 547 | self.labelNext.configure(text = self.nextText) 548 | self.update_idletasks() 549 | 550 | if self.labelCurrent is not None: 551 | self.labelCurrent.after(100, self.updatetext_tick) 552 | 553 | if __name__ == "__main__": 554 | app = Application() 555 | app.master.title('ProPresenter Stage Display') 556 | app.clock_tick() 557 | app.updatetext_tick() 558 | app.mainloop() 559 | -------------------------------------------------------------------------------- /config-sample.json: -------------------------------------------------------------------------------- 1 | { 2 | "IPAddress": "127.0.0.1", 3 | "IPPort": 60119, 4 | "Password": "password", 5 | "WordWrapLength": 1500, 6 | "FontSizeClock": 52, 7 | "FontSizeCurrent": 52, 8 | "FontSizeNext": 36, 9 | "FontName": "Arial", 10 | "BackgroundColour": "#000000", 11 | "TextColour": "#FFFFFF", 12 | 13 | "LowerThirdMode": false, 14 | "FontStyle": "", 15 | "FontUppercase": false, 16 | "FontAlign": "center", 17 | "PadX": 50, 18 | "PadY": 50, 19 | "MergeLines": false, 20 | "MergeLinesMin": 4, 21 | "MergeLinesJoinChar": ",", 22 | 23 | "SplitLines": null, 24 | 25 | "TimerLabels": ["Elapsed Time", "Video Countdown"] 26 | } -------------------------------------------------------------------------------- /start.sh: -------------------------------------------------------------------------------- 1 | cd /home/pi/ProPresenter-Stage-Display-Python/ 2 | sleep 10 3 | python2 StageDisplay.py 4 | 5 | --------------------------------------------------------------------------------