├── .gitignore ├── LICENSE ├── README.md ├── doc ├── astro2x.png ├── date2x.png ├── fortune2x.png ├── time2x.png └── weather2x.png ├── images ├── Clear Sky.png ├── FirstQuarterMoon.png ├── FullMoon.png ├── Heavy Rain Shower.png ├── Heavy Rain.png ├── LastQuarterMoon.png ├── Light Cloud.png ├── Light Rain Shower.png ├── Light Rain.png ├── Mist.png ├── NewMoon.png ├── Partly Cloudy.png ├── Sunny Intervals.png ├── Sunny.png ├── Sunrise.png ├── Sunset.png ├── Thick Cloud.png └── Thunderstorm.png ├── messages ├── 01-00 ├── 16-00 ├── 16-04 ├── 16-08 ├── 16-12 ├── 99-00 ├── astro ├── date ├── fortune ├── time └── weather └── unicorn-scroller.py /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | 5 | # C extensions 6 | *.so 7 | 8 | # Distribution / packaging 9 | .Python 10 | env/ 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | *.egg-info/ 23 | .installed.cfg 24 | *.egg 25 | 26 | # PyInstaller 27 | # Usually these files are written by a python script from a template 28 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 29 | *.manifest 30 | *.spec 31 | 32 | # Installer logs 33 | pip-log.txt 34 | pip-delete-this-directory.txt 35 | 36 | # Unit test / coverage reports 37 | htmlcov/ 38 | .tox/ 39 | .coverage 40 | .coverage.* 41 | .cache 42 | nosetests.xml 43 | coverage.xml 44 | *,cover 45 | 46 | # Translations 47 | *.mo 48 | *.pot 49 | 50 | # Django stuff: 51 | *.log 52 | 53 | # Sphinx documentation 54 | docs/_build/ 55 | 56 | # PyBuilder 57 | target/ 58 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | {description} 294 | Copyright (C) {year} {fullname} 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | {signature of Ty Coon}, 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | 341 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # unicorn-scroller 2 | 3 | A scrolling information display for the Pimoroni Unicorn HAT/PHAT on Raspberry Pi. 4 | By Andrew Wedgbury 5 | 6 | ## Setup 7 | 8 | To start with, clone this git repo! 9 | 10 | Install the unicornhat Python module from Pimoroni following the [instructions here] (https://github.com/pimoroni/unicorn-hat). 11 | 12 | unicorn-scroller.py uses the [PIL](http://www.pythonware.com/products/pil/) module. 13 | The astro message script uses the [pyephem](http://rhodesmill.org/pyephem/) module. 14 | You can install these via pip with: 15 | 16 | sudo pip install PIL 17 | sudo pip install pyephem 18 | 19 | You also need a font to use when displaying text. It's difficult to find a font that looks good at 8 pixels high - The best I've found is Minecraftia-Regular, which you can download from http://www.dafont.com/minecraftia.font 20 | Unzip the font into the same directory as the script. You can also try out some different fonts - there are plenty available for free online. Unzip your chosen font into the same directory and modify the "font" and "font-offset" variables near the top of the main program. 21 | 22 | You'll find various other variables defined at the top of unicorn-scroller.py, which you can use to set the display orientation, brightness, background colour and scroll speed. 23 | 24 | ## Runing 25 | 26 | To run from the command line: 27 | 28 | sudo python unicorn-scroller.py 29 | 30 | To run on system boot, add the following to /etc/rc.local 31 | (before the "exit 0" line at the end): 32 | 33 | (cd /home/pi/unicorn-scroller && python unicorn-scroller.py)& 34 | 35 | Being sure to change /home/pi/unicorn-scroller to the actual directory where 36 | you checked out the files if different. 37 | 38 | ## Messages 39 | 40 | The program scrolls messages generated by scripts located in the messages subdirectory. 41 | Each script outputs its message in a simple format, consisting of text and the names of image files located in the images subdirectory. 42 | 43 | The following message scripts are available: 44 | (The example images shown below were generated by saving the PIL Image object as a PNG file, and scaling up by 2x, and use the Minecraftia-Regular font) 45 | 46 | ### time 47 | 48 | Example: ![time](doc/time2x.png) 49 | 50 | Displays the current time. 51 | Make sure you have your timezone set correctly! 52 | 53 | ### date 54 | 55 | Example: ![time](doc/date2x.png) 56 | 57 | Displays the current date. 58 | 59 | ### weather 60 | 61 | Example: ![time](doc/weather2x.png) 62 | 63 | Displays the current weather conditions plus a 3 day forecast. 64 | This uses [BBC weather feeds](https://support.bbc.co.uk/platform/feeds/WeatherFeeds.htm), you will need to edit the script and add your location ID, the previous link should explain how to get this. 65 | 66 | ### astro 67 | 68 | Example: ![time](doc/astro2x.png) 69 | 70 | Displays some astronimical information calculated using pyephem - moon phase, sunrise and sunset times. 71 | You will need to set the 'loc' variable near the top of this script to describe your location for this to be accurate. 72 | 73 | ### fortune 74 | 75 | Example: ![time](doc/fortune2x.png) 76 | 77 | Displays a short fortune cookie message generated by the unix [fortune](http://linux.die.net/man/6/fortune) program. 78 | 79 | 80 | ## Message frequency 81 | 82 | The order and frequency of the messages to be displayed is determined by a set of [symbolic links](https://en.wikipedia.org/wiki/Symbolic_link) in the messages subdirectory. The program looks for links named in the form of two numbers separated by a dash, which are interpreted as a denominator, **d** and remainder **r** in the following formuala: 83 | 84 | i % d == r 85 | 86 | Where **i** is an integer which starts at 1 and is incremented for every loop, and **%** is the modulus operator. 87 | 88 | The default configuration is the following set of links: 89 | 90 | 01-00 -> time 91 | 16-00 -> date 92 | 16-04 -> weather 93 | 16-08 -> date 94 | 16-12 -> astro 95 | 99-00 -> fortune 96 | 97 | So the *time* message is shown for every loop, *date* is shown every 8 loops, and *weather* and *astro* on every 16 loops. The *fortune* message is shown less frequently, on every 99 loops. You can change these links as required, by removing (using the rm command) and adding (using the ln -s command). For example, to show the *fortune* message every 50 loops: 98 | 99 | cd messages 100 | rm 99-00 101 | ln -s fortune 50-00 102 | 103 | You can of course modify the message scripts or add new ones as required! 104 | -------------------------------------------------------------------------------- /doc/astro2x.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sconemad/unicorn-scroller/acd9873b321b882d76be986598a50fb81aab3f5d/doc/astro2x.png -------------------------------------------------------------------------------- /doc/date2x.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sconemad/unicorn-scroller/acd9873b321b882d76be986598a50fb81aab3f5d/doc/date2x.png -------------------------------------------------------------------------------- /doc/fortune2x.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sconemad/unicorn-scroller/acd9873b321b882d76be986598a50fb81aab3f5d/doc/fortune2x.png -------------------------------------------------------------------------------- /doc/time2x.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sconemad/unicorn-scroller/acd9873b321b882d76be986598a50fb81aab3f5d/doc/time2x.png -------------------------------------------------------------------------------- /doc/weather2x.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sconemad/unicorn-scroller/acd9873b321b882d76be986598a50fb81aab3f5d/doc/weather2x.png -------------------------------------------------------------------------------- /images/Clear Sky.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sconemad/unicorn-scroller/acd9873b321b882d76be986598a50fb81aab3f5d/images/Clear Sky.png -------------------------------------------------------------------------------- /images/FirstQuarterMoon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sconemad/unicorn-scroller/acd9873b321b882d76be986598a50fb81aab3f5d/images/FirstQuarterMoon.png -------------------------------------------------------------------------------- /images/FullMoon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sconemad/unicorn-scroller/acd9873b321b882d76be986598a50fb81aab3f5d/images/FullMoon.png -------------------------------------------------------------------------------- /images/Heavy Rain Shower.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sconemad/unicorn-scroller/acd9873b321b882d76be986598a50fb81aab3f5d/images/Heavy Rain Shower.png -------------------------------------------------------------------------------- /images/Heavy Rain.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sconemad/unicorn-scroller/acd9873b321b882d76be986598a50fb81aab3f5d/images/Heavy Rain.png -------------------------------------------------------------------------------- /images/LastQuarterMoon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sconemad/unicorn-scroller/acd9873b321b882d76be986598a50fb81aab3f5d/images/LastQuarterMoon.png -------------------------------------------------------------------------------- /images/Light Cloud.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sconemad/unicorn-scroller/acd9873b321b882d76be986598a50fb81aab3f5d/images/Light Cloud.png -------------------------------------------------------------------------------- /images/Light Rain Shower.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sconemad/unicorn-scroller/acd9873b321b882d76be986598a50fb81aab3f5d/images/Light Rain Shower.png -------------------------------------------------------------------------------- /images/Light Rain.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sconemad/unicorn-scroller/acd9873b321b882d76be986598a50fb81aab3f5d/images/Light Rain.png -------------------------------------------------------------------------------- /images/Mist.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sconemad/unicorn-scroller/acd9873b321b882d76be986598a50fb81aab3f5d/images/Mist.png -------------------------------------------------------------------------------- /images/NewMoon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sconemad/unicorn-scroller/acd9873b321b882d76be986598a50fb81aab3f5d/images/NewMoon.png -------------------------------------------------------------------------------- /images/Partly Cloudy.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sconemad/unicorn-scroller/acd9873b321b882d76be986598a50fb81aab3f5d/images/Partly Cloudy.png -------------------------------------------------------------------------------- /images/Sunny Intervals.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sconemad/unicorn-scroller/acd9873b321b882d76be986598a50fb81aab3f5d/images/Sunny Intervals.png -------------------------------------------------------------------------------- /images/Sunny.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sconemad/unicorn-scroller/acd9873b321b882d76be986598a50fb81aab3f5d/images/Sunny.png -------------------------------------------------------------------------------- /images/Sunrise.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sconemad/unicorn-scroller/acd9873b321b882d76be986598a50fb81aab3f5d/images/Sunrise.png -------------------------------------------------------------------------------- /images/Sunset.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sconemad/unicorn-scroller/acd9873b321b882d76be986598a50fb81aab3f5d/images/Sunset.png -------------------------------------------------------------------------------- /images/Thick Cloud.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sconemad/unicorn-scroller/acd9873b321b882d76be986598a50fb81aab3f5d/images/Thick Cloud.png -------------------------------------------------------------------------------- /images/Thunderstorm.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sconemad/unicorn-scroller/acd9873b321b882d76be986598a50fb81aab3f5d/images/Thunderstorm.png -------------------------------------------------------------------------------- /messages/01-00: -------------------------------------------------------------------------------- 1 | time -------------------------------------------------------------------------------- /messages/16-00: -------------------------------------------------------------------------------- 1 | date -------------------------------------------------------------------------------- /messages/16-04: -------------------------------------------------------------------------------- 1 | weather -------------------------------------------------------------------------------- /messages/16-08: -------------------------------------------------------------------------------- 1 | date -------------------------------------------------------------------------------- /messages/16-12: -------------------------------------------------------------------------------- 1 | astro -------------------------------------------------------------------------------- /messages/99-00: -------------------------------------------------------------------------------- 1 | fortune -------------------------------------------------------------------------------- /messages/astro: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | import ephem 4 | import time 5 | 6 | # Location 7 | 8 | # Can be set by city: 9 | #loc = ephem.city("London") 10 | 11 | # Or by lat/long, this is for Cambridge, UK: 12 | loc = ephem.Observer() 13 | loc.lat = '52.205' 14 | loc.lon = '0.119' 15 | loc.elevation = 6 16 | 17 | now = ephem.now() 18 | loc.date = now 19 | 20 | # Moon phase 21 | phases = [ 22 | ("NewMoon", ephem.next_new_moon(now)), 23 | ("NewMoon", ephem.previous_new_moon(now)), 24 | ("FirstQuarterMoon", ephem.next_first_quarter_moon(now)), 25 | ("FirstQuarterMoon", ephem.previous_first_quarter_moon(now)), 26 | ("FullMoon", ephem.next_full_moon(now)), 27 | ("FullMoon", ephem.previous_full_moon(now)), 28 | ("LastQuarterMoon", ephem.next_last_quarter_moon(now)), 29 | ("LastQuarterMoon", ephem.previous_last_quarter_moon(now))] 30 | 31 | min_delta = 31 32 | phase_name = "" 33 | for phase in phases: 34 | delta = now - phase[1] 35 | if (abs(delta) < abs(min_delta)): 36 | min_delta = delta 37 | phase_name = phase[0] 38 | 39 | print 'image:%s.png' % (phase_name) 40 | if (int(min_delta) != 0): 41 | print 'colour:white' 42 | print 'text:%+d' % (min_delta) 43 | 44 | print 'color:grey' 45 | print 'text:|' 46 | 47 | # Sunrise/sunset 48 | # Also estimate the current brightness level from time of day 49 | 50 | next_sunrise = loc.next_rising(ephem.Sun()) 51 | next_sunset = loc.next_setting(ephem.Sun()) 52 | 53 | if next_sunset < next_sunrise: 54 | prev_sunrise = loc.previous_rising(ephem.Sun()) 55 | l = next_sunset - prev_sunrise 56 | p = now - prev_sunrise 57 | brightness = 100 * (1 - abs((p / l) - 0.5)) 58 | tsunrise = ephem.localtime(prev_sunrise) 59 | tsunset = ephem.localtime(next_sunset) 60 | 61 | else: 62 | prev_sunset = loc.previous_setting(ephem.Sun()) 63 | l = next_sunrise - prev_sunset 64 | p = now - prev_sunset 65 | brightness = 100 * abs((p / l) - 0.5) 66 | tsunrise = ephem.localtime(next_sunrise) 67 | tsunset = ephem.localtime(prev_sunset) 68 | 69 | print 'estimated-brightness:%d' % (brightness) 70 | 71 | print 'image:Sunrise.png' 72 | print 'colour:yellow' 73 | print 'text:%02u:%02u' % (tsunrise.hour, tsunrise.minute) 74 | 75 | print 'color:grey' 76 | print 'text:|' 77 | 78 | print 'image:Sunset.png' 79 | print 'colour:red' 80 | print 'text:%02u:%02u' % (tsunset.hour, tsunset.minute) 81 | -------------------------------------------------------------------------------- /messages/date: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | import time 4 | 5 | t = time.localtime() 6 | 7 | print 'colour:yellow' 8 | print 'text:%s' % (time.strftime('%a %d %b', t)) 9 | -------------------------------------------------------------------------------- /messages/fortune: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | import subprocess 4 | 5 | p = subprocess.Popen(['/usr/games/fortune','-s'], stdout=subprocess.PIPE) 6 | out = p.communicate()[0] 7 | 8 | print 'colour:#ff00ff' 9 | 10 | for line in out.splitlines(0): 11 | print 'text:'+line 12 | -------------------------------------------------------------------------------- /messages/time: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | import time 4 | 5 | t = time.localtime() 6 | 7 | print 'colour:white' 8 | print 'text:%s' % (time.strftime('%H', t)) 9 | 10 | print 'colour:cyan' 11 | print 'text::' 12 | 13 | print 'colour:white' 14 | print 'text:%s' % (time.strftime('%M', t)) 15 | -------------------------------------------------------------------------------- /messages/weather: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | import time, os, re 4 | 5 | import sys 6 | reload(sys) 7 | sys.setdefaultencoding('utf-8') 8 | 9 | # Weather station ID (see BBC weather website) 10 | weather_id = '2653941' 11 | 12 | # Cache file (set to empty string to disable cacheing) 13 | cache = 'weather-%s.cache' % (weather_id) 14 | 15 | # Refresh time in seconds for cache 16 | refresh = 15 * 60 17 | 18 | 19 | def parse_weather(str): 20 | weather = '' 21 | m = re.match(r'^(.+)\: (.+), Maximum Temperature: (.+) \(.+\) Minimum Temperature: (.+) \(.+\)',str) 22 | if (m): 23 | weather += 'colour:yellow\n' 24 | weather += 'text:%.3s\n' % (m.group(1)) 25 | weather += 'image:%s.png\n' % (m.group(2)) 26 | weather += 'colour:red\n' 27 | weather += 'text:%s\n' % (m.group(3)) 28 | weather += 'colour:blue\n' 29 | weather += 'text:%s\n' % (m.group(4)) 30 | return weather 31 | 32 | m = re.match(r'^(.+)\: (.+), Minimum Temperature: (.+) \(.+\)',str) 33 | if (m): 34 | weather += 'colour:yellow\n' 35 | weather += 'text:%.3s\n' % (m.group(1)) 36 | weather += 'image:%s.png\n' % (m.group(2)) 37 | weather += 'colour:blue\n' 38 | weather += 'text:%s\n' % (m.group(3)) 39 | return weather 40 | 41 | m = re.match(r'^.+\: (.*), (.*) \(',str) 42 | weather += 'image:%s.png\n' % (m.group(1)) 43 | weather += 'colour:red\n' 44 | weather += 'text:%s\n' % (m.group(2)) 45 | return weather 46 | 47 | def get_weather(): 48 | import feedparser 49 | weather = '' 50 | # Current weather conditions 51 | url = "https://weather-broker-cdn.api.bbci.co.uk/en/observation/rss/%s" % (weather_id) 52 | feed = feedparser.parse(url) 53 | fitems = feed["items"] 54 | weather += parse_weather(fitems[0].title) 55 | 56 | # 3-day forecast 57 | url = "https://weather-broker-cdn.api.bbci.co.uk/en/forecast/rss/3day/%s" % (weather_id) 58 | feed = feedparser.parse(url) 59 | fitems = feed["items"] 60 | for fitem in fitems: 61 | weather += 'color:grey\n' 62 | weather += 'text:|\n' 63 | weather += parse_weather(fitem.title) 64 | return weather 65 | 66 | 67 | # Check if there is a cache file that has been updated within the 68 | # refresh time, if so use it. 69 | if (cache and 70 | os.path.isfile(cache) and 71 | (time.time() - os.path.getmtime(cache) < refresh)): 72 | print '# cached' 73 | f = open(cache, 'r') 74 | print f.read() 75 | exit(0) 76 | 77 | # Otherwise update and cache the data if required 78 | 79 | weather = get_weather() 80 | if (cache): 81 | f = open(cache, 'w+') 82 | f.write(weather) 83 | f.close() 84 | print '# updating' 85 | print weather 86 | -------------------------------------------------------------------------------- /unicorn-scroller.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # coding=utf-8 3 | 4 | # unicorn-scroller - A scrolling information display for the 5 | # Pimoroni Unicorn HAT/PHAT on Raspberry Pi. 6 | # 7 | # By Andrew Wedgbury 8 | # See README.md for more info 9 | # 10 | 11 | import unicornhat as unicorn 12 | from PIL import ImageFont, ImageColor, ImageDraw, ImageFilter, Image 13 | import time, sys, getopt, os, re, subprocess 14 | from random import randint 15 | 16 | # 17 | # --- Things you probably want to set --- 18 | # 19 | 20 | # Select rotation 0, 90, 180, 270 depending on how you mount the Pi 21 | # i.e. 0 means the HDMI socket is at the bottom 22 | unicorn.rotation(0) 23 | 24 | # Display brightness (0...1, 1 is very very very bright) 25 | brightness_min = 0.3 26 | brightness_max = 0.6 27 | estimate_brightness = 1 28 | 29 | # Text font 30 | # It's difficult to find a font that looks good at 8 pixels high - 31 | # The best I've found is Minecraftia-Regular, which you can download 32 | # from http://www.dafont.com/minecraftia.font 33 | # Unzip the font into the same directory as the script. 34 | font = ImageFont.truetype("Minecraftia-Regular.ttf", 8) 35 | 36 | # Y-shift to apply to the font to make it display correctly 37 | font_offset = -2 38 | 39 | # Pause between steps in seconds, defines the scroll speed 40 | # Too fast and you can't read it, or can you? 41 | step = 0.05 42 | 43 | # Background colour 44 | back='black' 45 | 46 | # Directory containing message scripts 47 | messages_dir = 'messages' 48 | 49 | # Directory containing images 50 | images_dir = 'images' 51 | 52 | # Detect HAT or PHAT layout and adapt accordingly 53 | # If yours isn't detected properly, then you may need 54 | # to change the following line to say HAT or PHAT 55 | # instead of AUTO: 56 | unicorn.set_layout(unicorn.AUTO) 57 | geom = unicorn.get_shape() 58 | if (geom[0] != geom[1]): 59 | unicorn.set_layout([ 60 | [0 , 1 , 2 , 3 , 4 , 5 , 6 , 7 ], 61 | [8 , 9 , 10, 11, 12, 13, 14, 15], 62 | [16, 17, 18, 19, 20, 21, 22, 23], 63 | [24, 25, 26, 27, 28, 29, 30, 31] 64 | ]) 65 | step *= 2 66 | 67 | 68 | def set_brightness(pc): 69 | b = brightness_min + ((brightness_max - brightness_min) * pc / 100.0) 70 | if (b > brightness_max): b = brightness_max 71 | if (b < brightness_min): b = brightness_min 72 | unicorn.brightness(b) 73 | 74 | def get_item_size(item): 75 | width = 1 76 | frames = 1 77 | if ('text' in item): 78 | width += font.getsize(item['text'])[0] 79 | elif ('image' in item): 80 | width += item['image'].size[0] 81 | frames = item['image'].size[1] / 8 82 | return width,frames 83 | 84 | def get_size(items): 85 | width = 0 86 | frames = 1 87 | for item in items: 88 | w,f = get_item_size(item) 89 | width += w 90 | frames = max(f, frames) 91 | return width,frames 92 | 93 | def render(items): 94 | width,frames = get_size(items) 95 | image = Image.new('RGB', (width,8), back) 96 | pos = 0 97 | for item in items: 98 | w,f = get_item_size(item) 99 | if ('text' in item): 100 | draw = ImageDraw.Draw(image) 101 | draw.text((pos, font_offset), item['text'], font=font, fill=item['fore']) 102 | elif ('image' in item): 103 | image.paste(item['image'], (pos,0)) 104 | pos += w 105 | return image 106 | 107 | def scroll(image): 108 | width,height = image.size 109 | for offset in range(-geom[1],width): 110 | for x in range(geom[1]): 111 | for y in range(8): 112 | if ((x+offset < 0) | (x+offset >= width)): 113 | r,g,b = ImageColor.getrgb(back) 114 | else: 115 | r, g, b = image.getpixel((x+offset,y)) 116 | unicorn.set_pixel(x,y, r,g,b) 117 | unicorn.show() 118 | time.sleep(step) 119 | 120 | def process_line(l): 121 | # print l 122 | global colour 123 | items = [] 124 | global estimate_brightness 125 | m = re.match(r'^colou?r: *(.+) *$', l) 126 | if (m): 127 | try: 128 | c = ImageColor.getrgb(m.group(1)) 129 | colour = m.group(1) 130 | except ValueError: 131 | print 'ERROR: Unknown colour: %s' % m.group(1) 132 | colour = 'white' 133 | return 134 | 135 | m = re.match(r'^text:(.+)$', l) 136 | if (m): 137 | return {'text':m.group(1), 'fore':colour} 138 | 139 | m = re.match(r'^image:(.+)$', l) 140 | if (m): 141 | try: 142 | im = Image.open(images_dir + '/' + m.group(1)) 143 | return {'image':im} 144 | except IOError: 145 | return {'text:' % (m.group(1))} 146 | return 147 | 148 | m = re.match(r'^estimated-brightness: *(\d+) *$', l) 149 | if (m and estimate_brightness): 150 | set_brightness(int(m.group(1))) 151 | return 152 | 153 | m = re.match(r'^measured-brightness: *(\d+) *$', l) 154 | if (m): 155 | set_brightness(int(m.group(1))) 156 | # Disable brightness estimation if measured 157 | estimate_brightness = 0 158 | return 159 | 160 | def process_message(f): 161 | items = [] 162 | global z 163 | p = subprocess.Popen([f], stdout=subprocess.PIPE, stderr=subprocess.PIPE) 164 | out,err = p.communicate() 165 | if (err): 166 | print "ERROR(%s): %s" % (f,err) 167 | for l in out.splitlines(0): 168 | item = process_line(l.decode('utf-8')) 169 | if (item): items.append(item) 170 | image = render(items) 171 | scroll(image) 172 | 173 | 174 | # Set medium brightness to start 175 | set_brightness(50) 176 | 177 | # Main loop 178 | i = 0 179 | while True: 180 | i += 1 181 | dir = os.listdir(messages_dir) 182 | dir.sort() 183 | for f in dir: 184 | path = messages_dir + '/' + f 185 | if (not os.access(path, os.X_OK)): continue 186 | m = re.match(r'^(\d+)\-(\d+)(\-[^~]+)?$', f) 187 | if (m): 188 | d = int(m.group(1)) 189 | e = int(m.group(2)) 190 | if (i % d == e): 191 | process_message(path) 192 | --------------------------------------------------------------------------------