|
| 1 | +|Scroll pHAT HD| https://shop.pimoroni.com/products/scroll-phat-hd |
| 2 | + |
| 3 | +17x7 pixels of single-colour, brightness-controlled, message scrolling |
| 4 | +goodness! |
| 5 | + |
| 6 | +Installing |
| 7 | +---------- |
| 8 | + |
| 9 | +Full install (recommended): |
| 10 | +~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 11 | + |
| 12 | +We've created an easy installation script that will install all |
| 13 | +pre-requisites and get your Scroll pHAT HD up and running with minimal |
| 14 | +efforts. To run it, fire up Terminal which you'll find in Menu -> |
| 15 | +Accessories -> Terminal on your Raspberry Pi desktop, as illustrated |
| 16 | +below: |
| 17 | + |
| 18 | +.. figure:: http://get.pimoroni.com/resources/github-repo-terminal.png |
| 19 | + :alt: Finding the terminal |
| 20 | + |
| 21 | +In the new terminal window type the command exactly as it appears below |
| 22 | +(check for typos) and follow the on-screen instructions: |
| 23 | + |
| 24 | +.. code:: bash |
| 25 | +
|
| 26 | + curl https://get.pimoroni.com/scrollphathd | bash |
| 27 | +
|
| 28 | +Alternatively, on Raspbian, you can download the ``pimoroni-dashboard`` |
| 29 | +and install your product by browsing to the relevant entry: |
| 30 | + |
| 31 | +.. code:: bash |
| 32 | +
|
| 33 | + sudo apt-get install pimoroni |
| 34 | +
|
| 35 | +(you will find the Dashboard under 'Accessories' too, in the Pi menu - |
| 36 | +or just run ``pimoroni-dashboard`` at the command line) |
| 37 | + |
| 38 | +If you choose to download examples you'll find them in |
| 39 | +``/home/pi/Pimoroni/scrollphathd/``. |
| 40 | + |
| 41 | +Manual install: |
| 42 | +~~~~~~~~~~~~~~~ |
| 43 | + |
| 44 | +Library install for Python 3: |
| 45 | +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 46 | + |
| 47 | +on Raspbian: |
| 48 | + |
| 49 | +.. code:: bash |
| 50 | +
|
| 51 | + sudo apt-get install python3-scrollphathd |
| 52 | +
|
| 53 | +other environments: |
| 54 | + |
| 55 | +.. code:: bash |
| 56 | +
|
| 57 | + sudo pip3 install scrollphathd |
| 58 | +
|
| 59 | +Library install for Python 2: |
| 60 | +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 61 | + |
| 62 | +on Raspbian: |
| 63 | + |
| 64 | +.. code:: bash |
| 65 | +
|
| 66 | + sudo apt-get install python-scrollphathd |
| 67 | +
|
| 68 | +other environments: |
| 69 | + |
| 70 | +.. code:: bash |
| 71 | +
|
| 72 | + sudo pip2 install scrollphathd |
| 73 | +
|
| 74 | +Development: |
| 75 | +~~~~~~~~~~~~ |
| 76 | + |
| 77 | +If you want to contribute, or like living on the edge of your seat by |
| 78 | +having the latest code, you should clone this repository, ``cd`` to the |
| 79 | +library directory, and run: |
| 80 | + |
| 81 | +.. code:: bash |
| 82 | +
|
| 83 | + sudo python3 setup.py install |
| 84 | +
|
| 85 | +(or ``sudo python setup.py install`` whichever your primary Python |
| 86 | +environment may be) |
| 87 | + |
| 88 | +In all cases you will have to enable the i2c bus. |
| 89 | + |
| 90 | +Documentation & Support |
| 91 | +----------------------- |
| 92 | + |
| 93 | +- Guides and tutorials - https://learn.pimoroni.com/scroll-phat-hd |
| 94 | +- Function reference - http://docs.pimoroni.com/scrollphathd/ |
| 95 | +- GPIO Pinout - https://pinout.xyz/pinout/scroll\_phat\_hd |
| 96 | +- Get help - http://forums.pimoroni.com/c/support |
| 97 | + |
| 98 | +Unofficial / Third-party libraries |
| 99 | +---------------------------------- |
| 100 | + |
| 101 | +- Java library by Jim Darby - https://github.com/hackerjimbo/PiJava |
| 102 | +- Rust library by Tiziano Santoro - |
| 103 | + https://github.com/tiziano88/scroll-phat-hd-rs |
| 104 | +- Go library by Tom Mitchell - |
| 105 | + https://github.com/tomnz/scroll-phat-hd-go |
| 106 | + |
| 107 | +.. |Scroll pHAT HD| image:: https://raw.githubusercontent.com/pimoroni/scroll-phat-hd/master/scroll-phat-hd-logo.png |
0 commit comments