Mercurial > PewPew
changeset 20:59f04961537e draft
Add assembly instructions to docs
| author | Radomir Dopieralski <sheep-devel@sheep.art.pl> |
|---|---|
| date | Wed, 30 Aug 2017 15:07:41 +0200 |
| parents | b1d274d05932 |
| children | 8b9e9ef8a88a |
| files | docs/assembly.rst docs/conf.py docs/images/pew-assembly.png docs/index.rst |
| diffstat | 4 files changed, 69 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/assembly.rst Wed Aug 30 15:07:41 2017 +0200 @@ -0,0 +1,67 @@ +Assembly and Setup +****************** + +The PewPew FeatherWing comes without the pin headers and LED matrix attached, +so that some simple soldering is required before using it. + + +Basic Assembly +============== + +The simplest way to assemble the PewPew board is to use an Adafruit Feather +board with female pin headers (Feather M0 Express works great for this), and +to solder the male pin headers onto the PewPew FeatherWing. Afterwars, insert +the LED Matrix into place, solder its pins from the bottom, and trim them with +wire cutters. + +.. image:: images/pew-assembly.png + +Make sure to insert the LED Matrix in correct orientation -- with the markings +in the same direction as the "down" button. Otherwise the colors will be wrong, +and the image will be flipped. + + +Making it Flatter +================= + +The basic assembly is fine, but it's good 2cm thick. You can make the whole +thing much thinner by applying a number of tricks. First, use the narrow female +pin headers for the Adafruit Feather. Second, move the plastic on your male pin +headers to the end of the header, insert the header from the top, and try it +with the Feather to see how long the pins need to be. Then solder them, and +trim the parts sticking out from the top with wire cutters. This way the PewPew +FeatherWing can sit right on top of the battery plug of the Feather. + +Note that the narrow headers are not included in the kit. + + +Optional Battery +================ + +To make the PewPew even more portable, you can add a small LiPO battery (the +100mAh batteries are about the right size). The FeatherWing even has a power +switch built-in that you can use. Just solder the battery leads to the two +holes marked "+" for the red wire, and "-" for the black wire. Be very careful +to not short the battery wires while you are doing that. Then you can use +two-sided tape to stick the battery on the underside of the FeatherWing, +sandwiching it between the two boards. You may need to add some electric tape +to prevent the metal body of the battery from shorting things on the boards. + +Note that the battery is not included in the kit. + + +Software Setup +============== + +All the example programs are written using CircuitPython, so you will need to +get that running on your Feather board. Fortunately Adafruit provides a lot of +tutorials about how to do it. Some of the boards (like the M0 Express) even +come with CircuitPython already loaded on them. + +Once you have CircuitPython running on the board, you need to copy the +``pew.mpy`` file to it. That's the main library that contains all the functions +needed to use the PewPew hardware. + +In addition, you need to copy your program onto the board. You have to name it +``main.py`` for it to be started automatically on power-up. Later on we will +see how we can use a menu program that will let you choose what to run.
--- a/docs/conf.py Fri Aug 25 10:44:17 2017 +0200 +++ b/docs/conf.py Wed Aug 30 15:07:41 2017 +0200 @@ -167,6 +167,6 @@ # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = { - 'python': ('https://docs.python.org/', None), + 'python': ('https://docs.python.org/3/', None), 'cp': ('http://circuitpython.readthedocs.io/en/stable/', None), }